com.amazonaws.services.redshiftserverless.model

Class CreateScheduledActionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.redshiftserverless.model.CreateScheduledActionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateScheduledActionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateScheduledActionRequest()

Method Summary

Modifier and Type	Method and Description
CreateScheduledActionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getEnabled() Indicates whether the schedule is enabled.
Date	getEndTime() The end time in UTC when the schedule is no longer active.
String	getNamespaceName() The name of the namespace for which to create a scheduled action.
String	getRoleArn() The ARN of the IAM role to assume to run the scheduled action.
Schedule	getSchedule() The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action.
String	getScheduledActionDescription() The description of the scheduled action.
String	getScheduledActionName() The name of the scheduled action.
Date	getStartTime() The start time in UTC when the schedule is active.
TargetAction	getTargetAction()
int	hashCode()
Boolean	isEnabled() Indicates whether the schedule is enabled.
void	setEnabled(Boolean enabled) Indicates whether the schedule is enabled.
void	setEndTime(Date endTime) The end time in UTC when the schedule is no longer active.
void	setNamespaceName(String namespaceName) The name of the namespace for which to create a scheduled action.
void	setRoleArn(String roleArn) The ARN of the IAM role to assume to run the scheduled action.
void	setSchedule(Schedule schedule) The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action.
void	setScheduledActionDescription(String scheduledActionDescription) The description of the scheduled action.
void	setScheduledActionName(String scheduledActionName) The name of the scheduled action.
void	setStartTime(Date startTime) The start time in UTC when the schedule is active.
void	setTargetAction(TargetAction targetAction)
String	toString() Returns a string representation of this object.
CreateScheduledActionRequest	withEnabled(Boolean enabled) Indicates whether the schedule is enabled.
CreateScheduledActionRequest	withEndTime(Date endTime) The end time in UTC when the schedule is no longer active.
CreateScheduledActionRequest	withNamespaceName(String namespaceName) The name of the namespace for which to create a scheduled action.
CreateScheduledActionRequest	withRoleArn(String roleArn) The ARN of the IAM role to assume to run the scheduled action.
CreateScheduledActionRequest	withSchedule(Schedule schedule) The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action.
CreateScheduledActionRequest	withScheduledActionDescription(String scheduledActionDescription) The description of the scheduled action.
CreateScheduledActionRequest	withScheduledActionName(String scheduledActionName) The name of the scheduled action.
CreateScheduledActionRequest	withStartTime(Date startTime) The start time in UTC when the schedule is active.
CreateScheduledActionRequest	withTargetAction(TargetAction targetAction)

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateScheduledActionRequest

public CreateScheduledActionRequest()

Method Detail

setEnabled

public void setEnabled(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.

Parameters:

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.

getEnabled

public Boolean getEnabled()

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.

withEnabled

public CreateScheduledActionRequest withEnabled(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.

Parameters:

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:

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

isEnabled

public Boolean isEnabled()

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.

setEndTime

public void setEndTime(Date 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.

getEndTime

public Date getEndTime()

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.

withEndTime

public CreateScheduledActionRequest withEndTime(Date 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.

setNamespaceName

public void setNamespaceName(String namespaceName)

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

Parameters:

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

getNamespaceName

public String getNamespaceName()

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.

withNamespaceName

public CreateScheduledActionRequest withNamespaceName(String namespaceName)

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

Parameters:

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

Returns:

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

setRoleArn

public void setRoleArn(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 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

getRoleArn

public String getRoleArn()

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:

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

withRoleArn

public CreateScheduledActionRequest withRoleArn(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 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.

setSchedule

public void setSchedule(Schedule 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.

getSchedule

public Schedule getSchedule()

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:

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.

withSchedule

public CreateScheduledActionRequest withSchedule(Schedule 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.

setScheduledActionDescription

public void setScheduledActionDescription(String scheduledActionDescription)

The description of the scheduled action.

Parameters:

scheduledActionDescription - The description of the scheduled action.

getScheduledActionDescription

public String getScheduledActionDescription()

The description of the scheduled action.

Returns:

The description of the scheduled action.

withScheduledActionDescription

public CreateScheduledActionRequest withScheduledActionDescription(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.

setScheduledActionName

public void setScheduledActionName(String scheduledActionName)

The name of the scheduled action.

Parameters:

scheduledActionName - The name of the scheduled action.

getScheduledActionName

public String getScheduledActionName()

The name of the scheduled action.

Returns:

The name of the scheduled action.

withScheduledActionName

public CreateScheduledActionRequest withScheduledActionName(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.

setStartTime

public void setStartTime(Date 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.

getStartTime

public Date getStartTime()

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.

withStartTime

public CreateScheduledActionRequest withStartTime(Date 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.

setTargetAction

public void setTargetAction(TargetAction targetAction)

Parameters:

targetAction -

getTargetAction

public TargetAction getTargetAction()

Returns:

withTargetAction

public CreateScheduledActionRequest withTargetAction(TargetAction targetAction)

Parameters:

targetAction -

Returns:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateScheduledActionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()