@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
256 lines (255 loc) • 11.9 kB
TypeScript
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<pulumi.ID>, 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<string>;
/**
* By default this is set to `false`. When set to true the phone number can’t be deleted.
*/
readonly deletionProtectionEnabled: pulumi.Output<boolean>;
/**
* The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*/
readonly isoCountryCode: pulumi.Output<string>;
/**
* The 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<string>;
/**
* The monthly price, in US dollars, to lease the phone number.
*/
readonly monthlyLeasingPrice: pulumi.Output<string>;
/**
* Describes if the origination identity can be used for text messages, voice calls or both. valid values are `SMS` and `VOICE`.
*/
readonly numberCapabilities: pulumi.Output<string[]>;
/**
* The type of phone number to request. Possible values are `LONG_CODE`, `TOLL_FREE`, `TEN_DLC`, or `SIMULATOR`.
*/
readonly numberType: pulumi.Output<string>;
/**
* The name of the opt-out list to associate with the phone number.
*/
readonly optOutListName: pulumi.Output<string>;
/**
* The new phone number that was requested.
*/
readonly phoneNumber: 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>;
/**
* Use this field to attach your phone number for an external registration process.
*/
readonly registrationId: pulumi.Output<string | undefined>;
/**
* 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<boolean>;
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;
}>;
readonly timeouts: pulumi.Output<outputs.pinpoint.Smsvoicev2PhoneNumberTimeouts | undefined>;
/**
* 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<string | undefined>;
/**
* By default this is set to `false`. When set to `true` you can receive incoming text messages from your end recipients.
*/
readonly twoWayChannelEnabled: pulumi.Output<boolean>;
/**
* IAM Role ARN for a service to assume, to be able to post inbound SMS messages.
*/
readonly twoWayChannelRole: pulumi.Output<string | undefined>;
/**
* 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<string>;
/**
* By default this is set to `false`. When set to true the phone number can’t be deleted.
*/
deletionProtectionEnabled?: pulumi.Input<boolean>;
/**
* The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*/
isoCountryCode?: pulumi.Input<string>;
/**
* The 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<string>;
/**
* The monthly price, in US dollars, to lease the phone number.
*/
monthlyLeasingPrice?: pulumi.Input<string>;
/**
* Describes if the origination identity can be used for text messages, voice calls or both. valid values are `SMS` and `VOICE`.
*/
numberCapabilities?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The type of phone number to request. Possible values are `LONG_CODE`, `TOLL_FREE`, `TEN_DLC`, or `SIMULATOR`.
*/
numberType?: pulumi.Input<string>;
/**
* The name of the opt-out list to associate with the phone number.
*/
optOutListName?: pulumi.Input<string>;
/**
* The new phone number that was requested.
*/
phoneNumber?: 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>;
/**
* Use this field to attach your phone number for an external registration process.
*/
registrationId?: pulumi.Input<string>;
/**
* 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<boolean>;
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>;
}>;
timeouts?: pulumi.Input<inputs.pinpoint.Smsvoicev2PhoneNumberTimeouts>;
/**
* 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<string>;
/**
* By default this is set to `false`. When set to `true` you can receive incoming text messages from your end recipients.
*/
twoWayChannelEnabled?: pulumi.Input<boolean>;
/**
* IAM Role ARN for a service to assume, to be able to post inbound SMS messages.
*/
twoWayChannelRole?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Smsvoicev2PhoneNumber resource.
*/
export interface Smsvoicev2PhoneNumberArgs {
/**
* By default this is set to `false`. When set to true the phone number can’t be deleted.
*/
deletionProtectionEnabled?: pulumi.Input<boolean>;
/**
* The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
*/
isoCountryCode: pulumi.Input<string>;
/**
* The 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<string>;
/**
* Describes if the origination identity can be used for text messages, voice calls or both. valid values are `SMS` and `VOICE`.
*/
numberCapabilities: pulumi.Input<pulumi.Input<string>[]>;
/**
* The type of phone number to request. Possible values are `LONG_CODE`, `TOLL_FREE`, `TEN_DLC`, or `SIMULATOR`.
*/
numberType: pulumi.Input<string>;
/**
* The name of the opt-out list to associate with the phone number.
*/
optOutListName?: 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>;
/**
* Use this field to attach your phone number for an external registration process.
*/
registrationId?: pulumi.Input<string>;
/**
* 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<boolean>;
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
timeouts?: pulumi.Input<inputs.pinpoint.Smsvoicev2PhoneNumberTimeouts>;
/**
* 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<string>;
/**
* By default this is set to `false`. When set to `true` you can receive incoming text messages from your end recipients.
*/
twoWayChannelEnabled?: pulumi.Input<boolean>;
/**
* IAM Role ARN for a service to assume, to be able to post inbound SMS messages.
*/
twoWayChannelRole?: pulumi.Input<string>;
}