commonMain.aws.sdk.kotlin.services.applicationautoscaling.model.PutScalingPolicyRequest.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
Show all versions of applicationautoscaling-jvm Show documentation
The AWS Kotlin client for Application Auto Scaling
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.applicationautoscaling.model
public class PutScalingPolicyRequest private constructor(builder: Builder) {
/**
* The name of the scaling policy.
*
* You cannot change the name of a scaling policy, but you can delete the original scaling policy and create a new scaling policy with the same settings and a different name.
*/
public val policyName: kotlin.String? = builder.policyName
/**
* The scaling policy type. This parameter is required if you are creating a scaling policy.
*
* The following policy types are supported:
*
* `TargetTrackingScaling`—Not supported for Amazon EMR
*
* `StepScaling`—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.
*
* For more information, see [Target tracking scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) and [Step scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) in the *Application Auto Scaling User Guide*.
*/
public val policyType: aws.sdk.kotlin.services.applicationautoscaling.model.PolicyType? = builder.policyType
/**
* The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
* + ECS service - The resource type is `service` and the unique identifier is the cluster name and service name. Example: `service/default/sample-webapp`.
* + Spot Fleet - The resource type is `spot-fleet-request` and the unique identifier is the Spot Fleet request ID. Example: `spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE`.
* + EMR cluster - The resource type is `instancegroup` and the unique identifier is the cluster ID and instance group ID. Example: `instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0`.
* + AppStream 2.0 fleet - The resource type is `fleet` and the unique identifier is the fleet name. Example: `fleet/sample-fleet`.
* + DynamoDB table - The resource type is `table` and the unique identifier is the table name. Example: `table/my-table`.
* + DynamoDB global secondary index - The resource type is `index` and the unique identifier is the index name. Example: `table/my-table/index/my-table-index`.
* + Aurora DB cluster - The resource type is `cluster` and the unique identifier is the cluster name. Example: `cluster:my-db-cluster`.
* + SageMaker endpoint variant - The resource type is `variant` and the unique identifier is the resource ID. Example: `endpoint/my-end-point/variant/KMeansClustering`.
* + Custom resources are not supported with a resource type. This parameter must specify the `OutputValue` from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our [GitHub repository](https://github.com/aws/aws-auto-scaling-custom-resource).
* + Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: `arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE`.
* + Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: `arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE`.
* + Lambda provisioned concurrency - The resource type is `function` and the unique identifier is the function name with a function version or alias name suffix that is not `$LATEST`. Example: `function:my-function:prod` or `function:my-function:1`.
* + Amazon Keyspaces table - The resource type is `table` and the unique identifier is the table name. Example: `keyspace/mykeyspace/table/mytable`.
* + Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: `arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5`.
* + Amazon ElastiCache replication group - The resource type is `replication-group` and the unique identifier is the replication group name. Example: `replication-group/mycluster`.
* + Neptune cluster - The resource type is `cluster` and the unique identifier is the cluster name. Example: `cluster:mycluster`.
* + SageMaker Serverless endpoint - The resource type is `variant` and the unique identifier is the resource ID. Example: `endpoint/my-end-point/variant/KMeansClustering`.
*/
public val resourceId: kotlin.String? = builder.resourceId
/**
* The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
* + `ecs:service:DesiredCount` - The desired task count of an ECS service.
* + `elasticmapreduce:instancegroup:InstanceCount` - The instance count of an EMR Instance Group.
* + `ec2:spot-fleet-request:TargetCapacity` - The target capacity of a Spot Fleet.
* + `appstream:fleet:DesiredCapacity` - The desired capacity of an AppStream 2.0 fleet.
* + `dynamodb:table:ReadCapacityUnits` - The provisioned read capacity for a DynamoDB table.
* + `dynamodb:table:WriteCapacityUnits` - The provisioned write capacity for a DynamoDB table.
* + `dynamodb:index:ReadCapacityUnits` - The provisioned read capacity for a DynamoDB global secondary index.
* + `dynamodb:index:WriteCapacityUnits` - The provisioned write capacity for a DynamoDB global secondary index.
* + `rds:cluster:ReadReplicaCount` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
* + `sagemaker:variant:DesiredInstanceCount` - The number of EC2 instances for a SageMaker model endpoint variant.
* + `custom-resource:ResourceType:Property` - The scalable dimension for a custom resource provided by your own application or service.
* + `comprehend:document-classifier-endpoint:DesiredInferenceUnits` - The number of inference units for an Amazon Comprehend document classification endpoint.
* + `comprehend:entity-recognizer-endpoint:DesiredInferenceUnits` - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
* + `lambda:function:ProvisionedConcurrency` - The provisioned concurrency for a Lambda function.
* + `cassandra:table:ReadCapacityUnits` - The provisioned read capacity for an Amazon Keyspaces table.
* + `cassandra:table:WriteCapacityUnits` - The provisioned write capacity for an Amazon Keyspaces table.
* + `kafka:broker-storage:VolumeSize` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
* + `elasticache:replication-group:NodeGroups` - The number of node groups for an Amazon ElastiCache replication group.
* + `elasticache:replication-group:Replicas` - The number of replicas per node group for an Amazon ElastiCache replication group.
* + `neptune:cluster:ReadReplicaCount` - The count of read replicas in an Amazon Neptune DB cluster.
* + `sagemaker:variant:DesiredProvisionedConcurrency` - The provisioned concurrency for a SageMaker Serverless endpoint.
*/
public val scalableDimension: aws.sdk.kotlin.services.applicationautoscaling.model.ScalableDimension? = builder.scalableDimension
/**
* The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use `custom-resource` instead.
*/
public val serviceNamespace: aws.sdk.kotlin.services.applicationautoscaling.model.ServiceNamespace? = builder.serviceNamespace
/**
* A step scaling policy.
*
* This parameter is required if you are creating a policy and the policy type is `StepScaling`.
*/
public val stepScalingPolicyConfiguration: aws.sdk.kotlin.services.applicationautoscaling.model.StepScalingPolicyConfiguration? = builder.stepScalingPolicyConfiguration
/**
* A target tracking scaling policy. Includes support for predefined or customized metrics.
*
* This parameter is required if you are creating a policy and the policy type is `TargetTrackingScaling`.
*/
public val targetTrackingScalingPolicyConfiguration: aws.sdk.kotlin.services.applicationautoscaling.model.TargetTrackingScalingPolicyConfiguration? = builder.targetTrackingScalingPolicyConfiguration
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.applicationautoscaling.model.PutScalingPolicyRequest = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("PutScalingPolicyRequest(")
append("policyName=$policyName,")
append("policyType=$policyType,")
append("resourceId=$resourceId,")
append("scalableDimension=$scalableDimension,")
append("serviceNamespace=$serviceNamespace,")
append("stepScalingPolicyConfiguration=$stepScalingPolicyConfiguration,")
append("targetTrackingScalingPolicyConfiguration=$targetTrackingScalingPolicyConfiguration")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = policyName?.hashCode() ?: 0
result = 31 * result + (policyType?.hashCode() ?: 0)
result = 31 * result + (resourceId?.hashCode() ?: 0)
result = 31 * result + (scalableDimension?.hashCode() ?: 0)
result = 31 * result + (serviceNamespace?.hashCode() ?: 0)
result = 31 * result + (stepScalingPolicyConfiguration?.hashCode() ?: 0)
result = 31 * result + (targetTrackingScalingPolicyConfiguration?.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 PutScalingPolicyRequest
if (policyName != other.policyName) return false
if (policyType != other.policyType) return false
if (resourceId != other.resourceId) return false
if (scalableDimension != other.scalableDimension) return false
if (serviceNamespace != other.serviceNamespace) return false
if (stepScalingPolicyConfiguration != other.stepScalingPolicyConfiguration) return false
if (targetTrackingScalingPolicyConfiguration != other.targetTrackingScalingPolicyConfiguration) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.applicationautoscaling.model.PutScalingPolicyRequest = Builder(this).apply(block).build()
public class Builder {
/**
* The name of the scaling policy.
*
* You cannot change the name of a scaling policy, but you can delete the original scaling policy and create a new scaling policy with the same settings and a different name.
*/
public var policyName: kotlin.String? = null
/**
* The scaling policy type. This parameter is required if you are creating a scaling policy.
*
* The following policy types are supported:
*
* `TargetTrackingScaling`—Not supported for Amazon EMR
*
* `StepScaling`—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.
*
* For more information, see [Target tracking scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) and [Step scaling policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) in the *Application Auto Scaling User Guide*.
*/
public var policyType: aws.sdk.kotlin.services.applicationautoscaling.model.PolicyType? = null
/**
* The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
* + ECS service - The resource type is `service` and the unique identifier is the cluster name and service name. Example: `service/default/sample-webapp`.
* + Spot Fleet - The resource type is `spot-fleet-request` and the unique identifier is the Spot Fleet request ID. Example: `spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE`.
* + EMR cluster - The resource type is `instancegroup` and the unique identifier is the cluster ID and instance group ID. Example: `instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0`.
* + AppStream 2.0 fleet - The resource type is `fleet` and the unique identifier is the fleet name. Example: `fleet/sample-fleet`.
* + DynamoDB table - The resource type is `table` and the unique identifier is the table name. Example: `table/my-table`.
* + DynamoDB global secondary index - The resource type is `index` and the unique identifier is the index name. Example: `table/my-table/index/my-table-index`.
* + Aurora DB cluster - The resource type is `cluster` and the unique identifier is the cluster name. Example: `cluster:my-db-cluster`.
* + SageMaker endpoint variant - The resource type is `variant` and the unique identifier is the resource ID. Example: `endpoint/my-end-point/variant/KMeansClustering`.
* + Custom resources are not supported with a resource type. This parameter must specify the `OutputValue` from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our [GitHub repository](https://github.com/aws/aws-auto-scaling-custom-resource).
* + Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: `arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE`.
* + Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: `arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE`.
* + Lambda provisioned concurrency - The resource type is `function` and the unique identifier is the function name with a function version or alias name suffix that is not `$LATEST`. Example: `function:my-function:prod` or `function:my-function:1`.
* + Amazon Keyspaces table - The resource type is `table` and the unique identifier is the table name. Example: `keyspace/mykeyspace/table/mytable`.
* + Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: `arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5`.
* + Amazon ElastiCache replication group - The resource type is `replication-group` and the unique identifier is the replication group name. Example: `replication-group/mycluster`.
* + Neptune cluster - The resource type is `cluster` and the unique identifier is the cluster name. Example: `cluster:mycluster`.
* + SageMaker Serverless endpoint - The resource type is `variant` and the unique identifier is the resource ID. Example: `endpoint/my-end-point/variant/KMeansClustering`.
*/
public var resourceId: kotlin.String? = null
/**
* The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
* + `ecs:service:DesiredCount` - The desired task count of an ECS service.
* + `elasticmapreduce:instancegroup:InstanceCount` - The instance count of an EMR Instance Group.
* + `ec2:spot-fleet-request:TargetCapacity` - The target capacity of a Spot Fleet.
* + `appstream:fleet:DesiredCapacity` - The desired capacity of an AppStream 2.0 fleet.
* + `dynamodb:table:ReadCapacityUnits` - The provisioned read capacity for a DynamoDB table.
* + `dynamodb:table:WriteCapacityUnits` - The provisioned write capacity for a DynamoDB table.
* + `dynamodb:index:ReadCapacityUnits` - The provisioned read capacity for a DynamoDB global secondary index.
* + `dynamodb:index:WriteCapacityUnits` - The provisioned write capacity for a DynamoDB global secondary index.
* + `rds:cluster:ReadReplicaCount` - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
* + `sagemaker:variant:DesiredInstanceCount` - The number of EC2 instances for a SageMaker model endpoint variant.
* + `custom-resource:ResourceType:Property` - The scalable dimension for a custom resource provided by your own application or service.
* + `comprehend:document-classifier-endpoint:DesiredInferenceUnits` - The number of inference units for an Amazon Comprehend document classification endpoint.
* + `comprehend:entity-recognizer-endpoint:DesiredInferenceUnits` - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
* + `lambda:function:ProvisionedConcurrency` - The provisioned concurrency for a Lambda function.
* + `cassandra:table:ReadCapacityUnits` - The provisioned read capacity for an Amazon Keyspaces table.
* + `cassandra:table:WriteCapacityUnits` - The provisioned write capacity for an Amazon Keyspaces table.
* + `kafka:broker-storage:VolumeSize` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
* + `elasticache:replication-group:NodeGroups` - The number of node groups for an Amazon ElastiCache replication group.
* + `elasticache:replication-group:Replicas` - The number of replicas per node group for an Amazon ElastiCache replication group.
* + `neptune:cluster:ReadReplicaCount` - The count of read replicas in an Amazon Neptune DB cluster.
* + `sagemaker:variant:DesiredProvisionedConcurrency` - The provisioned concurrency for a SageMaker Serverless endpoint.
*/
public var scalableDimension: aws.sdk.kotlin.services.applicationautoscaling.model.ScalableDimension? = null
/**
* The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use `custom-resource` instead.
*/
public var serviceNamespace: aws.sdk.kotlin.services.applicationautoscaling.model.ServiceNamespace? = null
/**
* A step scaling policy.
*
* This parameter is required if you are creating a policy and the policy type is `StepScaling`.
*/
public var stepScalingPolicyConfiguration: aws.sdk.kotlin.services.applicationautoscaling.model.StepScalingPolicyConfiguration? = null
/**
* A target tracking scaling policy. Includes support for predefined or customized metrics.
*
* This parameter is required if you are creating a policy and the policy type is `TargetTrackingScaling`.
*/
public var targetTrackingScalingPolicyConfiguration: aws.sdk.kotlin.services.applicationautoscaling.model.TargetTrackingScalingPolicyConfiguration? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.applicationautoscaling.model.PutScalingPolicyRequest) : this() {
this.policyName = x.policyName
this.policyType = x.policyType
this.resourceId = x.resourceId
this.scalableDimension = x.scalableDimension
this.serviceNamespace = x.serviceNamespace
this.stepScalingPolicyConfiguration = x.stepScalingPolicyConfiguration
this.targetTrackingScalingPolicyConfiguration = x.targetTrackingScalingPolicyConfiguration
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.applicationautoscaling.model.PutScalingPolicyRequest = PutScalingPolicyRequest(this)
/**
* construct an [aws.sdk.kotlin.services.applicationautoscaling.model.StepScalingPolicyConfiguration] inside the given [block]
*/
public fun stepScalingPolicyConfiguration(block: aws.sdk.kotlin.services.applicationautoscaling.model.StepScalingPolicyConfiguration.Builder.() -> kotlin.Unit) {
this.stepScalingPolicyConfiguration = aws.sdk.kotlin.services.applicationautoscaling.model.StepScalingPolicyConfiguration.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.applicationautoscaling.model.TargetTrackingScalingPolicyConfiguration] inside the given [block]
*/
public fun targetTrackingScalingPolicyConfiguration(block: aws.sdk.kotlin.services.applicationautoscaling.model.TargetTrackingScalingPolicyConfiguration.Builder.() -> kotlin.Unit) {
this.targetTrackingScalingPolicyConfiguration = aws.sdk.kotlin.services.applicationautoscaling.model.TargetTrackingScalingPolicyConfiguration.invoke(block)
}
internal fun correctErrors(): Builder {
return this
}
}
}