Class CfnScheduledAction

Creates a scheduled action.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnScheduledAction

Implements

IInspectable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

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(Construct, string, ICfnScheduledActionProps)

Creates a scheduled action.

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	Creates a scheduled action.
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>)	Creates a scheduled action.

Constructors

CfnScheduledAction(Construct, string, ICfnScheduledActionProps)

Creates a scheduled action.

public CfnScheduledAction(Construct scope, string id, ICfnScheduledActionProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

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

props ICfnScheduledActionProps

Resource properties.

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

Properties

AttrNextInvocations

List of times when the scheduled action will run.

public virtual string[] AttrNextInvocations { get; }

Property Value

string[]

Remarks

CloudformationAttribute: NextInvocations

AttrState

The state of the scheduled action.

public virtual string AttrState { get; }

Property Value

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

string

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

CfnProperties

Creates a scheduled action.

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

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

Enable

If true, the schedule is enabled.

public virtual object? Enable { get; set; }

Property Value

object

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

EndTime

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

public virtual string? EndTime { get; set; }

Property Value

string

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

IamRole

The IAM role to assume to run the scheduled action.

public virtual string? IamRole { get; set; }

Property Value

string

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

Schedule

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

public virtual string? Schedule { get; set; }

Property Value

string

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

ScheduledActionDescription

The description of the scheduled action.

public virtual string? ScheduledActionDescription { get; set; }

Property Value

string

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

ScheduledActionName

The name of the scheduled action.

public virtual string ScheduledActionName { get; set; }

Property Value

string

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

StartTime

The start time in UTC when the schedule is active.

public virtual string? StartTime { get; set; }

Property Value

string

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

TargetAction

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

public virtual object? TargetAction { get; set; }

Property Value

object

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

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.

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

RenderProperties(IDictionary<string, object>)

Creates a scheduled action.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

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

Implements

IInspectable