software.amazon.awscdk.services.ssmcontacts

Class CfnContact

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ssmcontacts.CfnContact

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.335Z")
 @Stability(value=Stable)
public class CfnContact
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SSMContacts::Contact`.

The AWS::SSMContacts::Contact resource 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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ssmcontacts.*;
 CfnContact cfnContact = CfnContact.Builder.create(this, "MyCfnContact")
         .alias("alias")
         .displayName("displayName")
         .plan(List.of(StageProperty.builder()
                 .durationInMinutes(123)
                 // the properties below are optional
                 .targets(List.of(TargetsProperty.builder()
                         .channelTargetInfo(ChannelTargetInfoProperty.builder()
                                 .channelId("channelId")
                                 .retryIntervalInMinutes(123)
                                 .build())
                         .contactTargetInfo(ContactTargetInfoProperty.builder()
                                 .contactId("contactId")
                                 .isEssential(false)
                                 .build())
                         .build()))
                 .build()))
         .type("type")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnContact.Builder A fluent builder for CfnContact.
static interface	CfnContact.ChannelTargetInfoProperty Information about the contact channel that Incident Manager uses to engage the contact.
static interface	CfnContact.ContactTargetInfoProperty The contact that Incident Manager is engaging during an incident.
static interface	CfnContact.StageProperty The `Stage` property type specifies a set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.
static interface	CfnContact.TargetsProperty The contact or contact channel that's being engaged.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnContact(software.constructs.Construct scope, String id, CfnContactProps props) Create a new `AWS::SSMContacts::Contact`.
protected	CfnContact(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnContact(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAlias() The unique and identifiable alias of the contact or escalation plan.
String	getAttrArn() The Amazon Resource Name (ARN) of the `Contact` resource, such as `arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias` .
protected Map<String,Object>	getCfnProperties()
String	getDisplayName() The full name of the contact or escalation plan.
Object	getPlan() A list of stages.
String	getType() Refers to the type of contact.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAlias(String value) The unique and identifiable alias of the contact or escalation plan.
void	setDisplayName(String value) The full name of the contact or escalation plan.
void	setPlan(IResolvable value) A list of stages.
void	setPlan(List<Object> value) A list of stages.
void	setType(String value) Refers to the type of contact.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnContact

protected CfnContact(software.amazon.jsii.JsiiObjectRef objRef)

CfnContact

protected CfnContact(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnContact

@Stability(value=Stable)
public CfnContact(@NotNull
                                           software.constructs.Construct scope,
                                           @NotNull
                                           String id,
                                           @NotNull
                                           CfnContactProps props)

Create a new `AWS::SSMContacts::Contact`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the `Contact` resource, such as `arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias` .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAlias

@Stability(value=Stable)
 @NotNull
public String getAlias()

The unique and identifiable alias of the contact or escalation plan.

setAlias

@Stability(value=Stable)
public void setAlias(@NotNull
                                              String value)

The unique and identifiable alias of the contact or escalation plan.

getDisplayName

@Stability(value=Stable)
 @NotNull
public String getDisplayName()

The full name of the contact or escalation plan.

setDisplayName

@Stability(value=Stable)
public void setDisplayName(@NotNull
                                                    String value)

The full name of the contact or escalation plan.

getPlan

@Stability(value=Stable)
 @NotNull
public Object getPlan()

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.

setPlan

@Stability(value=Stable)
public void setPlan(@NotNull
                                             IResolvable value)

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.

setPlan

@Stability(value=Stable)
public void setPlan(@NotNull
                                             List<Object> value)

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.

getType

@Stability(value=Stable)
 @NotNull
public String getType()

Refers to the type of contact.

A single contact is type PERSONAL and an escalation plan is type ESCALATION .

setType

@Stability(value=Stable)
public void setType(@NotNull
                                             String value)

Refers to the type of contact.

A single contact is type PERSONAL and an escalation plan is type ESCALATION .