CfnContact
- class aws_cdk.aws_ssmcontacts.CfnContact(scope, id, *, alias, display_name, type, plan=None)
Bases:
CfnResourceA CloudFormation
AWS::SSMContacts::Contact.The
AWS::SSMContacts::Contactresource specifies a contact or escalation plan. Incident Manager contacts are a subset of actions and data types that you can use for managing responder engagement and interaction.- CloudformationResource:
AWS::SSMContacts::Contact
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.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_contact = ssmcontacts.CfnContact(self, "MyCfnContact", alias="alias", display_name="displayName", type="type", # the properties below are optional plan=[ssmcontacts.CfnContact.StageProperty( duration_in_minutes=123, rotation_ids=["rotationIds"], targets=[ssmcontacts.CfnContact.TargetsProperty( channel_target_info=ssmcontacts.CfnContact.ChannelTargetInfoProperty( channel_id="channelId", retry_interval_in_minutes=123 ), contact_target_info=ssmcontacts.CfnContact.ContactTargetInfoProperty( contact_id="contactId", is_essential=False ) )] )] )
Create a new
AWS::SSMContacts::Contact.- Parameters:
scope (
Construct) –scope in which this resource is defined.
id (
str) –scoped id of the resource.
alias (
str) – The unique and identifiable alias of the contact or escalation plan.display_name (
str) – The full name of the contact or escalation plan.type (
str) – Refers to the type of contact:. -PERSONAL: A single, individual contact. -ESCALATION: An escalation plan. -ONCALL_SCHEDULE: An on-call schedule.plan (
Union[IResolvable,Sequence[Union[StageProperty,Dict[str,Any],IResolvable]],None]) – A list of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.
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
addPropertyOverrideor prefixpathwith “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
valueargument toaddOverridewill 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: truedefault (
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:
- 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::Contact'
- alias
The unique and identifiable alias of the contact or escalation plan.
- attr_arn
The Amazon Resource Name (ARN) of the
Contactresource, such asarn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias.- CloudformationAttribute:
Arn
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- 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.
- display_name
The full name of the contact or escalation plan.
- 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.
- plan
A list of stages.
A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.
- 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 }).
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- type
.
PERSONAL: A single, individual contact.ESCALATION: An escalation plan.ONCALL_SCHEDULE: An on-call schedule.
- Link:
- Type:
Refers to the type of contact
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto 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 CfnContact.ChannelTargetInfoProperty(*, channel_id, retry_interval_in_minutes)
Bases:
objectInformation 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:
- 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.CfnContact.ChannelTargetInfoProperty( channel_id="channelId", retry_interval_in_minutes=123 )
Attributes
- channel_id
The Amazon Resource Name (ARN) of the contact channel.
- retry_interval_in_minutes
The number of minutes to wait before retrying to send engagement if the engagement initially failed.
ContactTargetInfoProperty
- class CfnContact.ContactTargetInfoProperty(*, contact_id, is_essential)
Bases:
objectThe 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:
- 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.CfnContact.ContactTargetInfoProperty( contact_id="contactId", is_essential=False )
Attributes
- contact_id
The Amazon Resource Name (ARN) of the contact.
- is_essential
A Boolean value determining if the contact’s acknowledgement stops the progress of stages in the plan.
StageProperty
- class CfnContact.StageProperty(*, duration_in_minutes=None, rotation_ids=None, targets=None)
Bases:
objectThe
Stageproperty type specifies 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,None]) – The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.rotation_ids (
Optional[Sequence[str]]) – The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan.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:
- 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.CfnContact.StageProperty( duration_in_minutes=123, rotation_ids=["rotationIds"], targets=[ssmcontacts.CfnContact.TargetsProperty( channel_target_info=ssmcontacts.CfnContact.ChannelTargetInfoProperty( channel_id="channelId", retry_interval_in_minutes=123 ), contact_target_info=ssmcontacts.CfnContact.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.
- rotation_ids
The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan.
- targets
The contacts or contact methods that the escalation plan or engagement plan is engaging.
TargetsProperty
- class CfnContact.TargetsProperty(*, channel_target_info=None, contact_target_info=None)
Bases:
objectThe 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]) – The contact that Incident Manager is engaging during an incident.
- Link:
- 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.CfnContact.TargetsProperty( channel_target_info=ssmcontacts.CfnContact.ChannelTargetInfoProperty( channel_id="channelId", retry_interval_in_minutes=123 ), contact_target_info=ssmcontacts.CfnContact.ContactTargetInfoProperty( contact_id="contactId", is_essential=False ) )
Attributes
- channel_target_info
Information about the contact channel that Incident Manager engages.
- contact_target_info
The contact that Incident Manager is engaging during an incident.