Package com.pulumi.aws.sns

Class SmsPreferences

  • public class SmsPreferences
extends com.pulumi.resources.CustomResource
    Provides a way to set SNS SMS preferences. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.sns.SmsPreferences;
 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 updateSmsPrefs = new SmsPreferences("updateSmsPrefs");
 
     }
 }
    ## Import You cannot import the SMS preferences.

    • 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.util.Optional<java.lang.String>> defaultSenderId()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> defaultSmsType()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> deliveryStatusIamRoleArn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> deliveryStatusSuccessSamplingRate()  
      static SmsPreferences get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, SmsPreferencesState 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> monthlySpendLimit()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> usageReportS3Bucket()  

      • 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

      • SmsPreferences

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

      • SmsPreferences

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

      • SmsPreferences

        public SmsPreferences​(java.lang.String name,
                      @Nullable
                      SmsPreferencesArgs 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

      • defaultSenderId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> defaultSenderId()
        Returns:
        A string, such as your business brand, that is displayed as the sender on the receiving device.

      • defaultSmsType

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> defaultSmsType()
        Returns:
        The type of SMS message that you will send by default. Possible values are: Promotional, Transactional

      • deliveryStatusIamRoleArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> deliveryStatusIamRoleArn()
        Returns:
        The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs.

      • deliveryStatusSuccessSamplingRate

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> deliveryStatusSuccessSamplingRate()
        Returns:
        The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value must be between 0 and 100.

      • monthlySpendLimit

        public com.pulumi.core.Output<java.lang.Integer> monthlySpendLimit()
        Returns:
        The maximum amount in USD that you are willing to spend each month to send SMS messages.

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

      • usageReportS3Bucket

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> usageReportS3Bucket()
        Returns:
        The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS.

      • get

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