SmsPreferences

Provides a way to set SNS SMS preferences.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var updateSmsPrefs = new Aws.Sns.SmsPreferences("updateSmsPrefs", new Aws.Sns.SmsPreferencesArgs
        {
        });
    }

}

package main

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

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

import pulumi
import pulumi_aws as aws

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

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

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

Create a SmsPreferences Resource

new SmsPreferences(name: string, args?: SmsPreferencesArgs, opts?: CustomResourceOptions);

def SmsPreferences(resource_name, opts=None, default_sender_id=None, default_sms_type=None, delivery_status_iam_role_arn=None, delivery_status_success_sampling_rate=None, monthly_spend_limit=None, usage_report_s3_bucket=None, __props__=None);

func NewSmsPreferences(ctx *Context, name string, args *SmsPreferencesArgs, opts ...ResourceOption) (*SmsPreferences, error)

public SmsPreferences(string name, SmsPreferencesArgs? args = null, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

SmsPreferences Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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 string: 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 string: 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 string: 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 str: 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.

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 str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, default_sender_id=None, default_sms_type=None, delivery_status_iam_role_arn=None, delivery_status_success_sampling_rate=None, monthly_spend_limit=None, usage_report_s3_bucket=None, __props__=None);

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)

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.

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 string: 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 string: 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 string: 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 str: 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.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud