1. Packages
  2. AWS
  3. API Docs
  4. pinpoint
  5. Smsvoicev2ConfigurationSet
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.pinpoint.Smsvoicev2ConfigurationSet

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Manages an AWS End User Messaging SMS Configuration Set.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.pinpoint.Smsvoicev2ConfigurationSet("example", {
        name: "example-configuration-set",
        defaultSenderId: "example",
        defaultMessageType: "TRANSACTIONAL",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.pinpoint.Smsvoicev2ConfigurationSet("example",
        name="example-configuration-set",
        default_sender_id="example",
        default_message_type="TRANSACTIONAL")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/pinpoint"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := pinpoint.NewSmsvoicev2ConfigurationSet(ctx, "example", &pinpoint.Smsvoicev2ConfigurationSetArgs{
    			Name:               pulumi.String("example-configuration-set"),
    			DefaultSenderId:    pulumi.String("example"),
    			DefaultMessageType: pulumi.String("TRANSACTIONAL"),
    		})
    		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 example = new Aws.Pinpoint.Smsvoicev2ConfigurationSet("example", new()
        {
            Name = "example-configuration-set",
            DefaultSenderId = "example",
            DefaultMessageType = "TRANSACTIONAL",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.pinpoint.Smsvoicev2ConfigurationSet;
    import com.pulumi.aws.pinpoint.Smsvoicev2ConfigurationSetArgs;
    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 example = new Smsvoicev2ConfigurationSet("example", Smsvoicev2ConfigurationSetArgs.builder()
                .name("example-configuration-set")
                .defaultSenderId("example")
                .defaultMessageType("TRANSACTIONAL")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:pinpoint:Smsvoicev2ConfigurationSet
        properties:
          name: example-configuration-set
          defaultSenderId: example
          defaultMessageType: TRANSACTIONAL
    

    Create Smsvoicev2ConfigurationSet Resource

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

    Constructor syntax

    new Smsvoicev2ConfigurationSet(name: string, args?: Smsvoicev2ConfigurationSetArgs, opts?: CustomResourceOptions);
    @overload
    def Smsvoicev2ConfigurationSet(resource_name: str,
                                   args: Optional[Smsvoicev2ConfigurationSetArgs] = None,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def Smsvoicev2ConfigurationSet(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   default_message_type: Optional[str] = None,
                                   default_sender_id: Optional[str] = None,
                                   name: Optional[str] = None,
                                   tags: Optional[Mapping[str, str]] = None)
    func NewSmsvoicev2ConfigurationSet(ctx *Context, name string, args *Smsvoicev2ConfigurationSetArgs, opts ...ResourceOption) (*Smsvoicev2ConfigurationSet, error)
    public Smsvoicev2ConfigurationSet(string name, Smsvoicev2ConfigurationSetArgs? args = null, CustomResourceOptions? opts = null)
    public Smsvoicev2ConfigurationSet(String name, Smsvoicev2ConfigurationSetArgs args)
    public Smsvoicev2ConfigurationSet(String name, Smsvoicev2ConfigurationSetArgs args, CustomResourceOptions options)
    
    type: aws:pinpoint:Smsvoicev2ConfigurationSet
    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 Smsvoicev2ConfigurationSetArgs
    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 Smsvoicev2ConfigurationSetArgs
    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 Smsvoicev2ConfigurationSetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args Smsvoicev2ConfigurationSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args Smsvoicev2ConfigurationSetArgs
    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 smsvoicev2ConfigurationSetResource = new Aws.Pinpoint.Smsvoicev2ConfigurationSet("smsvoicev2ConfigurationSetResource", new()
    {
        DefaultMessageType = "string",
        DefaultSenderId = "string",
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := pinpoint.NewSmsvoicev2ConfigurationSet(ctx, "smsvoicev2ConfigurationSetResource", &pinpoint.Smsvoicev2ConfigurationSetArgs{
    	DefaultMessageType: pulumi.String("string"),
    	DefaultSenderId:    pulumi.String("string"),
    	Name:               pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var smsvoicev2ConfigurationSetResource = new Smsvoicev2ConfigurationSet("smsvoicev2ConfigurationSetResource", Smsvoicev2ConfigurationSetArgs.builder()
        .defaultMessageType("string")
        .defaultSenderId("string")
        .name("string")
        .tags(Map.of("string", "string"))
        .build());
    
    smsvoicev2_configuration_set_resource = aws.pinpoint.Smsvoicev2ConfigurationSet("smsvoicev2ConfigurationSetResource",
        default_message_type="string",
        default_sender_id="string",
        name="string",
        tags={
            "string": "string",
        })
    
    const smsvoicev2ConfigurationSetResource = new aws.pinpoint.Smsvoicev2ConfigurationSet("smsvoicev2ConfigurationSetResource", {
        defaultMessageType: "string",
        defaultSenderId: "string",
        name: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:pinpoint:Smsvoicev2ConfigurationSet
    properties:
        defaultMessageType: string
        defaultSenderId: string
        name: string
        tags:
            string: string
    

    Smsvoicev2ConfigurationSet Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Smsvoicev2ConfigurationSet resource accepts the following input properties:

    DefaultMessageType string
    The default message type. Must either be "TRANSACTIONAL" or "PROMOTIONAL"
    DefaultSenderId string
    The default sender ID to use for this configuration set.
    Name string
    The name of the configuration set.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    DefaultMessageType string
    The default message type. Must either be "TRANSACTIONAL" or "PROMOTIONAL"
    DefaultSenderId string
    The default sender ID to use for this configuration set.
    Name string
    The name of the configuration set.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    defaultMessageType String
    The default message type. Must either be "TRANSACTIONAL" or "PROMOTIONAL"
    defaultSenderId String
    The default sender ID to use for this configuration set.
    name String
    The name of the configuration set.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    defaultMessageType string
    The default message type. Must either be "TRANSACTIONAL" or "PROMOTIONAL"
    defaultSenderId string
    The default sender ID to use for this configuration set.
    name string
    The name of the configuration set.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    default_message_type str
    The default message type. Must either be "TRANSACTIONAL" or "PROMOTIONAL"
    default_sender_id str
    The default sender ID to use for this configuration set.
    name str
    The name of the configuration set.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    defaultMessageType String
    The default message type. Must either be "TRANSACTIONAL" or "PROMOTIONAL"
    defaultSenderId String
    The default sender ID to use for this configuration set.
    name String
    The name of the configuration set.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    ARN of the configuration set.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the configuration set.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the configuration set.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the configuration set.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the configuration set.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the configuration set.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Smsvoicev2ConfigurationSet Resource

    Get an existing Smsvoicev2ConfigurationSet 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?: Smsvoicev2ConfigurationSetState, opts?: CustomResourceOptions): Smsvoicev2ConfigurationSet
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            default_message_type: Optional[str] = None,
            default_sender_id: Optional[str] = None,
            name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> Smsvoicev2ConfigurationSet
    func GetSmsvoicev2ConfigurationSet(ctx *Context, name string, id IDInput, state *Smsvoicev2ConfigurationSetState, opts ...ResourceOption) (*Smsvoicev2ConfigurationSet, error)
    public static Smsvoicev2ConfigurationSet Get(string name, Input<string> id, Smsvoicev2ConfigurationSetState? state, CustomResourceOptions? opts = null)
    public static Smsvoicev2ConfigurationSet get(String name, Output<String> id, Smsvoicev2ConfigurationSetState 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:
    Arn string
    ARN of the configuration set.
    DefaultMessageType string
    The default message type. Must either be "TRANSACTIONAL" or "PROMOTIONAL"
    DefaultSenderId string
    The default sender ID to use for this configuration set.
    Name string
    The name of the configuration set.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the configuration set.
    DefaultMessageType string
    The default message type. Must either be "TRANSACTIONAL" or "PROMOTIONAL"
    DefaultSenderId string
    The default sender ID to use for this configuration set.
    Name string
    The name of the configuration set.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the configuration set.
    defaultMessageType String
    The default message type. Must either be "TRANSACTIONAL" or "PROMOTIONAL"
    defaultSenderId String
    The default sender ID to use for this configuration set.
    name String
    The name of the configuration set.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the configuration set.
    defaultMessageType string
    The default message type. Must either be "TRANSACTIONAL" or "PROMOTIONAL"
    defaultSenderId string
    The default sender ID to use for this configuration set.
    name string
    The name of the configuration set.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the configuration set.
    default_message_type str
    The default message type. Must either be "TRANSACTIONAL" or "PROMOTIONAL"
    default_sender_id str
    The default sender ID to use for this configuration set.
    name str
    The name of the configuration set.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the configuration set.
    defaultMessageType String
    The default message type. Must either be "TRANSACTIONAL" or "PROMOTIONAL"
    defaultSenderId String
    The default sender ID to use for this configuration set.
    name String
    The name of the configuration set.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Import

    Using pulumi import, import configuration sets using the name. For example:

    $ pulumi import aws:pinpoint/smsvoicev2ConfigurationSet:Smsvoicev2ConfigurationSet example example-configuration-set
    

    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
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi