Package software.amazon.awscdk.services.gamelift

Class CfnContainerFleet.ScalingPolicyProperty.Builder

java.lang.Object

software.amazon.awscdk.services.gamelift.CfnContainerFleet.ScalingPolicyProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnContainerFleet.ScalingPolicyProperty>

Enclosing interface:

CfnContainerFleet.ScalingPolicyProperty

@Stability(Stable)
public static final class CfnContainerFleet.ScalingPolicyProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnContainerFleet.ScalingPolicyProperty>

A builder for CfnContainerFleet.ScalingPolicyProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnContainerFleet.ScalingPolicyProperty	build()	Builds the configured instance.
CfnContainerFleet.ScalingPolicyProperty.Builder	comparisonOperator(String comparisonOperator)	Sets the value of CfnContainerFleet.ScalingPolicyProperty.getComparisonOperator()
CfnContainerFleet.ScalingPolicyProperty.Builder	evaluationPeriods(Number evaluationPeriods)	Sets the value of CfnContainerFleet.ScalingPolicyProperty.getEvaluationPeriods()
CfnContainerFleet.ScalingPolicyProperty.Builder	metricName(String metricName)	Sets the value of CfnContainerFleet.ScalingPolicyProperty.getMetricName()
CfnContainerFleet.ScalingPolicyProperty.Builder	name(String name)	Sets the value of CfnContainerFleet.ScalingPolicyProperty.getName()
CfnContainerFleet.ScalingPolicyProperty.Builder	policyType(String policyType)	Sets the value of CfnContainerFleet.ScalingPolicyProperty.getPolicyType()
CfnContainerFleet.ScalingPolicyProperty.Builder	scalingAdjustment(Number scalingAdjustment)	Sets the value of CfnContainerFleet.ScalingPolicyProperty.getScalingAdjustment()
CfnContainerFleet.ScalingPolicyProperty.Builder	scalingAdjustmentType(String scalingAdjustmentType)	Sets the value of CfnContainerFleet.ScalingPolicyProperty.getScalingAdjustmentType()
CfnContainerFleet.ScalingPolicyProperty.Builder	targetConfiguration(IResolvable targetConfiguration)	Sets the value of CfnContainerFleet.ScalingPolicyProperty.getTargetConfiguration()
CfnContainerFleet.ScalingPolicyProperty.Builder	targetConfiguration(CfnContainerFleet.TargetConfigurationProperty targetConfiguration)	Sets the value of CfnContainerFleet.ScalingPolicyProperty.getTargetConfiguration()
CfnContainerFleet.ScalingPolicyProperty.Builder	threshold(Number threshold)	Sets the value of CfnContainerFleet.ScalingPolicyProperty.getThreshold()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

metricName

@Stability(Stable)
public CfnContainerFleet.ScalingPolicyProperty.Builder metricName(String metricName)

Sets the value of CfnContainerFleet.ScalingPolicyProperty.getMetricName()

Parameters:

metricName - Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. This parameter is required.

Returns:

this

name

@Stability(Stable)
public CfnContainerFleet.ScalingPolicyProperty.Builder name(String name)

Sets the value of CfnContainerFleet.ScalingPolicyProperty.getName()

Parameters:

name - A descriptive label that is associated with a fleet's scaling policy. This parameter is required. Policy names do not need to be unique.

Returns:

this

comparisonOperator

@Stability(Stable)
public CfnContainerFleet.ScalingPolicyProperty.Builder comparisonOperator(String comparisonOperator)

Sets the value of CfnContainerFleet.ScalingPolicyProperty.getComparisonOperator()

Parameters:

comparisonOperator - Comparison operator to use when measuring a metric against the threshold value.

Returns:

this

evaluationPeriods

@Stability(Stable)
public CfnContainerFleet.ScalingPolicyProperty.Builder evaluationPeriods(Number evaluationPeriods)

Sets the value of CfnContainerFleet.ScalingPolicyProperty.getEvaluationPeriods()

Parameters:

evaluationPeriods - Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.

Returns:

this

policyType

@Stability(Stable)
public CfnContainerFleet.ScalingPolicyProperty.Builder policyType(String policyType)

Sets the value of CfnContainerFleet.ScalingPolicyProperty.getPolicyType()

Parameters:

policyType - The type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.

Returns:

this

scalingAdjustment

@Stability(Stable)
public CfnContainerFleet.ScalingPolicyProperty.Builder scalingAdjustment(Number scalingAdjustment)

Sets the value of CfnContainerFleet.ScalingPolicyProperty.getScalingAdjustment()

Parameters:

scalingAdjustment - Amount of adjustment to make, based on the scaling adjustment type.

Returns:

this

scalingAdjustmentType

@Stability(Stable)
public CfnContainerFleet.ScalingPolicyProperty.Builder scalingAdjustmentType(String scalingAdjustmentType)

Sets the value of CfnContainerFleet.ScalingPolicyProperty.getScalingAdjustmentType()

Parameters:

scalingAdjustmentType - The type of adjustment to make to a fleet's instance count.

Returns:

this

targetConfiguration

@Stability(Stable)
public CfnContainerFleet.ScalingPolicyProperty.Builder targetConfiguration(IResolvable targetConfiguration)

Sets the value of CfnContainerFleet.ScalingPolicyProperty.getTargetConfiguration()

Parameters:

targetConfiguration - Settings for a target-based scaling policy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value.

Returns:

this

targetConfiguration

@Stability(Stable)
public CfnContainerFleet.ScalingPolicyProperty.Builder targetConfiguration(CfnContainerFleet.TargetConfigurationProperty targetConfiguration)

Sets the value of CfnContainerFleet.ScalingPolicyProperty.getTargetConfiguration()

Parameters:

targetConfiguration - Settings for a target-based scaling policy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value.

Returns:

this

threshold

@Stability(Stable)
public CfnContainerFleet.ScalingPolicyProperty.Builder threshold(Number threshold)

Sets the value of CfnContainerFleet.ScalingPolicyProperty.getThreshold()

Parameters:

threshold - Metric value used to trigger a scaling event.

Returns:

this

build

@Stability(Stable)
public CfnContainerFleet.ScalingPolicyProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnContainerFleet.ScalingPolicyProperty>

Returns:

a new instance of CfnContainerFleet.ScalingPolicyProperty

Throws:

NullPointerException - if any required attribute was not provided