Class: Aws::ApplicationAutoScaling::Types::RegisterScalableTargetRequest

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

Overview

Note:

When making an API call, you may pass RegisterScalableTargetRequest data as a hash:

{
  service_namespace: "ecs", # required, accepts ecs, elasticmapreduce, ec2, appstream, dynamodb, rds, sagemaker, custom-resource
  resource_id: "ResourceIdMaxLen1600", # required
  scalable_dimension: "ecs:service:DesiredCount", # required, accepts ecs:service:DesiredCount, ec2:spot-fleet-request:TargetCapacity, elasticmapreduce:instancegroup:InstanceCount, appstream:fleet:DesiredCapacity, dynamodb:table:ReadCapacityUnits, dynamodb:table:WriteCapacityUnits, dynamodb:index:ReadCapacityUnits, dynamodb:index:WriteCapacityUnits, rds:cluster:ReadReplicaCount, sagemaker:variant:DesiredInstanceCount, custom-resource:ResourceType:Property
  min_capacity: 1,
  max_capacity: 1,
  role_arn: "ResourceIdMaxLen1600",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#max_capacity ⇒ Integer

The maximum value to scale to in response to a scale out event. This parameter is required if you are registering a scalable target.

Returns:

  • (Integer) 


1578
1579
1580
1581
1582
1583
1584
1585
1586
 
# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 1578

class RegisterScalableTargetRequest < Struct.new(
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :min_capacity,
  :max_capacity,
  :role_arn)
  include Aws::Structure
end

#min_capacity ⇒ Integer

The minimum value to scale to in response to a scale in event. This parameter is required if you are registering a scalable target.

Returns:

  • (Integer) 


1578
1579
1580
1581
1582
1583
1584
1585
1586
 
# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 1578

class RegisterScalableTargetRequest < Struct.new(
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :min_capacity,
  :max_capacity,
  :role_arn)
  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/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) 


1578
1579
1580
1581
1582
1583
1584
1585
1586
 
# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 1578

class RegisterScalableTargetRequest < Struct.new(
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :min_capacity,
  :max_capacity,
  :role_arn)
  include Aws::Structure
end

#role_arn ⇒ String

Application Auto Scaling creates a service-linked role that grants it permissions to modify the scalable target on your behalf. For more information, see [Service-Linked Roles for Application Auto Scaling].

For resources that are not supported using a service-linked role, this parameter is required and must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.

[1]: docs.aws.amazon.com/autoscaling/application/userguide/application-autoscaling-service-linked-roles.html

Returns:

  • (String) 


1578
1579
1580
1581
1582
1583
1584
1585
1586
 
# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 1578

class RegisterScalableTargetRequest < Struct.new(
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :min_capacity,
  :max_capacity,
  :role_arn)
  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 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) 


1578
1579
1580
1581
1582
1583
1584
1585
1586
 
# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 1578

class RegisterScalableTargetRequest < Struct.new(
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :min_capacity,
  :max_capacity,
  :role_arn)
  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) 


1578
1579
1580
1581
1582
1583
1584
1585
1586
 
# File 'lib/aws-sdk-applicationautoscaling/types.rb', line 1578

class RegisterScalableTargetRequest < Struct.new(
  :service_namespace,
  :resource_id,
  :scalable_dimension,
  :min_capacity,
  :max_capacity,
  :role_arn)
  include Aws::Structure
end