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

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

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

Overview

Represents a scalable resource.

Instance Attribute Summary collapse

Instance Attribute Details

#resource_idString

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)

    The ID of the resource.

#scalable_dimensionString

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.

    Possible values:

    • autoscaling:autoScalingGroup:DesiredCapacity
    • ecs:service:DesiredCount
    • ec2:spot-fleet-request:TargetCapacity
    • rds:cluster:ReadReplicaCount
    • dynamodb:table:ReadCapacityUnits
    • dynamodb:table:WriteCapacityUnits
    • dynamodb:index:ReadCapacityUnits
    • dynamodb:index:WriteCapacityUnits

Returns:

  • (String)

    The scalable dimension for the resource.

#scaling_plan_nameString

The name of the scaling plan.

Returns:

  • (String)

    The name of the scaling plan.

#scaling_plan_versionInteger

The version of the scaling plan.

Returns:

  • (Integer)

    The version of the scaling plan.

#scaling_policiesArray<Types::ScalingPolicy>

The scaling policies.

Returns:

#scaling_status_codeString

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.

    Possible values:

    • Inactive
    • PartiallyActive
    • Active

Returns:

  • (String)

    The scaling status of the resource.

#scaling_status_messageString

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

Returns:

  • (String)

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

#service_namespaceString

The namespace of the AWS service.

Possible values:

  • autoscaling
  • ecs
  • ec2
  • rds
  • dynamodb

Returns:

  • (String)

    The namespace of the AWS service.