Class CfnPlan
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.CfnPlan
- 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-09-24T10:56:40.530Z")
@Stability(Stable)
public class CfnPlan
extends CfnResource
implements IInspectable
Information about the stages and on-call rotation teams associated with an escalation plan or engagement plan.
Template example : We recommend creating all Incident Manager
Contacts
resources using a single AWS CloudFormation template. For a demonstration, see the examples for AWS::SSMContacts::Contacts .
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.*; CfnPlan cfnPlan = CfnPlan.Builder.create(this, "MyCfnPlan") .contactId("contactId") // the properties below are optional .rotationIds(List.of("rotationIds")) .stages(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())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnPlan
.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
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
CfnPlan
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnPlan
(software.amazon.jsii.JsiiObjectRef objRef) CfnPlan
(software.constructs.Construct scope, String id, CfnPlanProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name (ARN) of thePlan
resource.The Amazon Resource Name (ARN) of the contact.The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan.A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setContactId
(String value) The Amazon Resource Name (ARN) of the contact.void
setRotationIds
(List<String> value) The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan.void
A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.void
setStages
(IResolvable value) A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.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
-
CfnPlan
protected CfnPlan(software.amazon.jsii.JsiiObjectRef objRef) -
CfnPlan
protected CfnPlan(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnPlan
@Stability(Stable) public CfnPlan(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPlanProps 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 thePlan
resource. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getContactId
The Amazon Resource Name (ARN) of the contact. -
setContactId
The Amazon Resource Name (ARN) of the contact. -
getRotationIds
The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan. -
setRotationIds
The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan. -
getStages
A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods. -
setStages
A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods. -
setStages
A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.
-