Package software.amazon.awssdk.services.redshift.model

Interface CreateScheduledActionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateScheduledActionRequest.Builder,CreateScheduledActionRequest>, RedshiftRequest.Builder, SdkBuilder<CreateScheduledActionRequest.Builder,CreateScheduledActionRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateScheduledActionRequest

public static interface CreateScheduledActionRequest.Builder
extends RedshiftRequest.Builder, SdkPojo, CopyableBuilder<CreateScheduledActionRequest.Builder,CreateScheduledActionRequest>

Method Summary

Modifier and Type	Method	Description
CreateScheduledActionRequest.Builder	enable(Boolean enable)	If true, the schedule is enabled.
CreateScheduledActionRequest.Builder	endTime(Instant endTime)	The end time in UTC of the scheduled action.
CreateScheduledActionRequest.Builder	iamRole(String iamRole)	The IAM role to assume to run the target action.
CreateScheduledActionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateScheduledActionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateScheduledActionRequest.Builder	schedule(String schedule)	The schedule in at( ) or cron( ) format.
CreateScheduledActionRequest.Builder	scheduledActionDescription(String scheduledActionDescription)	The description of the scheduled action.
CreateScheduledActionRequest.Builder	scheduledActionName(String scheduledActionName)	The name of the scheduled action.
CreateScheduledActionRequest.Builder	startTime(Instant startTime)	The start time in UTC of the scheduled action.
default CreateScheduledActionRequest.Builder	targetAction(Consumer<ScheduledActionType.Builder> targetAction)	A JSON format string of the Amazon Redshift API operation with input parameters.
CreateScheduledActionRequest.Builder	targetAction(ScheduledActionType targetAction)	A JSON format string of the Amazon Redshift API operation with input parameters.

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

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.redshift.model.RedshiftRequest.Builder

build

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

CreateScheduledActionRequest.Builder scheduledActionName(String scheduledActionName)

The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see ScheduledAction.

Parameters:

scheduledActionName - The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see ScheduledAction.

Returns:

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

targetAction

CreateScheduledActionRequest.Builder targetAction(ScheduledActionType targetAction)

A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see ScheduledAction.

Parameters:

targetAction - A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see ScheduledAction.

Returns:

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

targetAction

default CreateScheduledActionRequest.Builder targetAction(Consumer<ScheduledActionType.Builder> targetAction)

A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see ScheduledAction.

This is a convenience method that creates an instance of the ScheduledActionType.Builder avoiding the need to create one manually via ScheduledActionType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to targetAction(ScheduledActionType).

Parameters:

targetAction - a consumer that will call methods on ScheduledActionType.Builder

Returns:

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

See Also:

• targetAction(ScheduledActionType)

schedule

CreateScheduledActionRequest.Builder schedule(String schedule)

The schedule in at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.

Parameters:

schedule - The schedule in at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.

Returns:

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

iamRole

CreateScheduledActionRequest.Builder iamRole(String iamRole)

The IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.

Parameters:

iamRole - The IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.

Returns:

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

scheduledActionDescription

CreateScheduledActionRequest.Builder scheduledActionDescription(String scheduledActionDescription)

The description of the scheduled action.

Parameters:

scheduledActionDescription - The description of the scheduled action.

Returns:

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

startTime

CreateScheduledActionRequest.Builder startTime(Instant startTime)

The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

Parameters:

startTime - The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

Returns:

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

endTime

CreateScheduledActionRequest.Builder endTime(Instant endTime)

The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

Parameters:

endTime - The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

Returns:

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

enable

CreateScheduledActionRequest.Builder enable(Boolean enable)

If true, the schedule is enabled. If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction.

Parameters:

enable - If true, the schedule is enabled. If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction.

Returns:

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

overrideConfiguration

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

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