pulumi-aws-native-kotlin/com.pulumi.awsnative.gamelift.kotlin.inputs/FleetScalingPolicyArgs

FleetScalingPolicyArgs

data class FleetScalingPolicyArgs(val comparisonOperator: Output<FleetScalingPolicyComparisonOperator>? = null, val evaluationPeriods: Output<Int>? = null, val location: Output<String>? = null, val metricName: Output<FleetScalingPolicyMetricName>, val name: Output<String>, val policyType: Output<FleetScalingPolicyPolicyType>? = null, val scalingAdjustment: Output<Int>? = null, val scalingAdjustmentType: Output<FleetScalingPolicyScalingAdjustmentType>? = null, val status: Output<FleetScalingPolicyStatus>? = null, val targetConfiguration: Output<FleetTargetConfigurationArgs>? = null, val threshold: Output<Double>? = null, val updateStatus: Output<FleetScalingPolicyUpdateStatus>? = null) : ConvertibleToJava<FleetScalingPolicyArgs>

Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.

Constructors

constructor(comparisonOperator: Output<FleetScalingPolicyComparisonOperator>? = null, evaluationPeriods: Output<Int>? = null, location: Output<String>? = null, metricName: Output<FleetScalingPolicyMetricName>, name: Output<String>, policyType: Output<FleetScalingPolicyPolicyType>? = null, scalingAdjustment: Output<Int>? = null, scalingAdjustmentType: Output<FleetScalingPolicyScalingAdjustmentType>? = null, status: Output<FleetScalingPolicyStatus>? = null, targetConfiguration: Output<FleetTargetConfigurationArgs>? = null, threshold: Output<Double>? = null, updateStatus: Output<FleetScalingPolicyUpdateStatus>? = null)

Properties

comparisonOperator

val comparisonOperator: Output<FleetScalingPolicyComparisonOperator>? = null

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

evaluationPeriods

val evaluationPeriods: Output<Int>? = null

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

location

val location: Output<String>? = null

The fleet location.

metricName

val metricName: Output<FleetScalingPolicyMetricName>

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

name

val name: Output<String>

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

policyType

val policyType: Output<FleetScalingPolicyPolicyType>? = null

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.

scalingAdjustment

val scalingAdjustment: Output<Int>? = null

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

scalingAdjustmentType

val scalingAdjustmentType: Output<FleetScalingPolicyScalingAdjustmentType>? = null

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

status

val status: Output<FleetScalingPolicyStatus>? = null

Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets. If the policy is suspended for a fleet, the policy status does not change.

targetConfiguration

val targetConfiguration: Output<FleetTargetConfigurationArgs>? = null

An object that contains settings for a target-based scaling policy.

threshold

val threshold: Output<Double>? = null

Metric value used to trigger a scaling event.

updateStatus

val updateStatus: Output<FleetScalingPolicyUpdateStatus>? = null

The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.

Functions

toJava

open override fun toJava(): FleetScalingPolicyArgs