SmsPreferences class
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")
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 main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "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.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");
}
}
resources:
updateSmsPrefs:
type: aws:sns:SmsPreferences
name: update_sms_prefs
Import
You cannot import the SMS preferences.
Constructors
- SmsPreferences(String name, {SmsPreferencesArgs? args, CustomResourceOptions? options})
-
Creates a new SmsPreferences.
nameThe Pulumi resource name.argsArguments used to configure this SmsPreferences. The set of arguments for SmsPreferences.optionsResource options controlling this resource's behavior. - SmsPreferences.reference(String urn)
- Creates a typed reference to an existing SmsPreferences resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
defaultSenderId
↔ Output<
String?> -
A string, such as your business brand, that is displayed as the sender on the receiving device.
latefinal
-
defaultSmsType
↔ Output<
String?> -
The type of SMS message that you will send by default. Possible values are: Promotional, Transactional
latefinal
-
deliveryStatusIamRoleArn
↔ Output<
String?> -
The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs.
latefinal
-
deliveryStatusSuccessSamplingRate
↔ Output<
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.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
monthlySpendLimit
↔ Output<
int> -
The maximum amount in USD that you are willing to spend each month to send SMS messages.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
usageReportS3Bucket
↔ Output<
String?> -
The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {SmsPreferencesState? state, CustomResourceOptions? options}) → SmsPreferences -
Gets an existing SmsPreferences resource's state with the given
nameandid.