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

Inherits:

Struct

• Object
• Struct
• Aws::ApplicationAutoScaling::Types::ScalingPolicy

Includes:

Structure

Defined in:

lib/aws-sdk-applicationautoscaling/types.rb

Overview

Represents a scaling policy.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #alarms ⇒ Array<Types::Alarm>

  The CloudWatch alarms associated with the scaling policy.

• #creation_time ⇒ Time

  The Unix timestamp for when the scaling policy was created.

• #policy_arn ⇒ String

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

• #policy_name ⇒ String

  The name of the scaling policy.

• #policy_type ⇒ String

  The scaling policy type.

• #resource_id ⇒ String

  The identifier of the resource associated with the scaling policy.

• #scalable_dimension ⇒ String

  The scalable dimension.

• #service_namespace ⇒ 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_configuration ⇒ Types::StepScalingPolicyConfiguration

  A step scaling policy.

• #target_tracking_scaling_policy_configuration ⇒ Types::TargetTrackingScalingPolicyConfiguration

  A target tracking policy.

Instance Attribute Details

#alarms ⇒ Array<Types::Alarm>

The CloudWatch alarms associated with the scaling policy.

Returns:

• (Array<Types::Alarm>)

# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 2002

class ScalingPolicy < Struct.new(
  :policy_arn,
  :policy_name,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :policy_type,
  :step_scaling_policy_configuration,
  :target_tracking_scaling_policy_configuration,
  :alarms,
  :creation_time)
  include Aws::Structure
end

#creation_time ⇒ Time

The Unix timestamp for when the scaling policy was created.

Returns:

• (Time)

# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 2002

class ScalingPolicy < Struct.new(
  :policy_arn,
  :policy_name,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :policy_type,
  :step_scaling_policy_configuration,
  :target_tracking_scaling_policy_configuration,
  :alarms,
  :creation_time)
  include Aws::Structure
end

#policy_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 2002

class ScalingPolicy < Struct.new(
  :policy_arn,
  :policy_name,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :policy_type,
  :step_scaling_policy_configuration,
  :target_tracking_scaling_policy_configuration,
  :alarms,
  :creation_time)
  include Aws::Structure
end

#policy_name ⇒ String

The name of the scaling policy.

Returns:

• (String)

# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 2002

class ScalingPolicy < Struct.new(
  :policy_arn,
  :policy_name,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :policy_type,
  :step_scaling_policy_configuration,
  :target_tracking_scaling_policy_configuration,
  :alarms,
  :creation_time)
  include Aws::Structure
end

#policy_type ⇒ String

The scaling policy type.

Returns:

• (String)

# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 2002

class ScalingPolicy < Struct.new(
  :policy_arn,
  :policy_name,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :policy_type,
  :step_scaling_policy_configuration,
  :target_tracking_scaling_policy_configuration,
  :alarms,
  :creation_time)
  include Aws::Structure
end

#resource_id ⇒ 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/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.

Returns:

• (String)

# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 2002

class ScalingPolicy < Struct.new(
  :policy_arn,
  :policy_name,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :policy_type,
  :step_scaling_policy_configuration,
  :target_tracking_scaling_policy_configuration,
  :alarms,
  :creation_time)
  include Aws::Structure
end

#scalable_dimension ⇒ String

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.

• ‘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.

Returns:

• (String)

# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 2002

class ScalingPolicy < Struct.new(
  :policy_arn,
  :policy_name,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :policy_type,
  :step_scaling_policy_configuration,
  :target_tracking_scaling_policy_configuration,
  :alarms,
  :creation_time)
  include Aws::Structure
end

#service_namespace ⇒ String

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*.

[1]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces

Returns:

• (String)

# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 2002

class ScalingPolicy < Struct.new(
  :policy_arn,
  :policy_name,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :policy_type,
  :step_scaling_policy_configuration,
  :target_tracking_scaling_policy_configuration,
  :alarms,
  :creation_time)
  include Aws::Structure
end

#step_scaling_policy_configuration ⇒ Types::StepScalingPolicyConfiguration

A step scaling policy.

Returns:

• (Types::StepScalingPolicyConfiguration)

# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 2002

class ScalingPolicy < Struct.new(
  :policy_arn,
  :policy_name,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :policy_type,
  :step_scaling_policy_configuration,
  :target_tracking_scaling_policy_configuration,
  :alarms,
  :creation_time)
  include Aws::Structure
end

#target_tracking_scaling_policy_configuration ⇒ Types::TargetTrackingScalingPolicyConfiguration

A target tracking policy.

Returns:

• (Types::TargetTrackingScalingPolicyConfiguration)

# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 2002

class ScalingPolicy < Struct.new(
  :policy_arn,
  :policy_name,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :policy_type,
  :step_scaling_policy_configuration,
  :target_tracking_scaling_policy_configuration,
  :alarms,
  :creation_time)
  include Aws::Structure
end