ContactChannel

class ContactChannel : KotlinCustomResource

Resource for managing an AWS SSM Contacts Contact Channel.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.ssmcontacts.ContactChannel("example", {
contactId: "arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias",
deliveryAddress: {
simpleAddress: "email@example.com",
},
name: "Example contact channel",
type: "EMAIL",
});
import pulumi
import pulumi_aws as aws
example = aws.ssmcontacts.ContactChannel("example",
contact_id="arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias",
delivery_address={
"simple_address": "email@example.com",
},
name="Example contact channel",
type="EMAIL")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.SsmContacts.ContactChannel("example", new()
{
ContactId = "arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias",
DeliveryAddress = new Aws.SsmContacts.Inputs.ContactChannelDeliveryAddressArgs
{
SimpleAddress = "email@example.com",
},
Name = "Example contact channel",
Type = "EMAIL",
});
});
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.NewContactChannel(ctx, "example", &ssmcontacts.ContactChannelArgs{
ContactId: pulumi.String("arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias"),
DeliveryAddress: &ssmcontacts.ContactChannelDeliveryAddressArgs{
SimpleAddress: pulumi.String("email@example.com"),
},
Name: pulumi.String("Example contact channel"),
Type: pulumi.String("EMAIL"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssmcontacts.ContactChannel;
import com.pulumi.aws.ssmcontacts.ContactChannelArgs;
import com.pulumi.aws.ssmcontacts.inputs.ContactChannelDeliveryAddressArgs;
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 ContactChannel("example", ContactChannelArgs.builder()
.contactId("arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias")
.deliveryAddress(ContactChannelDeliveryAddressArgs.builder()
.simpleAddress("email@example.com")
.build())
.name("Example contact channel")
.type("EMAIL")
.build());
}
}
resources:
example:
type: aws:ssmcontacts:ContactChannel
properties:
contactId: arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias
deliveryAddress:
simpleAddress: email@example.com
name: Example contact channel
type: EMAIL

Usage with SSM Contact

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const exampleContact = new aws.ssmcontacts.Contact("example_contact", {
alias: "example_contact",
type: "PERSONAL",
});
const example = new aws.ssmcontacts.ContactChannel("example", {
contactId: exampleContact.arn,
deliveryAddress: {
simpleAddress: "email@example.com",
},
name: "Example contact channel",
type: "EMAIL",
});
import pulumi
import pulumi_aws as aws
example_contact = aws.ssmcontacts.Contact("example_contact",
alias="example_contact",
type="PERSONAL")
example = aws.ssmcontacts.ContactChannel("example",
contact_id=example_contact.arn,
delivery_address={
"simple_address": "email@example.com",
},
name="Example contact channel",
type="EMAIL")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var exampleContact = new Aws.SsmContacts.Contact("example_contact", new()
{
Alias = "example_contact",
Type = "PERSONAL",
});
var example = new Aws.SsmContacts.ContactChannel("example", new()
{
ContactId = exampleContact.Arn,
DeliveryAddress = new Aws.SsmContacts.Inputs.ContactChannelDeliveryAddressArgs
{
SimpleAddress = "email@example.com",
},
Name = "Example contact channel",
Type = "EMAIL",
});
});
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 {
exampleContact, err := ssmcontacts.NewContact(ctx, "example_contact", &ssmcontacts.ContactArgs{
Alias: pulumi.String("example_contact"),
Type: pulumi.String("PERSONAL"),
})
if err != nil {
return err
}
_, err = ssmcontacts.NewContactChannel(ctx, "example", &ssmcontacts.ContactChannelArgs{
ContactId: exampleContact.Arn,
DeliveryAddress: &ssmcontacts.ContactChannelDeliveryAddressArgs{
SimpleAddress: pulumi.String("email@example.com"),
},
Name: pulumi.String("Example contact channel"),
Type: pulumi.String("EMAIL"),
})
if err != nil {
return err
}
return nil
})
}
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.ContactChannel;
import com.pulumi.aws.ssmcontacts.ContactChannelArgs;
import com.pulumi.aws.ssmcontacts.inputs.ContactChannelDeliveryAddressArgs;
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 exampleContact = new Contact("exampleContact", ContactArgs.builder()
.alias("example_contact")
.type("PERSONAL")
.build());
var example = new ContactChannel("example", ContactChannelArgs.builder()
.contactId(exampleContact.arn())
.deliveryAddress(ContactChannelDeliveryAddressArgs.builder()
.simpleAddress("email@example.com")
.build())
.name("Example contact channel")
.type("EMAIL")
.build());
}
}
resources:
exampleContact:
type: aws:ssmcontacts:Contact
name: example_contact
properties:
alias: example_contact
type: PERSONAL
example:
type: aws:ssmcontacts:ContactChannel
properties:
contactId: ${exampleContact.arn}
deliveryAddress:
simpleAddress: email@example.com
name: Example contact channel
type: EMAIL

Import

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

$ pulumi import aws:ssmcontacts/contactChannel:ContactChannel example arn:aws:ssm-contacts:us-west-2:123456789012:contact-channel/example

Properties

Link copied to clipboard

Whether the contact channel is activated. The contact channel must be activated to use it to engage the contact. One of ACTIVATED or NOT_ACTIVATED.

Link copied to clipboard
val arn: Output<String>

Amazon Resource Name (ARN) of the contact channel.

Link copied to clipboard
val contactId: Output<String>

Amazon Resource Name (ARN) of the AWS SSM Contact that the contact channel belongs to.

Link copied to clipboard

Block that contains contact engagement details. See details below.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val name: Output<String>

Name of the contact channel. Must be between 1 and 255 characters, and may contain alphanumerics, underscores (_), hyphens (-), periods (.), and spaces.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val type: Output<String>

Type of the contact channel. One of SMS, VOICE or EMAIL.

Link copied to clipboard
val urn: Output<String>