Class CfnScheduledActionMixinProps

Properties for CfnScheduledActionPropsMixin.

Inheritance

object

CfnScheduledActionMixinProps

Implements

ICfnScheduledActionMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Redshift

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnScheduledActionMixinProps : ICfnScheduledActionMixinProps

Syntax (vb)

Public Class CfnScheduledActionMixinProps Implements ICfnScheduledActionMixinProps

Remarks

See: 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.CfnPropertyMixins.AWS.Redshift;

             var cfnScheduledActionMixinProps = new CfnScheduledActionMixinProps {
                 Enable = false,
                 EndTime = "endTime",
                 IamRole = "iamRole",
                 Schedule = "schedule",
                 ScheduledActionDescription = "scheduledActionDescription",
                 ScheduledActionName = "scheduledActionName",
                 StartTime = "startTime",
                 TargetAction = new ScheduledActionTypeProperty {
                     PauseCluster = new PauseClusterMessageProperty {
                         ClusterIdentifier = "clusterIdentifier"
                     },
                     ResizeCluster = new ResizeClusterMessageProperty {
                         Classic = false,
                         ClusterIdentifier = "clusterIdentifier",
                         ClusterType = "clusterType",
                         NodeType = "nodeType",
                         NumberOfNodes = 123
                     },
                     ResumeCluster = new ResumeClusterMessageProperty {
                         ClusterIdentifier = "clusterIdentifier"
                     }
                 }
             };

Synopsis

Constructors

CfnScheduledActionMixinProps()

Properties for CfnScheduledActionPropsMixin.

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.

Constructors

CfnScheduledActionMixinProps()

Properties for CfnScheduledActionPropsMixin.

public CfnScheduledActionMixinProps()

Remarks

See: 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.CfnPropertyMixins.AWS.Redshift;

             var cfnScheduledActionMixinProps = new CfnScheduledActionMixinProps {
                 Enable = false,
                 EndTime = "endTime",
                 IamRole = "iamRole",
                 Schedule = "schedule",
                 ScheduledActionDescription = "scheduledActionDescription",
                 ScheduledActionName = "scheduledActionName",
                 StartTime = "startTime",
                 TargetAction = new ScheduledActionTypeProperty {
                     PauseCluster = new PauseClusterMessageProperty {
                         ClusterIdentifier = "clusterIdentifier"
                     },
                     ResizeCluster = new ResizeClusterMessageProperty {
                         Classic = false,
                         ClusterIdentifier = "clusterIdentifier",
                         ClusterType = "clusterType",
                         NodeType = "nodeType",
                         NumberOfNodes = 123
                     },
                     ResumeCluster = new ResumeClusterMessageProperty {
                         ClusterIdentifier = "clusterIdentifier"
                     }
                 }
             };

Properties

Enable

If true, the schedule is enabled.

public object? Enable { get; set; }

Property Value

object

Remarks

If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction .

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

Type union: either bool or IResolvable

EndTime

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

public string? EndTime { get; set; }

Property Value

string

Remarks

After this time, the scheduled action does not trigger.

See: 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.

public string? IamRole { get; set; }

Property Value

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 .

See: 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.

public string? Schedule { get; set; }

Property Value

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 .

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

ScheduledActionDescription

The description of the scheduled action.

public string? ScheduledActionDescription { get; set; }

Property Value

string

Remarks

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

ScheduledActionName

The name of the scheduled action.

public string? ScheduledActionName { get; set; }

Property Value

string

Remarks

See: 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.

public string? StartTime { get; set; }

Property Value

string

Remarks

Before this time, the scheduled action does not trigger.

See: 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.

public object? TargetAction { get; set; }

Property Value

object

Remarks

" {"ResizeCluster":{"NodeType":"ra3.4xlarge","ClusterIdentifier":"my-test-cluster","NumberOfNodes":3}} ".

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

Type union: either IResolvable or CfnScheduledActionPropsMixin.IScheduledActionTypeProperty

Implements

ICfnScheduledActionMixinProps