com.pulumi.awsnative.applicationautoscaling.kotlin.ScalingPolicy.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-native-kotlin Show documentation
Show all versions of pulumi-aws-native-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.applicationautoscaling.kotlin
import com.pulumi.awsnative.applicationautoscaling.kotlin.outputs.ScalingPolicyStepScalingPolicyConfiguration
import com.pulumi.awsnative.applicationautoscaling.kotlin.outputs.ScalingPolicyTargetTrackingScalingPolicyConfiguration
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import com.pulumi.awsnative.applicationautoscaling.kotlin.outputs.ScalingPolicyStepScalingPolicyConfiguration.Companion.toKotlin as scalingPolicyStepScalingPolicyConfigurationToKotlin
import com.pulumi.awsnative.applicationautoscaling.kotlin.outputs.ScalingPolicyTargetTrackingScalingPolicyConfiguration.Companion.toKotlin as scalingPolicyTargetTrackingScalingPolicyConfigurationToKotlin
/**
* Builder for [ScalingPolicy].
*/
@PulumiTagMarker
public class ScalingPolicyResourceBuilder internal constructor() {
public var name: String? = null
public var args: ScalingPolicyArgs = ScalingPolicyArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend ScalingPolicyArgsBuilder.() -> Unit) {
val builder = ScalingPolicyArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): ScalingPolicy {
val builtJavaResource =
com.pulumi.awsnative.applicationautoscaling.ScalingPolicy(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return ScalingPolicy(builtJavaResource)
}
}
/**
* The ``AWS::ApplicationAutoScaling::ScalingPolicy`` resource defines a scaling policy that Application Auto Scaling uses to adjust the capacity of a scalable target.
* 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 class ScalingPolicy internal constructor(
override val javaResource: com.pulumi.awsnative.applicationautoscaling.ScalingPolicy,
) : KotlinCustomResource(javaResource, ScalingPolicyMapper) {
/**
* Returns the ARN of a scaling policy.
*/
public val arn: Output
get() = javaResource.arn().applyValue({ args0 -> args0 })
/**
* The name of the scaling policy.
* Updates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing ``AWS::ApplicationAutoScaling::ScalingPolicy`` resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name.
*/
public val policyName: Output
get() = javaResource.policyName().applyValue({ args0 -> args0 })
/**
* The scaling policy type.
* 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.
*/
public val policyType: Output
get() = javaResource.policyType().applyValue({ args0 -> args0 })
/**
* 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/my-cluster/my-service``.
* + 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://docs.aws.amazon.com/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``.
* + SageMaker inference component - The resource type is ``inference-component`` and the unique identifier is the resource ID. Example: ``inference-component/my-inference-component``.
* + Pool of WorkSpaces - The resource type is ``workspacespool`` and the unique identifier is the pool ID. Example: ``workspacespool/wspool-123456``.
*/
public val resourceId: Output?
get() = javaResource.resourceId().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
* + ``ecs:service:DesiredCount`` - The 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 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.
* + ``sagemaker:inference-component:DesiredCopyCount`` - The number of copies across an endpoint for a SageMaker inference component.
* + ``workspaces:workspacespool:DesiredUserSessions`` - The number of user sessions for the WorkSpaces in the pool.
*/
public val scalableDimension: Output?
get() = javaResource.scalableDimension().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the ``AWS::ApplicationAutoScaling::ScalableTarget`` resource.
* You must specify either the ``ScalingTargetId`` property, or the ``ResourceId``, ``ScalableDimension``, and ``ServiceNamespace`` properties, but not both.
*/
public val scalingTargetId: Output?
get() = javaResource.scalingTargetId().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The namespace of the AWS service that provides the resource, or a ``custom-resource``.
*/
public val serviceNamespace: Output?
get() = javaResource.serviceNamespace().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* A step scaling policy.
*/
public val stepScalingPolicyConfiguration: Output?
get() = javaResource.stepScalingPolicyConfiguration().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
scalingPolicyStepScalingPolicyConfigurationToKotlin(args0)
})
}).orElse(null)
})
/**
* A target tracking scaling policy.
*/
public val targetTrackingScalingPolicyConfiguration:
Output?
get() = javaResource.targetTrackingScalingPolicyConfiguration().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
scalingPolicyTargetTrackingScalingPolicyConfigurationToKotlin(args0)
})
}).orElse(null)
})
}
public object ScalingPolicyMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.awsnative.applicationautoscaling.ScalingPolicy::class == javaResource::class
override fun map(javaResource: Resource): ScalingPolicy = ScalingPolicy(
javaResource as
com.pulumi.awsnative.applicationautoscaling.ScalingPolicy,
)
}
/**
* @see [ScalingPolicy].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [ScalingPolicy].
*/
public suspend fun scalingPolicy(
name: String,
block: suspend ScalingPolicyResourceBuilder.() -> Unit,
): ScalingPolicy {
val builder = ScalingPolicyResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [ScalingPolicy].
* @param name The _unique_ name of the resulting resource.
*/
public fun scalingPolicy(name: String): ScalingPolicy {
val builder = ScalingPolicyResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy