Package com.pulumi.aws.pinpoint

Class Smsvoicev2PhoneNumber

  • public class Smsvoicev2PhoneNumber
extends com.pulumi.resources.CustomResource
    Manages an AWS End User Messaging SMS phone number. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.pinpoint.Smsvoicev2PhoneNumber;
 import com.pulumi.aws.pinpoint.Smsvoicev2PhoneNumberArgs;
 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 Smsvoicev2PhoneNumber("example", Smsvoicev2PhoneNumberArgs.builder()
             .isoCountryCode("US")
             .messageType("TRANSACTIONAL")
             .numberType("TOLL_FREE")
             .numberCapabilities("SMS")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import phone numbers using the `id`. For example: ```sh $ pulumi import aws:pinpoint/smsvoicev2PhoneNumber:Smsvoicev2PhoneNumber example phone-abcdef0123456789abcdef0123456789 ```

    • 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.Boolean> deletionProtectionEnabled()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> forceDisassociate()  
      static Smsvoicev2PhoneNumber get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, Smsvoicev2PhoneNumberState 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> isoCountryCode()  
      com.pulumi.core.Output<java.lang.String> messageType()  
      com.pulumi.core.Output<java.lang.String> monthlyLeasingPrice()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> numberCapabilities()  
      com.pulumi.core.Output<java.lang.String> numberType()  
      com.pulumi.core.Output<java.lang.String> optOutListName()  
      com.pulumi.core.Output<java.lang.String> phoneNumber()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> registrationId()  
      com.pulumi.core.Output<java.lang.Boolean> selfManagedOptOutsEnabled()  
      com.pulumi.core.Output<java.lang.String> status()  
      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.util.Optional<Smsvoicev2PhoneNumberTimeouts>> timeouts()  
      com.pulumi.core.Output<java.lang.String> twoWayChannelArn()  
      com.pulumi.core.Output<java.lang.Boolean> twoWayChannelEnabled()  
      com.pulumi.core.Output<java.lang.String> twoWayChannelRole()  
      com.pulumi.core.Output<java.lang.Boolean> waitForActive()  

      • 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

      • Smsvoicev2PhoneNumber

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

      • Smsvoicev2PhoneNumber

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

      • Smsvoicev2PhoneNumber

        public Smsvoicev2PhoneNumber​(java.lang.String name,
                             Smsvoicev2PhoneNumberArgs 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:
        ARN of the phone number.

      • deletionProtectionEnabled

        public com.pulumi.core.Output<java.lang.Boolean> deletionProtectionEnabled()
        Returns:
        Whether deletion protection is enabled. When `true`, the phone number cannot be deleted.

      • forceDisassociate

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> forceDisassociate()
        Returns:
        Whether to disassociate the phone number from any pool it is associated with before destroying it.

      • isoCountryCode

        public com.pulumi.core.Output<java.lang.String> isoCountryCode()
        Returns:
        Two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

      • messageType

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

      • monthlyLeasingPrice

        public com.pulumi.core.Output<java.lang.String> monthlyLeasingPrice()
        Returns:
        Monthly price, in US dollars, to lease the phone number.

      • numberCapabilities

        public com.pulumi.core.Output<java.util.List<java.lang.String>> numberCapabilities()
        Returns:
        Whether the origination identity can be used for text messages, voice calls or both. Valid values are `SMS` and `VOICE`.

      • numberType

        public com.pulumi.core.Output<java.lang.String> numberType()
        Returns:
        Type of phone number to request. Possible values are `LONG_CODE`, `TOLL_FREE`, `TEN_DLC`, or `SIMULATOR`. The following arguments are optional:

      • optOutListName

        public com.pulumi.core.Output<java.lang.String> optOutListName()
        Returns:
        Name of the opt-out list to associate with the phone number. If omitted, AWS assigns the `Default` opt-out list.

      • phoneNumber

        public com.pulumi.core.Output<java.lang.String> phoneNumber()
        Returns:
        New phone number that was requested.

      • 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.

      • registrationId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> registrationId()
        Returns:
        Use this field to attach your phone number for an external registration process.

      • selfManagedOptOutsEnabled

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

      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        Status of the phone number. Possible values are `PENDING`, `ACTIVE`, `ASSOCIATING`, `DISASSOCIATING`, and `DELETED`.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags. 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:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • twoWayChannelArn

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

      • twoWayChannelEnabled

        public com.pulumi.core.Output<java.lang.Boolean> twoWayChannelEnabled()
        Returns:
        Whether two-way messaging is enabled. When `true`, you can receive incoming text messages from your end recipients. If omitted, AWS sets this to `false`.

      • twoWayChannelRole

        public com.pulumi.core.Output<java.lang.String> twoWayChannelRole()
        Returns:
        IAM Role ARN for a service to assume, to be able to post inbound SMS messages.

      • waitForActive

        public com.pulumi.core.Output<java.lang.Boolean> waitForActive()
        Returns:
        Whether to wait for the phone number to reach `ACTIVE` status before considering the resource created or updated. Defaults to `true`. Set to `false` for number types gated on carrier or registration approval (for example, `TEN_DLC`, `TOLL_FREE`, or any number submitted with `registrationId`), which can remain `PENDING` for days or weeks. When `false`, `pulumi up` returns once AWS accepts the phone number request; track activation with the `status` attribute.

      • get

        public static Smsvoicev2PhoneNumber get​(java.lang.String name,
                                        com.pulumi.core.Output<java.lang.String> id,
                                        @Nullable
                                        Smsvoicev2PhoneNumberState 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.