ScheduledAction ¶

class ScheduledAction(TypedDict, closed=True):
    scheduled_action_name: NotRequired["capo_redshift.types.string.String"]
    """<p>The name of the scheduled action. </p>"""
    target_action: NotRequired[
        "capo_redshift.types.scheduled_action_type.ScheduledActionType"
    ]
    r"""<p>A JSON format string of the Amazon Redshift API operation with input parameters. </p> <p>"<code>{\"ResizeCluster\":{\"NodeType\":\"ra3.4xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}</code>". </p>"""
    schedule: NotRequired["capo_redshift.types.string.String"]
    """<p>The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.</p> <p>Format of at expressions is "<code>at(yyyy-mm-ddThh:mm:ss)</code>". For example, "<code>at(2016-03-04T17:27:00)</code>".</p> <p>Format of cron expressions is "<code>cron(Minutes Hours Day-of-month Month Day-of-week Year)</code>". For example, "<code>cron(0 10 ? * MON *)</code>". For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions">Cron Expressions</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p>"""
    iam_role: NotRequired["capo_redshift.types.string.String"]
    """<p>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 <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html">Using Identity-Based Policies for Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </p>"""
    scheduled_action_description: NotRequired["capo_redshift.types.string.String"]
    """<p>The description of the scheduled action. </p>"""
    state: NotRequired[
        "capo_redshift.types.scheduled_action_state.ScheduledActionState"
    ]
    """<p>The state of the scheduled action. For example, <code>DISABLED</code>. </p>"""
    next_invocations: NotRequired[
        "capo_redshift.types.scheduled_action_time_list.ScheduledActionTimeList"
    ]
    """<p>List of times when the scheduled action will run. </p>"""
    start_time: NotRequired["capo_redshift.types.t_stamp.TStamp"]
    """<p>The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger. </p>"""
    end_time: NotRequired["capo_redshift.types.t_stamp.TStamp"]
    """<p>The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger. </p>"""