UNPKG

@pulumi/aws

Version:

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

103 lines (102 loc) 2.91 kB
import * as pulumi from "@pulumi/pulumi"; /** * Data source for managing an AWS SSM Contact. * * ## Example Usage * * ### Basic Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = aws.ssmcontacts.getContact({ * arn: "arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias", * }); * ``` */ export declare function getContact(args: GetContactArgs, opts?: pulumi.InvokeOptions): Promise<GetContactResult>; /** * A collection of arguments for invoking getContact. */ export interface GetContactArgs { /** * The Amazon Resource Name (ARN) of the contact or escalation plan. */ 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; /** * Map of tags to assign to the resource. */ tags?: { [key: string]: string; }; } /** * A collection of values returned by getContact. */ export interface GetContactResult { /** * A unique and identifiable alias of the contact or escalation plan. */ readonly alias: string; readonly arn: string; /** * Full friendly name of the contact or escalation plan. */ readonly displayName: string; /** * The provider-assigned unique ID for this managed resource. */ readonly id: string; readonly region: string; /** * Map of tags to assign to the resource. */ readonly tags: { [key: string]: string; }; /** * The type of contact engaged. A single contact is type `PERSONAL` and an escalation plan is type `ESCALATION`. */ readonly type: string; } /** * Data source for managing an AWS SSM Contact. * * ## Example Usage * * ### Basic Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = aws.ssmcontacts.getContact({ * arn: "arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias", * }); * ``` */ export declare function getContactOutput(args: GetContactOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetContactResult>; /** * A collection of arguments for invoking getContact. */ export interface GetContactOutputArgs { /** * The Amazon Resource Name (ARN) of the contact or escalation plan. */ 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>; /** * Map of tags to assign to the resource. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; }