software.amazon.awssdk.services.redshift.model

Interface CreateScheduledActionResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<CreateScheduledActionResponse.Builder,CreateScheduledActionResponse>, RedshiftResponse.Builder, SdkBuilder<CreateScheduledActionResponse.Builder,CreateScheduledActionResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

CreateScheduledActionResponse

public static interface CreateScheduledActionResponse.Builder
extends RedshiftResponse.Builder, SdkPojo, CopyableBuilder<CreateScheduledActionResponse.Builder,CreateScheduledActionResponse>

Method Summary

Modifier and Type	Method and Description
CreateScheduledActionResponse.Builder	endTime(Instant endTime) The end time in UTC when the schedule is no longer active.
CreateScheduledActionResponse.Builder	iamRole(String iamRole) The IAM role to assume to run the scheduled action.
CreateScheduledActionResponse.Builder	nextInvocations(Collection<Instant> nextInvocations) List of times when the scheduled action will run.
CreateScheduledActionResponse.Builder	nextInvocations(Instant... nextInvocations) List of times when the scheduled action will run.
CreateScheduledActionResponse.Builder	schedule(String schedule) The schedule for a one-time (at format) or recurring (cron format) scheduled action.
CreateScheduledActionResponse.Builder	scheduledActionDescription(String scheduledActionDescription) The description of the scheduled action.
CreateScheduledActionResponse.Builder	scheduledActionName(String scheduledActionName) The name of the scheduled action.
CreateScheduledActionResponse.Builder	startTime(Instant startTime) The start time in UTC when the schedule is active.
CreateScheduledActionResponse.Builder	state(ScheduledActionState state) The state of the scheduled action.
CreateScheduledActionResponse.Builder	state(String state) The state of the scheduled action.
default CreateScheduledActionResponse.Builder	targetAction(Consumer<ScheduledActionType.Builder> targetAction) A JSON format string of the Amazon Redshift API operation with input parameters.
CreateScheduledActionResponse.Builder	targetAction(ScheduledActionType targetAction) A JSON format string of the Amazon Redshift API operation with input parameters.

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

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

equalsBySdkFields, 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

scheduledActionName

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

targetAction

CreateScheduledActionResponse.Builder targetAction(ScheduledActionType targetAction)

A JSON format string of the Amazon Redshift API operation with input parameters.

" {\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} ".

Parameters:

targetAction - A JSON format string of the Amazon Redshift API operation with input parameters.

" {\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} ".

Returns:

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

targetAction

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

A JSON format string of the Amazon Redshift API operation with input parameters.

" {\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} ".

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

CreateScheduledActionResponse.Builder schedule(String schedule)

The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.

Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, " at(2016-03-04T17:27:00)".

Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

Parameters:

schedule - The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.

Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, " at(2016-03-04T17:27:00)".

Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, 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.

iamRole

CreateScheduledActionResponse.Builder iamRole(String iamRole)

The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.

Parameters:

iamRole - The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.

Returns:

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

scheduledActionDescription

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

state

CreateScheduledActionResponse.Builder state(String state)

The state of the scheduled action. For example, DISABLED.

Parameters:

state - The state of the scheduled action. For example, DISABLED.

Returns:

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

See Also:

ScheduledActionState, ScheduledActionState

state

CreateScheduledActionResponse.Builder state(ScheduledActionState state)

The state of the scheduled action. For example, DISABLED.

Parameters:

state - The state of the scheduled action. For example, DISABLED.

Returns:

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

See Also:

ScheduledActionState, ScheduledActionState

nextInvocations

CreateScheduledActionResponse.Builder nextInvocations(Collection<Instant> nextInvocations)

List of times when the scheduled action will run.

Parameters:

nextInvocations - List of times when the scheduled action will run.

Returns:

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

nextInvocations

CreateScheduledActionResponse.Builder nextInvocations(Instant... nextInvocations)

List of times when the scheduled action will run.

Parameters:

nextInvocations - List of times when the scheduled action will run.

Returns:

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

startTime

CreateScheduledActionResponse.Builder startTime(Instant startTime)

The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

Parameters:

startTime - The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

Returns:

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

endTime

CreateScheduledActionResponse.Builder endTime(Instant endTime)

The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

Parameters:

endTime - The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

Returns:

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