Package software.amazon.awscdk.services.gamelift

Interface CfnFleet.TargetConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFleet.TargetConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnFleet

@Stability(Stable)
public static interface CfnFleet.TargetConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.gamelift.*;
 TargetConfigurationProperty targetConfigurationProperty = TargetConfigurationProperty.builder()
         .targetValue(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-targetconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFleet.TargetConfigurationProperty.Builder	A builder for CfnFleet.TargetConfigurationProperty
static final class	CfnFleet.TargetConfigurationProperty.Jsii$Proxy	An implementation for CfnFleet.TargetConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnFleet.TargetConfigurationProperty.Builder	builder()
Number	getTargetValue()	Desired value to use with a target-based scaling policy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTargetValue

@Stability(Stable)
@NotNull
Number getTargetValue()

Desired value to use with a target-based scaling policy.

The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-targetconfiguration.html#cfn-gamelift-fleet-targetconfiguration-targetvalue

builder

@Stability(Stable)
static CfnFleet.TargetConfigurationProperty.Builder builder()

Returns:

a CfnFleet.TargetConfigurationProperty.Builder of CfnFleet.TargetConfigurationProperty