Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. connect
  5. PhoneNumber

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.connect.PhoneNumber

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Connect::PhoneNumber

    Create PhoneNumber Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PhoneNumber(name: string, args: PhoneNumberArgs, opts?: CustomResourceOptions);
    @overload
def PhoneNumber(resource_name: str,
                args: PhoneNumberArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def PhoneNumber(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                target_arn: Optional[str] = None,
                country_code: Optional[str] = None,
                description: Optional[str] = None,
                prefix: Optional[str] = None,
                source_phone_number_arn: Optional[str] = None,
                tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                type: Optional[str] = None)
    func NewPhoneNumber(ctx *Context, name string, args PhoneNumberArgs, opts ...ResourceOption) (*PhoneNumber, error)
    public PhoneNumber(string name, PhoneNumberArgs args, CustomResourceOptions? opts = null)
    public PhoneNumber(String name, PhoneNumberArgs args)
public PhoneNumber(String name, PhoneNumberArgs args, CustomResourceOptions options)

    type: aws-native:connect:PhoneNumber
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PhoneNumberArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PhoneNumberArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PhoneNumberArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PhoneNumberArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PhoneNumberArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    PhoneNumber Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PhoneNumber resource accepts the following input properties:

    TargetArn string
    The ARN of the target the phone number is claimed to.
    CountryCode string
    The phone number country code.
    Description string
    The description of the phone number.
    Prefix string
    The phone number prefix.
    SourcePhoneNumberArn string
    The source phone number arn.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    One or more tags.
    Type string
    The phone number type
    TargetArn string
    The ARN of the target the phone number is claimed to.
    CountryCode string
    The phone number country code.
    Description string
    The description of the phone number.
    Prefix string
    The phone number prefix.
    SourcePhoneNumberArn string
    The source phone number arn.
    Tags TagArgs
    One or more tags.
    Type string
    The phone number type
    targetArn String
    The ARN of the target the phone number is claimed to.
    countryCode String
    The phone number country code.
    description String
    The description of the phone number.
    prefix String
    The phone number prefix.
    sourcePhoneNumberArn String
    The source phone number arn.
    tags List<Tag>
    One or more tags.
    type String
    The phone number type
    targetArn string
    The ARN of the target the phone number is claimed to.
    countryCode string
    The phone number country code.
    description string
    The description of the phone number.
    prefix string
    The phone number prefix.
    sourcePhoneNumberArn string
    The source phone number arn.
    tags Tag[]
    One or more tags.
    type string
    The phone number type
    target_arn str
    The ARN of the target the phone number is claimed to.
    country_code str
    The phone number country code.
    description str
    The description of the phone number.
    prefix str
    The phone number prefix.
    source_phone_number_arn str
    The source phone number arn.
    tags Sequence[TagArgs]
    One or more tags.
    type str
    The phone number type
    targetArn String
    The ARN of the target the phone number is claimed to.
    countryCode String
    The phone number country code.
    description String
    The description of the phone number.
    prefix String
    The phone number prefix.
    sourcePhoneNumberArn String
    The source phone number arn.
    tags List<Property Map>
    One or more tags.
    type String
    The phone number type

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PhoneNumber resource produces the following output properties:

    Address string
    The phone number e164 address.
    Id string
    The provider-assigned unique ID for this managed resource.
    PhoneNumberArn string
    The phone number ARN
    Address string
    The phone number e164 address.
    Id string
    The provider-assigned unique ID for this managed resource.
    PhoneNumberArn string
    The phone number ARN
    address String
    The phone number e164 address.
    id String
    The provider-assigned unique ID for this managed resource.
    phoneNumberArn String
    The phone number ARN
    address string
    The phone number e164 address.
    id string
    The provider-assigned unique ID for this managed resource.
    phoneNumberArn string
    The phone number ARN
    address str
    The phone number e164 address.
    id str
    The provider-assigned unique ID for this managed resource.
    phone_number_arn str
    The phone number ARN
    address String
    The phone number e164 address.
    id String
    The provider-assigned unique ID for this managed resource.
    phoneNumberArn String
    The phone number ARN

    Supporting Types

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
    pulumi/pulumi-aws-native