public static interface ScheduledAction.Builder extends CopyableBuilder<ScheduledAction.Builder,ScheduledAction>
Modifier and Type | Method and Description |
---|---|
ScheduledAction.Builder |
creationTime(Instant creationTime)
The date and time that the scheduled action was created.
|
ScheduledAction.Builder |
endTime(Instant endTime)
The date and time that the action is scheduled to end.
|
ScheduledAction.Builder |
resourceId(String resourceId)
The identifier of the resource associated with the scaling policy.
|
ScheduledAction.Builder |
scalableDimension(ScalableDimension scalableDimension)
The scalable dimension.
|
ScheduledAction.Builder |
scalableDimension(String scalableDimension)
The scalable dimension.
|
default ScheduledAction.Builder |
scalableTargetAction(Consumer<ScalableTargetAction.Builder> scalableTargetAction)
The new minimum and maximum capacity.
|
ScheduledAction.Builder |
scalableTargetAction(ScalableTargetAction scalableTargetAction)
The new minimum and maximum capacity.
|
ScheduledAction.Builder |
schedule(String schedule)
The schedule for this action.
|
ScheduledAction.Builder |
scheduledActionARN(String scheduledActionARN)
The Amazon Resource Name (ARN) of the scheduled action.
|
ScheduledAction.Builder |
scheduledActionName(String scheduledActionName)
The name of the scheduled action.
|
ScheduledAction.Builder |
serviceNamespace(ServiceNamespace serviceNamespace)
The namespace of the AWS service.
|
ScheduledAction.Builder |
serviceNamespace(String serviceNamespace)
The namespace of the AWS service.
|
ScheduledAction.Builder |
startTime(Instant startTime)
The date and time that the action is scheduled to begin.
|
copy
applyMutation, build
ScheduledAction.Builder scheduledActionName(String scheduledActionName)
The name of the scheduled action.
scheduledActionName
- The name of the scheduled action.ScheduledAction.Builder scheduledActionARN(String scheduledActionARN)
The Amazon Resource Name (ARN) of the scheduled action.
scheduledActionARN
- The Amazon Resource Name (ARN) of the scheduled action.ScheduledAction.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
ScheduledAction.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
ScheduledAction.Builder schedule(String schedule)
The schedule for this action. The following formats are supported:
At expressions - at(yyyy-mm-ddThh:mm:ss)
Rate expressions - rate(value unit)
Cron expressions - cron(fields)
At expressions are useful for one-time schedules. Specify the time, in UTC.
For rate expressions, value is a positive integer and unit is minute
|
minutes
| hour
| hours
| day
| days
.
For more information about cron expressions, see Cron.
schedule
- The schedule for this action. The following formats are supported:
At expressions - at(yyyy-mm-ddThh:mm:ss)
Rate expressions - rate(value unit)
Cron expressions - cron(fields)
At expressions are useful for one-time schedules. Specify the time, in UTC.
For rate expressions, value is a positive integer and unit is minute
|
minutes
| hour
| hours
| day
| days
.
For more information about cron expressions, see Cron.
ScheduledAction.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
.
ScheduledAction.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
ScheduledAction.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
ScheduledAction.Builder startTime(Instant startTime)
The date and time that the action is scheduled to begin.
startTime
- The date and time that the action is scheduled to begin.ScheduledAction.Builder endTime(Instant endTime)
The date and time that the action is scheduled to end.
endTime
- The date and time that the action is scheduled to end.ScheduledAction.Builder scalableTargetAction(ScalableTargetAction scalableTargetAction)
The new minimum and maximum capacity. You can set both values or just one. During the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
scalableTargetAction
- The new minimum and maximum capacity. You can set both values or just one. During the scheduled time,
if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the
minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling
scales in to the maximum capacity.default ScheduledAction.Builder scalableTargetAction(Consumer<ScalableTargetAction.Builder> scalableTargetAction)
The new minimum and maximum capacity. You can set both values or just one. During the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
This is a convenience that creates an instance of theScalableTargetAction.Builder
avoiding the need
to create one manually via ScalableTargetAction.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to scalableTargetAction(ScalableTargetAction)
.scalableTargetAction
- a consumer that will call methods on ScalableTargetAction.Builder
scalableTargetAction(ScalableTargetAction)
ScheduledAction.Builder creationTime(Instant creationTime)
The date and time that the scheduled action was created.
creationTime
- The date and time that the scheduled action was created.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.