commonMain.aws.sdk.kotlin.services.gamelift.model.ScalingPolicy.kt Maven / Gradle / Ivy

Go to download
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.gamelift.model



/**
 * Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.
 */
public class ScalingPolicy private constructor(builder: Builder) {
    /**
     * Comparison operator to use when measuring a metric against the threshold value.
     */
    public val comparisonOperator: aws.sdk.kotlin.services.gamelift.model.ComparisonOperatorType? = builder.comparisonOperator
    /**
     * Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
     */
    public val evaluationPeriods: kotlin.Int? = builder.evaluationPeriods
    /**
     * The Amazon Resource Name ([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is `arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912`.
     */
    public val fleetArn: kotlin.String? = builder.fleetArn
    /**
     * A unique identifier for the fleet that is associated with this scaling policy.
     */
    public val fleetId: kotlin.String? = builder.fleetId
    /**
     * The fleet location.
     */
    public val location: kotlin.String? = builder.location
    /**
     * Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see [Monitor Amazon GameLift with Amazon CloudWatch](https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html).
     * + **ActivatingGameSessions** -- Game sessions in the process of being created.
     * + **ActiveGameSessions** -- Game sessions that are currently running.
     * + **ActiveInstances** -- Fleet instances that are currently running at least one game session.
     * + **AvailableGameSessions** -- Additional game sessions that fleet could host simultaneously, given current capacity.
     * + **AvailablePlayerSessions** -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.
     * + **CurrentPlayerSessions** -- Player slots in active game sessions that are being used by a player or are reserved for a player.
     * + **IdleInstances** -- Active instances that are currently hosting zero game sessions.
     * + **PercentAvailableGameSessions** -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.
     * + **PercentIdleInstances** -- Percentage of the total number of active instances that are hosting zero game sessions.
     * + **QueueDepth** -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.
     * + **WaitTime** -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination.
     */
    public val metricName: aws.sdk.kotlin.services.gamelift.model.MetricName? = builder.metricName
    /**
     * A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
     */
    public val name: kotlin.String? = builder.name
    /**
     * 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*.
     */
    public val policyType: aws.sdk.kotlin.services.gamelift.model.PolicyType? = builder.policyType
    /**
     * Amount of adjustment to make, based on the scaling adjustment type.
     */
    public val scalingAdjustment: kotlin.Int? = builder.scalingAdjustment
    /**
     * The type of adjustment to make to a fleet's instance count.
     * + **ChangeInCapacity** -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.
     * + **ExactCapacity** -- set the instance count to the scaling adjustment value.
     * + **PercentChangeInCapacity** -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down.
     */
    public val scalingAdjustmentType: aws.sdk.kotlin.services.gamelift.model.ScalingAdjustmentType? = builder.scalingAdjustmentType
    /**
     * 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.
     * + **ACTIVE** -- The scaling policy can be used for auto-scaling a fleet.
     * + **UPDATE_REQUESTED** -- A request to update the scaling policy has been received.
     * + **UPDATING** -- A change is being made to the scaling policy.
     * + **DELETE_REQUESTED** -- A request to delete the scaling policy has been received.
     * + **DELETING** -- The scaling policy is being deleted.
     * + **DELETED** -- The scaling policy has been deleted.
     * + **ERROR** -- An error occurred in creating the policy. It should be removed and recreated.
     */
    public val status: aws.sdk.kotlin.services.gamelift.model.ScalingStatusType? = builder.status
    /**
     * An object that contains settings for a target-based scaling policy.
     */
    public val targetConfiguration: aws.sdk.kotlin.services.gamelift.model.TargetConfiguration? = builder.targetConfiguration
    /**
     * Metric value used to trigger a scaling event.
     */
    public val threshold: kotlin.Double? = builder.threshold
    /**
     * 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.
     */
    public val updateStatus: aws.sdk.kotlin.services.gamelift.model.LocationUpdateStatus? = builder.updateStatus

    public companion object {
        public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.gamelift.model.ScalingPolicy = Builder().apply(block).build()
    }

    override fun toString(): kotlin.String = buildString {
        append("ScalingPolicy(")
        append("comparisonOperator=$comparisonOperator,")
        append("evaluationPeriods=$evaluationPeriods,")
        append("fleetArn=$fleetArn,")
        append("fleetId=$fleetId,")
        append("location=$location,")
        append("metricName=$metricName,")
        append("name=$name,")
        append("policyType=$policyType,")
        append("scalingAdjustment=$scalingAdjustment,")
        append("scalingAdjustmentType=$scalingAdjustmentType,")
        append("status=$status,")
        append("targetConfiguration=$targetConfiguration,")
        append("threshold=$threshold,")
        append("updateStatus=$updateStatus")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = comparisonOperator?.hashCode() ?: 0
        result = 31 * result + (evaluationPeriods ?: 0)
        result = 31 * result + (fleetArn?.hashCode() ?: 0)
        result = 31 * result + (fleetId?.hashCode() ?: 0)
        result = 31 * result + (location?.hashCode() ?: 0)
        result = 31 * result + (metricName?.hashCode() ?: 0)
        result = 31 * result + (name?.hashCode() ?: 0)
        result = 31 * result + (policyType?.hashCode() ?: 0)
        result = 31 * result + (scalingAdjustment ?: 0)
        result = 31 * result + (scalingAdjustmentType?.hashCode() ?: 0)
        result = 31 * result + (status?.hashCode() ?: 0)
        result = 31 * result + (targetConfiguration?.hashCode() ?: 0)
        result = 31 * result + (threshold?.hashCode() ?: 0)
        result = 31 * result + (updateStatus?.hashCode() ?: 0)
        return result
    }

