Package com.pulumi.aws.connect

Class PhoneNumber

  • public class PhoneNumber
extends com.pulumi.resources.CustomResource
    Provides an Amazon Connect Phone Number resource. For more information see [Amazon Connect: Getting Started](https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-get-started.html) ## Example Usage ### Basic 
     
 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.ArrayList;
 import java.util.Arrays;
 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());
 
     }
 }
    ### 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.ArrayList;
 import java.util.Arrays;
 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());
 
     }
 }
    ### Prefix to filter phone numbers 
     
 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.ArrayList;
 import java.util.Arrays;
 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());
 
     }
 }
    ## Import ### Identity Schema #### Required * `id` - (String) ID of the connect phone number. #### Optional - `accountId` (String) AWS Account where this resource is managed. - `region` (String) Region where this resource is managed. Using `pulumi import`, import Amazon Connect Phone Numbers using its `id`. For example: ```sh $ pulumi import aws:connect/phoneNumber:PhoneNumber example 12345678-abcd-1234-efgh-9876543210ab ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> countryCode()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static PhoneNumber get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, PhoneNumberState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> phoneNumber()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> prefix()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.List<PhoneNumberStatus>> statuses()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> targetArn()  
      com.pulumi.core.Output<java.lang.String> type()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PhoneNumber

        public PhoneNumber​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • PhoneNumber

        public PhoneNumber​(java.lang.String name,
                   PhoneNumberArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • PhoneNumber

        public PhoneNumber​(java.lang.String name,
                   PhoneNumberArgs args,
                   @Nullable
                   com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        The ARN of the phone number.

      • countryCode

        public com.pulumi.core.Output<java.lang.String> countryCode()
        Returns:
        The ISO country code. For a list of Valid values, refer to [PhoneNumberCountryCode](https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchAvailablePhoneNumbers.html#connect-SearchAvailablePhoneNumbers-request-PhoneNumberCountryCode).

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        The description of the phone number.

      • phoneNumber

        public com.pulumi.core.Output<java.lang.String> phoneNumber()
        Returns:
        The phone number. Phone numbers are formatted `[+] [country code] [subscriber number including area code]`.

      • prefix

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> prefix()
        Returns:
        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.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        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.

      • statuses

        public com.pulumi.core.Output<java.util.List<PhoneNumberStatus>> statuses()
        Returns:
        The status of the phone number. Valid Values: `CLAIMED` | `IN_PROGRESS` | `FAILED`.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Tags to apply to the Phone Number. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • targetArn

        public com.pulumi.core.Output<java.lang.String> targetArn()
        Returns:
        ARN for Amazon Connect instances that phone numbers are claimed to.

      • type

        public com.pulumi.core.Output<java.lang.String> type()
        Returns:
        The type of phone number. Valid Values: `TOLL_FREE` | `DID`.

      • get

        public static PhoneNumber get​(java.lang.String name,
                              com.pulumi.core.Output<java.lang.String> id,
                              @Nullable
                              PhoneNumberState state,
                              @Nullable
                              com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.