UNPKG

@pulumi/aws

Version:

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

94 lines (93 loc) 2.85 kB
import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../types/output"; /** * Data source for managing an AWS SSM Contacts Contact Channel. * * ## Example Usage * * ### Basic Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = aws.ssmcontacts.getContactChannel({ * arn: "arn:aws:ssm-contacts:us-west-2:123456789012:contact-channel/example", * }); * ``` */ export declare function getContactChannel(args: GetContactChannelArgs, opts?: pulumi.InvokeOptions): Promise<GetContactChannelResult>; /** * A collection of arguments for invoking getContactChannel. */ export interface GetContactChannelArgs { /** * Amazon Resource Name (ARN) of the contact channel. */ arn: string; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: string; } /** * A collection of values returned by getContactChannel. */ export interface GetContactChannelResult { /** * Whether the contact channel is activated. */ readonly activationStatus: string; readonly arn: string; /** * Amazon Resource Name (ARN) of the AWS SSM Contact that the contact channel belongs to. */ readonly contactId: string; /** * Details used to engage the contact channel. */ readonly deliveryAddresses: outputs.ssmcontacts.GetContactChannelDeliveryAddress[]; /** * The provider-assigned unique ID for this managed resource. */ readonly id: string; /** * Name of the contact channel. */ readonly name: string; readonly region: string; /** * Type of the contact channel. */ readonly type: string; } /** * Data source for managing an AWS SSM Contacts Contact Channel. * * ## Example Usage * * ### Basic Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = aws.ssmcontacts.getContactChannel({ * arn: "arn:aws:ssm-contacts:us-west-2:123456789012:contact-channel/example", * }); * ``` */ export declare function getContactChannelOutput(args: GetContactChannelOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetContactChannelResult>; /** * A collection of arguments for invoking getContactChannel. */ export interface GetContactChannelOutputArgs { /** * Amazon Resource Name (ARN) of the contact channel. */ arn: pulumi.Input<string>; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input<string>; }