Package software.amazon.awscdk.services.ssmcontacts

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, IPlanRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:47.676Z") @Stability(Stable) public class CfnPlan extends CfnResource implements IInspectable, IPlanRef
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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the Plan resource.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getPlanRef

      @Stability(Stable) @NotNull public PlanReference getPlanRef()
      A reference to a Plan resource.
      Specified by:
      getPlanRef in interface IPlanRef

    • getContactId

      @Stability(Stable) @NotNull public String getContactId()
      The Amazon Resource Name (ARN) of the contact.

    • setContactId

      @Stability(Stable) public void setContactId(@NotNull String value)
      The Amazon Resource Name (ARN) of the contact.

    • getRotationIds

      @Stability(Stable) @Nullable public List<String> getRotationIds()
      The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan.

    • setRotationIds

      @Stability(Stable) public void setRotationIds(@Nullable List<String> value)
      The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan.

    • getStages

      @Stability(Stable) @Nullable public Object getStages()
      A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnPlan.StageProperty>

    • setStages

      @Stability(Stable) public void setStages(@Nullable IResolvable value)
      A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.

    • setStages

      @Stability(Stable) public void setStages(@Nullable List<Object> value)
      A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.