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

Class CreateScheduledActionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.redshiftserverless.model.RedshiftServerlessRequest

software.amazon.awssdk.services.redshiftserverless.model.CreateScheduledActionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateScheduledActionRequest.Builder,CreateScheduledActionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateScheduledActionRequest
extends RedshiftServerlessRequest
implements ToCopyableBuilder<CreateScheduledActionRequest.Builder,CreateScheduledActionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateScheduledActionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateScheduledActionRequest.Builder	builder()
Boolean	enabled()	Indicates whether the schedule is enabled.
Instant	endTime()	The end time in UTC when the schedule is no longer active.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	namespaceName()	The name of the namespace for which to create a scheduled action.
String	roleArn()	The ARN of the IAM role to assume to run the scheduled action.
Schedule	schedule()	The schedule for a one-time (at format) or recurring (cron format) scheduled action.
String	scheduledActionDescription()	The description of the scheduled action.
String	scheduledActionName()	The name of the scheduled action.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateScheduledActionRequest.Builder>	serializableBuilderClass()
Instant	startTime()	The start time in UTC when the schedule is active.
TargetAction	targetAction()	Returns the value of the TargetAction property for this object.
CreateScheduledActionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

enabled

public final 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.

Returns:

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.

endTime

public final Instant endTime()

The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

Returns:

The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

namespaceName

public final String namespaceName()

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

Returns:

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

roleArn

public final 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

Returns:

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

schedule

public final 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.

Returns:

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.

scheduledActionDescription

public final String scheduledActionDescription()

The description of the scheduled action.

Returns:

The description of the scheduled action.

scheduledActionName

public final String scheduledActionName()

The name of the scheduled action.

Returns:

The name of the scheduled action.

startTime

public final Instant startTime()

The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

Returns:

The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

targetAction

public final TargetAction targetAction()

Returns the value of the TargetAction property for this object.

Returns:

The value of the TargetAction property for this object.

toBuilder

public CreateScheduledActionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateScheduledActionRequest.Builder,CreateScheduledActionRequest>

Specified by:

toBuilder in class RedshiftServerlessRequest

builder

public static CreateScheduledActionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateScheduledActionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo