Class: Aws::AutoScalingPlans::Types::ScalingPlanResource

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-autoscalingplans/types.rb

Overview

Represents a scalable resource.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#resource_id ⇒ String

The ID of the resource. This string consists of the resource type and unique identifier.

  • Auto Scaling group - The resource type is ‘autoScalingGroup` and the unique identifier is the name of the Auto Scaling group. Example: `autoScalingGroup/my-asg`.

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

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

Returns:

  • (String) 


1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
 
# File 'lib/aws-sdk-autoscalingplans/types.rb', line 1032

class ScalingPlanResource < Struct.new(
  :scaling_plan_name,
  :scaling_plan_version,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :scaling_policies,
  :scaling_status_code,
  :scaling_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#scalable_dimension ⇒ String

The scalable dimension for the resource.

  • ‘autoscaling:autoScalingGroup:DesiredCapacity` - The desired capacity of an Auto Scaling group.

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

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

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

Returns:

  • (String) 


1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
 
# File 'lib/aws-sdk-autoscalingplans/types.rb', line 1032

class ScalingPlanResource < Struct.new(
  :scaling_plan_name,
  :scaling_plan_version,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :scaling_policies,
  :scaling_status_code,
  :scaling_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#scaling_plan_name ⇒ String

The name of the scaling plan.

Returns:

  • (String) 


1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
 
# File 'lib/aws-sdk-autoscalingplans/types.rb', line 1032

class ScalingPlanResource < Struct.new(
  :scaling_plan_name,
  :scaling_plan_version,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :scaling_policies,
  :scaling_status_code,
  :scaling_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#scaling_plan_version ⇒ Integer

The version number of the scaling plan.

Returns:

  • (Integer) 


1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
 
# File 'lib/aws-sdk-autoscalingplans/types.rb', line 1032

class ScalingPlanResource < Struct.new(
  :scaling_plan_name,
  :scaling_plan_version,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :scaling_policies,
  :scaling_status_code,
  :scaling_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#scaling_policies ⇒ Array<Types::ScalingPolicy>

The scaling policies.

Returns:



1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
 
# File 'lib/aws-sdk-autoscalingplans/types.rb', line 1032

class ScalingPlanResource < Struct.new(
  :scaling_plan_name,
  :scaling_plan_version,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :scaling_policies,
  :scaling_status_code,
  :scaling_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#scaling_status_code ⇒ String

The scaling status of the resource.

  • ‘Active` - The scaling configuration is active.

  • ‘Inactive` - The scaling configuration is not active because the scaling plan is being created or the scaling configuration could not be applied. Check the status message for more information.

  • ‘PartiallyActive` - The scaling configuration is partially active because the scaling plan is being created or deleted or the scaling configuration could not be fully applied. Check the status message for more information.

Returns:

  • (String) 


1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
 
# File 'lib/aws-sdk-autoscalingplans/types.rb', line 1032

class ScalingPlanResource < Struct.new(
  :scaling_plan_name,
  :scaling_plan_version,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :scaling_policies,
  :scaling_status_code,
  :scaling_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#scaling_status_message ⇒ String

A simple message about the current scaling status of the resource.

Returns:

  • (String) 


1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
 
# File 'lib/aws-sdk-autoscalingplans/types.rb', line 1032

class ScalingPlanResource < Struct.new(
  :scaling_plan_name,
  :scaling_plan_version,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :scaling_policies,
  :scaling_status_code,
  :scaling_status_message)
  SENSITIVE = []
  include Aws::Structure
end

#service_namespace ⇒ String

The namespace of the AWS service.

Returns:

  • (String) 


1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
 
# File 'lib/aws-sdk-autoscalingplans/types.rb', line 1032

class ScalingPlanResource < Struct.new(
  :scaling_plan_name,
  :scaling_plan_version,
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :scaling_policies,
  :scaling_status_code,
  :scaling_status_message)
  SENSITIVE = []
  include Aws::Structure
end