@pulumi/aws-native/smsvoice/phoneNumber.d.ts

The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
 * Resource Type definition for AWS::SMSVOICE::PhoneNumber
 */
export declare class PhoneNumber extends pulumi.CustomResource {
    /**
     * Get an existing PhoneNumber 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 opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): PhoneNumber;
    /**
     * Returns true if the given object is an instance of PhoneNumber.  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 PhoneNumber;
    /**
     * The `PhoneNumber` 's Amazon Resource Name (ARN)
     */
    readonly arn: pulumi.Output<string>;
    /**
     * When set to true the sender ID can't be deleted. By default this is set to false.
     */
    readonly deletionProtectionEnabled: pulumi.Output<boolean | undefined>;
    /**
     * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
     */
    readonly isoCountryCode: pulumi.Output<string>;
    /**
     * A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message. Keywords "HELP" and "STOP" are mandatory keywords
     */
    readonly mandatoryKeywords: pulumi.Output<outputs.smsvoice.MandatoryKeywordsProperties>;
    /**
     * Indicates if the phone number will be used for text messages, voice messages, or both.
     */
    readonly numberCapabilities: pulumi.Output<enums.smsvoice.PhoneNumberNumberCapabilitiesItem[]>;
    /**
     * The type of phone number to request.
     */
    readonly numberType: pulumi.Output<enums.smsvoice.PhoneNumberNumberType>;
    /**
     * The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
     */
    readonly optOutListName: pulumi.Output<string | undefined>;
    /**
     * A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message.
     */
    readonly optionalKeywords: pulumi.Output<outputs.smsvoice.PhoneNumberOptionalKeyword[] | undefined>;
    /**
     * The phone number in E.164 format.
     */
    readonly phoneNumber: pulumi.Output<string>;
    /**
     * The unique identifier for the phone number.
     */
    readonly phoneNumberId: pulumi.Output<string>;
    /**
     * By default this is set to false. When 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 OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
     */
    readonly selfManagedOptOutsEnabled: pulumi.Output<boolean | undefined>;
    /**
     * An array of key-value pairs to apply to this resource.
     */
    readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
    /**
     * When you set up two-way SMS, you can receive incoming messages from your customers. When one of your customers sends a message to your phone number, the message body is sent to an Amazon SNS topic or Amazon Connect for processing.
     */
    readonly twoWay: pulumi.Output<outputs.smsvoice.TwoWayProperties | undefined>;
    /**
     * Create a PhoneNumber 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: PhoneNumberArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * The set of arguments for constructing a PhoneNumber resource.
 */
export interface PhoneNumberArgs {
    /**
     * When set to true the sender ID can't be deleted. By default this is set to false.
     */
    deletionProtectionEnabled?: pulumi.Input<boolean>;
    /**
     * The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
     */
    isoCountryCode: pulumi.Input<string>;
    /**
     * A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message. Keywords "HELP" and "STOP" are mandatory keywords
     */
    mandatoryKeywords: pulumi.Input<inputs.smsvoice.MandatoryKeywordsPropertiesArgs>;
    /**
     * Indicates if the phone number will be used for text messages, voice messages, or both.
     */
    numberCapabilities: pulumi.Input<pulumi.Input<enums.smsvoice.PhoneNumberNumberCapabilitiesItem>[]>;
    /**
     * The type of phone number to request.
     */
    numberType: pulumi.Input<enums.smsvoice.PhoneNumberNumberType>;
    /**
     * The name of the OptOutList to associate with the phone number. You can use the OptOutListName or OptOutListArn.
     */
    optOutListName?: pulumi.Input<string>;
    /**
     * A keyword is a word that you can search for on a particular phone number or pool. It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, AWS End User Messaging SMS and Voice responds with a customizable message.
     */
    optionalKeywords?: pulumi.Input<pulumi.Input<inputs.smsvoice.PhoneNumberOptionalKeywordArgs>[]>;
    /**
     * By default this is set to false. When 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 OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
     */
    selfManagedOptOutsEnabled?: pulumi.Input<boolean>;
    /**
     * An array of key-value pairs to apply to this resource.
     */
    tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
    /**
     * When you set up two-way SMS, you can receive incoming messages from your customers. When one of your customers sends a message to your phone number, the message body is sent to an Amazon SNS topic or Amazon Connect for processing.
     */
    twoWay?: pulumi.Input<inputs.smsvoice.TwoWayPropertiesArgs>;
}