import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Manages an AWS End User Messaging SMS Pool. * * ## Example Usage * * ### Basic Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = new aws.pinpoint.Smsvoicev2PhoneNumber("example", { * isoCountryCode: "US", * messageType: "TRANSACTIONAL", * numberType: "SIMULATOR", * numberCapabilities: ["SMS"], * }); * const exampleSmsvoicev2Pool = new aws.pinpoint.Smsvoicev2Pool("example", { * isoCountryCode: "US", * messageType: "TRANSACTIONAL", * originationIdentities: [example.arn], * tags: { * Name: "example", * }, * }); * ``` * * ### Two-Way Channel * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = new aws.sns.Topic("example", {name: "example-two-way-channel"}); * const exampleRole = new aws.iam.Role("example", { * name: "example-pool-two-way", * assumeRolePolicy: JSON.stringify({ * Version: "2012-10-17", * Statement: [{ * Effect: "Allow", * Principal: { * Service: "sms-voice.amazonaws.com", * }, * Action: "sts:AssumeRole", * }], * }), * }); * const exampleSmsvoicev2PhoneNumber = new aws.pinpoint.Smsvoicev2PhoneNumber("example", { * isoCountryCode: "US", * messageType: "TRANSACTIONAL", * numberType: "SIMULATOR", * numberCapabilities: ["SMS"], * }); * const exampleSmsvoicev2Pool = new aws.pinpoint.Smsvoicev2Pool("example", { * isoCountryCode: "US", * messageType: "TRANSACTIONAL", * originationIdentities: [exampleSmsvoicev2PhoneNumber.arn], * twoWayEnabled: true, * twoWayChannelArn: example.arn, * twoWayChannelRole: exampleRole.arn, * tags: { * Name: "example", * }, * }); * ``` * * ## Import * * > **Note:** `isoCountryCode` is never returned by AWS, so importing a pool with `isoCountryCode` set plans a replacement until removed from config. * * ### Identity Schema * * #### Required * * * `id` - (String) ID of the Pool. * * #### Optional * * * `accountId` (String) AWS Account where this resource is managed. * * `region` (String) Region where this resource is managed. * * Using `pulumi import`, import an AWS End User Messaging SMS Pool using the `id`. For example: * * ```sh * $ pulumi import aws:pinpoint/smsvoicev2Pool:Smsvoicev2Pool example pool-abcdef0123456789abcdef0123456789 * ``` */ export declare class Smsvoicev2Pool extends pulumi.CustomResource { /** * Get an existing Smsvoicev2Pool 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, state?: Smsvoicev2PoolState, opts?: pulumi.CustomResourceOptions): Smsvoicev2Pool; /** * Returns true if the given object is an instance of Smsvoicev2Pool. 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 Smsvoicev2Pool; /** * ARN of the pool. */ readonly arn: pulumi.Output; /** * Whether deletion protection is enabled. When `true`, the pool cannot be deleted. */ readonly deletionProtectionEnabled: pulumi.Output; /** * Two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the pool. Cannot be changed after creation. */ readonly isoCountryCode: pulumi.Output; /** * Type of message. Valid values are `TRANSACTIONAL` and `PROMOTIONAL`. Cannot be changed after creation. */ readonly messageType: pulumi.Output; /** * Name of the opt-out list associated with the pool. */ readonly optOutListName: pulumi.Output; /** * Set of origination identity ARNs (phone number ARNs or sender ID ARNs) associated with the pool. At least one identity is required at creation. * * The following arguments are optional: */ readonly originationIdentities: pulumi.Output; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html#cli-configure-options-region). Defaults to the region set in the provider configuration. */ readonly region: pulumi.Output; /** * Whether the pool relies on self-managed opt-out handling. When `false`, AWS auto-replies to HELP/STOP requests and manages the opt-out list. */ readonly selfManagedOptOutsEnabled: pulumi.Output; /** * Whether shared routes are enabled for the pool. When `true`, messages may use shared phone numbers or sender IDs in countries that allow it. */ readonly sharedRoutesEnabled: pulumi.Output; /** * Map of tags to assign to the resource. 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>; /** * Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ readonly tagsAll: pulumi.Output<{ [key: string]: string; }>; readonly timeouts: pulumi.Output; /** * Destination for incoming messages. Specify an ARN to receive incoming messages, or `connect.[region].amazonaws.com` (with `[region]` replaced by the AWS Region of the Amazon Connect instance) to set Amazon Connect as the inbound destination. */ readonly twoWayChannelArn: pulumi.Output; /** * ARN of the IAM role that End User Messaging SMS assumes to publish inbound messages to the two-way channel. */ readonly twoWayChannelRole: pulumi.Output; /** * Whether inbound message reception is enabled for the pool. When `true`, `twoWayChannelArn` must be set. */ readonly twoWayEnabled: pulumi.Output; /** * Create a Smsvoicev2Pool 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: Smsvoicev2PoolArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Smsvoicev2Pool resources. */ export interface Smsvoicev2PoolState { /** * ARN of the pool. */ arn?: pulumi.Input; /** * Whether deletion protection is enabled. When `true`, the pool cannot be deleted. */ deletionProtectionEnabled?: pulumi.Input; /** * Two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the pool. Cannot be changed after creation. */ isoCountryCode?: pulumi.Input; /** * Type of message. Valid values are `TRANSACTIONAL` and `PROMOTIONAL`. Cannot be changed after creation. */ messageType?: pulumi.Input; /** * Name of the opt-out list associated with the pool. */ optOutListName?: pulumi.Input; /** * Set of origination identity ARNs (phone number ARNs or sender ID ARNs) associated with the pool. At least one identity is required at creation. * * The following arguments are optional: */ originationIdentities?: pulumi.Input[] | undefined>; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html#cli-configure-options-region). Defaults to the region set in the provider configuration. */ region?: pulumi.Input; /** * Whether the pool relies on self-managed opt-out handling. When `false`, AWS auto-replies to HELP/STOP requests and manages the opt-out list. */ selfManagedOptOutsEnabled?: pulumi.Input; /** * Whether shared routes are enabled for the pool. When `true`, messages may use shared phone numbers or sender IDs in countries that allow it. */ sharedRoutesEnabled?: pulumi.Input; /** * Map of tags to assign to the resource. 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; } | undefined>; /** * Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. */ tagsAll?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; timeouts?: pulumi.Input; /** * Destination for incoming messages. Specify an ARN to receive incoming messages, or `connect.[region].amazonaws.com` (with `[region]` replaced by the AWS Region of the Amazon Connect instance) to set Amazon Connect as the inbound destination. */ twoWayChannelArn?: pulumi.Input; /** * ARN of the IAM role that End User Messaging SMS assumes to publish inbound messages to the two-way channel. */ twoWayChannelRole?: pulumi.Input; /** * Whether inbound message reception is enabled for the pool. When `true`, `twoWayChannelArn` must be set. */ twoWayEnabled?: pulumi.Input; } /** * The set of arguments for constructing a Smsvoicev2Pool resource. */ export interface Smsvoicev2PoolArgs { /** * Whether deletion protection is enabled. When `true`, the pool cannot be deleted. */ deletionProtectionEnabled?: pulumi.Input; /** * Two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the pool. Cannot be changed after creation. */ isoCountryCode?: pulumi.Input; /** * Type of message. Valid values are `TRANSACTIONAL` and `PROMOTIONAL`. Cannot be changed after creation. */ messageType: pulumi.Input; /** * Name of the opt-out list associated with the pool. */ optOutListName?: pulumi.Input; /** * Set of origination identity ARNs (phone number ARNs or sender ID ARNs) associated with the pool. At least one identity is required at creation. * * The following arguments are optional: */ originationIdentities: pulumi.Input[]>; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html#cli-configure-options-region). Defaults to the region set in the provider configuration. */ region?: pulumi.Input; /** * Whether the pool relies on self-managed opt-out handling. When `false`, AWS auto-replies to HELP/STOP requests and manages the opt-out list. */ selfManagedOptOutsEnabled?: pulumi.Input; /** * Whether shared routes are enabled for the pool. When `true`, messages may use shared phone numbers or sender IDs in countries that allow it. */ sharedRoutesEnabled?: pulumi.Input; /** * Map of tags to assign to the resource. 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; } | undefined>; timeouts?: pulumi.Input; /** * Destination for incoming messages. Specify an ARN to receive incoming messages, or `connect.[region].amazonaws.com` (with `[region]` replaced by the AWS Region of the Amazon Connect instance) to set Amazon Connect as the inbound destination. */ twoWayChannelArn?: pulumi.Input; /** * ARN of the IAM role that End User Messaging SMS assumes to publish inbound messages to the two-way channel. */ twoWayChannelRole?: pulumi.Input; /** * Whether inbound message reception is enabled for the pool. When `true`, `twoWayChannelArn` must be set. */ twoWayEnabled?: pulumi.Input; } //# sourceMappingURL=smsvoicev2Pool.d.ts.map