Package com.pulumi.aws.pinpoint

Class SmsChannel

  • public class SmsChannel
extends com.pulumi.resources.CustomResource
    Use the `aws.pinpoint.SmsChannel` resource to manage End User Messaging SMS Channels. > **NOTE:** AWS has feature frozen the SMS channel of End User Messaging. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.pinpoint.App;
 import com.pulumi.aws.pinpoint.SmsChannel;
 import com.pulumi.aws.pinpoint.SmsChannelArgs;
 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 app = new App("app");
 
         var sms = new SmsChannel("sms", SmsChannelArgs.builder()
             .applicationId(app.applicationId())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import the End User Messaging SMS Channel using the `applicationId`. For example: ```sh $ pulumi import aws:pinpoint/smsChannel:SmsChannel sms application-id ```

    • 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> applicationId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enabled()  
      static SmsChannel get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, SmsChannelState 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.Integer> promotionalMessagesPerSecond()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> senderId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> shortCode()  
      com.pulumi.core.Output<java.lang.Integer> transactionalMessagesPerSecond()  

      • 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

      • SmsChannel

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

      • SmsChannel

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

      • SmsChannel

        public SmsChannel​(java.lang.String name,
                  SmsChannelArgs 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

      • applicationId

        public com.pulumi.core.Output<java.lang.String> applicationId()
        Returns:
        ID of the application.

      • enabled

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enabled()
        Returns:
        Whether the channel is enabled or disabled. By default, it is set to `true`.

      • promotionalMessagesPerSecond

        public com.pulumi.core.Output<java.lang.Integer> promotionalMessagesPerSecond()
        Returns:
        Maximum number of promotional messages that can be sent per second.

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

      • senderId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> senderId()
        Returns:
        Identifier of the sender for your messages.

      • shortCode

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> shortCode()
        Returns:
        Short Code registered with the phone provider.

      • transactionalMessagesPerSecond

        public com.pulumi.core.Output<java.lang.Integer> transactionalMessagesPerSecond()
        Returns:
        Maximum number of transactional messages per second that can be sent.

      • get

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