Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. ssmcontacts
  5. Plan
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.ssmcontacts.Plan

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing an AWS SSM Contact Plan.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ssmcontacts.Plan("example", {
    contactId: "arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias",
    stages: [{
        durationInMinutes: 1,
    }],
});

    import pulumi
import pulumi_aws as aws

example = aws.ssmcontacts.Plan("example",
    contact_id="arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias",
    stages=[{
        "duration_in_minutes": 1,
    }])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ssmcontacts"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ssmcontacts.NewPlan(ctx, "example", &ssmcontacts.PlanArgs{
			ContactId: pulumi.String("arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias"),
			Stages: ssmcontacts.PlanStageArray{
				&ssmcontacts.PlanStageArgs{
					DurationInMinutes: pulumi.Int(1),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.SsmContacts.Plan("example", new()
    {
        ContactId = "arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias",
        Stages = new[]
        {
            new Aws.SsmContacts.Inputs.PlanStageArgs
            {
                DurationInMinutes = 1,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssmcontacts.Plan;
import com.pulumi.aws.ssmcontacts.PlanArgs;
import com.pulumi.aws.ssmcontacts.inputs.PlanStageArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Plan("example", PlanArgs.builder()
            .contactId("arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias")
            .stages(PlanStageArgs.builder()
                .durationInMinutes(1)
                .build())
            .build());

    }
}

    resources:
  example:
    type: aws:ssmcontacts:Plan
    properties:
      contactId: arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias
      stages:
        - durationInMinutes: 1

    Usage with SSM Contact

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const contact = new aws.ssmcontacts.Contact("contact", {
    alias: "alias",
    type: "PERSONAL",
});
const plan = new aws.ssmcontacts.Plan("plan", {
    contactId: contact.arn,
    stages: [{
        durationInMinutes: 1,
    }],
});

    import pulumi
import pulumi_aws as aws

contact = aws.ssmcontacts.Contact("contact",
    alias="alias",
    type="PERSONAL")
plan = aws.ssmcontacts.Plan("plan",
    contact_id=contact.arn,
    stages=[{
        "duration_in_minutes": 1,
    }])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ssmcontacts"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		contact, err := ssmcontacts.NewContact(ctx, "contact", &ssmcontacts.ContactArgs{
			Alias: pulumi.String("alias"),
			Type:  pulumi.String("PERSONAL"),
		})
		if err != nil {
			return err
		}
		_, err = ssmcontacts.NewPlan(ctx, "plan", &ssmcontacts.PlanArgs{
			ContactId: contact.Arn,
			Stages: ssmcontacts.PlanStageArray{
				&ssmcontacts.PlanStageArgs{
					DurationInMinutes: pulumi.Int(1),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var contact = new Aws.SsmContacts.Contact("contact", new()
    {
        Alias = "alias",
        Type = "PERSONAL",
    });

    var plan = new Aws.SsmContacts.Plan("plan", new()
    {
        ContactId = contact.Arn,
        Stages = new[]
        {
            new Aws.SsmContacts.Inputs.PlanStageArgs
            {
                DurationInMinutes = 1,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssmcontacts.Contact;
import com.pulumi.aws.ssmcontacts.ContactArgs;
import com.pulumi.aws.ssmcontacts.Plan;
import com.pulumi.aws.ssmcontacts.PlanArgs;
import com.pulumi.aws.ssmcontacts.inputs.PlanStageArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var contact = new Contact("contact", ContactArgs.builder()
            .alias("alias")
            .type("PERSONAL")
            .build());

        var plan = new Plan("plan", PlanArgs.builder()
            .contactId(contact.arn())
            .stages(PlanStageArgs.builder()
                .durationInMinutes(1)
                .build())
            .build());

    }
}

    resources:
  contact:
    type: aws:ssmcontacts:Contact
    properties:
      alias: alias
      type: PERSONAL
  plan:
    type: aws:ssmcontacts:Plan
    properties:
      contactId: ${contact.arn}
      stages:
        - durationInMinutes: 1

    Usage With All Fields

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const escalationPlan = new aws.ssmcontacts.Contact("escalation_plan", {
    alias: "escalation-plan-alias",
    type: "ESCALATION",
});
const contactOne = new aws.ssmcontacts.Contact("contact_one", {
    alias: "alias",
    type: "PERSONAL",
});
const contactTwo = new aws.ssmcontacts.Contact("contact_two", {
    alias: "alias",
    type: "PERSONAL",
});
const test = new aws.ssmcontacts.Plan("test", {
    contactId: escalationPlan.arn,
    stages: [{
        durationInMinutes: 0,
        targets: [
            {
                contactTargetInfo: {
                    isEssential: false,
                    contactId: contactOne.arn,
                },
            },
            {
                contactTargetInfo: {
                    isEssential: true,
                    contactId: contactTwo.arn,
                },
            },
            {
                channelTargetInfo: {
                    retryIntervalInMinutes: 2,
                    contactChannelId: channel.arn,
                },
            },
        ],
    }],
});

    import pulumi
import pulumi_aws as aws

escalation_plan = aws.ssmcontacts.Contact("escalation_plan",
    alias="escalation-plan-alias",
    type="ESCALATION")
contact_one = aws.ssmcontacts.Contact("contact_one",
    alias="alias",
    type="PERSONAL")
contact_two = aws.ssmcontacts.Contact("contact_two",
    alias="alias",
    type="PERSONAL")
test = aws.ssmcontacts.Plan("test",
    contact_id=escalation_plan.arn,
    stages=[{
        "duration_in_minutes": 0,
        "targets": [
            {
                "contact_target_info": {
                    "is_essential": False,
                    "contact_id": contact_one.arn,
                },
            },
            {
                "contact_target_info": {
                    "is_essential": True,
                    "contact_id": contact_two.arn,
                },
            },
            {
                "channel_target_info": {
                    "retry_interval_in_minutes": 2,
                    "contact_channel_id": channel["arn"],
                },
            },
        ],
    }])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ssmcontacts"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		escalationPlan, err := ssmcontacts.NewContact(ctx, "escalation_plan", &ssmcontacts.ContactArgs{
			Alias: pulumi.String("escalation-plan-alias"),
			Type:  pulumi.String("ESCALATION"),
		})
		if err != nil {
			return err
		}
		contactOne, err := ssmcontacts.NewContact(ctx, "contact_one", &ssmcontacts.ContactArgs{
			Alias: pulumi.String("alias"),
			Type:  pulumi.String("PERSONAL"),
		})
		if err != nil {
			return err
		}
		contactTwo, err := ssmcontacts.NewContact(ctx, "contact_two", &ssmcontacts.ContactArgs{
			Alias: pulumi.String("alias"),
			Type:  pulumi.String("PERSONAL"),
		})
		if err != nil {
			return err
		}
		_, err = ssmcontacts.NewPlan(ctx, "test", &ssmcontacts.PlanArgs{
			ContactId: escalationPlan.Arn,
			Stages: ssmcontacts.PlanStageArray{
				&ssmcontacts.PlanStageArgs{
					DurationInMinutes: pulumi.Int(0),
					Targets: ssmcontacts.PlanStageTargetArray{
						&ssmcontacts.PlanStageTargetArgs{
							ContactTargetInfo: &ssmcontacts.PlanStageTargetContactTargetInfoArgs{
								IsEssential: pulumi.Bool(false),
								ContactId:   contactOne.Arn,
							},
						},
						&ssmcontacts.PlanStageTargetArgs{
							ContactTargetInfo: &ssmcontacts.PlanStageTargetContactTargetInfoArgs{
								IsEssential: pulumi.Bool(true),
								ContactId:   contactTwo.Arn,
							},
						},
						&ssmcontacts.PlanStageTargetArgs{
							ChannelTargetInfo: &ssmcontacts.PlanStageTargetChannelTargetInfoArgs{
								RetryIntervalInMinutes: pulumi.Int(2),
								ContactChannelId:       pulumi.Any(channel.Arn),
							},
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var escalationPlan = new Aws.SsmContacts.Contact("escalation_plan", new()
    {
        Alias = "escalation-plan-alias",
        Type = "ESCALATION",
    });

    var contactOne = new Aws.SsmContacts.Contact("contact_one", new()
    {
        Alias = "alias",
        Type = "PERSONAL",
    });

    var contactTwo = new Aws.SsmContacts.Contact("contact_two", new()
    {
        Alias = "alias",
        Type = "PERSONAL",
    });

    var test = new Aws.SsmContacts.Plan("test", new()
    {
        ContactId = escalationPlan.Arn,
        Stages = new[]
        {
            new Aws.SsmContacts.Inputs.PlanStageArgs
            {
                DurationInMinutes = 0,
                Targets = new[]
                {
                    new Aws.SsmContacts.Inputs.PlanStageTargetArgs
                    {
                        ContactTargetInfo = new Aws.SsmContacts.Inputs.PlanStageTargetContactTargetInfoArgs
                        {
                            IsEssential = false,
                            ContactId = contactOne.Arn,
                        },
                    },
                    new Aws.SsmContacts.Inputs.PlanStageTargetArgs
                    {
                        ContactTargetInfo = new Aws.SsmContacts.Inputs.PlanStageTargetContactTargetInfoArgs
                        {
                            IsEssential = true,
                            ContactId = contactTwo.Arn,
                        },
                    },
                    new Aws.SsmContacts.Inputs.PlanStageTargetArgs
                    {
                        ChannelTargetInfo = new Aws.SsmContacts.Inputs.PlanStageTargetChannelTargetInfoArgs
                        {
                            RetryIntervalInMinutes = 2,
                            ContactChannelId = channel.Arn,
                        },
                    },
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssmcontacts.Contact;
import com.pulumi.aws.ssmcontacts.ContactArgs;
import com.pulumi.aws.ssmcontacts.Plan;
import com.pulumi.aws.ssmcontacts.PlanArgs;
import com.pulumi.aws.ssmcontacts.inputs.PlanStageArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var escalationPlan = new Contact("escalationPlan", ContactArgs.builder()
            .alias("escalation-plan-alias")
            .type("ESCALATION")
            .build());

        var contactOne = new Contact("contactOne", ContactArgs.builder()
            .alias("alias")
            .type("PERSONAL")
            .build());

        var contactTwo = new Contact("contactTwo", ContactArgs.builder()
            .alias("alias")
            .type("PERSONAL")
            .build());

        var test = new Plan("test", PlanArgs.builder()
            .contactId(escalationPlan.arn())
            .stages(PlanStageArgs.builder()
                .durationInMinutes(0)
                .targets(                
                    PlanStageTargetArgs.builder()
                        .contactTargetInfo(PlanStageTargetContactTargetInfoArgs.builder()
                            .isEssential(false)
                            .contactId(contactOne.arn())
                            .build())
                        .build(),
                    PlanStageTargetArgs.builder()
                        .contactTargetInfo(PlanStageTargetContactTargetInfoArgs.builder()
                            .isEssential(true)
                            .contactId(contactTwo.arn())
                            .build())
                        .build(),
                    PlanStageTargetArgs.builder()
                        .channelTargetInfo(PlanStageTargetChannelTargetInfoArgs.builder()
                            .retryIntervalInMinutes(2)
                            .contactChannelId(channel.arn())
                            .build())
                        .build())
                .build())
            .build());

    }
}

    resources:
  escalationPlan:
    type: aws:ssmcontacts:Contact
    name: escalation_plan
    properties:
      alias: escalation-plan-alias
      type: ESCALATION
  contactOne:
    type: aws:ssmcontacts:Contact
    name: contact_one
    properties:
      alias: alias
      type: PERSONAL
  contactTwo:
    type: aws:ssmcontacts:Contact
    name: contact_two
    properties:
      alias: alias
      type: PERSONAL
  test:
    type: aws:ssmcontacts:Plan
    properties:
      contactId: ${escalationPlan.arn}
      stages:
        - durationInMinutes: 0
          targets:
            - contactTargetInfo:
                isEssential: false
                contactId: ${contactOne.arn}
            - contactTargetInfo:
                isEssential: true
                contactId: ${contactTwo.arn}
            - channelTargetInfo:
                retryIntervalInMinutes: 2
                contactChannelId: ${channel.arn}

    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: PlanArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Plan(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         contact_id: Optional[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, CustomResourceOptions? opts = null)
    public Plan(String name, PlanArgs args)
public Plan(String name, PlanArgs args, CustomResourceOptions options)

    type: aws: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.

    Constructor example

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

    var awsPlanResource = new Aws.SsmContacts.Plan("awsPlanResource", new()
{
    ContactId = "string",
    Stages = new[]
    {
        new Aws.SsmContacts.Inputs.PlanStageArgs
        {
            DurationInMinutes = 0,
            Targets = new[]
            {
                new Aws.SsmContacts.Inputs.PlanStageTargetArgs
                {
                    ChannelTargetInfo = new Aws.SsmContacts.Inputs.PlanStageTargetChannelTargetInfoArgs
                    {
                        ContactChannelId = "string",
                        RetryIntervalInMinutes = 0,
                    },
                    ContactTargetInfo = new Aws.SsmContacts.Inputs.PlanStageTargetContactTargetInfoArgs
                    {
                        IsEssential = false,
                        ContactId = "string",
                    },
                },
            },
        },
    },
});

    example, err := ssmcontacts.NewPlan(ctx, "awsPlanResource", &ssmcontacts.PlanArgs{
	ContactId: pulumi.String("string"),
	Stages: ssmcontacts.PlanStageArray{
		&ssmcontacts.PlanStageArgs{
			DurationInMinutes: pulumi.Int(0),
			Targets: ssmcontacts.PlanStageTargetArray{
				&ssmcontacts.PlanStageTargetArgs{
					ChannelTargetInfo: &ssmcontacts.PlanStageTargetChannelTargetInfoArgs{
						ContactChannelId:       pulumi.String("string"),
						RetryIntervalInMinutes: pulumi.Int(0),
					},
					ContactTargetInfo: &ssmcontacts.PlanStageTargetContactTargetInfoArgs{
						IsEssential: pulumi.Bool(false),
						ContactId:   pulumi.String("string"),
					},
				},
			},
		},
	},
})

    var awsPlanResource = new Plan("awsPlanResource", PlanArgs.builder()
    .contactId("string")
    .stages(PlanStageArgs.builder()
        .durationInMinutes(0)
        .targets(PlanStageTargetArgs.builder()
            .channelTargetInfo(PlanStageTargetChannelTargetInfoArgs.builder()
                .contactChannelId("string")
                .retryIntervalInMinutes(0)
                .build())
            .contactTargetInfo(PlanStageTargetContactTargetInfoArgs.builder()
                .isEssential(false)
                .contactId("string")
                .build())
            .build())
        .build())
    .build());

    aws_plan_resource = aws.ssmcontacts.Plan("awsPlanResource",
    contact_id="string",
    stages=[{
        "duration_in_minutes": 0,
        "targets": [{
            "channel_target_info": {
                "contact_channel_id": "string",
                "retry_interval_in_minutes": 0,
            },
            "contact_target_info": {
                "is_essential": False,
                "contact_id": "string",
            },
        }],
    }])

    const awsPlanResource = new aws.ssmcontacts.Plan("awsPlanResource", {
    contactId: "string",
    stages: [{
        durationInMinutes: 0,
        targets: [{
            channelTargetInfo: {
                contactChannelId: "string",
                retryIntervalInMinutes: 0,
            },
            contactTargetInfo: {
                isEssential: false,
                contactId: "string",
            },
        }],
    }],
});

    type: aws:ssmcontacts:Plan
properties:
    contactId: string
    stages:
        - durationInMinutes: 0
          targets:
            - channelTargetInfo:
                contactChannelId: string
                retryIntervalInMinutes: 0
              contactTargetInfo:
                contactId: string
                isEssential: false

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Plan resource accepts the following input properties:

    ContactId string
    The Amazon Resource Name (ARN) of the contact or escalation plan.
    Stages List<PlanStage>
    One or more configuration blocks for specifying a list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods. See Stage below for more details.
    ContactId string
    The Amazon Resource Name (ARN) of the contact or escalation plan.
    Stages []PlanStageArgs
    One or more configuration blocks for specifying a list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods. See Stage below for more details.
    contactId String
    The Amazon Resource Name (ARN) of the contact or escalation plan.
    stages List<PlanStage>
    One or more configuration blocks for specifying a list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods. See Stage below for more details.
    contactId string
    The Amazon Resource Name (ARN) of the contact or escalation plan.
    stages PlanStage[]
    One or more configuration blocks for specifying a list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods. See Stage below for more details.
    contact_id str
    The Amazon Resource Name (ARN) of the contact or escalation plan.
    stages Sequence[PlanStageArgs]
    One or more configuration blocks for specifying a list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods. See Stage below for more details.
    contactId String
    The Amazon Resource Name (ARN) of the contact or escalation plan.
    stages List<Property Map>
    One or more configuration blocks for specifying a list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods. See Stage below for more details.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Plan Resource

    Get an existing Plan resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PlanState, opts?: CustomResourceOptions): Plan
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        contact_id: Optional[str] = None,
        stages: Optional[Sequence[PlanStageArgs]] = None) -> Plan
    func GetPlan(ctx *Context, name string, id IDInput, state *PlanState, opts ...ResourceOption) (*Plan, error)
    public static Plan Get(string name, Input<string> id, PlanState? state, CustomResourceOptions? opts = null)
    public static Plan get(String name, Output<String> id, PlanState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ContactId string
    The Amazon Resource Name (ARN) of the contact or escalation plan.
    Stages List<PlanStage>
    One or more configuration blocks for specifying a list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods. See Stage below for more details.
    ContactId string
    The Amazon Resource Name (ARN) of the contact or escalation plan.
    Stages []PlanStageArgs
    One or more configuration blocks for specifying a list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods. See Stage below for more details.
    contactId String
    The Amazon Resource Name (ARN) of the contact or escalation plan.
    stages List<PlanStage>
    One or more configuration blocks for specifying a list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods. See Stage below for more details.
    contactId string
    The Amazon Resource Name (ARN) of the contact or escalation plan.
    stages PlanStage[]
    One or more configuration blocks for specifying a list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods. See Stage below for more details.
    contact_id str
    The Amazon Resource Name (ARN) of the contact or escalation plan.
    stages Sequence[PlanStageArgs]
    One or more configuration blocks for specifying a list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods. See Stage below for more details.
    contactId String
    The Amazon Resource Name (ARN) of the contact or escalation plan.
    stages List<Property Map>
    One or more configuration blocks for specifying a list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods. See Stage below for more details.

    Supporting Types

    PlanStage, PlanStageArgs

    DurationInMinutes int
    The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.
    Targets List<PlanStageTarget>
    One or more configuration blocks for specifying the contacts or contact methods that the escalation plan or engagement plan is engaging. See Target below for more details.
    DurationInMinutes int
    The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.
    Targets []PlanStageTarget
    One or more configuration blocks for specifying the contacts or contact methods that the escalation plan or engagement plan is engaging. See Target below for more details.
    durationInMinutes Integer
    The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.
    targets List<PlanStageTarget>
    One or more configuration blocks for specifying the contacts or contact methods that the escalation plan or engagement plan is engaging. See Target below for more details.
    durationInMinutes number
    The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.
    targets PlanStageTarget[]
    One or more configuration blocks for specifying the contacts or contact methods that the escalation plan or engagement plan is engaging. See Target below for more details.
    duration_in_minutes int
    The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.
    targets Sequence[PlanStageTarget]
    One or more configuration blocks for specifying the contacts or contact methods that the escalation plan or engagement plan is engaging. See Target below for more details.
    durationInMinutes Number
    The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.
    targets List<Property Map>
    One or more configuration blocks for specifying the contacts or contact methods that the escalation plan or engagement plan is engaging. See Target below for more details.

    PlanStageTarget, PlanStageTargetArgs

    ChannelTargetInfo PlanStageTargetChannelTargetInfo
    A configuration block for specifying information about the contact channel that Incident Manager engages. See Channel Target Info for more details.
    ContactTargetInfo PlanStageTargetContactTargetInfo
    A configuration block for specifying information about the contact that Incident Manager engages. See Contact Target Info for more details.
    ChannelTargetInfo PlanStageTargetChannelTargetInfo
    A configuration block for specifying information about the contact channel that Incident Manager engages. See Channel Target Info for more details.
    ContactTargetInfo PlanStageTargetContactTargetInfo
    A configuration block for specifying information about the contact that Incident Manager engages. See Contact Target Info for more details.
    channelTargetInfo PlanStageTargetChannelTargetInfo
    A configuration block for specifying information about the contact channel that Incident Manager engages. See Channel Target Info for more details.
    contactTargetInfo PlanStageTargetContactTargetInfo
    A configuration block for specifying information about the contact that Incident Manager engages. See Contact Target Info for more details.
    channelTargetInfo PlanStageTargetChannelTargetInfo
    A configuration block for specifying information about the contact channel that Incident Manager engages. See Channel Target Info for more details.
    contactTargetInfo PlanStageTargetContactTargetInfo
    A configuration block for specifying information about the contact that Incident Manager engages. See Contact Target Info for more details.
    channel_target_info PlanStageTargetChannelTargetInfo
    A configuration block for specifying information about the contact channel that Incident Manager engages. See Channel Target Info for more details.
    contact_target_info PlanStageTargetContactTargetInfo
    A configuration block for specifying information about the contact that Incident Manager engages. See Contact Target Info for more details.
    channelTargetInfo Property Map
    A configuration block for specifying information about the contact channel that Incident Manager engages. See Channel Target Info for more details.
    contactTargetInfo Property Map
    A configuration block for specifying information about the contact that Incident Manager engages. See Contact Target Info for more details.

    PlanStageTargetChannelTargetInfo, PlanStageTargetChannelTargetInfoArgs

    ContactChannelId string
    The Amazon Resource Name (ARN) of the contact channel.
    RetryIntervalInMinutes int
    The number of minutes to wait before retrying to send engagement if the engagement initially failed.
    ContactChannelId string
    The Amazon Resource Name (ARN) of the contact channel.
    RetryIntervalInMinutes int
    The number of minutes to wait before retrying to send engagement if the engagement initially failed.
    contactChannelId String
    The Amazon Resource Name (ARN) of the contact channel.
    retryIntervalInMinutes Integer
    The number of minutes to wait before retrying to send engagement if the engagement initially failed.
    contactChannelId string
    The Amazon Resource Name (ARN) of the contact channel.
    retryIntervalInMinutes number
    The number of minutes to wait before retrying to send engagement if the engagement initially failed.
    contact_channel_id str
    The Amazon Resource Name (ARN) of the contact channel.
    retry_interval_in_minutes int
    The number of minutes to wait before retrying to send engagement if the engagement initially failed.
    contactChannelId String
    The Amazon Resource Name (ARN) of the contact channel.
    retryIntervalInMinutes Number
    The number of minutes to wait before retrying to send engagement if the engagement initially failed.

    PlanStageTargetContactTargetInfo, PlanStageTargetContactTargetInfoArgs

    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.
    contactId string
    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.
    contact_id str
    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.

    Import

    Using pulumi import, import SSM Contact Plan using the Contact ARN. For example:

    $ pulumi import aws:ssmcontacts/plan:Plan example {ARNValue}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws