Class: Aws::ApplicationAutoScaling::Types::ScalableTarget

Inherits:

Struct

Object
Struct
Aws::ApplicationAutoScaling::Types::ScalableTarget

show all

Includes:: Structure

Defined in:: lib/aws-sdk-applicationautoscaling/types.rb

Overview

Represents a scalable target.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#creation_time ⇒ Time

The Unix timestamp for when the scalable target was created.
#max_capacity ⇒ Integer

The maximum value to scale to in response to a scale-out activity.
#min_capacity ⇒ Integer

The minimum value to scale to in response to a scale-in activity.
#resource_id ⇒ String

The identifier of the resource associated with the scalable target.
#role_arn ⇒ String

The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
#scalable_dimension ⇒ String

The scalable dimension associated with the scalable target.
#scalable_target_arn ⇒ String

The ARN of the scalable target.
#service_namespace ⇒ String

The namespace of the Amazon Web Services service that provides the resource, or a ‘custom-resource`.
#suspended_state ⇒ Types::SuspendedState

Specifies whether the scaling activities for a scalable target are in a suspended state.

Instance Attribute Details

#creation_time ⇒ `Time`

The Unix timestamp for when the scalable target was created.

Returns:

(Time)

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

class ScalableTarget < Struct.new(
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :min_capacity,
  :max_capacity,
  :role_arn,
  :creation_time,
  :suspended_state,
  :scalable_target_arn)
  SENSITIVE = []
  include Aws::Structure
end

#max_capacity ⇒ `Integer`

The maximum value to scale to in response to a scale-out activity.

Returns:

(Integer)

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

class ScalableTarget < Struct.new(
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :min_capacity,
  :max_capacity,
  :role_arn,
  :creation_time,
  :suspended_state,
  :scalable_target_arn)
  SENSITIVE = []
  include Aws::Structure
end

#min_capacity ⇒ `Integer`

The minimum value to scale to in response to a scale-in activity.

Returns:

(Integer)

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

class ScalableTarget < Struct.new(
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :min_capacity,
  :max_capacity,
  :role_arn,
  :creation_time,
  :suspended_state,
  :scalable_target_arn)
  SENSITIVE = []
  include Aws::Structure
end

#resource_id ⇒ `String`

The identifier of the resource associated with the scalable target. 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/my-cluster/my-service`.
Spot Fleet - 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 table name. Example: `table/my-table`.
DynamoDB global secondary index - The resource type is ‘index` and the unique identifier is the index name. 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`.
SageMaker endpoint variant - 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].
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ‘arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE`.
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: ‘arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE`.
Lambda provisioned concurrency - The resource type is ‘function` and the unique identifier is the function name with a function version or alias name suffix that is not `$LATEST`. Example: `function:my-function:prod` or `function:my-function:1`.
Amazon Keyspaces table - The resource type is ‘table` and the unique identifier is the table name. Example: `keyspace/mykeyspace/table/mytable`.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: ‘arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5`.
Amazon ElastiCache replication group - The resource type is ‘replication-group` and the unique identifier is the replication group name. Example: `replication-group/mycluster`.
Neptune cluster - The resource type is ‘cluster` and the unique identifier is the cluster name. Example: `cluster:mycluster`.
SageMaker serverless endpoint - The resource type is ‘variant` and the unique identifier is the resource ID. Example: `endpoint/my-end-point/variant/KMeansClustering`.
SageMaker inference component - The resource type is ‘inference-component` and the unique identifier is the resource ID. Example: `inference-component/my-inference-component`.
Pool of WorkSpaces - The resource type is ‘workspacespool` and the unique identifier is the pool ID. Example: `workspacespool/wspool-123456`.

[1]: github.com/aws/aws-auto-scaling-custom-resource

Returns:

(String)

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

class ScalableTarget < Struct.new(
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :min_capacity,
  :max_capacity,
  :role_arn,
  :creation_time,
  :suspended_state,
  :scalable_target_arn)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ `String`

The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.

Returns:

(String)

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

class ScalableTarget < Struct.new(
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :min_capacity,
  :max_capacity,
  :role_arn,
  :creation_time,
  :suspended_state,
  :scalable_target_arn)
  SENSITIVE = []
  include Aws::Structure
end

#scalable_dimension ⇒ `String`

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

‘ecs:service:DesiredCount` - The task count of an ECS service.
‘elasticmapreduce:instancegroup:InstanceCount` - The instance count of an EMR Instance Group.
‘ec2:spot-fleet-request:TargetCapacity` - The target capacity of a Spot Fleet.
‘appstream:fleet:DesiredCapacity` - The 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 a SageMaker model endpoint variant.
‘custom-resource:ResourceType:Property` - The scalable dimension for a custom resource provided by your own application or service.
‘comprehend:document-classifier-endpoint:DesiredInferenceUnits` - The number of inference units for an Amazon Comprehend document classification endpoint.
‘comprehend:entity-recognizer-endpoint:DesiredInferenceUnits` - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
‘lambda:function:ProvisionedConcurrency` - The provisioned concurrency for a Lambda function.
‘cassandra:table:ReadCapacityUnits` - The provisioned read capacity for an Amazon Keyspaces table.
‘cassandra:table:WriteCapacityUnits` - The provisioned write capacity for an Amazon Keyspaces table.
‘kafka:broker-storage:VolumeSize` - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
‘elasticache:replication-group:NodeGroups` - The number of node groups for an Amazon ElastiCache replication group.
‘elasticache:replication-group:Replicas` - The number of replicas per node group for an Amazon ElastiCache replication group.
‘neptune:cluster:ReadReplicaCount` - The count of read replicas in an Amazon Neptune DB cluster.
‘sagemaker:variant:DesiredProvisionedConcurrency` - The provisioned concurrency for a SageMaker serverless endpoint.
‘sagemaker:inference-component:DesiredCopyCount` - The number of copies across an endpoint for a SageMaker inference component.
‘workspaces:workspacespool:DesiredUserSessions` - The number of user sessions for the WorkSpaces in the pool.

Returns:

(String)

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

class ScalableTarget < Struct.new(
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :min_capacity,
  :max_capacity,
  :role_arn,
  :creation_time,
  :suspended_state,
  :scalable_target_arn)
  SENSITIVE = []
  include Aws::Structure
end

#scalable_target_arn ⇒ `String`

The ARN of the scalable target.

Returns:

(String)

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

class ScalableTarget < Struct.new(
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :min_capacity,
  :max_capacity,
  :role_arn,
  :creation_time,
  :suspended_state,
  :scalable_target_arn)
  SENSITIVE = []
  include Aws::Structure
end

#service_namespace ⇒ `String`

The namespace of the Amazon Web Services service that provides the resource, or a ‘custom-resource`.

Returns:

(String)

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

class ScalableTarget < Struct.new(
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :min_capacity,
  :max_capacity,
  :role_arn,
  :creation_time,
  :suspended_state,
  :scalable_target_arn)
  SENSITIVE = []
  include Aws::Structure
end

#suspended_state ⇒ `Types::SuspendedState`

Specifies whether the scaling activities for a scalable target are in a suspended state.

Returns:

(Types::SuspendedState)

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

class ScalableTarget < Struct.new(
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :min_capacity,
  :max_capacity,
  :role_arn,
  :creation_time,
  :suspended_state,
  :scalable_target_arn)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::ApplicationAutoScaling::Types::ScalableTarget

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#creation_time ⇒ Time

#max_capacity ⇒ Integer

#min_capacity ⇒ Integer

#resource_id ⇒ String

#role_arn ⇒ String

#scalable_dimension ⇒ String

#scalable_target_arn ⇒ String

#service_namespace ⇒ String

#suspended_state ⇒ Types::SuspendedState

#creation_time ⇒ `Time`

#max_capacity ⇒ `Integer`

#min_capacity ⇒ `Integer`

#resource_id ⇒ `String`

#role_arn ⇒ `String`

#scalable_dimension ⇒ `String`

#scalable_target_arn ⇒ `String`

#service_namespace ⇒ `String`

#suspended_state ⇒ `Types::SuspendedState`