Interface ICfnScheduledActionProps

Properties for defining a CfnScheduledAction.

Namespace: Amazon.CDK.AWS.Redshift

Assembly: Amazon.CDK.AWS.Redshift.dll

Syntax (csharp)

public interface ICfnScheduledActionProps

Syntax (vb)

Public Interface ICfnScheduledActionProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Redshift;

CfnScheduledActionProps cfnScheduledActionProps = new CfnScheduledActionProps {
    ScheduledActionName = "scheduledActionName",

    // the properties below are optional
    Enable = false,
    EndTime = "endTime",
    IamRole = "iamRole",
    Schedule = "schedule",
    ScheduledActionDescription = "scheduledActionDescription",
    StartTime = "startTime",
    TargetAction = new ScheduledActionTypeProperty {
        PauseCluster = new PauseClusterMessageProperty {
            ClusterIdentifier = "clusterIdentifier"
        },
        ResizeCluster = new ResizeClusterMessageProperty {
            ClusterIdentifier = "clusterIdentifier",

            // the properties below are optional
            Classic = false,
            ClusterType = "clusterType",
            NodeType = "nodeType",
            NumberOfNodes = 123
        },
        ResumeCluster = new ResumeClusterMessageProperty {
            ClusterIdentifier = "clusterIdentifier"
        }
    }
};

Synopsis

Properties

Enable	If true, the schedule is enabled.
EndTime	The end time in UTC when the schedule is no longer active.
IamRole	The IAM role to assume to run the scheduled action.
Schedule	The schedule for a one-time (at format) or recurring (cron format) scheduled action.
ScheduledActionDescription	The description of the scheduled action.
ScheduledActionName	The name of the scheduled action.
StartTime	The start time in UTC when the schedule is active.
TargetAction	A JSON format string of the Amazon Redshift API operation with input parameters.

Properties

Enable

If true, the schedule is enabled.

virtual object Enable { get; }

Property Value

System.Object

Remarks

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

EndTime

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

virtual string EndTime { get; }

Property Value

System.String

Remarks

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

IamRole

The IAM role to assume to run the scheduled action.

virtual string IamRole { get; }

Property Value

System.String

Remarks

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

Schedule

The schedule for a one-time (at format) or recurring (cron format) scheduled action.

virtual string Schedule { get; }

Property Value

System.String

Remarks

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

ScheduledActionDescription

The description of the scheduled action.

virtual string ScheduledActionDescription { get; }

Property Value

System.String

Remarks

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

ScheduledActionName

The name of the scheduled action.

string ScheduledActionName { get; }

Property Value

System.String

Remarks

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

StartTime

The start time in UTC when the schedule is active.

virtual string StartTime { get; }

Property Value

System.String

Remarks

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

TargetAction

A JSON format string of the Amazon Redshift API operation with input parameters.

virtual object TargetAction { get; }

Property Value

System.Object

Remarks

" {"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