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

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.123.0 published on Monday, Sep 16, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.applicationautoscaling.ScalingPolicy

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.123.0 published on Monday, Sep 16, 2024 by Pulumi
pulumi/pulumi-aws-native

    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 and Step scaling policies in the Application Auto Scaling User Guide.

    Create ScalingPolicy Resource

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

    Constructor syntax

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

@overload
def ScalingPolicy(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  policy_type: Optional[str] = None,
                  policy_name: Optional[str] = None,
                  resource_id: Optional[str] = None,
                  scalable_dimension: Optional[str] = None,
                  scaling_target_id: Optional[str] = None,
                  service_namespace: Optional[str] = None,
                  step_scaling_policy_configuration: Optional[ScalingPolicyStepScalingPolicyConfigurationArgs] = None,
                  target_tracking_scaling_policy_configuration: Optional[ScalingPolicyTargetTrackingScalingPolicyConfigurationArgs] = None)
    func NewScalingPolicy(ctx *Context, name string, args ScalingPolicyArgs, opts ...ResourceOption) (*ScalingPolicy, error)
    public ScalingPolicy(string name, ScalingPolicyArgs args, CustomResourceOptions? opts = null)
    public ScalingPolicy(String name, ScalingPolicyArgs args)
public ScalingPolicy(String name, ScalingPolicyArgs args, CustomResourceOptions options)

    type: aws-native:applicationautoscaling:ScalingPolicy
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 ScalingPolicyArgs
    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 ScalingPolicyArgs
    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 ScalingPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ScalingPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ScalingPolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ScalingPolicy Resource Properties

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

    Inputs

    The ScalingPolicy resource accepts the following input properties:

    PolicyType string
    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.
    PolicyName string
    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.
    ResourceId string
    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.
    • 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.
    ScalableDimension string
    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.
    ScalingTargetId string
    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.
    ServiceNamespace string
    The namespace of the AWS service that provides the resource, or a custom-resource.
    StepScalingPolicyConfiguration Pulumi.AwsNative.ApplicationAutoScaling.Inputs.ScalingPolicyStepScalingPolicyConfiguration
    A step scaling policy.
    TargetTrackingScalingPolicyConfiguration Pulumi.AwsNative.ApplicationAutoScaling.Inputs.ScalingPolicyTargetTrackingScalingPolicyConfiguration
    A target tracking scaling policy.
    PolicyType string
    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.
    PolicyName string
    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.
    ResourceId string
    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.
    • 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.
    ScalableDimension string
    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.
    ScalingTargetId string
    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.
    ServiceNamespace string
    The namespace of the AWS service that provides the resource, or a custom-resource.
    StepScalingPolicyConfiguration ScalingPolicyStepScalingPolicyConfigurationArgs
    A step scaling policy.
    TargetTrackingScalingPolicyConfiguration ScalingPolicyTargetTrackingScalingPolicyConfigurationArgs
    A target tracking scaling policy.
    policyType String
    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.
    policyName String
    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.
    resourceId String
    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.
    • 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.
    scalableDimension String
    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.
    scalingTargetId String
    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.
    serviceNamespace String
    The namespace of the AWS service that provides the resource, or a custom-resource.
    stepScalingPolicyConfiguration ScalingPolicyStepScalingPolicyConfiguration
    A step scaling policy.
    targetTrackingScalingPolicyConfiguration ScalingPolicyTargetTrackingScalingPolicyConfiguration
    A target tracking scaling policy.
    policyType string
    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.
    policyName string
    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.
    resourceId string
    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.
    • 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.
    scalableDimension string
    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.
    scalingTargetId string
    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.
    serviceNamespace string
    The namespace of the AWS service that provides the resource, or a custom-resource.
    stepScalingPolicyConfiguration ScalingPolicyStepScalingPolicyConfiguration
    A step scaling policy.
    targetTrackingScalingPolicyConfiguration ScalingPolicyTargetTrackingScalingPolicyConfiguration
    A target tracking scaling policy.
    policy_type str
    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.
    policy_name str
    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.
    resource_id str
    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.
    • 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.
    scalable_dimension str
    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.
    scaling_target_id str
    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.
    service_namespace str
    The namespace of the AWS service that provides the resource, or a custom-resource.
    step_scaling_policy_configuration ScalingPolicyStepScalingPolicyConfigurationArgs
    A step scaling policy.
    target_tracking_scaling_policy_configuration ScalingPolicyTargetTrackingScalingPolicyConfigurationArgs
    A target tracking scaling policy.
    policyType String
    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.
    policyName String
    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.
    resourceId String
    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.
    • 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.
    scalableDimension String
    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.
    scalingTargetId String
    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.
    serviceNamespace String
    The namespace of the AWS service that provides the resource, or a custom-resource.
    stepScalingPolicyConfiguration Property Map
    A step scaling policy.
    targetTrackingScalingPolicyConfiguration Property Map
    A target tracking scaling policy.

    Outputs

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

    Arn string
    Returns the ARN of a scaling policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    Returns the ARN of a scaling policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    Returns the ARN of a scaling policy.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    Returns the ARN of a scaling policy.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    Returns the ARN of a scaling policy.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    Returns the ARN of a scaling policy.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ScalingPolicyCustomizedMetricSpecification, ScalingPolicyCustomizedMetricSpecificationArgs

    Dimensions List<Pulumi.AwsNative.ApplicationAutoScaling.Inputs.ScalingPolicyMetricDimension>
    The dimensions of the metric. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
    MetricName string
    The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that's returned by a call to ListMetrics.
    Metrics List<Pulumi.AwsNative.ApplicationAutoScaling.Inputs.ScalingPolicyTargetTrackingMetricDataQuery>
    The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.
    Namespace string
    The namespace of the metric.
    Statistic string
    The statistic of the metric.
    Unit string
    The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
    Dimensions []ScalingPolicyMetricDimension
    The dimensions of the metric. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
    MetricName string
    The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that's returned by a call to ListMetrics.
    Metrics []ScalingPolicyTargetTrackingMetricDataQuery
    The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.
    Namespace string
    The namespace of the metric.
    Statistic string
    The statistic of the metric.
    Unit string
    The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
    dimensions List<ScalingPolicyMetricDimension>
    The dimensions of the metric. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
    metricName String
    The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that's returned by a call to ListMetrics.
    metrics List<ScalingPolicyTargetTrackingMetricDataQuery>
    The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.
    namespace String
    The namespace of the metric.
    statistic String
    The statistic of the metric.
    unit String
    The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
    dimensions ScalingPolicyMetricDimension[]
    The dimensions of the metric. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
    metricName string
    The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that's returned by a call to ListMetrics.
    metrics ScalingPolicyTargetTrackingMetricDataQuery[]
    The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.
    namespace string
    The namespace of the metric.
    statistic string
    The statistic of the metric.
    unit string
    The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
    dimensions Sequence[ScalingPolicyMetricDimension]
    The dimensions of the metric. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
    metric_name str
    The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that's returned by a call to ListMetrics.
    metrics Sequence[ScalingPolicyTargetTrackingMetricDataQuery]
    The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.
    namespace str
    The namespace of the metric.
    statistic str
    The statistic of the metric.
    unit str
    The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
    dimensions List<Property Map>
    The dimensions of the metric. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
    metricName String
    The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that's returned by a call to ListMetrics.
    metrics List<Property Map>
    The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.
    namespace String
    The namespace of the metric.
    statistic String
    The statistic of the metric.
    unit String
    The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.

    ScalingPolicyMetricDimension, ScalingPolicyMetricDimensionArgs

    Name string
    The name of the dimension.
    Value string
    The value of the dimension.
    Name string
    The name of the dimension.
    Value string
    The value of the dimension.
    name String
    The name of the dimension.
    value String
    The value of the dimension.
    name string
    The name of the dimension.
    value string
    The value of the dimension.
    name str
    The name of the dimension.
    value str
    The value of the dimension.
    name String
    The name of the dimension.
    value String
    The value of the dimension.

    ScalingPolicyPredefinedMetricSpecification, ScalingPolicyPredefinedMetricSpecificationArgs

    PredefinedMetricType string
    The metric type. The ALBRequestCountPerTarget metric type applies only to Spot fleet requests and ECS services.
    ResourceLabel string

    Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service. You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is: app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff. Where:

    • app// is the final portion of the load balancer ARN
    • targetgroup// is the final portion of the target group ARN.

    To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

    PredefinedMetricType string
    The metric type. The ALBRequestCountPerTarget metric type applies only to Spot fleet requests and ECS services.
    ResourceLabel string

    Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service. You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is: app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff. Where:

    • app// is the final portion of the load balancer ARN
    • targetgroup// is the final portion of the target group ARN.

    To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

    predefinedMetricType String
    The metric type. The ALBRequestCountPerTarget metric type applies only to Spot fleet requests and ECS services.
    resourceLabel String

    Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service. You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is: app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff. Where:

    • app// is the final portion of the load balancer ARN
    • targetgroup// is the final portion of the target group ARN.

    To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

    predefinedMetricType string
    The metric type. The ALBRequestCountPerTarget metric type applies only to Spot fleet requests and ECS services.
    resourceLabel string

    Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service. You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is: app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff. Where:

    • app// is the final portion of the load balancer ARN
    • targetgroup// is the final portion of the target group ARN.

    To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

    predefined_metric_type str
    The metric type. The ALBRequestCountPerTarget metric type applies only to Spot fleet requests and ECS services.
    resource_label str

    Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service. You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is: app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff. Where:

    • app// is the final portion of the load balancer ARN
    • targetgroup// is the final portion of the target group ARN.

    To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

    predefinedMetricType String
    The metric type. The ALBRequestCountPerTarget metric type applies only to Spot fleet requests and ECS services.
    resourceLabel String

    Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service. You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is: app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff. Where:

    • app// is the final portion of the load balancer ARN
    • targetgroup// is the final portion of the target group ARN.

    To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

    ScalingPolicyStepAdjustment, ScalingPolicyStepAdjustmentArgs

    ScalingAdjustment int
    The amount by which to scale. The adjustment is based on the value that you specified in the AdjustmentType property (either an absolute number or a percentage). A positive value adds to the current capacity and a negative number subtracts from the current capacity.
    MetricIntervalLowerBound double
    The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity. You must specify at least one upper or lower bound.
    MetricIntervalUpperBound double
    The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity. You must specify at least one upper or lower bound.
    ScalingAdjustment int
    The amount by which to scale. The adjustment is based on the value that you specified in the AdjustmentType property (either an absolute number or a percentage). A positive value adds to the current capacity and a negative number subtracts from the current capacity.
    MetricIntervalLowerBound float64
    The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity. You must specify at least one upper or lower bound.
    MetricIntervalUpperBound float64
    The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity. You must specify at least one upper or lower bound.
    scalingAdjustment Integer
    The amount by which to scale. The adjustment is based on the value that you specified in the AdjustmentType property (either an absolute number or a percentage). A positive value adds to the current capacity and a negative number subtracts from the current capacity.
    metricIntervalLowerBound Double
    The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity. You must specify at least one upper or lower bound.
    metricIntervalUpperBound Double
    The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity. You must specify at least one upper or lower bound.
    scalingAdjustment number
    The amount by which to scale. The adjustment is based on the value that you specified in the AdjustmentType property (either an absolute number or a percentage). A positive value adds to the current capacity and a negative number subtracts from the current capacity.
    metricIntervalLowerBound number
    The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity. You must specify at least one upper or lower bound.
    metricIntervalUpperBound number
    The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity. You must specify at least one upper or lower bound.
    scaling_adjustment int
    The amount by which to scale. The adjustment is based on the value that you specified in the AdjustmentType property (either an absolute number or a percentage). A positive value adds to the current capacity and a negative number subtracts from the current capacity.
    metric_interval_lower_bound float
    The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity. You must specify at least one upper or lower bound.
    metric_interval_upper_bound float
    The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity. You must specify at least one upper or lower bound.
    scalingAdjustment Number
    The amount by which to scale. The adjustment is based on the value that you specified in the AdjustmentType property (either an absolute number or a percentage). A positive value adds to the current capacity and a negative number subtracts from the current capacity.
    metricIntervalLowerBound Number
    The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity. You must specify at least one upper or lower bound.
    metricIntervalUpperBound Number
    The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity. You must specify at least one upper or lower bound.

    ScalingPolicyStepScalingPolicyConfiguration, ScalingPolicyStepScalingPolicyConfigurationArgs

    AdjustmentType string
    Specifies whether the ScalingAdjustment value in the StepAdjustment property is an absolute number or a percentage of the current capacity.
    Cooldown int
    The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.
    MetricAggregationType string
    The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.
    MinAdjustmentMagnitude int
    The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.
    StepAdjustments List<Pulumi.AwsNative.ApplicationAutoScaling.Inputs.ScalingPolicyStepAdjustment>
    A set of adjustments that enable you to scale based on the size of the alarm breach. At least one step adjustment is required if you are adding a new step scaling policy configuration.
    AdjustmentType string
    Specifies whether the ScalingAdjustment value in the StepAdjustment property is an absolute number or a percentage of the current capacity.
    Cooldown int
    The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.
    MetricAggregationType string
    The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.
    MinAdjustmentMagnitude int
    The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.
    StepAdjustments []ScalingPolicyStepAdjustment
    A set of adjustments that enable you to scale based on the size of the alarm breach. At least one step adjustment is required if you are adding a new step scaling policy configuration.
    adjustmentType String
    Specifies whether the ScalingAdjustment value in the StepAdjustment property is an absolute number or a percentage of the current capacity.
    cooldown Integer
    The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.
    metricAggregationType String
    The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.
    minAdjustmentMagnitude Integer
    The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.
    stepAdjustments List<ScalingPolicyStepAdjustment>
    A set of adjustments that enable you to scale based on the size of the alarm breach. At least one step adjustment is required if you are adding a new step scaling policy configuration.
    adjustmentType string
    Specifies whether the ScalingAdjustment value in the StepAdjustment property is an absolute number or a percentage of the current capacity.
    cooldown number
    The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.
    metricAggregationType string
    The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.
    minAdjustmentMagnitude number
    The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.
    stepAdjustments ScalingPolicyStepAdjustment[]
    A set of adjustments that enable you to scale based on the size of the alarm breach. At least one step adjustment is required if you are adding a new step scaling policy configuration.
    adjustment_type str
    Specifies whether the ScalingAdjustment value in the StepAdjustment property is an absolute number or a percentage of the current capacity.
    cooldown int
    The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.
    metric_aggregation_type str
    The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.
    min_adjustment_magnitude int
    The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.
    step_adjustments Sequence[ScalingPolicyStepAdjustment]
    A set of adjustments that enable you to scale based on the size of the alarm breach. At least one step adjustment is required if you are adding a new step scaling policy configuration.
    adjustmentType String
    Specifies whether the ScalingAdjustment value in the StepAdjustment property is an absolute number or a percentage of the current capacity.
    cooldown Number
    The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.
    metricAggregationType String
    The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.
    minAdjustmentMagnitude Number
    The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.
    stepAdjustments List<Property Map>
    A set of adjustments that enable you to scale based on the size of the alarm breach. At least one step adjustment is required if you are adding a new step scaling policy configuration.

    ScalingPolicyTargetTrackingMetric, ScalingPolicyTargetTrackingMetricArgs

    Dimensions List<Pulumi.AwsNative.ApplicationAutoScaling.Inputs.ScalingPolicyTargetTrackingMetricDimension>
    The dimensions for the metric. For the list of available dimensions, see the AWS documentation available from the table in services that publish CloudWatch metrics in the Amazon CloudWatch User Guide. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
    MetricName string
    The name of the metric.
    Namespace string
    The namespace of the metric. For more information, see the table in services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
    Dimensions []ScalingPolicyTargetTrackingMetricDimension
    The dimensions for the metric. For the list of available dimensions, see the AWS documentation available from the table in services that publish CloudWatch metrics in the Amazon CloudWatch User Guide. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
    MetricName string
    The name of the metric.
    Namespace string
    The namespace of the metric. For more information, see the table in services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
    dimensions List<ScalingPolicyTargetTrackingMetricDimension>
    The dimensions for the metric. For the list of available dimensions, see the AWS documentation available from the table in services that publish CloudWatch metrics in the Amazon CloudWatch User Guide. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
    metricName String
    The name of the metric.
    namespace String
    The namespace of the metric. For more information, see the table in services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
    dimensions ScalingPolicyTargetTrackingMetricDimension[]
    The dimensions for the metric. For the list of available dimensions, see the AWS documentation available from the table in services that publish CloudWatch metrics in the Amazon CloudWatch User Guide. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
    metricName string
    The name of the metric.
    namespace string
    The namespace of the metric. For more information, see the table in services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
    dimensions Sequence[ScalingPolicyTargetTrackingMetricDimension]
    The dimensions for the metric. For the list of available dimensions, see the AWS documentation available from the table in services that publish CloudWatch metrics in the Amazon CloudWatch User Guide. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
    metric_name str
    The name of the metric.
    namespace str
    The namespace of the metric. For more information, see the table in services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
    dimensions List<Property Map>
    The dimensions for the metric. For the list of available dimensions, see the AWS documentation available from the table in services that publish CloudWatch metrics in the Amazon CloudWatch User Guide. Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
    metricName String
    The name of the metric.
    namespace String
    The namespace of the metric. For more information, see the table in services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.

    ScalingPolicyTargetTrackingMetricDataQuery, ScalingPolicyTargetTrackingMetricDataQueryArgs

    Expression string
    The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat, but not both.
    Id string
    A short name that identifies the object's results in the response. This name must be unique among all MetricDataQuery objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.
    Label string
    A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.
    MetricStat Pulumi.AwsNative.ApplicationAutoScaling.Inputs.ScalingPolicyTargetTrackingMetricStat
    Information about the metric data to return. Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
    ReturnData bool
    Indicates whether to return the timestamps and raw data values of this metric. If you use any math expressions, specify true for this value for only the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the metric specification. If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData. This sets it to its default (true).
    Expression string
    The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat, but not both.
    Id string
    A short name that identifies the object's results in the response. This name must be unique among all MetricDataQuery objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.
    Label string
    A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.
    MetricStat ScalingPolicyTargetTrackingMetricStat
    Information about the metric data to return. Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
    ReturnData bool
    Indicates whether to return the timestamps and raw data values of this metric. If you use any math expressions, specify true for this value for only the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the metric specification. If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData. This sets it to its default (true).
    expression String
    The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat, but not both.
    id String
    A short name that identifies the object's results in the response. This name must be unique among all MetricDataQuery objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.
    label String
    A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.
    metricStat ScalingPolicyTargetTrackingMetricStat
    Information about the metric data to return. Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
    returnData Boolean
    Indicates whether to return the timestamps and raw data values of this metric. If you use any math expressions, specify true for this value for only the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the metric specification. If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData. This sets it to its default (true).
    expression string
    The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat, but not both.
    id string
    A short name that identifies the object's results in the response. This name must be unique among all MetricDataQuery objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.
    label string
    A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.
    metricStat ScalingPolicyTargetTrackingMetricStat
    Information about the metric data to return. Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
    returnData boolean
    Indicates whether to return the timestamps and raw data values of this metric. If you use any math expressions, specify true for this value for only the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the metric specification. If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData. This sets it to its default (true).
    expression str
    The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat, but not both.
    id str
    A short name that identifies the object's results in the response. This name must be unique among all MetricDataQuery objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.
    label str
    A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.
    metric_stat ScalingPolicyTargetTrackingMetricStat
    Information about the metric data to return. Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
    return_data bool
    Indicates whether to return the timestamps and raw data values of this metric. If you use any math expressions, specify true for this value for only the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the metric specification. If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData. This sets it to its default (true).
    expression String
    The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat, but not both.
    id String
    A short name that identifies the object's results in the response. This name must be unique among all MetricDataQuery objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.
    label String
    A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.
    metricStat Property Map
    Information about the metric data to return. Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
    returnData Boolean
    Indicates whether to return the timestamps and raw data values of this metric. If you use any math expressions, specify true for this value for only the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the metric specification. If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData. This sets it to its default (true).

    ScalingPolicyTargetTrackingMetricDimension, ScalingPolicyTargetTrackingMetricDimensionArgs

    Name string
    The name of the dimension.
    Value string
    The value of the dimension.
    Name string
    The name of the dimension.
    Value string
    The value of the dimension.
    name String
    The name of the dimension.
    value String
    The value of the dimension.
    name string
    The name of the dimension.
    value string
    The value of the dimension.
    name str
    The name of the dimension.
    value str
    The value of the dimension.
    name String
    The name of the dimension.
    value String
    The value of the dimension.

    ScalingPolicyTargetTrackingMetricStat, ScalingPolicyTargetTrackingMetricStatArgs

    Metric Pulumi.AwsNative.ApplicationAutoScaling.Inputs.ScalingPolicyTargetTrackingMetric
    The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.
    Stat string
    The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide. The most commonly used metric for scaling is Average.
    Unit string
    The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
    Metric ScalingPolicyTargetTrackingMetric
    The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.
    Stat string
    The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide. The most commonly used metric for scaling is Average.
    Unit string
    The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
    metric ScalingPolicyTargetTrackingMetric
    The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.
    stat String
    The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide. The most commonly used metric for scaling is Average.
    unit String
    The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
    metric ScalingPolicyTargetTrackingMetric
    The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.
    stat string
    The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide. The most commonly used metric for scaling is Average.
    unit string
    The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
    metric ScalingPolicyTargetTrackingMetric
    The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.
    stat str
    The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide. The most commonly used metric for scaling is Average.
    unit str
    The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
    metric Property Map
    The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.
    stat String
    The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide. The most commonly used metric for scaling is Average.
    unit String
    The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.

    ScalingPolicyTargetTrackingScalingPolicyConfiguration, ScalingPolicyTargetTrackingScalingPolicyConfigurationArgs

    TargetValue double
    The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.
    CustomizedMetricSpecification Pulumi.AwsNative.ApplicationAutoScaling.Inputs.ScalingPolicyCustomizedMetricSpecification
    A customized metric. You can specify either a predefined metric or a customized metric.
    DisableScaleIn bool
    Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.
    PredefinedMetricSpecification Pulumi.AwsNative.ApplicationAutoScaling.Inputs.ScalingPolicyPredefinedMetricSpecification
    A predefined metric. You can specify either a predefined metric or a customized metric.
    ScaleInCooldown int
    The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
    ScaleOutCooldown int
    The amount of time, in seconds, to wait for a previous scale-out activity to take effect. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
    TargetValue float64
    The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.
    CustomizedMetricSpecification ScalingPolicyCustomizedMetricSpecification
    A customized metric. You can specify either a predefined metric or a customized metric.
    DisableScaleIn bool
    Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.
    PredefinedMetricSpecification ScalingPolicyPredefinedMetricSpecification
    A predefined metric. You can specify either a predefined metric or a customized metric.
    ScaleInCooldown int
    The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
    ScaleOutCooldown int
    The amount of time, in seconds, to wait for a previous scale-out activity to take effect. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
    targetValue Double
    The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.
    customizedMetricSpecification ScalingPolicyCustomizedMetricSpecification
    A customized metric. You can specify either a predefined metric or a customized metric.
    disableScaleIn Boolean
    Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.
    predefinedMetricSpecification ScalingPolicyPredefinedMetricSpecification
    A predefined metric. You can specify either a predefined metric or a customized metric.
    scaleInCooldown Integer
    The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
    scaleOutCooldown Integer
    The amount of time, in seconds, to wait for a previous scale-out activity to take effect. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
    targetValue number
    The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.
    customizedMetricSpecification ScalingPolicyCustomizedMetricSpecification
    A customized metric. You can specify either a predefined metric or a customized metric.
    disableScaleIn boolean
    Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.
    predefinedMetricSpecification ScalingPolicyPredefinedMetricSpecification
    A predefined metric. You can specify either a predefined metric or a customized metric.
    scaleInCooldown number
    The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
    scaleOutCooldown number
    The amount of time, in seconds, to wait for a previous scale-out activity to take effect. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
    target_value float
    The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.
    customized_metric_specification ScalingPolicyCustomizedMetricSpecification
    A customized metric. You can specify either a predefined metric or a customized metric.
    disable_scale_in bool
    Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.
    predefined_metric_specification ScalingPolicyPredefinedMetricSpecification
    A predefined metric. You can specify either a predefined metric or a customized metric.
    scale_in_cooldown int
    The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
    scale_out_cooldown int
    The amount of time, in seconds, to wait for a previous scale-out activity to take effect. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
    targetValue Number
    The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.
    customizedMetricSpecification Property Map
    A customized metric. You can specify either a predefined metric or a customized metric.
    disableScaleIn Boolean
    Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.
    predefinedMetricSpecification Property Map
    A predefined metric. You can specify either a predefined metric or a customized metric.
    scaleInCooldown Number
    The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
    scaleOutCooldown Number
    The amount of time, in seconds, to wait for a previous scale-out activity to take effect. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.123.0 published on Monday, Sep 16, 2024 by Pulumi
    pulumi/pulumi-aws-native