Package software.amazon.awscdk.services.ssmcontacts

Interface CfnPlanProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPlanProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:24.160Z")
@Stability(Stable)
public interface CfnPlanProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPlan.

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.*;
 CfnPlanProps cfnPlanProps = CfnPlanProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-plan.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPlanProps.Builder	A builder for CfnPlanProps
static final class	CfnPlanProps.Jsii$Proxy	An implementation for CfnPlanProps

Method Summary

Modifier and Type	Method	Description
static CfnPlanProps.Builder	builder()
String	getContactId()	The Amazon Resource Name (ARN) of the contact.
default List<String>	getRotationIds()	The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan.
default Object	getStages()	A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContactId

@Stability(Stable)
@NotNull
String getContactId()

The Amazon Resource Name (ARN) of the contact.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-plan.html#cfn-ssmcontacts-plan-contactid

getRotationIds

@Stability(Stable)
@Nullable
default List<String> getRotationIds()

The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-plan.html#cfn-ssmcontacts-plan-rotationids

getStages

@Stability(Stable)
@Nullable
default Object getStages()

A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-plan.html#cfn-ssmcontacts-plan-stages

builder

@Stability(Stable)
static CfnPlanProps.Builder builder()

Returns:

a CfnPlanProps.Builder of CfnPlanProps