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

Interface ModifyScheduledActionResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<ModifyScheduledActionResponse.Builder,ModifyScheduledActionResponse>, RedshiftResponse.Builder, SdkBuilder<ModifyScheduledActionResponse.Builder,ModifyScheduledActionResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
ModifyScheduledActionResponse
public static interface ModifyScheduledActionResponse.Builder extends RedshiftResponse.Builder, SdkPojo, CopyableBuilder<ModifyScheduledActionResponse.Builder,ModifyScheduledActionResponse>

  • Method Details

    • scheduledActionName

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

      ModifyScheduledActionResponse.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 ModifyScheduledActionResponse.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:

    • schedule

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

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

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

      ModifyScheduledActionResponse.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:

    • state

      ModifyScheduledActionResponse.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:

    • nextInvocations

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

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

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

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