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 phone number. * * ## Example 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: "TOLL_FREE", * numberCapabilities: ["SMS"], * }); * ``` * * ## Import * * Using `pulumi import`, import phone numbers using the `id`. For example: * * ```sh * $ pulumi import aws:pinpoint/smsvoicev2PhoneNumber:Smsvoicev2PhoneNumber example phone-abcdef0123456789abcdef0123456789 * ``` */ export declare class Smsvoicev2PhoneNumber extends pulumi.CustomResource { /** * Get an existing Smsvoicev2PhoneNumber 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?: Smsvoicev2PhoneNumberState, opts?: pulumi.CustomResourceOptions): Smsvoicev2PhoneNumber; /** * Returns true if the given object is an instance of Smsvoicev2PhoneNumber. 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 Smsvoicev2PhoneNumber; /** * ARN of the phone number. */ readonly arn: pulumi.Output; /** * Whether deletion protection is enabled. When `true`, the phone number cannot be deleted. */ readonly deletionProtectionEnabled: pulumi.Output; /** * Whether to disassociate the phone number from any pool it is associated with before destroying it. */ readonly forceDisassociate: pulumi.Output; /** * Two-character code, in ISO 3166-1 alpha-2 format, for the country or region. */ readonly isoCountryCode: pulumi.Output; /** * Type of message. Valid values are `TRANSACTIONAL` for messages that are critical or time-sensitive and `PROMOTIONAL` for messages that aren’t critical or time-sensitive. */ readonly messageType: pulumi.Output; /** * Monthly price, in US dollars, to lease the phone number. */ readonly monthlyLeasingPrice: pulumi.Output; /** * Whether the origination identity can be used for text messages, voice calls or both. Valid values are `SMS` and `VOICE`. */ readonly numberCapabilities: pulumi.Output; /** * Type of phone number to request. Possible values are `LONG_CODE`, `TOLL_FREE`, `TEN_DLC`, or `SIMULATOR`. * * The following arguments are optional: */ readonly numberType: pulumi.Output; /** * Name of the opt-out list to associate with the phone number. If omitted, AWS assigns the `Default` opt-out list. */ readonly optOutListName: pulumi.Output; /** * New phone number that was requested. */ readonly phoneNumber: pulumi.Output; /** * 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; /** * Use this field to attach your phone number for an external registration process. */ readonly registrationId: pulumi.Output; /** * When set to `false` an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the opt-out list. When set to true you’re responsible for responding to HELP and STOP requests. You’re also responsible for tracking and honoring opt-out request. */ readonly selfManagedOptOutsEnabled: pulumi.Output; /** * Status of the phone number. Possible values are `PENDING`, `ACTIVE`, `ASSOCIATING`, `DISASSOCIATING`, and `DELETED`. */ readonly status: pulumi.Output; /** * 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>; /** * 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; /** * Configuration for two-way SMS. Specify an ARN to receive incoming SMS 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; /** * Whether two-way messaging is enabled. When `true`, you can receive incoming text messages from your end recipients. If omitted, AWS sets this to `false`. */ readonly twoWayChannelEnabled: pulumi.Output; /** * IAM Role ARN for a service to assume, to be able to post inbound SMS messages. */ readonly twoWayChannelRole: pulumi.Output; /** * Whether to wait for the phone number to reach `ACTIVE` status before considering the resource created or updated. Defaults to `true`. Set to `false` for number types gated on carrier or registration approval (for example, `TEN_DLC`, `TOLL_FREE`, or any number submitted with `registrationId`), which can remain `PENDING` for days or weeks. When `false`, `pulumi up` returns once AWS accepts the phone number request; track activation with the `status` attribute. */ readonly waitForActive: pulumi.Output; /** * Create a Smsvoicev2PhoneNumber 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: Smsvoicev2PhoneNumberArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Smsvoicev2PhoneNumber resources. */ export interface Smsvoicev2PhoneNumberState { /** * ARN of the phone number. */ arn?: pulumi.Input; /** * Whether deletion protection is enabled. When `true`, the phone number cannot be deleted. */ deletionProtectionEnabled?: pulumi.Input; /** * Whether to disassociate the phone number from any pool it is associated with before destroying it. */ forceDisassociate?: pulumi.Input; /** * Two-character code, in ISO 3166-1 alpha-2 format, for the country or region. */ isoCountryCode?: pulumi.Input; /** * Type of message. Valid values are `TRANSACTIONAL` for messages that are critical or time-sensitive and `PROMOTIONAL` for messages that aren’t critical or time-sensitive. */ messageType?: pulumi.Input; /** * Monthly price, in US dollars, to lease the phone number. */ monthlyLeasingPrice?: pulumi.Input; /** * Whether the origination identity can be used for text messages, voice calls or both. Valid values are `SMS` and `VOICE`. */ numberCapabilities?: pulumi.Input[] | undefined>; /** * Type of phone number to request. Possible values are `LONG_CODE`, `TOLL_FREE`, `TEN_DLC`, or `SIMULATOR`. * * The following arguments are optional: */ numberType?: pulumi.Input; /** * Name of the opt-out list to associate with the phone number. If omitted, AWS assigns the `Default` opt-out list. */ optOutListName?: pulumi.Input; /** * New phone number that was requested. */ phoneNumber?: pulumi.Input; /** * 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; /** * Use this field to attach your phone number for an external registration process. */ registrationId?: pulumi.Input; /** * When set to `false` an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the opt-out list. When set to true you’re responsible for responding to HELP and STOP requests. You’re also responsible for tracking and honoring opt-out request. */ selfManagedOptOutsEnabled?: pulumi.Input; /** * Status of the phone number. Possible values are `PENDING`, `ACTIVE`, `ASSOCIATING`, `DISASSOCIATING`, and `DELETED`. */ status?: pulumi.Input; /** * 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; } | 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; /** * Configuration for two-way SMS. Specify an ARN to receive incoming SMS 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; /** * Whether two-way messaging is enabled. When `true`, you can receive incoming text messages from your end recipients. If omitted, AWS sets this to `false`. */ twoWayChannelEnabled?: pulumi.Input; /** * IAM Role ARN for a service to assume, to be able to post inbound SMS messages. */ twoWayChannelRole?: pulumi.Input; /** * Whether to wait for the phone number to reach `ACTIVE` status before considering the resource created or updated. Defaults to `true`. Set to `false` for number types gated on carrier or registration approval (for example, `TEN_DLC`, `TOLL_FREE`, or any number submitted with `registrationId`), which can remain `PENDING` for days or weeks. When `false`, `pulumi up` returns once AWS accepts the phone number request; track activation with the `status` attribute. */ waitForActive?: pulumi.Input; } /** * The set of arguments for constructing a Smsvoicev2PhoneNumber resource. */ export interface Smsvoicev2PhoneNumberArgs { /** * Whether deletion protection is enabled. When `true`, the phone number cannot be deleted. */ deletionProtectionEnabled?: pulumi.Input; /** * Whether to disassociate the phone number from any pool it is associated with before destroying it. */ forceDisassociate?: pulumi.Input; /** * Two-character code, in ISO 3166-1 alpha-2 format, for the country or region. */ isoCountryCode: pulumi.Input; /** * Type of message. Valid values are `TRANSACTIONAL` for messages that are critical or time-sensitive and `PROMOTIONAL` for messages that aren’t critical or time-sensitive. */ messageType: pulumi.Input; /** * Whether the origination identity can be used for text messages, voice calls or both. Valid values are `SMS` and `VOICE`. */ numberCapabilities: pulumi.Input[]>; /** * Type of phone number to request. Possible values are `LONG_CODE`, `TOLL_FREE`, `TEN_DLC`, or `SIMULATOR`. * * The following arguments are optional: */ numberType: pulumi.Input; /** * Name of the opt-out list to associate with the phone number. If omitted, AWS assigns the `Default` opt-out list. */ optOutListName?: pulumi.Input; /** * 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; /** * Use this field to attach your phone number for an external registration process. */ registrationId?: pulumi.Input; /** * When set to `false` an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the opt-out list. When set to true you’re responsible for responding to HELP and STOP requests. You’re also responsible for tracking and honoring opt-out request. */ selfManagedOptOutsEnabled?: pulumi.Input; /** * 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; } | undefined>; timeouts?: pulumi.Input; /** * Configuration for two-way SMS. Specify an ARN to receive incoming SMS 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; /** * Whether two-way messaging is enabled. When `true`, you can receive incoming text messages from your end recipients. If omitted, AWS sets this to `false`. */ twoWayChannelEnabled?: pulumi.Input; /** * IAM Role ARN for a service to assume, to be able to post inbound SMS messages. */ twoWayChannelRole?: pulumi.Input; /** * Whether to wait for the phone number to reach `ACTIVE` status before considering the resource created or updated. Defaults to `true`. Set to `false` for number types gated on carrier or registration approval (for example, `TEN_DLC`, `TOLL_FREE`, or any number submitted with `registrationId`), which can remain `PENDING` for days or weeks. When `false`, `pulumi up` returns once AWS accepts the phone number request; track activation with the `status` attribute. */ waitForActive?: pulumi.Input; } //# sourceMappingURL=smsvoicev2PhoneNumber.d.ts.map