CfnScheduledActionPropsMixin

class aws_cdk.mixins_preview.aws_redshift.mixins.CfnScheduledActionPropsMixin(props, *, strategy=None)

Bases: Mixin

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-scheduledaction.html
CloudformationResource:: AWS::Redshift::ScheduledAction
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_scheduled_action_props_mixin = redshift_mixins.CfnScheduledActionPropsMixin(redshift_mixins.CfnScheduledActionMixinProps(
    enable=False,
    end_time="endTime",
    iam_role="iamRole",
    schedule="schedule",
    scheduled_action_description="scheduledActionDescription",
    scheduled_action_name="scheduledActionName",
    start_time="startTime",
    target_action=redshift_mixins.CfnScheduledActionPropsMixin.ScheduledActionTypeProperty(
        pause_cluster=redshift_mixins.CfnScheduledActionPropsMixin.PauseClusterMessageProperty(
            cluster_identifier="clusterIdentifier"
        ),
        resize_cluster=redshift_mixins.CfnScheduledActionPropsMixin.ResizeClusterMessageProperty(
            classic=False,
            cluster_identifier="clusterIdentifier",
            cluster_type="clusterType",
            node_type="nodeType",
            number_of_nodes=123
        ),
        resume_cluster=redshift_mixins.CfnScheduledActionPropsMixin.ResumeClusterMessageProperty(
            cluster_identifier="clusterIdentifier"
        )
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Redshift::ScheduledAction.

Parameters:

props (Union[CfnScheduledActionMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['enable', 'endTime', 'iamRole', 'schedule', 'scheduledActionDescription', 'scheduledActionName', 'startTime', 'targetAction']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

PauseClusterMessageProperty

class CfnScheduledActionPropsMixin.PauseClusterMessageProperty(*, cluster_identifier=None)

Bases: object

Describes a pause cluster operation.

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

Parameters:: cluster_identifier (Optional[str]) – The identifier of the cluster to be paused.
See:: 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.
from aws_cdk.mixins_preview.aws_redshift import mixins as redshift_mixins

pause_cluster_message_property = redshift_mixins.CfnScheduledActionPropsMixin.PauseClusterMessageProperty(
    cluster_identifier="clusterIdentifier"
)

Attributes

cluster_identifier

The identifier of the cluster to be paused.

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

ResizeClusterMessageProperty

class CfnScheduledActionPropsMixin.ResizeClusterMessageProperty(*, classic=None, cluster_identifier=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:

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_identifier (Optional[str]) – The unique identifier for the cluster to resize.
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.

See:

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.
from aws_cdk.mixins_preview.aws_redshift import mixins as redshift_mixins

resize_cluster_message_property = redshift_mixins.CfnScheduledActionPropsMixin.ResizeClusterMessageProperty(
    classic=False,
    cluster_identifier="clusterIdentifier",
    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.

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

cluster_identifier

The unique identifier for the cluster to resize.

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

cluster_type

The new cluster type for the specified cluster.

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

node_type

The new node type for the nodes you are adding.

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

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

number_of_nodes

The new number of nodes for the cluster.

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

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

ResumeClusterMessageProperty

class CfnScheduledActionPropsMixin.ResumeClusterMessageProperty(*, cluster_identifier=None)

Bases: object

Describes a resume cluster operation.

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

Parameters:: cluster_identifier (Optional[str]) – The identifier of the cluster to be resumed.
See:: 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.
from aws_cdk.mixins_preview.aws_redshift import mixins as redshift_mixins

resume_cluster_message_property = redshift_mixins.CfnScheduledActionPropsMixin.ResumeClusterMessageProperty(
    cluster_identifier="clusterIdentifier"
)

Attributes

cluster_identifier

The identifier of the cluster to be resumed.

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

ScheduledActionTypeProperty

class CfnScheduledActionPropsMixin.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:

pause_cluster (Union[IResolvable, PauseClusterMessageProperty, Dict[str, Any], None]) – An action that runs a PauseCluster API operation.
resize_cluster (Union[IResolvable, ResizeClusterMessageProperty, Dict[str, Any], None]) – An action that runs a ResizeCluster API operation.
resume_cluster (Union[IResolvable, ResumeClusterMessageProperty, Dict[str, Any], None]) – An action that runs a ResumeCluster API operation.

See:

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.
from aws_cdk.mixins_preview.aws_redshift import mixins as redshift_mixins

scheduled_action_type_property = redshift_mixins.CfnScheduledActionPropsMixin.ScheduledActionTypeProperty(
    pause_cluster=redshift_mixins.CfnScheduledActionPropsMixin.PauseClusterMessageProperty(
        cluster_identifier="clusterIdentifier"
    ),
    resize_cluster=redshift_mixins.CfnScheduledActionPropsMixin.ResizeClusterMessageProperty(
        classic=False,
        cluster_identifier="clusterIdentifier",
        cluster_type="clusterType",
        node_type="nodeType",
        number_of_nodes=123
    ),
    resume_cluster=redshift_mixins.CfnScheduledActionPropsMixin.ResumeClusterMessageProperty(
        cluster_identifier="clusterIdentifier"
    )
)

Attributes

pause_cluster

An action that runs a PauseCluster API operation.

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

resize_cluster

An action that runs a ResizeCluster API operation.

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

resume_cluster

An action that runs a ResumeCluster API operation.

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