software.amazon.awssdk.services.applicationautoscaling.model

Interface PutScheduledActionRequest.Builder

All Superinterfaces:

ApplicationAutoScalingRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<PutScheduledActionRequest.Builder,PutScheduledActionRequest>, SdkBuilder<PutScheduledActionRequest.Builder,PutScheduledActionRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

PutScheduledActionRequest

public static interface PutScheduledActionRequest.Builder
extends ApplicationAutoScalingRequest.Builder, SdkPojo, CopyableBuilder<PutScheduledActionRequest.Builder,PutScheduledActionRequest>

Method Summary

Modifier and Type	Method and Description
PutScheduledActionRequest.Builder	endTime(Instant endTime) The date and time for the scheduled action to end.
PutScheduledActionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
PutScheduledActionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
PutScheduledActionRequest.Builder	resourceId(String resourceId) The identifier of the resource associated with the scheduled action.
PutScheduledActionRequest.Builder	scalableDimension(ScalableDimension scalableDimension) The scalable dimension.
PutScheduledActionRequest.Builder	scalableDimension(String scalableDimension) The scalable dimension.
default PutScheduledActionRequest.Builder	scalableTargetAction(Consumer<ScalableTargetAction.Builder> scalableTargetAction) The new minimum and maximum capacity.
PutScheduledActionRequest.Builder	scalableTargetAction(ScalableTargetAction scalableTargetAction) The new minimum and maximum capacity.
PutScheduledActionRequest.Builder	schedule(String schedule) The schedule for this action.
PutScheduledActionRequest.Builder	scheduledActionName(String scheduledActionName) The name of the scheduled action.
PutScheduledActionRequest.Builder	serviceNamespace(ServiceNamespace serviceNamespace) The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service.
PutScheduledActionRequest.Builder	serviceNamespace(String serviceNamespace) The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service.
PutScheduledActionRequest.Builder	startTime(Instant startTime) The date and time for the scheduled action to start.

Methods inherited from interface software.amazon.awssdk.services.applicationautoscaling.model.ApplicationAutoScalingRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

serviceNamespace

PutScheduledActionRequest.Builder serviceNamespace(String serviceNamespace)

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.

Parameters:

serviceNamespace - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServiceNamespace, ServiceNamespace

serviceNamespace

PutScheduledActionRequest.Builder serviceNamespace(ServiceNamespace serviceNamespace)

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.

Parameters:

serviceNamespace - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServiceNamespace, ServiceNamespace

schedule

PutScheduledActionRequest.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 Expressions in the Amazon CloudWatch Events 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. 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 Expressions in the Amazon CloudWatch Events User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

scheduledActionName

PutScheduledActionRequest.Builder scheduledActionName(String 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.

resourceId

PutScheduledActionRequest.Builder resourceId(String resourceId)

The identifier of the resource associated with the scheduled action. 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.

Parameters:

resourceId - The identifier of the resource associated with the scheduled action. 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:

Returns a reference to this object so that method calls can be chained together.

scalableDimension

PutScheduledActionRequest.Builder scalableDimension(String scalableDimension)

The scalable dimension. This parameter is required if you are creating a scheduled action. 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.

Parameters:

scalableDimension - The scalable dimension. This parameter is required if you are creating a scheduled action. 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:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScalableDimension, ScalableDimension

scalableDimension

PutScheduledActionRequest.Builder scalableDimension(ScalableDimension scalableDimension)

The scalable dimension. This parameter is required if you are creating a scheduled action. 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.

Parameters:

scalableDimension - The scalable dimension. This parameter is required if you are creating a scheduled action. 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:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScalableDimension, ScalableDimension

startTime

PutScheduledActionRequest.Builder startTime(Instant startTime)

The date and time for the scheduled action to start.

Parameters:

startTime - The date and time for the scheduled action to start.

Returns:

Returns a reference to this object so that method calls can be chained together.

endTime

PutScheduledActionRequest.Builder endTime(Instant endTime)

The date and time for the scheduled action to end.

Parameters:

endTime - The date and time for the scheduled action to end.

Returns:

Returns a reference to this object so that method calls can be chained together.

scalableTargetAction

PutScheduledActionRequest.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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

scalableTargetAction

default PutScheduledActionRequest.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 the ScalableTargetAction.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).

Parameters:

scalableTargetAction - a consumer that will call methods on ScalableTargetAction.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

scalableTargetAction(ScalableTargetAction)

overrideConfiguration

PutScheduledActionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

PutScheduledActionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.