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.103.1 (build bef2dea)",
date="2024-10-11T15:56:06.534Z")
@Stability(Stable)
public class CfnContact
extends CfnResource
implements IInspectable
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") .type("type") // the properties below are optional .plan(List.of(StageProperty.builder() .durationInMinutes(123) .rotationIds(List.of("rotationIds")) .targets(List.of(TargetsProperty.builder() .channelTargetInfo(ChannelTargetInfoProperty.builder() .channelId("channelId") .retryIntervalInMinutes(123) .build()) .contactTargetInfo(ContactTargetInfoProperty.builder() .contactId("contactId") .isEssential(false) .build()) .build())) .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnContact
.static interface
Information about the contact channel that Incident Manager uses to engage the contact.static interface
The contact that Incident Manager is engaging during an incident.static interface
TheStage
property type specifies a set amount of time that an escalation plan or engagement plan engages the specified contacts or contact methods.static interface
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.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnContact
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnContact
(software.amazon.jsii.JsiiObjectRef objRef) CfnContact
(software.constructs.Construct scope, String id, CfnContactProps props) -
Method Summary
Modifier and TypeMethodDescriptiongetAlias()
The unique and identifiable alias of the contact or escalation plan.The Amazon Resource Name (ARN) of theContact
resource, such asarn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias
.The full name of the contact or escalation plan.getPlan()
A list of stages.getType()
The type of contact.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
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
A list of stages.void
setPlan
(IResolvable value) A list of stages.void
The type of contact.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnContact
protected CfnContact(software.amazon.jsii.JsiiObjectRef objRef) -
CfnContact
protected CfnContact(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnContact
@Stability(Stable) public CfnContact(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnContactProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of theContact
resource, such asarn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias
. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getAlias
The unique and identifiable alias of the contact or escalation plan. -
setAlias
The unique and identifiable alias of the contact or escalation plan. -
getDisplayName
The full name of the contact or escalation plan. -
setDisplayName
The full name of the contact or escalation plan. -
getType
The type of contact. -
setType
The type of contact. -
getPlan
A list of stages. -
setPlan
A list of stages. -
setPlan
A list of stages.
-