AWS::Redshift::ScheduledAction
Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action.
For example, you can create a schedule of when to run the ResizeCluster
API operation.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Redshift::ScheduledAction", "Properties" : { "Enable" :
Boolean
, "EndTime" :String
, "IamRole" :String
, "Schedule" :String
, "ScheduledActionDescription" :String
, "ScheduledActionName" :String
, "StartTime" :String
, "TargetAction" :ScheduledActionType
} }
YAML
Type: AWS::Redshift::ScheduledAction Properties: Enable:
Boolean
EndTime:String
IamRole:String
Schedule:String
ScheduledActionDescription:String
ScheduledActionName:String
StartTime:String
TargetAction:ScheduledActionType
Properties
Enable
-
If true, the schedule is enabled. If false, the scheduled action does not trigger. For more information about
state
of the scheduled action, see AWS::Redshift::ScheduledAction.Required: No
Type: Boolean
Update requires: No interruption
EndTime
-
The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
Required: No
Type: String
Update requires: No interruption
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.
Required: No
Type: String
Maximum:
2147483647
Update requires: No interruption
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.Required: No
Type: String
Maximum:
2147483647
Update requires: No interruption
ScheduledActionDescription
-
The description of the scheduled action.
Required: No
Type: String
Maximum:
2147483647
Update requires: No interruption
ScheduledActionName
-
The name of the scheduled action.
Required: Yes
Type: String
Maximum:
2147483647
Update requires: Replacement
StartTime
-
The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
Required: No
Type: String
Update requires: No interruption
TargetAction
-
A JSON format string of the Amazon Redshift API operation with input parameters.
"
{\"ResizeCluster\":{\"NodeType\":\"ra3.4xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}
".Required: No
Type: ScheduledActionType
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the resource name. For example:
{ "Ref": "myScheduledActionName" }
For the Amazon Redshift
ScheduledActionName
, Ref returns the name of the scheduled action.
For more information about using the Ref
function, see Ref
.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt
.
NextInvocations
-
List of times when the scheduled action will run.
State
-
The state of the scheduled action. For example,
DISABLED
.