public static interface ScalableTarget.Builder extends CopyableBuilder<ScalableTarget.Builder,ScalableTarget>
Modifier and Type | Method and Description |
---|---|
ScalableTarget.Builder |
creationTime(Instant creationTime)
The Unix timestamp for when the scalable target was created.
|
ScalableTarget.Builder |
maxCapacity(Integer maxCapacity)
The maximum value to scale to in response to a scale out event.
|
ScalableTarget.Builder |
minCapacity(Integer minCapacity)
The minimum value to scale to in response to a scale in event.
|
ScalableTarget.Builder |
resourceId(String resourceId)
The identifier of the resource associated with the scalable target.
|
ScalableTarget.Builder |
roleARN(String roleARN)
The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
|
ScalableTarget.Builder |
scalableDimension(ScalableDimension scalableDimension)
The scalable dimension associated with the scalable target.
|
ScalableTarget.Builder |
scalableDimension(String scalableDimension)
The scalable dimension associated with the scalable target.
|
ScalableTarget.Builder |
serviceNamespace(ServiceNamespace serviceNamespace)
The namespace of the AWS service.
|
ScalableTarget.Builder |
serviceNamespace(String serviceNamespace)
The namespace of the AWS service.
|
copy
applyMutation, build
ScalableTarget.Builder serviceNamespace(String serviceNamespace)
The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
serviceNamespace
- The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.ServiceNamespace
,
ServiceNamespace
ScalableTarget.Builder serviceNamespace(ServiceNamespace serviceNamespace)
The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
serviceNamespace
- The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.ServiceNamespace
,
ServiceNamespace
ScalableTarget.Builder resourceId(String resourceId)
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
.
resourceId
- 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
.
ScalableTarget.Builder scalableDimension(String scalableDimension)
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.
scalableDimension
- 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.
ScalableDimension
,
ScalableDimension
ScalableTarget.Builder scalableDimension(ScalableDimension scalableDimension)
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.
scalableDimension
- 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.
ScalableDimension
,
ScalableDimension
ScalableTarget.Builder minCapacity(Integer minCapacity)
The minimum value to scale to in response to a scale in event.
minCapacity
- The minimum value to scale to in response to a scale in event.ScalableTarget.Builder maxCapacity(Integer maxCapacity)
The maximum value to scale to in response to a scale out event.
maxCapacity
- The maximum value to scale to in response to a scale out event.ScalableTarget.Builder roleARN(String roleARN)
The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
roleARN
- The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your
behalf.ScalableTarget.Builder creationTime(Instant creationTime)
The Unix timestamp for when the scalable target was created.
creationTime
- The Unix timestamp for when the scalable target was created.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.