Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. sns
  5. SmsPreferences

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

aws.sns.SmsPreferences

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a way to set SNS SMS preferences.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const updateSmsPrefs = new aws.sns.SmsPreferences("update_sms_prefs", {});

    import pulumi
import pulumi_aws as aws

update_sms_prefs = aws.sns.SmsPreferences("update_sms_prefs")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sns"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sns.NewSmsPreferences(ctx, "update_sms_prefs", nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var updateSmsPrefs = new Aws.Sns.SmsPreferences("update_sms_prefs");

});

    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.List;
import java.util.ArrayList;
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");

    }
}

    resources:
  updateSmsPrefs:
    type: aws:sns:SmsPreferences
    name: update_sms_prefs

    Create SmsPreferences Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SmsPreferences(name: string, args?: SmsPreferencesArgs, opts?: CustomResourceOptions);
    @overload
def SmsPreferences(resource_name: str,
                   args: Optional[SmsPreferencesArgs] = None,
                   opts: Optional[ResourceOptions] = None)

@overload
def SmsPreferences(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   default_sender_id: Optional[str] = None,
                   default_sms_type: Optional[str] = None,
                   delivery_status_iam_role_arn: Optional[str] = None,
                   delivery_status_success_sampling_rate: Optional[str] = None,
                   monthly_spend_limit: Optional[int] = None,
                   usage_report_s3_bucket: Optional[str] = None)
    func NewSmsPreferences(ctx *Context, name string, args *SmsPreferencesArgs, opts ...ResourceOption) (*SmsPreferences, error)
    public SmsPreferences(string name, SmsPreferencesArgs? args = null, CustomResourceOptions? opts = null)
    public SmsPreferences(String name, SmsPreferencesArgs args)
public SmsPreferences(String name, SmsPreferencesArgs args, CustomResourceOptions options)

    type: aws:sns:SmsPreferences
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SmsPreferencesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SmsPreferencesArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SmsPreferencesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SmsPreferencesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SmsPreferencesArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var smsPreferencesResource = new Aws.Sns.SmsPreferences("smsPreferencesResource", new()
{
    DefaultSenderId = "string",
    DefaultSmsType = "string",
    DeliveryStatusIamRoleArn = "string",
    DeliveryStatusSuccessSamplingRate = "string",
    MonthlySpendLimit = 0,
    UsageReportS3Bucket = "string",
});

    example, err := sns.NewSmsPreferences(ctx, "smsPreferencesResource", &sns.SmsPreferencesArgs{
	DefaultSenderId:                   pulumi.String("string"),
	DefaultSmsType:                    pulumi.String("string"),
	DeliveryStatusIamRoleArn:          pulumi.String("string"),
	DeliveryStatusSuccessSamplingRate: pulumi.String("string"),
	MonthlySpendLimit:                 pulumi.Int(0),
	UsageReportS3Bucket:               pulumi.String("string"),
})

    var smsPreferencesResource = new SmsPreferences("smsPreferencesResource", SmsPreferencesArgs.builder()
    .defaultSenderId("string")
    .defaultSmsType("string")
    .deliveryStatusIamRoleArn("string")
    .deliveryStatusSuccessSamplingRate("string")
    .monthlySpendLimit(0)
    .usageReportS3Bucket("string")
    .build());

    sms_preferences_resource = aws.sns.SmsPreferences("smsPreferencesResource",
    default_sender_id="string",
    default_sms_type="string",
    delivery_status_iam_role_arn="string",
    delivery_status_success_sampling_rate="string",
    monthly_spend_limit=0,
    usage_report_s3_bucket="string")

    const smsPreferencesResource = new aws.sns.SmsPreferences("smsPreferencesResource", {
    defaultSenderId: "string",
    defaultSmsType: "string",
    deliveryStatusIamRoleArn: "string",
    deliveryStatusSuccessSamplingRate: "string",
    monthlySpendLimit: 0,
    usageReportS3Bucket: "string",
});

    type: aws:sns:SmsPreferences
properties:
    defaultSenderId: string
    defaultSmsType: string
    deliveryStatusIamRoleArn: string
    deliveryStatusSuccessSamplingRate: string
    monthlySpendLimit: 0
    usageReportS3Bucket: string

    SmsPreferences Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The SmsPreferences resource accepts the following input properties:

    DefaultSenderId string
    A string, such as your business brand, that is displayed as the sender on the receiving device.
    DefaultSmsType string
    The type of SMS message that you will send by default. Possible values are: Promotional, Transactional
    DeliveryStatusIamRoleArn string
    The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs.
    DeliveryStatusSuccessSamplingRate string
    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 int
    The maximum amount in USD that you are willing to spend each month to send SMS messages.
    UsageReportS3Bucket string
    The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS.
    DefaultSenderId string
    A string, such as your business brand, that is displayed as the sender on the receiving device.
    DefaultSmsType string
    The type of SMS message that you will send by default. Possible values are: Promotional, Transactional
    DeliveryStatusIamRoleArn string
    The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs.
    DeliveryStatusSuccessSamplingRate string
    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 int
    The maximum amount in USD that you are willing to spend each month to send SMS messages.
    UsageReportS3Bucket string
    The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS.
    defaultSenderId String
    A string, such as your business brand, that is displayed as the sender on the receiving device.
    defaultSmsType String
    The type of SMS message that you will send by default. Possible values are: Promotional, Transactional
    deliveryStatusIamRoleArn String
    The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs.
    deliveryStatusSuccessSamplingRate String
    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 Integer
    The maximum amount in USD that you are willing to spend each month to send SMS messages.
    usageReportS3Bucket String
    The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS.
    defaultSenderId string
    A string, such as your business brand, that is displayed as the sender on the receiving device.
    defaultSmsType string
    The type of SMS message that you will send by default. Possible values are: Promotional, Transactional
    deliveryStatusIamRoleArn string
    The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs.
    deliveryStatusSuccessSamplingRate string
    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 number
    The maximum amount in USD that you are willing to spend each month to send SMS messages.
    usageReportS3Bucket string
    The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS.
    default_sender_id str
    A string, such as your business brand, that is displayed as the sender on the receiving device.
    default_sms_type str
    The type of SMS message that you will send by default. Possible values are: Promotional, Transactional
    delivery_status_iam_role_arn str
    The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs.
    delivery_status_success_sampling_rate str
    The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value must be between 0 and 100.
    monthly_spend_limit int
    The maximum amount in USD that you are willing to spend each month to send SMS messages.
    usage_report_s3_bucket str
    The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS.
    defaultSenderId String
    A string, such as your business brand, that is displayed as the sender on the receiving device.
    defaultSmsType String
    The type of SMS message that you will send by default. Possible values are: Promotional, Transactional
    deliveryStatusIamRoleArn String
    The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs.
    deliveryStatusSuccessSamplingRate String
    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 Number
    The maximum amount in USD that you are willing to spend each month to send SMS messages.
    usageReportS3Bucket String
    The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SmsPreferences resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SmsPreferences Resource

    Get an existing SmsPreferences resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SmsPreferencesState, opts?: CustomResourceOptions): SmsPreferences
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        default_sender_id: Optional[str] = None,
        default_sms_type: Optional[str] = None,
        delivery_status_iam_role_arn: Optional[str] = None,
        delivery_status_success_sampling_rate: Optional[str] = None,
        monthly_spend_limit: Optional[int] = None,
        usage_report_s3_bucket: Optional[str] = None) -> SmsPreferences
    func GetSmsPreferences(ctx *Context, name string, id IDInput, state *SmsPreferencesState, opts ...ResourceOption) (*SmsPreferences, error)
    public static SmsPreferences Get(string name, Input<string> id, SmsPreferencesState? state, CustomResourceOptions? opts = null)
    public static SmsPreferences get(String name, Output<String> id, SmsPreferencesState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DefaultSenderId string
    A string, such as your business brand, that is displayed as the sender on the receiving device.
    DefaultSmsType string
    The type of SMS message that you will send by default. Possible values are: Promotional, Transactional
    DeliveryStatusIamRoleArn string
    The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs.
    DeliveryStatusSuccessSamplingRate string
    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 int
    The maximum amount in USD that you are willing to spend each month to send SMS messages.
    UsageReportS3Bucket string
    The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS.
    DefaultSenderId string
    A string, such as your business brand, that is displayed as the sender on the receiving device.
    DefaultSmsType string
    The type of SMS message that you will send by default. Possible values are: Promotional, Transactional
    DeliveryStatusIamRoleArn string
    The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs.
    DeliveryStatusSuccessSamplingRate string
    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 int
    The maximum amount in USD that you are willing to spend each month to send SMS messages.
    UsageReportS3Bucket string
    The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS.
    defaultSenderId String
    A string, such as your business brand, that is displayed as the sender on the receiving device.
    defaultSmsType String
    The type of SMS message that you will send by default. Possible values are: Promotional, Transactional
    deliveryStatusIamRoleArn String
    The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs.
    deliveryStatusSuccessSamplingRate String
    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 Integer
    The maximum amount in USD that you are willing to spend each month to send SMS messages.
    usageReportS3Bucket String
    The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS.
    defaultSenderId string
    A string, such as your business brand, that is displayed as the sender on the receiving device.
    defaultSmsType string
    The type of SMS message that you will send by default. Possible values are: Promotional, Transactional
    deliveryStatusIamRoleArn string
    The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs.
    deliveryStatusSuccessSamplingRate string
    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 number
    The maximum amount in USD that you are willing to spend each month to send SMS messages.
    usageReportS3Bucket string
    The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS.
    default_sender_id str
    A string, such as your business brand, that is displayed as the sender on the receiving device.
    default_sms_type str
    The type of SMS message that you will send by default. Possible values are: Promotional, Transactional
    delivery_status_iam_role_arn str
    The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs.
    delivery_status_success_sampling_rate str
    The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value must be between 0 and 100.
    monthly_spend_limit int
    The maximum amount in USD that you are willing to spend each month to send SMS messages.
    usage_report_s3_bucket str
    The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS.
    defaultSenderId String
    A string, such as your business brand, that is displayed as the sender on the receiving device.
    defaultSmsType String
    The type of SMS message that you will send by default. Possible values are: Promotional, Transactional
    deliveryStatusIamRoleArn String
    The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs.
    deliveryStatusSuccessSamplingRate String
    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 Number
    The maximum amount in USD that you are willing to spend each month to send SMS messages.
    usageReportS3Bucket String
    The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS.

    Import

    You cannot import the SMS preferences.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws