Interface CreateScheduledActionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateScheduledActionRequest.Builder,CreateScheduledActionRequest>, RedshiftServerlessRequest.Builder, SdkBuilder<CreateScheduledActionRequest.Builder,CreateScheduledActionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateScheduledActionRequest
@Mutable @NotThreadSafe public static interface CreateScheduledActionRequest.Builder extends RedshiftServerlessRequest.Builder, SdkPojo, CopyableBuilder<CreateScheduledActionRequest.Builder,CreateScheduledActionRequest>

  • Method Details

    • enabled

      CreateScheduledActionRequest.Builder enabled(Boolean enabled)

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

      Parameters:
      enabled - Indicates whether 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.

    • endTime

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

    • namespaceName

      CreateScheduledActionRequest.Builder namespaceName(String namespaceName)

      The name of the namespace for which to create a scheduled action.

      Parameters:
      namespaceName - The name of the namespace for which to create a scheduled action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      CreateScheduledActionRequest.Builder roleArn(String roleArn)

      The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (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 Management Guide

      Parameters:
      roleArn - The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (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 Management Guide
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schedule

      CreateScheduledActionRequest.Builder schedule(Schedule schedule)

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

      • Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.

      • Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, "(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 timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.

      • Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.

      • Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, "(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.

    • schedule

      default CreateScheduledActionRequest.Builder schedule(Consumer<Schedule.Builder> schedule)

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

      • Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.

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

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

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

      Parameters:
      schedule - a consumer that will call methods on Schedule.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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

    • scheduledActionName

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

    • startTime

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

    • targetAction

      CreateScheduledActionRequest.Builder targetAction(TargetAction targetAction)
      Sets the value of the TargetAction property for this object.
      Parameters:
      targetAction - The new value for the TargetAction property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetAction

      default CreateScheduledActionRequest.Builder targetAction(Consumer<TargetAction.Builder> targetAction)
      Sets the value of the TargetAction property for this object. This is a convenience method that creates an instance of the TargetAction.Builder avoiding the need to create one manually via TargetAction.builder().

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

      Parameters:
      targetAction - a consumer that will call methods on TargetAction.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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