    override fun equals(other: kotlin.Any?): kotlin.Boolean {
        if (this === other) return true
        if (other == null || this::class != other::class) return false

        other as ScalingPolicy

        if (comparisonOperator != other.comparisonOperator) return false
        if (evaluationPeriods != other.evaluationPeriods) return false
        if (fleetArn != other.fleetArn) return false
        if (fleetId != other.fleetId) return false
        if (location != other.location) return false
        if (metricName != other.metricName) return false
        if (name != other.name) return false
        if (policyType != other.policyType) return false
        if (scalingAdjustment != other.scalingAdjustment) return false
        if (scalingAdjustmentType != other.scalingAdjustmentType) return false
        if (status != other.status) return false
        if (targetConfiguration != other.targetConfiguration) return false
        if (threshold != other.threshold) return false
        if (updateStatus != other.updateStatus) return false

        return true
    }

    public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.gamelift.model.ScalingPolicy = Builder(this).apply(block).build()

    public class Builder {
        /**
         * Comparison operator to use when measuring a metric against the threshold value.
         */
        public var comparisonOperator: aws.sdk.kotlin.services.gamelift.model.ComparisonOperatorType? = null
        /**
         * Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
         */
        public var evaluationPeriods: kotlin.Int? = null
        /**
         * The Amazon Resource Name ([ARN](https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html)) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is `arn:aws:gamelift:::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912`.
         */
        public var fleetArn: kotlin.String? = null
        /**
         * A unique identifier for the fleet that is associated with this scaling policy.
         */
        public var fleetId: kotlin.String? = null
        /**
         * The fleet location.
         */
        public var location: kotlin.String? = null
        /**
         * Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see [Monitor Amazon GameLift with Amazon CloudWatch](https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html).
         * + **ActivatingGameSessions** -- Game sessions in the process of being created.
         * + **ActiveGameSessions** -- Game sessions that are currently running.
         * + **ActiveInstances** -- Fleet instances that are currently running at least one game session.
         * + **AvailableGameSessions** -- Additional game sessions that fleet could host simultaneously, given current capacity.
         * + **AvailablePlayerSessions** -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.
         * + **CurrentPlayerSessions** -- Player slots in active game sessions that are being used by a player or are reserved for a player.
         * + **IdleInstances** -- Active instances that are currently hosting zero game sessions.
         * + **PercentAvailableGameSessions** -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.
         * + **PercentIdleInstances** -- Percentage of the total number of active instances that are hosting zero game sessions.
         * + **QueueDepth** -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.
         * + **WaitTime** -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination.
         */
        public var metricName: aws.sdk.kotlin.services.gamelift.model.MetricName? = null
        /**
         * A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
         */
        public var name: kotlin.String? = 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*.
         */
        public var policyType: aws.sdk.kotlin.services.gamelift.model.PolicyType? = null
        /**
         * Amount of adjustment to make, based on the scaling adjustment type.
         */
        public var scalingAdjustment: kotlin.Int? = null
        /**
         * The type of adjustment to make to a fleet's instance count.
         * + **ChangeInCapacity** -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.
         * + **ExactCapacity** -- set the instance count to the scaling adjustment value.
         * + **PercentChangeInCapacity** -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down.
         */
        public var scalingAdjustmentType: aws.sdk.kotlin.services.gamelift.model.ScalingAdjustmentType? = 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.
         * + **ACTIVE** -- The scaling policy can be used for auto-scaling a fleet.
         * + **UPDATE_REQUESTED** -- A request to update the scaling policy has been received.
         * + **UPDATING** -- A change is being made to the scaling policy.
         * + **DELETE_REQUESTED** -- A request to delete the scaling policy has been received.
         * + **DELETING** -- The scaling policy is being deleted.
         * + **DELETED** -- The scaling policy has been deleted.
         * + **ERROR** -- An error occurred in creating the policy. It should be removed and recreated.
         */
        public var status: aws.sdk.kotlin.services.gamelift.model.ScalingStatusType? = null
        /**
         * An object that contains settings for a target-based scaling policy.
         */
        public var targetConfiguration: aws.sdk.kotlin.services.gamelift.model.TargetConfiguration? = null
        /**
         * Metric value used to trigger a scaling event.
         */
        public var threshold: kotlin.Double? = 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.
         */
        public var updateStatus: aws.sdk.kotlin.services.gamelift.model.LocationUpdateStatus? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.gamelift.model.ScalingPolicy) : this() {
            this.comparisonOperator = x.comparisonOperator
            this.evaluationPeriods = x.evaluationPeriods
            this.fleetArn = x.fleetArn
            this.fleetId = x.fleetId
            this.location = x.location
            this.metricName = x.metricName
            this.name = x.name
            this.policyType = x.policyType
            this.scalingAdjustment = x.scalingAdjustment
            this.scalingAdjustmentType = x.scalingAdjustmentType
            this.status = x.status
            this.targetConfiguration = x.targetConfiguration
            this.threshold = x.threshold
            this.updateStatus = x.updateStatus
        }

        @PublishedApi
        internal fun build(): aws.sdk.kotlin.services.gamelift.model.ScalingPolicy = ScalingPolicy(this)

        /**
         * construct an [aws.sdk.kotlin.services.gamelift.model.TargetConfiguration] inside the given [block]
         */
        public fun targetConfiguration(block: aws.sdk.kotlin.services.gamelift.model.TargetConfiguration.Builder.() -> kotlin.Unit) {
            this.targetConfiguration = aws.sdk.kotlin.services.gamelift.model.TargetConfiguration.invoke(block)
        }

        internal fun correctErrors(): Builder {
            return this
        }
    }
}