CfnPlan

class aws_cdk.aws_ssmcontacts.CfnPlan(scope, id, *, contact_id, rotation_ids=None, stages=None)

Bases: CfnResource

A CloudFormation AWS::SSMContacts::Plan.

Information about the stages and on-call rotation teams associated with an escalation plan or engagement plan.

CloudformationResource:: AWS::SSMContacts::Plan
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-plan.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_ssmcontacts as ssmcontacts

cfn_plan = ssmcontacts.CfnPlan(self, "MyCfnPlan",
    contact_id="contactId",

    # the properties below are optional
    rotation_ids=["rotationIds"],
    stages=[ssmcontacts.CfnPlan.StageProperty(
        duration_in_minutes=123,

        # the properties below are optional
        targets=[ssmcontacts.CfnPlan.TargetsProperty(
            channel_target_info=ssmcontacts.CfnPlan.ChannelTargetInfoProperty(
                channel_id="channelId",
                retry_interval_in_minutes=123
            ),
            contact_target_info=ssmcontacts.CfnPlan.ContactTargetInfoProperty(
                contact_id="contactId",
                is_essential=False
            )
        )]
    )]
)

Create a new AWS::SSMContacts::Plan.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
contact_id (str) – The Amazon Resource Name (ARN) of the contact.
rotation_ids (Optional[Sequence[str]]) – The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan.
stages (Union[IResolvable, Sequence[Union[IResolvable, StageProperty, Dict[str, Any]]], None]) – A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.

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:

Return type:

None

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.

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:

Return type:

Any

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.

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::SSMContacts::Plan'

attr_arn

The Amazon Resource Name (ARN) of the Plan resource.

CloudformationAttribute:: Arn

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

cfn_resource_type: AWS resource type.

contact_id

The Amazon Resource Name (ARN) of the contact.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-plan.html#cfn-ssmcontacts-plan-contactid

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.

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

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.

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 }).

rotation_ids

The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-plan.html#cfn-ssmcontacts-plan-rotationids

stack

The stack in which this element is defined.

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

stages

A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-plan.html#cfn-ssmcontacts-plan-stages

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

ChannelTargetInfoProperty

class CfnPlan.ChannelTargetInfoProperty(*, channel_id, retry_interval_in_minutes)

Bases: object

Information about the contact channel that Incident Manager uses to engage the contact.

Parameters:

channel_id (str) – The Amazon Resource Name (ARN) of the contact channel.
retry_interval_in_minutes (Union[int, float]) – The number of minutes to wait before retrying to send engagement if the engagement initially failed.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-channeltargetinfo.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_ssmcontacts as ssmcontacts

channel_target_info_property = ssmcontacts.CfnPlan.ChannelTargetInfoProperty(
    channel_id="channelId",
    retry_interval_in_minutes=123
)

Attributes

channel_id

The Amazon Resource Name (ARN) of the contact channel.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-channeltargetinfo.html#cfn-ssmcontacts-plan-channeltargetinfo-channelid

retry_interval_in_minutes

The number of minutes to wait before retrying to send engagement if the engagement initially failed.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-channeltargetinfo.html#cfn-ssmcontacts-plan-channeltargetinfo-retryintervalinminutes

ContactTargetInfoProperty

class CfnPlan.ContactTargetInfoProperty(*, contact_id, is_essential)

Bases: object

The contact that Incident Manager is engaging during an incident.

Parameters:

contact_id (str) – The Amazon Resource Name (ARN) of the contact.
is_essential (Union[bool, IResolvable]) – A Boolean value determining if the contact’s acknowledgement stops the progress of stages in the plan.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-contacttargetinfo.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_ssmcontacts as ssmcontacts

contact_target_info_property = ssmcontacts.CfnPlan.ContactTargetInfoProperty(
    contact_id="contactId",
    is_essential=False
)

Attributes

contact_id

The Amazon Resource Name (ARN) of the contact.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-contacttargetinfo.html#cfn-ssmcontacts-plan-contacttargetinfo-contactid

is_essential

A Boolean value determining if the contact’s acknowledgement stops the progress of stages in the plan.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-contacttargetinfo.html#cfn-ssmcontacts-plan-contacttargetinfo-isessential

StageProperty

class CfnPlan.StageProperty(*, duration_in_minutes, targets=None)

Bases: object

A set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.

Parameters:

duration_in_minutes (Union[int, float]) – The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.
targets (Union[IResolvable, Sequence[Union[IResolvable, TargetsProperty, Dict[str, Any]]], None]) – The contacts or contact methods that the escalation plan or engagement plan is engaging.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-stage.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_ssmcontacts as ssmcontacts

stage_property = ssmcontacts.CfnPlan.StageProperty(
    duration_in_minutes=123,

    # the properties below are optional
    targets=[ssmcontacts.CfnPlan.TargetsProperty(
        channel_target_info=ssmcontacts.CfnPlan.ChannelTargetInfoProperty(
            channel_id="channelId",
            retry_interval_in_minutes=123
        ),
        contact_target_info=ssmcontacts.CfnPlan.ContactTargetInfoProperty(
            contact_id="contactId",
            is_essential=False
        )
    )]
)

Attributes

duration_in_minutes

The time to wait until beginning the next stage.

The duration can only be set to 0 if a target is specified.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-stage.html#cfn-ssmcontacts-plan-stage-durationinminutes

targets

The contacts or contact methods that the escalation plan or engagement plan is engaging.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-stage.html#cfn-ssmcontacts-plan-stage-targets

TargetsProperty

class CfnPlan.TargetsProperty(*, channel_target_info=None, contact_target_info=None)

Bases: object

The contact or contact channel that’s being engaged.

Parameters:

channel_target_info (Union[IResolvable, ChannelTargetInfoProperty, Dict[str, Any], None]) – Information about the contact channel that Incident Manager engages.
contact_target_info (Union[IResolvable, ContactTargetInfoProperty, Dict[str, Any], None]) – Information about the contact that Incident Manager engages.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-targets.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_ssmcontacts as ssmcontacts

targets_property = ssmcontacts.CfnPlan.TargetsProperty(
    channel_target_info=ssmcontacts.CfnPlan.ChannelTargetInfoProperty(
        channel_id="channelId",
        retry_interval_in_minutes=123
    ),
    contact_target_info=ssmcontacts.CfnPlan.ContactTargetInfoProperty(
        contact_id="contactId",
        is_essential=False
    )
)

Attributes

channel_target_info

Information about the contact channel that Incident Manager engages.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-targets.html#cfn-ssmcontacts-plan-targets-channeltargetinfo

contact_target_info

Information about the contact that Incident Manager engages.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-plan-targets.html#cfn-ssmcontacts-plan-targets-contacttargetinfo