We recommend new projects start with resources from the AWS provider.
aws-native.applicationautoscaling.getScalingPolicy
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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.
Using getScalingPolicy
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getScalingPolicy(args: GetScalingPolicyArgs, opts?: InvokeOptions): Promise<GetScalingPolicyResult>
function getScalingPolicyOutput(args: GetScalingPolicyOutputArgs, opts?: InvokeOptions): Output<GetScalingPolicyResult>
def get_scaling_policy(arn: Optional[str] = None,
scalable_dimension: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetScalingPolicyResult
def get_scaling_policy_output(arn: Optional[pulumi.Input[str]] = None,
scalable_dimension: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetScalingPolicyResult]
func LookupScalingPolicy(ctx *Context, args *LookupScalingPolicyArgs, opts ...InvokeOption) (*LookupScalingPolicyResult, error)
func LookupScalingPolicyOutput(ctx *Context, args *LookupScalingPolicyOutputArgs, opts ...InvokeOption) LookupScalingPolicyResultOutput
> Note: This function is named LookupScalingPolicy
in the Go SDK.
public static class GetScalingPolicy
{
public static Task<GetScalingPolicyResult> InvokeAsync(GetScalingPolicyArgs args, InvokeOptions? opts = null)
public static Output<GetScalingPolicyResult> Invoke(GetScalingPolicyInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetScalingPolicyResult> getScalingPolicy(GetScalingPolicyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:applicationautoscaling:getScalingPolicy
arguments:
# arguments dictionary
The following arguments are supported:
- Arn string
- Returns the ARN of a scaling policy.
- Scalable
Dimension 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.
- Arn string
- Returns the ARN of a scaling policy.
- Scalable
Dimension 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.
- arn String
- Returns the ARN of a scaling policy.
- scalable
Dimension 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.
- arn string
- Returns the ARN of a scaling policy.
- scalable
Dimension 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.
- arn str
- Returns the ARN of a scaling policy.
- 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.
- arn String
- Returns the ARN of a scaling policy.
- scalable
Dimension 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.
getScalingPolicy Result
The following output properties are available:
- Arn string
- Returns the ARN of a scaling policy.
- Policy
Type string - The scaling policy type.
The following policy types are supported:
TargetTrackingScaling
—Not supported for Amazon EMRStepScaling
—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune. - Step
Scaling Pulumi.Policy Configuration Aws Native. Application Auto Scaling. Outputs. Scaling Policy Step Scaling Policy Configuration - A step scaling policy.
- Target
Tracking Pulumi.Scaling Policy Configuration Aws Native. Application Auto Scaling. Outputs. Scaling Policy Target Tracking Scaling Policy Configuration - A target tracking scaling policy.
- Arn string
- Returns the ARN of a scaling policy.
- Policy
Type string - The scaling policy type.
The following policy types are supported:
TargetTrackingScaling
—Not supported for Amazon EMRStepScaling
—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune. - Step
Scaling ScalingPolicy Configuration Policy Step Scaling Policy Configuration - A step scaling policy.
- Target
Tracking ScalingScaling Policy Configuration Policy Target Tracking Scaling Policy Configuration - A target tracking scaling policy.
- arn String
- Returns the ARN of a scaling policy.
- policy
Type String - The scaling policy type.
The following policy types are supported:
TargetTrackingScaling
—Not supported for Amazon EMRStepScaling
—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune. - step
Scaling ScalingPolicy Configuration Policy Step Scaling Policy Configuration - A step scaling policy.
- target
Tracking ScalingScaling Policy Configuration Policy Target Tracking Scaling Policy Configuration - A target tracking scaling policy.
- arn string
- Returns the ARN of a scaling policy.
- policy
Type string - The scaling policy type.
The following policy types are supported:
TargetTrackingScaling
—Not supported for Amazon EMRStepScaling
—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune. - step
Scaling ScalingPolicy Configuration Policy Step Scaling Policy Configuration - A step scaling policy.
- target
Tracking ScalingScaling Policy Configuration Policy Target Tracking Scaling Policy Configuration - A target tracking scaling policy.
- arn str
- Returns the ARN of a scaling policy.
- policy_
type str - The scaling policy type.
The following policy types are supported:
TargetTrackingScaling
—Not supported for Amazon EMRStepScaling
—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune. - step_
scaling_ Scalingpolicy_ configuration Policy Step Scaling Policy Configuration - A step scaling policy.
- target_
tracking_ Scalingscaling_ policy_ configuration Policy Target Tracking Scaling Policy Configuration - A target tracking scaling policy.
- arn String
- Returns the ARN of a scaling policy.
- policy
Type String - The scaling policy type.
The following policy types are supported:
TargetTrackingScaling
—Not supported for Amazon EMRStepScaling
—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune. - step
Scaling Property MapPolicy Configuration - A step scaling policy.
- target
Tracking Property MapScaling Policy Configuration - A target tracking scaling policy.
Supporting Types
ScalingPolicyCustomizedMetricSpecification
- Dimensions
List<Pulumi.
Aws Native. Application Auto Scaling. Inputs. Scaling Policy Metric Dimension> - 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 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.
Aws Native. Application Auto Scaling. Inputs. Scaling Policy Target Tracking Metric Data Query> - 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
[]Scaling
Policy Metric Dimension - 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 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
[]Scaling
Policy Target Tracking Metric Data Query - 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<Scaling
Policy Metric Dimension> - 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 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<Scaling
Policy Target Tracking Metric Data Query> - 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
Scaling
Policy Metric Dimension[] - 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 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
Scaling
Policy Target Tracking Metric Data Query[] - 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[Scaling
Policy Metric Dimension] - 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[Scaling
Policy Target Tracking Metric Data Query] - 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.
- metric
Name 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
ScalingPolicyPredefinedMetricSpecification
- Predefined
Metric stringType - The metric type. The
ALBRequestCountPerTarget
metric type applies only to Spot fleet requests and ECS services. - Resource
Label 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 stringType - The metric type. The
ALBRequestCountPerTarget
metric type applies only to Spot fleet requests and ECS services. - Resource
Label 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 StringType - The metric type. The
ALBRequestCountPerTarget
metric type applies only to Spot fleet requests and ECS services. - resource
Label 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 stringType - The metric type. The
ALBRequestCountPerTarget
metric type applies only to Spot fleet requests and ECS services. - resource
Label 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_ strtype - 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.
- predefined
Metric StringType - The metric type. The
ALBRequestCountPerTarget
metric type applies only to Spot fleet requests and ECS services. - resource
Label 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
- 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 doubleLower Bound - 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 doubleUpper Bound - 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 float64Lower Bound - 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 float64Upper Bound - 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 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. - metric
Interval DoubleLower Bound - 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 DoubleUpper Bound - 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 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. - metric
Interval numberLower Bound - 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 numberUpper Bound - 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_ floatlower_ bound - 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_ floatupper_ bound - 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 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. - metric
Interval NumberLower Bound - 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 NumberUpper Bound - 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
- Adjustment
Type string - Specifies whether the
ScalingAdjustment
value in theStepAdjustment
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 stringType - The aggregation type for the CloudWatch metrics. Valid values are
Minimum
,Maximum
, andAverage
. If the aggregation type is null, the value is treated asAverage
. - Min
Adjustment intMagnitude - 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 aMinAdjustmentMagnitude
of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified aMinAdjustmentMagnitude
of 2, Application Auto Scaling scales out the service by 2 tasks. - Step
Adjustments List<Pulumi.Aws Native. Application Auto Scaling. Inputs. Scaling Policy Step Adjustment> - 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 string - Specifies whether the
ScalingAdjustment
value in theStepAdjustment
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 stringType - The aggregation type for the CloudWatch metrics. Valid values are
Minimum
,Maximum
, andAverage
. If the aggregation type is null, the value is treated asAverage
. - Min
Adjustment intMagnitude - 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 aMinAdjustmentMagnitude
of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified aMinAdjustmentMagnitude
of 2, Application Auto Scaling scales out the service by 2 tasks. - Step
Adjustments []ScalingPolicy Step Adjustment - 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 String - Specifies whether the
ScalingAdjustment
value in theStepAdjustment
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.
- metric
Aggregation StringType - The aggregation type for the CloudWatch metrics. Valid values are
Minimum
,Maximum
, andAverage
. If the aggregation type is null, the value is treated asAverage
. - min
Adjustment IntegerMagnitude - 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 aMinAdjustmentMagnitude
of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified aMinAdjustmentMagnitude
of 2, Application Auto Scaling scales out the service by 2 tasks. - step
Adjustments List<ScalingPolicy Step Adjustment> - 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 string - Specifies whether the
ScalingAdjustment
value in theStepAdjustment
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.
- metric
Aggregation stringType - The aggregation type for the CloudWatch metrics. Valid values are
Minimum
,Maximum
, andAverage
. If the aggregation type is null, the value is treated asAverage
. - min
Adjustment numberMagnitude - 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 aMinAdjustmentMagnitude
of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified aMinAdjustmentMagnitude
of 2, Application Auto Scaling scales out the service by 2 tasks. - step
Adjustments ScalingPolicy Step Adjustment[] - 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 theStepAdjustment
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_ strtype - The aggregation type for the CloudWatch metrics. Valid values are
Minimum
,Maximum
, andAverage
. If the aggregation type is null, the value is treated asAverage
. - min_
adjustment_ intmagnitude - 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 aMinAdjustmentMagnitude
of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified aMinAdjustmentMagnitude
of 2, Application Auto Scaling scales out the service by 2 tasks. - step_
adjustments Sequence[ScalingPolicy Step Adjustment] - 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 String - Specifies whether the
ScalingAdjustment
value in theStepAdjustment
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.
- metric
Aggregation StringType - The aggregation type for the CloudWatch metrics. Valid values are
Minimum
,Maximum
, andAverage
. If the aggregation type is null, the value is treated asAverage
. - min
Adjustment NumberMagnitude - 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 aMinAdjustmentMagnitude
of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified aMinAdjustmentMagnitude
of 2, Application Auto Scaling scales out the service by 2 tasks. - step
Adjustments 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
- Dimensions
List<Pulumi.
Aws Native. Application Auto Scaling. Inputs. Scaling Policy Target Tracking Metric Dimension> - 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 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
[]Scaling
Policy Target Tracking Metric Dimension - 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 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<Scaling
Policy Target Tracking Metric Dimension> - 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 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
Scaling
Policy Target Tracking Metric Dimension[] - 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 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[Scaling
Policy Target Tracking Metric Dimension] - 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.
- metric
Name 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
- 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 theId
of other expressions to use the result of those expressions. Conditional: Within eachTargetTrackingMetricDataQuery
object, you must specify eitherExpression
orMetricStat
, 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.
- Metric
Stat Pulumi.Aws Native. Application Auto Scaling. Inputs. Scaling Policy Target Tracking Metric Stat - Information about the metric data to return.
Conditional: Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
, 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 specifyfalse
forReturnData
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 forReturnData
. 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 theId
of other expressions to use the result of those expressions. Conditional: Within eachTargetTrackingMetricDataQuery
object, you must specify eitherExpression
orMetricStat
, 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.
- Metric
Stat ScalingPolicy Target Tracking Metric Stat - Information about the metric data to return.
Conditional: Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
, 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 specifyfalse
forReturnData
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 forReturnData
. 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 theId
of other expressions to use the result of those expressions. Conditional: Within eachTargetTrackingMetricDataQuery
object, you must specify eitherExpression
orMetricStat
, 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.
- metric
Stat ScalingPolicy Target Tracking Metric Stat - Information about the metric data to return.
Conditional: Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both. - return
Data 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 specifyfalse
forReturnData
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 forReturnData
. 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 theId
of other expressions to use the result of those expressions. Conditional: Within eachTargetTrackingMetricDataQuery
object, you must specify eitherExpression
orMetricStat
, 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.
- metric
Stat ScalingPolicy Target Tracking Metric Stat - Information about the metric data to return.
Conditional: Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both. - return
Data 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 specifyfalse
forReturnData
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 forReturnData
. 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 theId
of other expressions to use the result of those expressions. Conditional: Within eachTargetTrackingMetricDataQuery
object, you must specify eitherExpression
orMetricStat
, 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 ScalingPolicy Target Tracking Metric Stat - Information about the metric data to return.
Conditional: Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
, 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 specifyfalse
forReturnData
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 forReturnData
. 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 theId
of other expressions to use the result of those expressions. Conditional: Within eachTargetTrackingMetricDataQuery
object, you must specify eitherExpression
orMetricStat
, 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.
- metric
Stat Property Map - Information about the metric data to return.
Conditional: Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
, but not both. - return
Data 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 specifyfalse
forReturnData
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 forReturnData
. This sets it to its default (true
).
ScalingPolicyTargetTrackingMetricDimension
ScalingPolicyTargetTrackingMetricStat
- Metric
Pulumi.
Aws Native. Application Auto Scaling. Inputs. Scaling Policy Target Tracking Metric - 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
Scaling
Policy Target Tracking Metric - 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
Scaling
Policy Target Tracking Metric - 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
Scaling
Policy Target Tracking Metric - 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
Scaling
Policy Target Tracking Metric - 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
- Target
Value 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.
- Customized
Metric Pulumi.Specification Aws Native. Application Auto Scaling. Inputs. Scaling Policy Customized Metric Specification - A customized metric. You can specify either a predefined metric or a customized metric.
- Disable
Scale boolIn - 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 isfalse
. - Predefined
Metric Pulumi.Specification Aws Native. Application Auto Scaling. Inputs. Scaling Policy Predefined Metric Specification - A predefined metric. You can specify either a predefined metric or a customized metric.
- Scale
In intCooldown - 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 intCooldown - 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 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.
- Customized
Metric ScalingSpecification Policy Customized Metric Specification - A customized metric. You can specify either a predefined metric or a customized metric.
- Disable
Scale boolIn - 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 isfalse
. - Predefined
Metric ScalingSpecification Policy Predefined Metric Specification - A predefined metric. You can specify either a predefined metric or a customized metric.
- Scale
In intCooldown - 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 intCooldown - 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 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.
- customized
Metric ScalingSpecification Policy Customized Metric Specification - A customized metric. You can specify either a predefined metric or a customized metric.
- disable
Scale BooleanIn - 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 isfalse
. - predefined
Metric ScalingSpecification Policy Predefined Metric Specification - A predefined metric. You can specify either a predefined metric or a customized metric.
- scale
In IntegerCooldown - 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 IntegerCooldown - 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 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.
- customized
Metric ScalingSpecification Policy Customized Metric Specification - A customized metric. You can specify either a predefined metric or a customized metric.
- disable
Scale booleanIn - 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 isfalse
. - predefined
Metric ScalingSpecification Policy Predefined Metric Specification - A predefined metric. You can specify either a predefined metric or a customized metric.
- scale
In numberCooldown - 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 numberCooldown - 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_ Scalingspecification Policy Customized Metric Specification - A customized metric. You can specify either a predefined metric or a customized metric.
- disable_
scale_ boolin - 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 isfalse
. - predefined_
metric_ Scalingspecification Policy Predefined Metric Specification - A predefined metric. You can specify either a predefined metric or a customized metric.
- scale_
in_ intcooldown - 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_ intcooldown - 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 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.
- customized
Metric Property MapSpecification - A customized metric. You can specify either a predefined metric or a customized metric.
- disable
Scale BooleanIn - 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 isfalse
. - predefined
Metric Property MapSpecification - A predefined metric. You can specify either a predefined metric or a customized metric.
- scale
In NumberCooldown - 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 NumberCooldown - 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
We recommend new projects start with resources from the AWS provider.