Interface ScheduledActionResponse.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ScheduledActionResponse.Builder,
,ScheduledActionResponse> SdkBuilder<ScheduledActionResponse.Builder,
,ScheduledActionResponse> SdkPojo
- Enclosing class:
ScheduledActionResponse
-
Method Summary
Modifier and TypeMethodDescriptionThe end time ofnamespaceName
(String namespaceName) The end time in UTC when the schedule is no longer active.nextInvocations
(Instant... nextInvocations) An array of timestamps of when the next scheduled actions will trigger.nextInvocations
(Collection<Instant> nextInvocations) An array of timestamps of when the next scheduled actions will trigger.The ARN of the IAM role to assume to run the scheduled action.default ScheduledActionResponse.Builder
schedule
(Consumer<Schedule.Builder> schedule) The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action.The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action.scheduledActionDescription
(String scheduledActionDescription) The description of the scheduled action.scheduledActionName
(String scheduledActionName) The name of the scheduled action.scheduledActionUuid
(String scheduledActionUuid) The uuid of the scheduled action.The start time in UTC when the schedule is active.The state of the scheduled action.The state of the scheduled action.default ScheduledActionResponse.Builder
targetAction
(Consumer<TargetAction.Builder> targetAction) Sets the value of the TargetAction property for this object.targetAction
(TargetAction targetAction) Sets the value of the TargetAction property for this object.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
endTime
The end time of
- Parameters:
endTime
- The end time of- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
namespaceName
The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
- Parameters:
namespaceName
- 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.
-
nextInvocations
An array of timestamps of when the next scheduled actions will trigger.
- Parameters:
nextInvocations
- An array of timestamps of when the next scheduled actions will trigger.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextInvocations
An array of timestamps of when the next scheduled actions will trigger.
- Parameters:
nextInvocations
- An array of timestamps of when the next scheduled actions will trigger.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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.
Schedule.Builder
avoiding the need to create one manually viaSchedule.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toschedule(Schedule)
.- Parameters:
schedule
- a consumer that will call methods onSchedule.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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
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.
-
scheduledActionUuid
The uuid of the scheduled action.
- Parameters:
scheduledActionUuid
- The uuid of the scheduled action.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
state
The state of the scheduled action.
- Parameters:
state
- The state of the scheduled action.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
state
The state of the scheduled action.
- Parameters:
state
- The state of the scheduled action.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
Sets the value of the TargetAction property for this object. This is a convenience method that creates an instance of theTargetAction.Builder
avoiding the need to create one manually viaTargetAction.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totargetAction(TargetAction)
.- Parameters:
targetAction
- a consumer that will call methods onTargetAction.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-