You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ApplicationAutoScaling::Types::ScalingPolicy

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Represents a scaling policy to use with Application Auto Scaling.

Instance Attribute Summary collapse

Instance Attribute Details

#alarmsArray<Types::Alarm>

The CloudWatch alarms associated with the scaling policy.

Returns:

  • (Array<Types::Alarm>)

    The CloudWatch alarms associated with the scaling policy.

#creation_timeTime

The Unix timestamp for when the scaling policy was created.

Returns:

  • (Time)

    The Unix timestamp for when the scaling policy was created.

#policy_arnString

The Amazon Resource Name (ARN) of the scaling policy.

Returns:

  • (String)

    The Amazon Resource Name (ARN) of the scaling policy.

#policy_nameString

The name of the scaling policy.

Returns:

  • (String)

    The name of the scaling policy.

#policy_typeString

The scaling policy type.

Possible values:

  • StepScaling
  • TargetTrackingScaling

Returns:

  • (String)

    The scaling policy type.

#resource_idString

The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot Fleet request - 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 resource ID. Example: table/my-table.

  • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. 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.

  • Amazon SageMaker endpoint variants - 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.

Returns:

  • (String)

    The identifier of the resource associated with the scaling policy.

#scalable_dimensionString

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

  • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

  • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

  • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

  • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

  • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

  • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

  • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

  • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

    Possible values:

    • ecs:service:DesiredCount
    • ec2:spot-fleet-request:TargetCapacity
    • elasticmapreduce:instancegroup:InstanceCount
    • appstream:fleet:DesiredCapacity
    • dynamodb:table:ReadCapacityUnits
    • dynamodb:table:WriteCapacityUnits
    • dynamodb:index:ReadCapacityUnits
    • dynamodb:index:WriteCapacityUnits
    • rds:cluster:ReadReplicaCount
    • sagemaker:variant:DesiredInstanceCount
    • custom-resource:ResourceType:Property

Returns:

  • (String)

    The scalable dimension.

#service_namespaceString

The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Returns:

  • (String)

    The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service.

#step_scaling_policy_configurationTypes::StepScalingPolicyConfiguration

A step scaling policy.

Returns:

#target_tracking_scaling_policy_configurationTypes::TargetTrackingScalingPolicyConfiguration

A target tracking scaling policy.

Returns: