Plan class
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", {
stages: [{
durationInMinutes: 1,
}],
contactId: "arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias",
});
import pulumi
import pulumi_aws as aws
example = aws.ssmcontacts.Plan("example",
stages=[{
"duration_in_minutes": 1,
}],
contact_id="arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias")
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()
{
Stages = new[]
{
new Aws.SsmContacts.Inputs.PlanStageArgs
{
DurationInMinutes = 1,
},
},
ContactId = "arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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{
Stages: ssmcontacts.PlanStageArray{
&ssmcontacts.PlanStageArgs{
DurationInMinutes: pulumi.Int(1),
},
},
ContactId: pulumi.String("arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ssmcontacts_plan" "example" {
stages {
duration_in_minutes = 1
}
contact_id = "arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias"
}
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.ArrayList;
import java.util.Arrays;
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()
.stages(PlanStageArgs.builder()
.durationInMinutes(1)
.build())
.contactId("arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias")
.build());
}
}
resources:
example:
type: aws:ssmcontacts:Plan
properties:
stages:
- durationInMinutes: 1
contactId: arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias
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", {
stages: [{
durationInMinutes: 1,
}],
contactId: contact.arn,
});
import pulumi
import pulumi_aws as aws
contact = aws.ssmcontacts.Contact("contact",
alias="alias",
type="PERSONAL")
plan = aws.ssmcontacts.Plan("plan",
stages=[{
"duration_in_minutes": 1,
}],
contact_id=contact.arn)
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()
{
Stages = new[]
{
new Aws.SsmContacts.Inputs.PlanStageArgs
{
DurationInMinutes = 1,
},
},
ContactId = contact.Arn,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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{
Stages: ssmcontacts.PlanStageArray{
&ssmcontacts.PlanStageArgs{
DurationInMinutes: pulumi.Int(1),
},
},
ContactId: contact.Arn,
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ssmcontacts_contact" "contact" {
alias = "alias"
type = "PERSONAL"
}
resource "aws_ssmcontacts_plan" "plan" {
stages {
duration_in_minutes = 1
}
contact_id = aws_ssmcontacts_contact.contact.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.ArrayList;
import java.util.Arrays;
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()
.stages(PlanStageArgs.builder()
.durationInMinutes(1)
.build())
.contactId(contact.arn())
.build());
}
}
resources:
contact:
type: aws:ssmcontacts:Contact
properties:
alias: alias
type: PERSONAL
plan:
type: aws:ssmcontacts:Plan
properties:
stages:
- durationInMinutes: 1
contactId: ${contact.arn}
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", {
stages: [{
targets: [
{
contactTargetInfo: {
isEssential: false,
contactId: contactOne.arn,
},
},
{
contactTargetInfo: {
isEssential: true,
contactId: contactTwo.arn,
},
},
{
channelTargetInfo: {
retryIntervalInMinutes: 2,
contactChannelId: channel.arn,
},
},
],
durationInMinutes: 0,
}],
contactId: escalationPlan.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",
stages=[{
"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"],
},
},
],
"duration_in_minutes": 0,
}],
contact_id=escalation_plan.arn)
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()
{
Stages = new[]
{
new Aws.SsmContacts.Inputs.PlanStageArgs
{
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,
},
},
},
DurationInMinutes = 0,
},
},
ContactId = escalationPlan.Arn,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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{
Stages: ssmcontacts.PlanStageArray{
&ssmcontacts.PlanStageArgs{
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),
},
},
},
DurationInMinutes: pulumi.Int(0),
},
},
ContactId: escalationPlan.Arn,
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ssmcontacts_contact" "escalation_plan" {
alias = "escalation-plan-alias"
type = "ESCALATION"
}
resource "aws_ssmcontacts_contact" "contact_one" {
alias = "alias"
type = "PERSONAL"
}
resource "aws_ssmcontacts_contact" "contact_two" {
alias = "alias"
type = "PERSONAL"
}
resource "aws_ssmcontacts_plan" "test" {
stages {
targets {
contact_target_info = {
is_essential = false
contact_id = aws_ssmcontacts_contact.contact_one.arn
}
}
targets {
contact_target_info = {
is_essential = true
contact_id = aws_ssmcontacts_contact.contact_two.arn
}
}
targets {
channel_target_info = {
retry_interval_in_minutes = 2
contact_channel_id = channel.arn
}
}
duration_in_minutes = 0
}
contact_id = aws_ssmcontacts_contact.escalation_plan.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 com.pulumi.aws.ssmcontacts.inputs.PlanStageTargetArgs;
import com.pulumi.aws.ssmcontacts.inputs.PlanStageTargetContactTargetInfoArgs;
import com.pulumi.aws.ssmcontacts.inputs.PlanStageTargetChannelTargetInfoArgs;
import java.util.ArrayList;
import java.util.Arrays;
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()
.stages(PlanStageArgs.builder()
.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())
.durationInMinutes(0)
.build())
.contactId(escalationPlan.arn())
.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:
stages:
- targets:
- contactTargetInfo:
isEssential: false
contactId: ${contactOne.arn}
- contactTargetInfo:
isEssential: true
contactId: ${contactTwo.arn}
- channelTargetInfo:
retryIntervalInMinutes: 2
contactChannelId: ${channel.arn}
durationInMinutes: 0
contactId: ${escalationPlan.arn}
Import
Using pulumi import, import SSM Contact Plan using the Contact ARN. For example:
$ pulumi import aws:ssmcontacts/plan:Plan example {ARNValue}
Constructors
- Plan(String name, {PlanArgs? args, CustomResourceOptions? options})
-
Creates a new Plan.
nameThe Pulumi resource name.argsArguments used to configure this Plan. The set of arguments for Plan.optionsResource options controlling this resource's behavior. - Plan.reference(String urn)
- Creates a typed reference to an existing Plan resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
contactId
↔ Output<
String> -
The ARN of the contact or escalation plan.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
stages
↔ Output<
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.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited