commonMain.aws.sdk.kotlin.services.applicationautoscaling.model.PredefinedMetricSpecification.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of applicationautoscaling-jvm Show documentation
The AWS Kotlin client for Application Auto Scaling
The newest version!
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.applicationautoscaling.model

import aws.smithy.kotlin.runtime.SdkDsl

/**
 * Represents a predefined metric for a target tracking scaling policy to use with Application Auto Scaling.
 *
 * For more information, [Predefined metrics for target tracking scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/monitor-cloudwatch-metrics.html#predefined-metrics) in the *Application Auto Scaling User Guide*.
 */
public class PredefinedMetricSpecification private constructor(builder: Builder) {
    /**
     * The metric type. The `ALBRequestCountPerTarget` metric type applies only to Spot Fleets and ECS services.
     */
    public val predefinedMetricType: aws.sdk.kotlin.services.applicationautoscaling.model.MetricType = requireNotNull(builder.predefinedMetricType) { "A non-null value must be provided for predefinedMetricType" }
    /**
     * Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is `ALBRequestCountPerTarget` and there is a target group attached to the Spot Fleet or ECS service.
     *
     * You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
     *
     * `app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff`.
     *
     * Where:
     * + app// is the final portion of the load balancer ARN
     * + targetgroup// is the final portion of the target group ARN.
     *
     * To find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation.
     */
    public val resourceLabel: kotlin.String? = builder.resourceLabel

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

    override fun toString(): kotlin.String = buildString {
        append("PredefinedMetricSpecification(")
        append("predefinedMetricType=$predefinedMetricType,")
        append("resourceLabel=$resourceLabel")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = predefinedMetricType.hashCode()
        result = 31 * result + (resourceLabel?.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 PredefinedMetricSpecification

        if (predefinedMetricType != other.predefinedMetricType) return false
        if (resourceLabel != other.resourceLabel) return false

        return true
    }

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

    @SdkDsl
    public class Builder {
        /**
         * The metric type. The `ALBRequestCountPerTarget` metric type applies only to Spot Fleets and ECS services.
         */
        public var predefinedMetricType: aws.sdk.kotlin.services.applicationautoscaling.model.MetricType? = null
        /**
         * Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is `ALBRequestCountPerTarget` and there is a target group attached to the Spot Fleet or ECS service.
         *
         * You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
         *
         * `app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff`.
         *
         * Where:
         * + app// is the final portion of the load balancer ARN
         * + targetgroup// is the final portion of the target group ARN.
         *
         * To find the ARN for an Application Load Balancer, use the [DescribeLoadBalancers](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html) API operation. To find the ARN for the target group, use the [DescribeTargetGroups](https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeTargetGroups.html) API operation.
         */
        public var resourceLabel: kotlin.String? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.applicationautoscaling.model.PredefinedMetricSpecification) : this() {
            this.predefinedMetricType = x.predefinedMetricType
            this.resourceLabel = x.resourceLabel
        }

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

        internal fun correctErrors(): Builder {
            if (predefinedMetricType == null) predefinedMetricType = MetricType.SdkUnknown("no value provided")
            return this
        }
    }
}