Package software.amazon.awssdk.services.redshiftserverless.model

Interface UpdateScheduledActionRequest.Builder

    • Method Detail

      • enabled

        UpdateScheduledActionRequest.Builder enabled​(Boolean enabled)

        Specifies whether to enable the scheduled action.

        Parameters:
        enabled - Specifies whether to enable the scheduled action.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • endTime

        UpdateScheduledActionRequest.Builder endTime​(Instant endTime)

        The end time in UTC of the scheduled action to update.

        Parameters:
        endTime - The end time in UTC of the scheduled action to update.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • roleArn

        UpdateScheduledActionRequest.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 Cluster 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 Cluster Management Guide
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • schedule

        UpdateScheduledActionRequest.Builder schedule​(Schedule 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.

      • schedule

        default UpdateScheduledActionRequest.Builder schedule​(Consumer<Schedule.Builder> 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.

        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:
        schedule(Schedule)

      • scheduledActionDescription

        UpdateScheduledActionRequest.Builder scheduledActionDescription​(String scheduledActionDescription)

        The descripion of the scheduled action to update to.

        Parameters:
        scheduledActionDescription - The descripion of the scheduled action to update to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • scheduledActionName

        UpdateScheduledActionRequest.Builder scheduledActionName​(String scheduledActionName)

        The name of the scheduled action to update to.

        Parameters:
        scheduledActionName - The name of the scheduled action to update to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • startTime

        UpdateScheduledActionRequest.Builder startTime​(Instant startTime)

        The start time in UTC of the scheduled action to update to.

        Parameters:
        startTime - The start time in UTC of the scheduled action to update to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • targetAction

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