public static interface ScalingPolicy.Builder extends CopyableBuilder<ScalingPolicy.Builder,ScalingPolicy>
Modifier and Type | Method and Description |
---|---|
ScalingPolicy.Builder |
alarms(Alarm... alarms)
The CloudWatch alarms associated with the scaling policy.
|
ScalingPolicy.Builder |
alarms(Collection<Alarm> alarms)
The CloudWatch alarms associated with the scaling policy.
|
ScalingPolicy.Builder |
creationTime(Instant creationTime)
The Unix timestamp for when the scaling policy was created.
|
ScalingPolicy.Builder |
policyARN(String policyARN)
The Amazon Resource Name (ARN) of the scaling policy.
|
ScalingPolicy.Builder |
policyName(String policyName)
The name of the scaling policy.
|
ScalingPolicy.Builder |
policyType(PolicyType policyType)
The scaling policy type.
|
ScalingPolicy.Builder |
policyType(String policyType)
The scaling policy type.
|
ScalingPolicy.Builder |
resourceId(String resourceId)
The identifier of the resource associated with the scaling policy.
|
ScalingPolicy.Builder |
scalableDimension(ScalableDimension scalableDimension)
The scalable dimension.
|
ScalingPolicy.Builder |
scalableDimension(String scalableDimension)
The scalable dimension.
|
ScalingPolicy.Builder |
serviceNamespace(ServiceNamespace serviceNamespace)
The namespace of the AWS service.
|
ScalingPolicy.Builder |
serviceNamespace(String serviceNamespace)
The namespace of the AWS service.
|
default ScalingPolicy.Builder |
stepScalingPolicyConfiguration(Consumer<StepScalingPolicyConfiguration.Builder> stepScalingPolicyConfiguration)
A step scaling policy.
|
ScalingPolicy.Builder |
stepScalingPolicyConfiguration(StepScalingPolicyConfiguration stepScalingPolicyConfiguration)
A step scaling policy.
|
default ScalingPolicy.Builder |
targetTrackingScalingPolicyConfiguration(Consumer<TargetTrackingScalingPolicyConfiguration.Builder> targetTrackingScalingPolicyConfiguration)
A target tracking policy.
|
ScalingPolicy.Builder |
targetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration)
A target tracking policy.
|
copy
apply, build
ScalingPolicy.Builder policyARN(String policyARN)
The Amazon Resource Name (ARN) of the scaling policy.
policyARN
- The Amazon Resource Name (ARN) of the scaling policy.ScalingPolicy.Builder policyName(String policyName)
The name of the scaling policy.
policyName
- The name of the scaling policy.ScalingPolicy.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
ScalingPolicy.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
ScalingPolicy.Builder resourceId(String resourceId)
The identifier of the resource associated with the scaling policy. 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 scaling policy. 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
.
ScalingPolicy.Builder scalableDimension(String scalableDimension)
The scalable dimension. 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. 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
ScalingPolicy.Builder scalableDimension(ScalableDimension scalableDimension)
The scalable dimension. 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. 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
ScalingPolicy.Builder policyType(String policyType)
The scaling policy type.
policyType
- The scaling policy type.PolicyType
,
PolicyType
ScalingPolicy.Builder policyType(PolicyType policyType)
The scaling policy type.
policyType
- The scaling policy type.PolicyType
,
PolicyType
ScalingPolicy.Builder stepScalingPolicyConfiguration(StepScalingPolicyConfiguration stepScalingPolicyConfiguration)
A step scaling policy.
stepScalingPolicyConfiguration
- A step scaling policy.default ScalingPolicy.Builder stepScalingPolicyConfiguration(Consumer<StepScalingPolicyConfiguration.Builder> stepScalingPolicyConfiguration)
A step scaling policy.
This is a convenience that creates an instance of theStepScalingPolicyConfiguration.Builder
avoiding
the need to create one manually via StepScalingPolicyConfiguration.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called
immediately and its result is passed to
stepScalingPolicyConfiguration(StepScalingPolicyConfiguration)
.stepScalingPolicyConfiguration
- a consumer that will call methods on StepScalingPolicyConfiguration.Builder
stepScalingPolicyConfiguration(StepScalingPolicyConfiguration)
ScalingPolicy.Builder targetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration)
A target tracking policy.
targetTrackingScalingPolicyConfiguration
- A target tracking policy.default ScalingPolicy.Builder targetTrackingScalingPolicyConfiguration(Consumer<TargetTrackingScalingPolicyConfiguration.Builder> targetTrackingScalingPolicyConfiguration)
A target tracking policy.
This is a convenience that creates an instance of theTargetTrackingScalingPolicyConfiguration.Builder
avoiding the need to create one manually via
TargetTrackingScalingPolicyConfiguration.builder()
.
When the Consumer
completes, SdkBuilder.build()
is
called immediately and its result is passed to
targetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfiguration)
.targetTrackingScalingPolicyConfiguration
- a consumer that will call methods on TargetTrackingScalingPolicyConfiguration.Builder
targetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfiguration)
ScalingPolicy.Builder alarms(Collection<Alarm> alarms)
The CloudWatch alarms associated with the scaling policy.
alarms
- The CloudWatch alarms associated with the scaling policy.ScalingPolicy.Builder alarms(Alarm... alarms)
The CloudWatch alarms associated with the scaling policy.
alarms
- The CloudWatch alarms associated with the scaling policy.ScalingPolicy.Builder creationTime(Instant creationTime)
The Unix timestamp for when the scaling policy was created.
creationTime
- The Unix timestamp for when the scaling policy was created.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.