UNPKG

@pulumi/aws

Version:

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

119 lines (118 loc) 4.68 kB
import * as pulumi from "@pulumi/pulumi"; /** * Manages an AWS End User Messaging SMS opt-out list. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = new aws.pinpoint.Smsvoicev2OptOutList("example", {name: "example-opt-out-list"}); * ``` * * ## Import * * Using `pulumi import`, import opt-out lists using the `name`. For example: * * ```sh * $ pulumi import aws:pinpoint/smsvoicev2OptOutList:Smsvoicev2OptOutList example example-opt-out-list * ``` */ export declare class Smsvoicev2OptOutList extends pulumi.CustomResource { /** * Get an existing Smsvoicev2OptOutList resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input<pulumi.ID>, state?: Smsvoicev2OptOutListState, opts?: pulumi.CustomResourceOptions): Smsvoicev2OptOutList; /** * Returns true if the given object is an instance of Smsvoicev2OptOutList. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Smsvoicev2OptOutList; /** * ARN of the opt-out list. */ readonly arn: pulumi.Output<string>; /** * The name of the opt-out list. */ readonly name: pulumi.Output<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. */ readonly region: pulumi.Output<string>; /** * Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ readonly tags: pulumi.Output<{ [key: string]: string; } | undefined>; /** * A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ readonly tagsAll: pulumi.Output<{ [key: string]: string; }>; /** * Create a Smsvoicev2OptOutList resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args?: Smsvoicev2OptOutListArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Smsvoicev2OptOutList resources. */ export interface Smsvoicev2OptOutListState { /** * ARN of the opt-out list. */ arn?: pulumi.Input<string>; /** * The name of the opt-out list. */ name?: 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>; /** * Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; /** * A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ tagsAll?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; } /** * The set of arguments for constructing a Smsvoicev2OptOutList resource. */ export interface Smsvoicev2OptOutListArgs { /** * The name of the opt-out list. */ name?: 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>; /** * Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. */ tags?: pulumi.Input<{ [key: string]: pulumi.Input<string>; }>; }