Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. pinpoint
  5. Smsvoicev2OptOutList
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.pinpoint.Smsvoicev2OptOutList

Explore with Pulumi AI

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

    Manages an AWS End User Messaging SMS opt-out list.

    Example Usage

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

const example = new aws.pinpoint.Smsvoicev2OptOutList("example", {name: "example-opt-out-list"});

    import pulumi
import pulumi_aws as aws

example = aws.pinpoint.Smsvoicev2OptOutList("example", name="example-opt-out-list")

    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.NewSmsvoicev2OptOutList(ctx, "example", &pinpoint.Smsvoicev2OptOutListArgs{
			Name: pulumi.String("example-opt-out-list"),
		})
		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.Smsvoicev2OptOutList("example", new()
    {
        Name = "example-opt-out-list",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.pinpoint.Smsvoicev2OptOutList;
import com.pulumi.aws.pinpoint.Smsvoicev2OptOutListArgs;
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 Smsvoicev2OptOutList("example", Smsvoicev2OptOutListArgs.builder()
            .name("example-opt-out-list")
            .build());

    }
}

    resources:
  example:
    type: aws:pinpoint:Smsvoicev2OptOutList
    properties:
      name: example-opt-out-list

    Create Smsvoicev2OptOutList Resource

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

    Constructor syntax

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

@overload
def Smsvoicev2OptOutList(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         name: Optional[str] = None,
                         tags: Optional[Mapping[str, str]] = None)
    func NewSmsvoicev2OptOutList(ctx *Context, name string, args *Smsvoicev2OptOutListArgs, opts ...ResourceOption) (*Smsvoicev2OptOutList, error)
    public Smsvoicev2OptOutList(string name, Smsvoicev2OptOutListArgs? args = null, CustomResourceOptions? opts = null)
    public Smsvoicev2OptOutList(String name, Smsvoicev2OptOutListArgs args)
public Smsvoicev2OptOutList(String name, Smsvoicev2OptOutListArgs args, CustomResourceOptions options)

    type: aws:pinpoint:Smsvoicev2OptOutList
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 Smsvoicev2OptOutListArgs
    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 Smsvoicev2OptOutListArgs
    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 Smsvoicev2OptOutListArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args Smsvoicev2OptOutListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args Smsvoicev2OptOutListArgs
    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 smsvoicev2OptOutListResource = new Aws.Pinpoint.Smsvoicev2OptOutList("smsvoicev2OptOutListResource", new()
{
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := pinpoint.NewSmsvoicev2OptOutList(ctx, "smsvoicev2OptOutListResource", &pinpoint.Smsvoicev2OptOutListArgs{
	Name: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var smsvoicev2OptOutListResource = new Smsvoicev2OptOutList("smsvoicev2OptOutListResource", Smsvoicev2OptOutListArgs.builder()
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    smsvoicev2_opt_out_list_resource = aws.pinpoint.Smsvoicev2OptOutList("smsvoicev2OptOutListResource",
    name="string",
    tags={
        "string": "string",
    })

    const smsvoicev2OptOutListResource = new aws.pinpoint.Smsvoicev2OptOutList("smsvoicev2OptOutListResource", {
    name: "string",
    tags: {
        string: "string",
    },
});

    type: aws:pinpoint:Smsvoicev2OptOutList
properties:
    name: string
    tags:
        string: string

    Smsvoicev2OptOutList 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 Smsvoicev2OptOutList resource accepts the following input properties:

    Name string
    The name of the opt-out list.
    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.
    Name string
    The name of the opt-out list.
    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.
    name String
    The name of the opt-out list.
    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.
    name string
    The name of the opt-out list.
    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.
    name str
    The name of the opt-out list.
    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.
    name String
    The name of the opt-out list.
    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 Smsvoicev2OptOutList resource produces the following output properties:

    Arn string
    ARN of the opt-out list.
    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 opt-out list.
    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 opt-out list.
    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 opt-out list.
    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 opt-out list.
    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 opt-out list.
    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 Smsvoicev2OptOutList Resource

    Get an existing Smsvoicev2OptOutList 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?: Smsvoicev2OptOutListState, opts?: CustomResourceOptions): Smsvoicev2OptOutList
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Smsvoicev2OptOutList
    func GetSmsvoicev2OptOutList(ctx *Context, name string, id IDInput, state *Smsvoicev2OptOutListState, opts ...ResourceOption) (*Smsvoicev2OptOutList, error)
    public static Smsvoicev2OptOutList Get(string name, Input<string> id, Smsvoicev2OptOutListState? state, CustomResourceOptions? opts = null)
    public static Smsvoicev2OptOutList get(String name, Output<String> id, Smsvoicev2OptOutListState 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 opt-out list.
    Name string
    The name of the opt-out list.
    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 opt-out list.
    Name string
    The name of the opt-out list.
    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 opt-out list.
    name String
    The name of the opt-out list.
    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 opt-out list.
    name string
    The name of the opt-out list.
    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 opt-out list.
    name str
    The name of the opt-out list.
    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 opt-out list.
    name String
    The name of the opt-out list.
    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 opt-out lists using the name. For example:

    $ pulumi import aws:pinpoint/smsvoicev2OptOutList:Smsvoicev2OptOutList example example-opt-out-list

    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
    pulumi/pulumi-aws