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

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

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.ssmcontacts.ContactChannel

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::SSMContacts::ContactChannel

    Create ContactChannel Resource

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

    Constructor syntax

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

@overload
def ContactChannel(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   channel_address: Optional[str] = None,
                   channel_name: Optional[str] = None,
                   channel_type: Optional[ContactChannelChannelType] = None,
                   contact_id: Optional[str] = None,
                   defer_activation: Optional[bool] = None)
    func NewContactChannel(ctx *Context, name string, args *ContactChannelArgs, opts ...ResourceOption) (*ContactChannel, error)
    public ContactChannel(string name, ContactChannelArgs? args = null, CustomResourceOptions? opts = null)
    public ContactChannel(String name, ContactChannelArgs args)
public ContactChannel(String name, ContactChannelArgs args, CustomResourceOptions options)

    type: aws-native:ssmcontacts:ContactChannel
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 ContactChannelArgs
    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 ContactChannelArgs
    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 ContactChannelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ContactChannelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ContactChannelArgs
    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 contactChannelResource = new aws_native.ssmcontacts.ContactChannel("contactChannelResource", {
    channelAddress: "string",
    channelName: "string",
    channelType: aws_native.ssmcontacts.ContactChannelChannelType.Sms,
    contactId: "string",
    deferActivation: false,
});

    Coming soon!

    ContactChannel 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 ContactChannel resource accepts the following input properties:

    ChannelAddress string
    The details that SSM Incident Manager uses when trying to engage the contact channel.
    ChannelName string
    The device name. String of 6 to 50 alphabetical, numeric, dash, and underscore characters.
    ChannelType Pulumi.AwsNative.SsmContacts.ContactChannelChannelType
    Device type, which specify notification channel. Currently supported values: "SMS", "VOICE", "EMAIL", "CHATBOT.
    ContactId string
    ARN of the contact resource
    DeferActivation bool
    If you want to activate the channel at a later time, you can choose to defer activation. SSM Incident Manager can't engage your contact channel until it has been activated.
    ChannelAddress string
    The details that SSM Incident Manager uses when trying to engage the contact channel.
    ChannelName string
    The device name. String of 6 to 50 alphabetical, numeric, dash, and underscore characters.
    ChannelType ContactChannelChannelType
    Device type, which specify notification channel. Currently supported values: "SMS", "VOICE", "EMAIL", "CHATBOT.
    ContactId string
    ARN of the contact resource
    DeferActivation bool
    If you want to activate the channel at a later time, you can choose to defer activation. SSM Incident Manager can't engage your contact channel until it has been activated.
    channelAddress String
    The details that SSM Incident Manager uses when trying to engage the contact channel.
    channelName String
    The device name. String of 6 to 50 alphabetical, numeric, dash, and underscore characters.
    channelType ContactChannelChannelType
    Device type, which specify notification channel. Currently supported values: "SMS", "VOICE", "EMAIL", "CHATBOT.
    contactId String
    ARN of the contact resource
    deferActivation Boolean
    If you want to activate the channel at a later time, you can choose to defer activation. SSM Incident Manager can't engage your contact channel until it has been activated.
    channelAddress string
    The details that SSM Incident Manager uses when trying to engage the contact channel.
    channelName string
    The device name. String of 6 to 50 alphabetical, numeric, dash, and underscore characters.
    channelType ContactChannelChannelType
    Device type, which specify notification channel. Currently supported values: "SMS", "VOICE", "EMAIL", "CHATBOT.
    contactId string
    ARN of the contact resource
    deferActivation boolean
    If you want to activate the channel at a later time, you can choose to defer activation. SSM Incident Manager can't engage your contact channel until it has been activated.
    channel_address str
    The details that SSM Incident Manager uses when trying to engage the contact channel.
    channel_name str
    The device name. String of 6 to 50 alphabetical, numeric, dash, and underscore characters.
    channel_type ContactChannelChannelType
    Device type, which specify notification channel. Currently supported values: "SMS", "VOICE", "EMAIL", "CHATBOT.
    contact_id str
    ARN of the contact resource
    defer_activation bool
    If you want to activate the channel at a later time, you can choose to defer activation. SSM Incident Manager can't engage your contact channel until it has been activated.
    channelAddress String
    The details that SSM Incident Manager uses when trying to engage the contact channel.
    channelName String
    The device name. String of 6 to 50 alphabetical, numeric, dash, and underscore characters.
    channelType "SMS" | "VOICE" | "EMAIL"
    Device type, which specify notification channel. Currently supported values: "SMS", "VOICE", "EMAIL", "CHATBOT.
    contactId String
    ARN of the contact resource
    deferActivation Boolean
    If you want to activate the channel at a later time, you can choose to defer activation. SSM Incident Manager can't engage your contact channel until it has been activated.

    Outputs

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

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

    Supporting Types

    ContactChannelChannelType, ContactChannelChannelTypeArgs

    Sms
    SMS
    Voice
    VOICE
    Email
    EMAIL
    ContactChannelChannelTypeSms
    SMS
    ContactChannelChannelTypeVoice
    VOICE
    ContactChannelChannelTypeEmail
    EMAIL
    Sms
    SMS
    Voice
    VOICE
    Email
    EMAIL
    Sms
    SMS
    Voice
    VOICE
    Email
    EMAIL
    SMS
    SMS
    VOICE
    VOICE
    EMAIL
    EMAIL
    "SMS"
    SMS
    "VOICE"
    VOICE
    "EMAIL"
    EMAIL

    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.103.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-aws-native