Class 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
    {
    });
}

}

Inheritance

System.Object

Resource

CustomResource

SmsPreferences

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Sns

Assembly: Pulumi.Aws.dll

Syntax

public class SmsPreferences : CustomResource

Constructors

SmsPreferences(String, SmsPreferencesArgs, CustomResourceOptions)

Create a SmsPreferences resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
SmsPreferencesArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

DefaultSenderId

A string, such as your business brand, that is displayed as the sender on the receiving device.

Declaration

public Output<string> DefaultSenderId { get; }

Property Value

Type	Description
Output<System.String>

DefaultSmsType

The type of SMS message that you will send by default. Possible values are: Promotional, Transactional

Declaration

public Output<string> DefaultSmsType { get; }

Property Value

Type	Description
Output<System.String>

DeliveryStatusIamRoleArn

The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs.

Declaration

public Output<string> DeliveryStatusIamRoleArn { get; }

Property Value

Type	Description
Output<System.String>

DeliveryStatusSuccessSamplingRate

The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value must be between 0 and 100.

Declaration

public Output<string> DeliveryStatusSuccessSamplingRate { get; }

Property Value

Type	Description
Output<System.String>

MonthlySpendLimit

The maximum amount in USD that you are willing to spend each month to send SMS messages.

Declaration

public Output<string> MonthlySpendLimit { get; }

Property Value

Type	Description
Output<System.String>

UsageReportS3Bucket

The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS.

Declaration

public Output<string> UsageReportS3Bucket { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, SmsPreferencesState, CustomResourceOptions)

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

Declaration

public static SmsPreferences Get(string name, Input<string> id, SmsPreferencesState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
SmsPreferencesState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
SmsPreferences