Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. connect
  5. PhoneNumber

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

aws.connect.PhoneNumber

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

    Provides an Amazon Connect Phone Number resource. For more information see Amazon Connect: Getting Started

    Example Usage

    Basic

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.connect.PhoneNumber("example", {
    targetArn: exampleAwsConnectInstance.arn,
    countryCode: "US",
    type: "DID",
    tags: {
        hello: "world",
    },
});

    import pulumi
import pulumi_aws as aws

example = aws.connect.PhoneNumber("example",
    target_arn=example_aws_connect_instance["arn"],
    country_code="US",
    type="DID",
    tags={
        "hello": "world",
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.NewPhoneNumber(ctx, "example", &connect.PhoneNumberArgs{
			TargetArn:   pulumi.Any(exampleAwsConnectInstance.Arn),
			CountryCode: pulumi.String("US"),
			Type:        pulumi.String("DID"),
			Tags: pulumi.StringMap{
				"hello": pulumi.String("world"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Connect.PhoneNumber("example", new()
    {
        TargetArn = exampleAwsConnectInstance.Arn,
        CountryCode = "US",
        Type = "DID",
        Tags = 
        {
            { "hello", "world" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.PhoneNumber;
import com.pulumi.aws.connect.PhoneNumberArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new PhoneNumber("example", PhoneNumberArgs.builder()
            .targetArn(exampleAwsConnectInstance.arn())
            .countryCode("US")
            .type("DID")
            .tags(Map.of("hello", "world"))
            .build());

    }
}

    resources:
  example:
    type: aws:connect:PhoneNumber
    properties:
      targetArn: ${exampleAwsConnectInstance.arn}
      countryCode: US
      type: DID
      tags:
        hello: world

    Description

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.connect.PhoneNumber("example", {
    targetArn: exampleAwsConnectInstance.arn,
    countryCode: "US",
    type: "DID",
    description: "example description",
});

    import pulumi
import pulumi_aws as aws

example = aws.connect.PhoneNumber("example",
    target_arn=example_aws_connect_instance["arn"],
    country_code="US",
    type="DID",
    description="example description")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.NewPhoneNumber(ctx, "example", &connect.PhoneNumberArgs{
			TargetArn:   pulumi.Any(exampleAwsConnectInstance.Arn),
			CountryCode: pulumi.String("US"),
			Type:        pulumi.String("DID"),
			Description: pulumi.String("example description"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Connect.PhoneNumber("example", new()
    {
        TargetArn = exampleAwsConnectInstance.Arn,
        CountryCode = "US",
        Type = "DID",
        Description = "example description",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.PhoneNumber;
import com.pulumi.aws.connect.PhoneNumberArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new PhoneNumber("example", PhoneNumberArgs.builder()
            .targetArn(exampleAwsConnectInstance.arn())
            .countryCode("US")
            .type("DID")
            .description("example description")
            .build());

    }
}

    resources:
  example:
    type: aws:connect:PhoneNumber
    properties:
      targetArn: ${exampleAwsConnectInstance.arn}
      countryCode: US
      type: DID
      description: example description

    Prefix to filter phone numbers

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.connect.PhoneNumber("example", {
    targetArn: exampleAwsConnectInstance.arn,
    countryCode: "US",
    type: "DID",
    prefix: "+18005",
});

    import pulumi
import pulumi_aws as aws

example = aws.connect.PhoneNumber("example",
    target_arn=example_aws_connect_instance["arn"],
    country_code="US",
    type="DID",
    prefix="+18005")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.NewPhoneNumber(ctx, "example", &connect.PhoneNumberArgs{
			TargetArn:   pulumi.Any(exampleAwsConnectInstance.Arn),
			CountryCode: pulumi.String("US"),
			Type:        pulumi.String("DID"),
			Prefix:      pulumi.String("+18005"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Connect.PhoneNumber("example", new()
    {
        TargetArn = exampleAwsConnectInstance.Arn,
        CountryCode = "US",
        Type = "DID",
        Prefix = "+18005",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.PhoneNumber;
import com.pulumi.aws.connect.PhoneNumberArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new PhoneNumber("example", PhoneNumberArgs.builder()
            .targetArn(exampleAwsConnectInstance.arn())
            .countryCode("US")
            .type("DID")
            .prefix("+18005")
            .build());

    }
}

    resources:
  example:
    type: aws:connect:PhoneNumber
    properties:
      targetArn: ${exampleAwsConnectInstance.arn}
      countryCode: US
      type: DID
      prefix: '+18005'

    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,
                country_code: Optional[str] = None,
                target_arn: Optional[str] = None,
                type: Optional[str] = None,
                description: Optional[str] = None,
                prefix: Optional[str] = None,
                tags: Optional[Mapping[str, 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: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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var phoneNumberResource = new Aws.Connect.PhoneNumber("phoneNumberResource", new()
{
    CountryCode = "string",
    TargetArn = "string",
    Type = "string",
    Description = "string",
    Prefix = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := connect.NewPhoneNumber(ctx, "phoneNumberResource", &connect.PhoneNumberArgs{
	CountryCode: pulumi.String("string"),
	TargetArn:   pulumi.String("string"),
	Type:        pulumi.String("string"),
	Description: pulumi.String("string"),
	Prefix:      pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var phoneNumberResource = new PhoneNumber("phoneNumberResource", PhoneNumberArgs.builder()
    .countryCode("string")
    .targetArn("string")
    .type("string")
    .description("string")
    .prefix("string")
    .tags(Map.of("string", "string"))
    .build());

    phone_number_resource = aws.connect.PhoneNumber("phoneNumberResource",
    country_code="string",
    target_arn="string",
    type="string",
    description="string",
    prefix="string",
    tags={
        "string": "string",
    })

    const phoneNumberResource = new aws.connect.PhoneNumber("phoneNumberResource", {
    countryCode: "string",
    targetArn: "string",
    type: "string",
    description: "string",
    prefix: "string",
    tags: {
        string: "string",
    },
});

    type: aws:connect:PhoneNumber
properties:
    countryCode: string
    description: string
    prefix: string
    tags:
        string: string
    targetArn: string
    type: string

    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

    The PhoneNumber resource accepts the following input properties:

    CountryCode string
    The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
    TargetArn string
    The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
    Type string
    The type of phone number. Valid Values: TOLL_FREE | DID.
    Description string
    The description of the phone number.
    Prefix string
    The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
    Tags Dictionary<string, string>
    Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    CountryCode string
    The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
    TargetArn string
    The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
    Type string
    The type of phone number. Valid Values: TOLL_FREE | DID.
    Description string
    The description of the phone number.
    Prefix string
    The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
    Tags map[string]string
    Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    countryCode String
    The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
    targetArn String
    The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
    type String
    The type of phone number. Valid Values: TOLL_FREE | DID.
    description String
    The description of the phone number.
    prefix String
    The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
    tags Map<String,String>
    Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    countryCode string
    The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
    targetArn string
    The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
    type string
    The type of phone number. Valid Values: TOLL_FREE | DID.
    description string
    The description of the phone number.
    prefix string
    The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
    tags {[key: string]: string}
    Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    country_code str
    The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
    target_arn str
    The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
    type str
    The type of phone number. Valid Values: TOLL_FREE | DID.
    description str
    The description of the phone number.
    prefix str
    The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
    tags Mapping[str, str]
    Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    countryCode String
    The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
    targetArn String
    The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
    type String
    The type of phone number. Valid Values: TOLL_FREE | DID.
    description String
    The description of the phone number.
    prefix String
    The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
    tags Map<String>
    Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    The ARN of the phone number.
    Id string
    The provider-assigned unique ID for this managed resource.
    PhoneNumberValue string
    The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
    Statuses List<PhoneNumberStatus>
    The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The ARN of the phone number.
    Id string
    The provider-assigned unique ID for this managed resource.
    PhoneNumber string
    The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
    Statuses []PhoneNumberStatus
    The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the phone number.
    id String
    The provider-assigned unique ID for this managed resource.
    phoneNumber String
    The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
    statuses List<PhoneNumberStatus>
    The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The ARN of the phone number.
    id string
    The provider-assigned unique ID for this managed resource.
    phoneNumber string
    The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
    statuses PhoneNumberStatus[]
    The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The ARN of the phone number.
    id str
    The provider-assigned unique ID for this managed resource.
    phone_number str
    The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
    statuses Sequence[PhoneNumberStatus]
    The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the phone number.
    id String
    The provider-assigned unique ID for this managed resource.
    phoneNumber String
    The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
    statuses List<Property Map>
    The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing PhoneNumber Resource

    Get an existing PhoneNumber resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PhoneNumberState, opts?: CustomResourceOptions): PhoneNumber
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        country_code: Optional[str] = None,
        description: Optional[str] = None,
        phone_number: Optional[str] = None,
        prefix: Optional[str] = None,
        statuses: Optional[Sequence[PhoneNumberStatusArgs]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        target_arn: Optional[str] = None,
        type: Optional[str] = None) -> PhoneNumber
    func GetPhoneNumber(ctx *Context, name string, id IDInput, state *PhoneNumberState, opts ...ResourceOption) (*PhoneNumber, error)
    public static PhoneNumber Get(string name, Input<string> id, PhoneNumberState? state, CustomResourceOptions? opts = null)
    public static PhoneNumber get(String name, Output<String> id, PhoneNumberState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The ARN of the phone number.
    CountryCode string
    The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
    Description string
    The description of the phone number.
    PhoneNumberValue string
    The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
    Prefix string
    The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
    Statuses List<PhoneNumberStatus>
    The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
    Tags Dictionary<string, string>
    Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TargetArn string
    The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
    Type string
    The type of phone number. Valid Values: TOLL_FREE | DID.
    Arn string
    The ARN of the phone number.
    CountryCode string
    The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
    Description string
    The description of the phone number.
    PhoneNumber string
    The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
    Prefix string
    The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
    Statuses []PhoneNumberStatusArgs
    The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
    Tags map[string]string
    Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TargetArn string
    The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
    Type string
    The type of phone number. Valid Values: TOLL_FREE | DID.
    arn String
    The ARN of the phone number.
    countryCode String
    The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
    description String
    The description of the phone number.
    phoneNumber String
    The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
    prefix String
    The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
    statuses List<PhoneNumberStatus>
    The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
    tags Map<String,String>
    Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    targetArn String
    The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
    type String
    The type of phone number. Valid Values: TOLL_FREE | DID.
    arn string
    The ARN of the phone number.
    countryCode string
    The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
    description string
    The description of the phone number.
    phoneNumber string
    The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
    prefix string
    The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
    statuses PhoneNumberStatus[]
    The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
    tags {[key: string]: string}
    Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    targetArn string
    The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
    type string
    The type of phone number. Valid Values: TOLL_FREE | DID.
    arn str
    The ARN of the phone number.
    country_code str
    The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
    description str
    The description of the phone number.
    phone_number str
    The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
    prefix str
    The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
    statuses Sequence[PhoneNumberStatusArgs]
    The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
    tags Mapping[str, str]
    Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    target_arn str
    The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
    type str
    The type of phone number. Valid Values: TOLL_FREE | DID.
    arn String
    The ARN of the phone number.
    countryCode String
    The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
    description String
    The description of the phone number.
    phoneNumber String
    The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
    prefix String
    The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
    statuses List<Property Map>
    The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
    tags Map<String>
    Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    targetArn String
    The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
    type String
    The type of phone number. Valid Values: TOLL_FREE | DID.

    Supporting Types

    PhoneNumberStatus, PhoneNumberStatusArgs

    Message string
    The status message.
    Status string
    The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
    Message string
    The status message.
    Status string
    The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
    message String
    The status message.
    status String
    The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
    message string
    The status message.
    status string
    The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
    message str
    The status message.
    status str
    The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
    message String
    The status message.
    status String
    The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.

    Import

    Using pulumi import, import Amazon Connect Phone Numbers using its id. For example:

    $ pulumi import aws:connect/phoneNumber:PhoneNumber example 12345678-abcd-1234-efgh-9876543210ab

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws