CfnScheduledAction

class aws_cdk.aws_redshift.CfnScheduledAction(scope, id, *, scheduled_action_name, enable=None, end_time=None, iam_role=None, schedule=None, scheduled_action_description=None, start_time=None, target_action=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::Redshift::ScheduledAction.

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

CloudformationResource

AWS::Redshift::ScheduledAction

Link

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_redshift as redshift

cfn_scheduled_action = redshift.CfnScheduledAction(self, "MyCfnScheduledAction",
    scheduled_action_name="scheduledActionName",

    # the properties below are optional
    enable=False,
    end_time="endTime",
    iam_role="iamRole",
    schedule="schedule",
    scheduled_action_description="scheduledActionDescription",
    start_time="startTime",
    target_action=redshift.CfnScheduledAction.ScheduledActionTypeProperty(
        pause_cluster=redshift.CfnScheduledAction.PauseClusterMessageProperty(
            cluster_identifier="clusterIdentifier"
        ),
        resize_cluster=redshift.CfnScheduledAction.ResizeClusterMessageProperty(
            cluster_identifier="clusterIdentifier",

            # the properties below are optional
            classic=False,
            cluster_type="clusterType",
            node_type="nodeType",
            number_of_nodes=123
        ),
        resume_cluster=redshift.CfnScheduledAction.ResumeClusterMessageProperty(
            cluster_identifier="clusterIdentifier"
        )
    )
)

Create a new AWS::Redshift::ScheduledAction.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • scheduled_action_name (str) – The name of the scheduled action.

  • enable (Union[bool, IResolvable, None]) – If true, the schedule is enabled. If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction .

  • end_time (Optional[str]) – The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

  • iam_role (Optional[str]) – 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 Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide .

  • schedule (Optional[str]) – The schedule for a one-time (at format) or recurring (cron format) scheduled action. 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 .

  • scheduled_action_description (Optional[str]) – The description of the scheduled action.

  • start_time (Optional[str]) – The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

  • target_action (Union[IResolvable, ScheduledActionTypeProperty, None]) – A JSON format string of the Amazon Redshift API operation with input parameters. ” {\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} “.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Redshift::ScheduledAction'
attr_next_invocations

List of times when the scheduled action will run.

CloudformationAttribute

NextInvocations

Return type

List[str]

attr_state

The state of the scheduled action.

For example, DISABLED .

CloudformationAttribute

State

Return type

str

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

enable

If true, the schedule is enabled.

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

Return type

Union[bool, IResolvable, None]

end_time

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

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

Return type

Optional[str]

iam_role

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

Return type

Optional[str]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

schedule

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

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

Return type

Optional[str]

scheduled_action_description

The description of the scheduled action.

Link

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

Return type

Optional[str]

scheduled_action_name

The name of the scheduled action.

Link

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

Return type

str

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

start_time

The start time in UTC when the schedule is active.

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

Return type

Optional[str]

target_action

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

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

Return type

Union[IResolvable, ScheduledActionTypeProperty, None]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

PauseClusterMessageProperty

class CfnScheduledAction.PauseClusterMessageProperty(*, cluster_identifier)

Bases: object

Describes a pause cluster operation.

For example, a scheduled action to run the PauseCluster API operation.

Parameters

cluster_identifier (str) – The identifier of the cluster to be paused.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-pauseclustermessage.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_redshift as redshift

pause_cluster_message_property = redshift.CfnScheduledAction.PauseClusterMessageProperty(
    cluster_identifier="clusterIdentifier"
)

Attributes

cluster_identifier

The identifier of the cluster to be paused.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-pauseclustermessage.html#cfn-redshift-scheduledaction-pauseclustermessage-clusteridentifier

Return type

str

ResizeClusterMessageProperty

class CfnScheduledAction.ResizeClusterMessageProperty(*, cluster_identifier, classic=None, cluster_type=None, node_type=None, number_of_nodes=None)

Bases: object

Describes a resize cluster operation.

For example, a scheduled action to run the ResizeCluster API operation.

Parameters
  • cluster_identifier (str) – The unique identifier for the cluster to resize.

  • classic (Union[bool, IResolvable, None]) – A boolean value indicating whether the resize operation is using the classic resize process. If you don’t provide this parameter or set the value to false , the resize type is elastic.

  • cluster_type (Optional[str]) – The new cluster type for the specified cluster.

  • node_type (Optional[str]) – The new node type for the nodes you are adding. If not specified, the cluster’s current node type is used.

  • number_of_nodes (Union[int, float, None]) – The new number of nodes for the cluster. If not specified, the cluster’s current number of nodes is used.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-resizeclustermessage.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_redshift as redshift

resize_cluster_message_property = redshift.CfnScheduledAction.ResizeClusterMessageProperty(
    cluster_identifier="clusterIdentifier",

    # the properties below are optional
    classic=False,
    cluster_type="clusterType",
    node_type="nodeType",
    number_of_nodes=123
)

Attributes

classic

A boolean value indicating whether the resize operation is using the classic resize process.

If you don’t provide this parameter or set the value to false , the resize type is elastic.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-resizeclustermessage.html#cfn-redshift-scheduledaction-resizeclustermessage-classic

Return type

Union[bool, IResolvable, None]

cluster_identifier

The unique identifier for the cluster to resize.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-resizeclustermessage.html#cfn-redshift-scheduledaction-resizeclustermessage-clusteridentifier

Return type

str

cluster_type

The new cluster type for the specified cluster.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-resizeclustermessage.html#cfn-redshift-scheduledaction-resizeclustermessage-clustertype

Return type

Optional[str]

node_type

The new node type for the nodes you are adding.

If not specified, the cluster’s current node type is used.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-resizeclustermessage.html#cfn-redshift-scheduledaction-resizeclustermessage-nodetype

Return type

Optional[str]

number_of_nodes

The new number of nodes for the cluster.

If not specified, the cluster’s current number of nodes is used.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-resizeclustermessage.html#cfn-redshift-scheduledaction-resizeclustermessage-numberofnodes

Return type

Union[int, float, None]

ResumeClusterMessageProperty

class CfnScheduledAction.ResumeClusterMessageProperty(*, cluster_identifier)

Bases: object

Describes a resume cluster operation.

For example, a scheduled action to run the ResumeCluster API operation.

Parameters

cluster_identifier (str) – The identifier of the cluster to be resumed.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-resumeclustermessage.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_redshift as redshift

resume_cluster_message_property = redshift.CfnScheduledAction.ResumeClusterMessageProperty(
    cluster_identifier="clusterIdentifier"
)

Attributes

cluster_identifier

The identifier of the cluster to be resumed.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-resumeclustermessage.html#cfn-redshift-scheduledaction-resumeclustermessage-clusteridentifier

Return type

str

ScheduledActionTypeProperty

class CfnScheduledAction.ScheduledActionTypeProperty(*, pause_cluster=None, resize_cluster=None, resume_cluster=None)

Bases: object

The action type that specifies an Amazon Redshift API operation that is supported by the Amazon Redshift scheduler.

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-scheduledactiontype.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_redshift as redshift

scheduled_action_type_property = redshift.CfnScheduledAction.ScheduledActionTypeProperty(
    pause_cluster=redshift.CfnScheduledAction.PauseClusterMessageProperty(
        cluster_identifier="clusterIdentifier"
    ),
    resize_cluster=redshift.CfnScheduledAction.ResizeClusterMessageProperty(
        cluster_identifier="clusterIdentifier",

        # the properties below are optional
        classic=False,
        cluster_type="clusterType",
        node_type="nodeType",
        number_of_nodes=123
    ),
    resume_cluster=redshift.CfnScheduledAction.ResumeClusterMessageProperty(
        cluster_identifier="clusterIdentifier"
    )
)

Attributes

pause_cluster

An action that runs a PauseCluster API operation.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-scheduledactiontype.html#cfn-redshift-scheduledaction-scheduledactiontype-pausecluster

Return type

Union[IResolvable, PauseClusterMessageProperty, None]

resize_cluster

An action that runs a ResizeCluster API operation.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-scheduledactiontype.html#cfn-redshift-scheduledaction-scheduledactiontype-resizecluster

Return type

Union[IResolvable, ResizeClusterMessageProperty, None]

resume_cluster

An action that runs a ResumeCluster API operation.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-redshift-scheduledaction-scheduledactiontype.html#cfn-redshift-scheduledaction-scheduledactiontype-resumecluster

Return type

Union[IResolvable, ResumeClusterMessageProperty, None]