CfnScheduledActionProps

class aws_cdk.aws_redshift.CfnScheduledActionProps(*, scheduled_action_name, enable=None, end_time=None, iam_role=None, schedule=None, scheduled_action_description=None, start_time=None, target_action=None)

Bases: object

Properties for defining a CfnScheduledAction.

Parameters
  • scheduled_action_name (str) – The name of the scheduled action.

  • enable (Union[bool, IResolvable, None]) – If true, the schedule is enabled. If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction .

  • end_time (Optional[str]) – The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

  • iam_role (Optional[str]) – 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 .

  • schedule (Optional[str]) – 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 .

  • scheduled_action_description (Optional[str]) – The description of the scheduled action.

  • start_time (Optional[str]) – The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

  • target_action (Union[IResolvable, ScheduledActionTypeProperty, None]) – A JSON format string of the Amazon Redshift API operation with input parameters. ” {\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} “.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_redshift as redshift

cfn_scheduled_action_props = redshift.CfnScheduledActionProps(
    scheduled_action_name="scheduledActionName",

    # the properties below are optional
    enable=False,
    end_time="endTime",
    iam_role="iamRole",
    schedule="schedule",
    scheduled_action_description="scheduledActionDescription",
    start_time="startTime",
    target_action=redshift.CfnScheduledAction.ScheduledActionTypeProperty(
        pause_cluster=redshift.CfnScheduledAction.PauseClusterMessageProperty(
            cluster_identifier="clusterIdentifier"
        ),
        resize_cluster=redshift.CfnScheduledAction.ResizeClusterMessageProperty(
            cluster_identifier="clusterIdentifier",

            # the properties below are optional
            classic=False,
            cluster_type="clusterType",
            node_type="nodeType",
            number_of_nodes=123
        ),
        resume_cluster=redshift.CfnScheduledAction.ResumeClusterMessageProperty(
            cluster_identifier="clusterIdentifier"
        )
    )
)

Attributes

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 ScheduledAction .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-enable

Return type

Union[bool, IResolvable, None]

end_time

The end time in UTC when the schedule is no longer active.

After this time, the scheduled action does not trigger.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-endtime

Return type

Optional[str]

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 in the Amazon Redshift Cluster Management Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-iamrole

Return type

Optional[str]

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-schedule

Return type

Optional[str]

scheduled_action_description

The description of the scheduled action.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-scheduledactiondescription

Return type

Optional[str]

scheduled_action_name

The name of the scheduled action.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-scheduledactionname

Return type

str

start_time

The start time in UTC when the schedule is active.

Before this time, the scheduled action does not trigger.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-starttime

Return type

Optional[str]

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}} “.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html#cfn-redshift-scheduledaction-targetaction

Return type

Union[IResolvable, ScheduledActionTypeProperty, None]