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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb

Overview

Represents a scaling policy.

Instance Attribute Summary collapse

Instance Attribute Details

#alarmsArray<Types::Alarm>

The CloudWatch alarms associated with the scaling policy.

Returns:



1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 1285

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_timeTime

The Unix timestamp for when the scaling policy was created.

Returns:

  • (Time)


1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 1285

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_arnString

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

Returns:

  • (String)


1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 1285

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_nameString

The name of the scaling policy.

Returns:

  • (String)


1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 1285

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_typeString

The scaling policy type.

Returns:

  • (String)


1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 1285

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

Returns:

  • (String)


1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 1285

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

Returns:

  • (String)


1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 1285

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_namespaceString

The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Returns:

  • (String)


1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 1285

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_configurationTypes::StepScalingPolicyConfiguration

A step scaling policy.



1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 1285

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_configurationTypes::TargetTrackingScalingPolicyConfiguration

A target tracking policy.



1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
# File 'gems/aws-sdk-applicationautoscaling/lib/aws-sdk-applicationautoscaling/types.rb', line 1285

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