Class CfnScheduledAction

Creates a scheduled action.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnScheduledAction
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Redshift
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnScheduledAction : CfnResource, IInspectable
Syntax (vb)
Public Class CfnScheduledAction
    Inherits CfnResource
    Implements IInspectable
Remarks

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.

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

CloudformationResource: AWS::Redshift::ScheduledAction

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;

var cfnScheduledAction = new CfnScheduledAction(this, "MyCfnScheduledAction", 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

Constructors

CfnScheduledAction(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnScheduledAction(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnScheduledAction(Construct, String, ICfnScheduledActionProps)

Properties

AttrNextInvocations

List of times when the scheduled action will run.
AttrState

The state of the scheduled action.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
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.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnScheduledAction(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnScheduledAction(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnScheduledAction(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnScheduledAction(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnScheduledAction(Construct, String, ICfnScheduledActionProps)

public CfnScheduledAction(Construct scope, string id, ICfnScheduledActionProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnScheduledActionProps

Resource properties.

Properties

AttrNextInvocations

List of times when the scheduled action will run.

public virtual string[] AttrNextInvocations { get; }
Property Value

System.String[]

Remarks

CloudformationAttribute: NextInvocations

AttrState

The state of the scheduled action.

public virtual string AttrState { get; }
Property Value

System.String

Remarks

For example, DISABLED .

CloudformationAttribute: State

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Enable

If true, the schedule is enabled.

public virtual object Enable { get; set; }
Property Value

System.Object

EndTime

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

public virtual string EndTime { get; set; }
Property Value

System.String

IamRole

The IAM role to assume to run the scheduled action.

public virtual string IamRole { get; set; }
Property Value

System.String

Schedule

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

public virtual string Schedule { get; set; }
Property Value

System.String

ScheduledActionDescription

The description of the scheduled action.

public virtual string ScheduledActionDescription { get; set; }
Property Value

System.String

ScheduledActionName

The name of the scheduled action.

public virtual string ScheduledActionName { get; set; }
Property Value

System.String

StartTime

The start time in UTC when the schedule is active.

public virtual string StartTime { get; set; }
Property Value

System.String

TargetAction

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

public virtual object TargetAction { get; set; }
Property Value

System.Object

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements