Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. ssmcontacts
  5. Plan

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.ssmcontacts.Plan

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
pulumi/pulumi-aws-native

    Engagement Plan for a SSM Incident Manager Contact.

    Create Plan Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Plan(name: string, args?: PlanArgs, opts?: CustomResourceOptions);
    @overload
def Plan(resource_name: str,
         args: Optional[PlanArgs] = None,
         opts: Optional[ResourceOptions] = None)

@overload
def Plan(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         contact_id: Optional[str] = None,
         rotation_ids: Optional[Sequence[str]] = None,
         stages: Optional[Sequence[PlanStageArgs]] = None)
    func NewPlan(ctx *Context, name string, args *PlanArgs, opts ...ResourceOption) (*Plan, error)
    public Plan(string name, PlanArgs? args = null, CustomResourceOptions? opts = null)
    public Plan(String name, PlanArgs args)
public Plan(String name, PlanArgs args, CustomResourceOptions options)

    type: aws-native:ssmcontacts:Plan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PlanArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PlanArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PlanArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const planResource = new aws_native.ssmcontacts.Plan("planResource", {
    contactId: "string",
    rotationIds: ["string"],
    stages: [{
        durationInMinutes: 0,
        targets: [{
            channelTargetInfo: {
                channelId: "string",
                retryIntervalInMinutes: 0,
            },
            contactTargetInfo: {
                contactId: "string",
                isEssential: false,
            },
        }],
    }],
});

    Coming soon!

    Plan Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Plan resource accepts the following input properties:

    ContactId string
    Contact ID for the AWS SSM Incident Manager Contact to associate the plan.
    RotationIds List<string>
    Rotation Ids to associate with Oncall Contact for engagement.
    Stages List<Pulumi.AwsNative.SsmContacts.Inputs.PlanStage>
    The stages that an escalation plan or engagement plan engages contacts and contact methods in.
    ContactId string
    Contact ID for the AWS SSM Incident Manager Contact to associate the plan.
    RotationIds []string
    Rotation Ids to associate with Oncall Contact for engagement.
    Stages []PlanStageArgs
    The stages that an escalation plan or engagement plan engages contacts and contact methods in.
    contactId String
    Contact ID for the AWS SSM Incident Manager Contact to associate the plan.
    rotationIds List<String>
    Rotation Ids to associate with Oncall Contact for engagement.
    stages List<PlanStage>
    The stages that an escalation plan or engagement plan engages contacts and contact methods in.
    contactId string
    Contact ID for the AWS SSM Incident Manager Contact to associate the plan.
    rotationIds string[]
    Rotation Ids to associate with Oncall Contact for engagement.
    stages PlanStage[]
    The stages that an escalation plan or engagement plan engages contacts and contact methods in.
    contact_id str
    Contact ID for the AWS SSM Incident Manager Contact to associate the plan.
    rotation_ids Sequence[str]
    Rotation Ids to associate with Oncall Contact for engagement.
    stages Sequence[PlanStageArgs]
    The stages that an escalation plan or engagement plan engages contacts and contact methods in.
    contactId String
    Contact ID for the AWS SSM Incident Manager Contact to associate the plan.
    rotationIds List<String>
    Rotation Ids to associate with Oncall Contact for engagement.
    stages List<Property Map>
    The stages that an escalation plan or engagement plan engages contacts and contact methods in.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Plan resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the contact.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The Amazon Resource Name (ARN) of the contact.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the contact.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) of the contact.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The Amazon Resource Name (ARN) of the contact.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the contact.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    PlanChannelTargetInfo, PlanChannelTargetInfoArgs

    ChannelId string
    The Amazon Resource Name (ARN) of the contact channel.
    RetryIntervalInMinutes int
    The number of minutes to wait to retry sending engagement in the case the engagement initially fails.
    ChannelId string
    The Amazon Resource Name (ARN) of the contact channel.
    RetryIntervalInMinutes int
    The number of minutes to wait to retry sending engagement in the case the engagement initially fails.
    channelId String
    The Amazon Resource Name (ARN) of the contact channel.
    retryIntervalInMinutes Integer
    The number of minutes to wait to retry sending engagement in the case the engagement initially fails.
    channelId string
    The Amazon Resource Name (ARN) of the contact channel.
    retryIntervalInMinutes number
    The number of minutes to wait to retry sending engagement in the case the engagement initially fails.
    channel_id str
    The Amazon Resource Name (ARN) of the contact channel.
    retry_interval_in_minutes int
    The number of minutes to wait to retry sending engagement in the case the engagement initially fails.
    channelId String
    The Amazon Resource Name (ARN) of the contact channel.
    retryIntervalInMinutes Number
    The number of minutes to wait to retry sending engagement in the case the engagement initially fails.

    PlanContactTargetInfo, PlanContactTargetInfoArgs

    ContactId string
    The Amazon Resource Name (ARN) of the contact.
    IsEssential bool
    A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.
    ContactId string
    The Amazon Resource Name (ARN) of the contact.
    IsEssential bool
    A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.
    contactId String
    The Amazon Resource Name (ARN) of the contact.
    isEssential Boolean
    A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.
    contactId string
    The Amazon Resource Name (ARN) of the contact.
    isEssential boolean
    A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.
    contact_id str
    The Amazon Resource Name (ARN) of the contact.
    is_essential bool
    A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.
    contactId String
    The Amazon Resource Name (ARN) of the contact.
    isEssential Boolean
    A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.

    PlanStage, PlanStageArgs

    DurationInMinutes int
    The time to wait until beginning the next stage.
    Targets List<Pulumi.AwsNative.SsmContacts.Inputs.PlanTargets>
    The contacts or contact methods that the escalation plan or engagement plan is engaging.
    DurationInMinutes int
    The time to wait until beginning the next stage.
    Targets []PlanTargets
    The contacts or contact methods that the escalation plan or engagement plan is engaging.
    durationInMinutes Integer
    The time to wait until beginning the next stage.
    targets List<PlanTargets>
    The contacts or contact methods that the escalation plan or engagement plan is engaging.
    durationInMinutes number
    The time to wait until beginning the next stage.
    targets PlanTargets[]
    The contacts or contact methods that the escalation plan or engagement plan is engaging.
    duration_in_minutes int
    The time to wait until beginning the next stage.
    targets Sequence[PlanTargets]
    The contacts or contact methods that the escalation plan or engagement plan is engaging.
    durationInMinutes Number
    The time to wait until beginning the next stage.
    targets List<Property Map>
    The contacts or contact methods that the escalation plan or engagement plan is engaging.

    PlanTargets, PlanTargetsArgs

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
    pulumi/pulumi-aws-native