class Aws::Redshift::Types::ScheduledAction
Describes a scheduled action. You can use a scheduled action to trigger some Amazon Redshift
API operations on a schedule. For information about which API operations can be scheduled, see ScheduledActionType
.
@!attribute [rw] scheduled_action_name
The name of the scheduled action. @return [String]
@!attribute [rw] target_action
A JSON format string of the Amazon Redshift API operation with input parameters. "`\{"ResizeCluster":\{"NodeType":"ds2.8xlarge","ClusterIdentifier":"my-test-cluster","NumberOfNodes":3\}\}`". @return [Types::ScheduledActionType]
@!attribute [rw] 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][1] in the *Amazon CloudWatch Events User Guide*. [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions @return [String]
@!attribute [rw] iam_role
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][1] in the *Amazon Redshift Cluster Management Guide*. [1]: https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html @return [String]
@!attribute [rw] scheduled_action_description
The description of the scheduled action. @return [String]
@!attribute [rw] state
The state of the scheduled action. For example, `DISABLED`. @return [String]
@!attribute [rw] next_invocations
List of times when the scheduled action will run. @return [Array<Time>]
@!attribute [rw] start_time
The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger. @return [Time]
@!attribute [rw] end_time
The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger. @return [Time]
@see docs.aws.amazon.com/goto/WebAPI/redshift-2012-12-01/ScheduledAction AWS API Documentation
Constants
- SENSITIVE