Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. applicationautoscaling
  5. ScalableTarget

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.applicationautoscaling.ScalableTarget

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    The AWS::ApplicationAutoScaling::ScalableTarget resource specifies a resource that Application Auto Scaling can scale, such as an AWS::DynamoDB::Table or AWS::ECS::Service resource. For more information, see Getting started in the Application Auto Scaling User Guide. If the resource that you want Application Auto Scaling to scale is not yet created in your account, add a dependency on the resource when registering it as a scalable target using the DependsOn attribute.

    Create ScalableTarget Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ScalableTarget(name: string, args: ScalableTargetArgs, opts?: CustomResourceOptions);
    @overload
def ScalableTarget(resource_name: str,
                   args: ScalableTargetArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def ScalableTarget(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   max_capacity: Optional[int] = None,
                   min_capacity: Optional[int] = None,
                   resource_id: Optional[str] = None,
                   scalable_dimension: Optional[str] = None,
                   service_namespace: Optional[str] = None,
                   role_arn: Optional[str] = None,
                   scheduled_actions: Optional[Sequence[ScalableTargetScheduledActionArgs]] = None,
                   suspended_state: Optional[ScalableTargetSuspendedStateArgs] = None)
    func NewScalableTarget(ctx *Context, name string, args ScalableTargetArgs, opts ...ResourceOption) (*ScalableTarget, error)
    public ScalableTarget(string name, ScalableTargetArgs args, CustomResourceOptions? opts = null)
    public ScalableTarget(String name, ScalableTargetArgs args)
public ScalableTarget(String name, ScalableTargetArgs args, CustomResourceOptions options)

    type: aws-native:applicationautoscaling:ScalableTarget
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ScalableTargetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ScalableTargetArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ScalableTargetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScalableTargetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScalableTargetArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ScalableTarget Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ScalableTarget resource accepts the following input properties:

    MaxCapacity int
    The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand.
    MinCapacity int
    The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand.
    ResourceId string
    The identifier of the resource associated with the scalable target. 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.
    • 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.
    ScalableDimension string
    The scalable dimension associated with the scalable target. 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.
    • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    ServiceNamespace string
    The namespace of the AWS service that provides the resource, or a custom-resource.
    RoleArn string
    Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. This can be either an IAM service role that Application Auto Scaling can assume to make calls to other AWS resources on your behalf, or a service-linked role for the specified service. For more information, see How Application Auto Scaling works with IAM in the Application Auto Scaling User Guide. To automatically create a service-linked role (recommended), specify the full ARN of the service-linked role in your stack template. To find the exact ARN of the service-linked role for your AWS or custom resource, see the Service-linked roles topic in the Application Auto Scaling User Guide. Look for the ARN in the table at the bottom of the page.
    ScheduledActions List<Pulumi.AwsNative.ApplicationAutoScaling.Inputs.ScalableTargetScheduledAction>
    The scheduled actions for the scalable target. Duplicates aren't allowed.
    SuspendedState Pulumi.AwsNative.ApplicationAutoScaling.Inputs.ScalableTargetSuspendedState
    An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities. Suspension Outcomes

    • For DynamicScalingInSuspended, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.
    • For DynamicScalingOutSuspended, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.
    • For ScheduledScalingSuspended, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended.
    MaxCapacity int
    The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand.
    MinCapacity int
    The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand.
    ResourceId string
    The identifier of the resource associated with the scalable target. 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.
    • 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.
    ScalableDimension string
    The scalable dimension associated with the scalable target. 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.
    • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    ServiceNamespace string
    The namespace of the AWS service that provides the resource, or a custom-resource.
    RoleArn string
    Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. This can be either an IAM service role that Application Auto Scaling can assume to make calls to other AWS resources on your behalf, or a service-linked role for the specified service. For more information, see How Application Auto Scaling works with IAM in the Application Auto Scaling User Guide. To automatically create a service-linked role (recommended), specify the full ARN of the service-linked role in your stack template. To find the exact ARN of the service-linked role for your AWS or custom resource, see the Service-linked roles topic in the Application Auto Scaling User Guide. Look for the ARN in the table at the bottom of the page.
    ScheduledActions []ScalableTargetScheduledActionArgs
    The scheduled actions for the scalable target. Duplicates aren't allowed.
    SuspendedState ScalableTargetSuspendedStateArgs
    An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities. Suspension Outcomes

    • For DynamicScalingInSuspended, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.
    • For DynamicScalingOutSuspended, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.
    • For ScheduledScalingSuspended, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended.
    maxCapacity Integer
    The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand.
    minCapacity Integer
    The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand.
    resourceId String
    The identifier of the resource associated with the scalable target. 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.
    • 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.
    scalableDimension String
    The scalable dimension associated with the scalable target. 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.
    • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    serviceNamespace String
    The namespace of the AWS service that provides the resource, or a custom-resource.
    roleArn String
    Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. This can be either an IAM service role that Application Auto Scaling can assume to make calls to other AWS resources on your behalf, or a service-linked role for the specified service. For more information, see How Application Auto Scaling works with IAM in the Application Auto Scaling User Guide. To automatically create a service-linked role (recommended), specify the full ARN of the service-linked role in your stack template. To find the exact ARN of the service-linked role for your AWS or custom resource, see the Service-linked roles topic in the Application Auto Scaling User Guide. Look for the ARN in the table at the bottom of the page.
    scheduledActions List<ScalableTargetScheduledAction>
    The scheduled actions for the scalable target. Duplicates aren't allowed.
    suspendedState ScalableTargetSuspendedState
    An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities. Suspension Outcomes

    • For DynamicScalingInSuspended, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.
    • For DynamicScalingOutSuspended, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.
    • For ScheduledScalingSuspended, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended.
    maxCapacity number
    The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand.
    minCapacity number
    The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand.
    resourceId string
    The identifier of the resource associated with the scalable target. 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.
    • 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.
    scalableDimension string
    The scalable dimension associated with the scalable target. 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.
    • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    serviceNamespace string
    The namespace of the AWS service that provides the resource, or a custom-resource.
    roleArn string
    Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. This can be either an IAM service role that Application Auto Scaling can assume to make calls to other AWS resources on your behalf, or a service-linked role for the specified service. For more information, see How Application Auto Scaling works with IAM in the Application Auto Scaling User Guide. To automatically create a service-linked role (recommended), specify the full ARN of the service-linked role in your stack template. To find the exact ARN of the service-linked role for your AWS or custom resource, see the Service-linked roles topic in the Application Auto Scaling User Guide. Look for the ARN in the table at the bottom of the page.
    scheduledActions ScalableTargetScheduledAction[]
    The scheduled actions for the scalable target. Duplicates aren't allowed.
    suspendedState ScalableTargetSuspendedState
    An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities. Suspension Outcomes

    • For DynamicScalingInSuspended, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.
    • For DynamicScalingOutSuspended, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.
    • For ScheduledScalingSuspended, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended.
    max_capacity int
    The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand.
    min_capacity int
    The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand.
    resource_id str
    The identifier of the resource associated with the scalable target. 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.
    • 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.
    scalable_dimension str
    The scalable dimension associated with the scalable target. 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.
    • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    service_namespace str
    The namespace of the AWS service that provides the resource, or a custom-resource.
    role_arn str
    Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. This can be either an IAM service role that Application Auto Scaling can assume to make calls to other AWS resources on your behalf, or a service-linked role for the specified service. For more information, see How Application Auto Scaling works with IAM in the Application Auto Scaling User Guide. To automatically create a service-linked role (recommended), specify the full ARN of the service-linked role in your stack template. To find the exact ARN of the service-linked role for your AWS or custom resource, see the Service-linked roles topic in the Application Auto Scaling User Guide. Look for the ARN in the table at the bottom of the page.
    scheduled_actions Sequence[ScalableTargetScheduledActionArgs]
    The scheduled actions for the scalable target. Duplicates aren't allowed.
    suspended_state ScalableTargetSuspendedStateArgs
    An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities. Suspension Outcomes

    • For DynamicScalingInSuspended, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.
    • For DynamicScalingOutSuspended, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.
    • For ScheduledScalingSuspended, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended.
    maxCapacity Number
    The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand.
    minCapacity Number
    The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand.
    resourceId String
    The identifier of the resource associated with the scalable target. 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.
    • 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.
    scalableDimension String
    The scalable dimension associated with the scalable target. 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.
    • sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    serviceNamespace String
    The namespace of the AWS service that provides the resource, or a custom-resource.
    roleArn String
    Specify the Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that allows Application Auto Scaling to modify the scalable target on your behalf. This can be either an IAM service role that Application Auto Scaling can assume to make calls to other AWS resources on your behalf, or a service-linked role for the specified service. For more information, see How Application Auto Scaling works with IAM in the Application Auto Scaling User Guide. To automatically create a service-linked role (recommended), specify the full ARN of the service-linked role in your stack template. To find the exact ARN of the service-linked role for your AWS or custom resource, see the Service-linked roles topic in the Application Auto Scaling User Guide. Look for the ARN in the table at the bottom of the page.
    scheduledActions List<Property Map>
    The scheduled actions for the scalable target. Duplicates aren't allowed.
    suspendedState Property Map
    An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities. Suspension Outcomes

    • For DynamicScalingInSuspended, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.
    • For DynamicScalingOutSuspended, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.
    • For ScheduledScalingSuspended, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ScalableTarget resource produces the following output properties:

    AwsId string
    Id string
    The provider-assigned unique ID for this managed resource.
    AwsId string
    Id string
    The provider-assigned unique ID for this managed resource.
    awsId String
    id String
    The provider-assigned unique ID for this managed resource.
    awsId string
    id string
    The provider-assigned unique ID for this managed resource.
    aws_id str
    id str
    The provider-assigned unique ID for this managed resource.
    awsId String
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ScalableTargetAction, ScalableTargetActionArgs

    MaxCapacity int
    The maximum capacity.
    MinCapacity int
    The minimum capacity.
    MaxCapacity int
    The maximum capacity.
    MinCapacity int
    The minimum capacity.
    maxCapacity Integer
    The maximum capacity.
    minCapacity Integer
    The minimum capacity.
    maxCapacity number
    The maximum capacity.
    minCapacity number
    The minimum capacity.
    max_capacity int
    The maximum capacity.
    min_capacity int
    The minimum capacity.
    maxCapacity Number
    The maximum capacity.
    minCapacity Number
    The minimum capacity.

    ScalableTargetScheduledAction, ScalableTargetScheduledActionArgs

    Schedule string

    The schedule for this action. The following formats are supported:

    • At expressions - "at(yyyy-mm-ddThh:mm:ss)"
    • Rate expressions - "rate(value unit)"
    • Cron expressions - "cron(fields)"

    At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval. At and cron expressions use Universal Coordinated Time (UTC) by default. The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year]. For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.

    ScheduledActionName string
    The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target.
    EndTime string
    The date and time that the action is scheduled to end, in UTC.
    ScalableTargetAction Pulumi.AwsNative.ApplicationAutoScaling.Inputs.ScalableTargetAction
    The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
    StartTime string
    The date and time that the action is scheduled to begin, in UTC.
    Timezone string
    The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.
    Schedule string

    The schedule for this action. The following formats are supported:

    • At expressions - "at(yyyy-mm-ddThh:mm:ss)"
    • Rate expressions - "rate(value unit)"
    • Cron expressions - "cron(fields)"

    At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval. At and cron expressions use Universal Coordinated Time (UTC) by default. The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year]. For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.

    ScheduledActionName string
    The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target.
    EndTime string
    The date and time that the action is scheduled to end, in UTC.
    ScalableTargetAction ScalableTargetAction
    The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
    StartTime string
    The date and time that the action is scheduled to begin, in UTC.
    Timezone string
    The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.
    schedule String

    The schedule for this action. The following formats are supported:

    • At expressions - "at(yyyy-mm-ddThh:mm:ss)"
    • Rate expressions - "rate(value unit)"
    • Cron expressions - "cron(fields)"

    At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval. At and cron expressions use Universal Coordinated Time (UTC) by default. The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year]. For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.

    scheduledActionName String
    The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target.
    endTime String
    The date and time that the action is scheduled to end, in UTC.
    scalableTargetAction ScalableTargetAction
    The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
    startTime String
    The date and time that the action is scheduled to begin, in UTC.
    timezone String
    The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.
    schedule string

    The schedule for this action. The following formats are supported:

    • At expressions - "at(yyyy-mm-ddThh:mm:ss)"
    • Rate expressions - "rate(value unit)"
    • Cron expressions - "cron(fields)"

    At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval. At and cron expressions use Universal Coordinated Time (UTC) by default. The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year]. For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.

    scheduledActionName string
    The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target.
    endTime string
    The date and time that the action is scheduled to end, in UTC.
    scalableTargetAction ScalableTargetAction
    The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
    startTime string
    The date and time that the action is scheduled to begin, in UTC.
    timezone string
    The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.
    schedule str

    The schedule for this action. The following formats are supported:

    • At expressions - "at(yyyy-mm-ddThh:mm:ss)"
    • Rate expressions - "rate(value unit)"
    • Cron expressions - "cron(fields)"

    At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval. At and cron expressions use Universal Coordinated Time (UTC) by default. The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year]. For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.

    scheduled_action_name str
    The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target.
    end_time str
    The date and time that the action is scheduled to end, in UTC.
    scalable_target_action ScalableTargetAction
    The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
    start_time str
    The date and time that the action is scheduled to begin, in UTC.
    timezone str
    The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.
    schedule String

    The schedule for this action. The following formats are supported:

    • At expressions - "at(yyyy-mm-ddThh:mm:ss)"
    • Rate expressions - "rate(value unit)"
    • Cron expressions - "cron(fields)"

    At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval. At and cron expressions use Universal Coordinated Time (UTC) by default. The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year]. For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.

    scheduledActionName String
    The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target.
    endTime String
    The date and time that the action is scheduled to end, in UTC.
    scalableTargetAction Property Map
    The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
    startTime String
    The date and time that the action is scheduled to begin, in UTC.
    timezone String
    The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.

    ScalableTargetSuspendedState, ScalableTargetSuspendedStateArgs

    DynamicScalingInSuspended bool
    Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is false.
    DynamicScalingOutSuspended bool
    Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is false.
    ScheduledScalingSuspended bool
    Whether scheduled scaling is suspended. Set the value to true if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is false.
    DynamicScalingInSuspended bool
    Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is false.
    DynamicScalingOutSuspended bool
    Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is false.
    ScheduledScalingSuspended bool
    Whether scheduled scaling is suspended. Set the value to true if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is false.
    dynamicScalingInSuspended Boolean
    Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is false.
    dynamicScalingOutSuspended Boolean
    Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is false.
    scheduledScalingSuspended Boolean
    Whether scheduled scaling is suspended. Set the value to true if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is false.
    dynamicScalingInSuspended boolean
    Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is false.
    dynamicScalingOutSuspended boolean
    Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is false.
    scheduledScalingSuspended boolean
    Whether scheduled scaling is suspended. Set the value to true if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is false.
    dynamic_scaling_in_suspended bool
    Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is false.
    dynamic_scaling_out_suspended bool
    Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is false.
    scheduled_scaling_suspended bool
    Whether scheduled scaling is suspended. Set the value to true if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is false.
    dynamicScalingInSuspended Boolean
    Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is false.
    dynamicScalingOutSuspended Boolean
    Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is false.
    scheduledScalingSuspended Boolean
    Whether scheduled scaling is suspended. Set the value to true if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is false.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native