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

Interface CreateScheduledActionResponse.Builder

    • 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\":\"ra3.4xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} ".

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

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

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

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

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