Interface ScheduledAction.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ScheduledAction.Builder,
,ScheduledAction> SdkBuilder<ScheduledAction.Builder,
,ScheduledAction> SdkPojo
- Enclosing class:
ScheduledAction
-
Method Summary
Modifier and TypeMethodDescriptioncreationTime
(Instant creationTime) The date and time that the scheduled action was created.The date and time that the action is scheduled to end, in UTC.resourceId
(String resourceId) The identifier of the resource associated with the scaling policy.scalableDimension
(String scalableDimension) The scalable dimension.scalableDimension
(ScalableDimension scalableDimension) The scalable dimension.default ScheduledAction.Builder
scalableTargetAction
(Consumer<ScalableTargetAction.Builder> scalableTargetAction) The new minimum and maximum capacity.scalableTargetAction
(ScalableTargetAction scalableTargetAction) The new minimum and maximum capacity.The schedule for this action.scheduledActionARN
(String scheduledActionARN) The Amazon Resource Name (ARN) of the scheduled action.scheduledActionName
(String scheduledActionName) The name of the scheduled action.serviceNamespace
(String serviceNamespace) The namespace of the Amazon Web Services service that provides the resource, or acustom-resource
.serviceNamespace
(ServiceNamespace serviceNamespace) The namespace of the Amazon Web Services service that provides the resource, or acustom-resource
.The date and time that the action is scheduled to begin, in UTC.The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
scheduledActionName
The name of the scheduled action.
- Parameters:
scheduledActionName
- The name of the scheduled action.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scheduledActionARN
The Amazon Resource Name (ARN) of the scheduled action.
- Parameters:
scheduledActionARN
- The Amazon Resource Name (ARN) of the scheduled action.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serviceNamespace
The namespace of the Amazon Web Services service that provides the resource, or a
custom-resource
.- Parameters:
serviceNamespace
- The namespace of the Amazon Web Services service that provides the resource, or acustom-resource
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
serviceNamespace
The namespace of the Amazon Web Services service that provides the resource, or a
custom-resource
.- Parameters:
serviceNamespace
- The namespace of the Amazon Web Services service that provides the resource, or acustom-resource
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.
At and cron expressions use Universal Coordinated Time (UTC) by default.
The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
For rate expressions, value is a positive integer and unit is
minute
|minutes
|hour
|hours
|day
|days
.For more information and examples, see Example scheduled actions for Application Auto Scaling in the Application Auto Scaling User Guide.
- Parameters:
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. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.
At and cron expressions use Universal Coordinated Time (UTC) by default.
The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
For rate expressions, value is a positive integer and unit is
minute
|minutes
|hour
|hours
|day
|days
.For more information and examples, see Example scheduled actions for Application Auto Scaling in the Application Auto Scaling User Guide.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
timezone
The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.
- Parameters:
timezone
- The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 - 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
orfunction: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
.
- Parameters:
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 - 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
orfunction: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
.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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. -
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 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 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.
- Parameters:
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. -
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 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 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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. -
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 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 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.
- Parameters:
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. -
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 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 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
startTime
The date and time that the action is scheduled to begin, in UTC.
- Parameters:
startTime
- The date and time that the action is scheduled to begin, in UTC.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endTime
The date and time that the action is scheduled to end, in UTC.
- Parameters:
endTime
- The date and time that the action is scheduled to end, in UTC.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scalableTargetAction
The new minimum and maximum capacity. You can set both values or just one. At 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.
- Parameters:
scalableTargetAction
- The new minimum and maximum capacity. You can set both values or just one. At 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scalableTargetAction
default ScheduledAction.Builder scalableTargetAction(Consumer<ScalableTargetAction.Builder> scalableTargetAction) The new minimum and maximum capacity. You can set both values or just one. At 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 method that creates an instance of theScalableTargetAction.Builder
avoiding the need to create one manually viaScalableTargetAction.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toscalableTargetAction(ScalableTargetAction)
.- Parameters:
scalableTargetAction
- a consumer that will call methods onScalableTargetAction.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
creationTime
The date and time that the scheduled action was created.
- Parameters:
creationTime
- The date and time that the scheduled action was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-