Class Smsvoicev2SenderId


  • public class Smsvoicev2SenderId
    extends com.pulumi.resources.CustomResource
    Manages an End User Messaging SMS Sender ID. ## Example Usage ### Basic Usage
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.pinpoint.Smsvoicev2SenderId;
     import com.pulumi.aws.pinpoint.Smsvoicev2SenderIdArgs;
     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 Smsvoicev2SenderId("example", Smsvoicev2SenderIdArgs.builder()
                 .senderId("MYCOMPANY")
                 .isoCountryCode("GB")
                 .messageTypes("TRANSACTIONAL")
                 .build());
     
         }
     }
     
     
    ### With Deletion Protection
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.pinpoint.Smsvoicev2SenderId;
     import com.pulumi.aws.pinpoint.Smsvoicev2SenderIdArgs;
     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 Smsvoicev2SenderId("example", Smsvoicev2SenderIdArgs.builder()
                 .senderId("MYCOMPANY")
                 .isoCountryCode("GB")
                 .messageTypes("TRANSACTIONAL")
                 .deletionProtectionEnabled(true)
                 .build());
     
         }
     }
     
     
    ## Import ### Identity Schema #### Required * `senderId` (String) Sender ID. * `isoCountryCode` (String) Two-character code, in ISO 3166-1 alpha-2 format, for the country or region. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import an End User Messaging SMS Sender ID using the `senderId` and `isoCountryCode`, separated by a comma. For example: ```sh $ pulumi import aws:pinpoint/smsvoicev2SenderId:Smsvoicev2SenderId example "MYSENDERID,US" ```
    • 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()  
      static Smsvoicev2SenderId get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, Smsvoicev2SenderIdState 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.util.List<java.lang.String>> messageTypes()  
      com.pulumi.core.Output<java.lang.String> monthlyLeasingPrice()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.Boolean> registered()  
      com.pulumi.core.Output<java.lang.String> registrationId()  
      com.pulumi.core.Output<java.lang.String> senderId()  
      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<Smsvoicev2SenderIdTimeouts>> timeouts()  
      • 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

      • Smsvoicev2SenderId

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

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

        public Smsvoicev2SenderId​(java.lang.String name,
                                  Smsvoicev2SenderIdArgs 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 sender ID.
      • deletionProtectionEnabled

        public com.pulumi.core.Output<java.lang.Boolean> deletionProtectionEnabled()
        Returns:
        Whether deletion protection is enabled. When set to `true`, the sender ID cannot be deleted. Defaults to `false`.
      • 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.
      • messageTypes

        public com.pulumi.core.Output<java.util.List<java.lang.String>> messageTypes()
        Returns:
        Type of message. Valid values are `TRANSACTIONAL` and `PROMOTIONAL`. Defaults to `["TRANSACTIONAL"]` if not specified.
      • monthlyLeasingPrice

        public com.pulumi.core.Output<java.lang.String> monthlyLeasingPrice()
        Returns:
        Monthly leasing price, in US dollars.
      • 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.
      • registered

        public com.pulumi.core.Output<java.lang.Boolean> registered()
        Returns:
        Whether the sender ID is registered.
      • registrationId

        public com.pulumi.core.Output<java.lang.String> registrationId()
        Returns:
        Unique identifier for the registration.
      • senderId

        public com.pulumi.core.Output<java.lang.String> senderId()
        Returns:
        Alphanumeric sender ID to request. Must be between 3 and 11 characters long, contain only upper case letters, numbers, and dashes, and cannot be numeric-only. AWS stores sender IDs in upper case, so upper case is required here to keep configuration, state, and resource identity consistent. The following arguments are optional:
      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags assigned to the resource. 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.
      • get

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