1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. pinpoint
  6. Smsvoicev2SenderId
Viewing docs for AWS v7.46.0
published on Thursday, Sep 10, 2026 by Pulumi
aws logo aws logo
Viewing docs for AWS v7.46.0
published on Thursday, Sep 10, 2026 by Pulumi

    Manages an End User Messaging SMS Sender ID.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.pinpoint.Smsvoicev2SenderId("example", {
        senderId: "MYCOMPANY",
        isoCountryCode: "GB",
        messageTypes: ["TRANSACTIONAL"],
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.pinpoint.Smsvoicev2SenderId("example",
        sender_id="MYCOMPANY",
        iso_country_code="GB",
        message_types=["TRANSACTIONAL"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/pinpoint"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := pinpoint.NewSmsvoicev2SenderId(ctx, "example", &pinpoint.Smsvoicev2SenderIdArgs{
    			SenderId:       pulumi.String("MYCOMPANY"),
    			IsoCountryCode: pulumi.String("GB"),
    			MessageTypes: pulumi.StringArray{
    				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.Smsvoicev2SenderId("example", new()
        {
            SenderId = "MYCOMPANY",
            IsoCountryCode = "GB",
            MessageTypes = new[]
            {
                "TRANSACTIONAL",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.pinpoint.Smsvoicev2SenderId;
    import com.pulumi.aws.pinpoint.Smsvoicev2SenderIdArgs;
    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 example = new Smsvoicev2SenderId("example", Smsvoicev2SenderIdArgs.builder()
                .senderId("MYCOMPANY")
                .isoCountryCode("GB")
                .messageTypes("TRANSACTIONAL")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:pinpoint:Smsvoicev2SenderId
        properties:
          senderId: MYCOMPANY
          isoCountryCode: GB
          messageTypes:
            - TRANSACTIONAL
    
    pulumi {
      required_providers {
        aws = {
          source = "pulumi/aws"
        }
      }
    }
    
    resource "aws_pinpoint_smsvoicev2senderid" "example" {
      sender_id        = "MYCOMPANY"
      iso_country_code = "GB"
      message_types    = ["TRANSACTIONAL"]
    }
    

    With Deletion Protection

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.pinpoint.Smsvoicev2SenderId("example", {
        senderId: "MYCOMPANY",
        isoCountryCode: "GB",
        messageTypes: ["TRANSACTIONAL"],
        deletionProtectionEnabled: true,
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.pinpoint.Smsvoicev2SenderId("example",
        sender_id="MYCOMPANY",
        iso_country_code="GB",
        message_types=["TRANSACTIONAL"],
        deletion_protection_enabled=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/pinpoint"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := pinpoint.NewSmsvoicev2SenderId(ctx, "example", &pinpoint.Smsvoicev2SenderIdArgs{
    			SenderId:       pulumi.String("MYCOMPANY"),
    			IsoCountryCode: pulumi.String("GB"),
    			MessageTypes: pulumi.StringArray{
    				pulumi.String("TRANSACTIONAL"),
    			},
    			DeletionProtectionEnabled: pulumi.Bool(true),
    		})
    		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.Smsvoicev2SenderId("example", new()
        {
            SenderId = "MYCOMPANY",
            IsoCountryCode = "GB",
            MessageTypes = new[]
            {
                "TRANSACTIONAL",
            },
            DeletionProtectionEnabled = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.pinpoint.Smsvoicev2SenderId;
    import com.pulumi.aws.pinpoint.Smsvoicev2SenderIdArgs;
    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 example = new Smsvoicev2SenderId("example", Smsvoicev2SenderIdArgs.builder()
                .senderId("MYCOMPANY")
                .isoCountryCode("GB")
                .messageTypes("TRANSACTIONAL")
                .deletionProtectionEnabled(true)
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:pinpoint:Smsvoicev2SenderId
        properties:
          senderId: MYCOMPANY
          isoCountryCode: GB
          messageTypes:
            - TRANSACTIONAL
          deletionProtectionEnabled: true
    
    pulumi {
      required_providers {
        aws = {
          source = "pulumi/aws"
        }
      }
    }
    
    resource "aws_pinpoint_smsvoicev2senderid" "example" {
      sender_id                   = "MYCOMPANY"
      iso_country_code            = "GB"
      message_types               = ["TRANSACTIONAL"]
      deletion_protection_enabled = true
    }
    

    Create Smsvoicev2SenderId Resource

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

    Constructor syntax

    new Smsvoicev2SenderId(name: string, args: Smsvoicev2SenderIdArgs, opts?: CustomResourceOptions);
    @overload
    def Smsvoicev2SenderId(resource_name: str,
                           args: Smsvoicev2SenderIdArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def Smsvoicev2SenderId(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           iso_country_code: Optional[str] = None,
                           sender_id: Optional[str] = None,
                           deletion_protection_enabled: Optional[bool] = None,
                           message_types: Optional[Sequence[str]] = None,
                           region: Optional[str] = None,
                           tags: Optional[Mapping[str, str]] = None,
                           timeouts: Optional[Smsvoicev2SenderIdTimeoutsArgs] = None)
    func NewSmsvoicev2SenderId(ctx *Context, name string, args Smsvoicev2SenderIdArgs, opts ...ResourceOption) (*Smsvoicev2SenderId, error)
    public Smsvoicev2SenderId(string name, Smsvoicev2SenderIdArgs args, CustomResourceOptions? opts = null)
    public Smsvoicev2SenderId(String name, Smsvoicev2SenderIdArgs args)
    public Smsvoicev2SenderId(String name, Smsvoicev2SenderIdArgs args, CustomResourceOptions options)
    
    type: aws:pinpoint:Smsvoicev2SenderId
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws_pinpoint_smsvoicev2_sender_id" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args Smsvoicev2SenderIdArgs
    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 Smsvoicev2SenderIdArgs
    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 Smsvoicev2SenderIdArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args Smsvoicev2SenderIdArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args Smsvoicev2SenderIdArgs
    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 smsvoicev2SenderIdResource = new Aws.Pinpoint.Smsvoicev2SenderId("smsvoicev2SenderIdResource", new()
    {
        IsoCountryCode = "string",
        SenderId = "string",
        DeletionProtectionEnabled = false,
        MessageTypes = new[]
        {
            "string",
        },
        Region = "string",
        Tags = 
        {
            { "string", "string" },
        },
        Timeouts = new Aws.Pinpoint.Inputs.Smsvoicev2SenderIdTimeoutsArgs
        {
            Create = "string",
            Delete = "string",
            Update = "string",
        },
    });
    
    example, err := pinpoint.NewSmsvoicev2SenderId(ctx, "smsvoicev2SenderIdResource", &pinpoint.Smsvoicev2SenderIdArgs{
    	IsoCountryCode:            pulumi.String("string"),
    	SenderId:                  pulumi.String("string"),
    	DeletionProtectionEnabled: pulumi.Bool(false),
    	MessageTypes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Region: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Timeouts: &pinpoint.Smsvoicev2SenderIdTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    		Update: pulumi.String("string"),
    	},
    })
    
    resource "aws_pinpoint_smsvoicev2_sender_id" "smsvoicev2SenderIdResource" {
      lifecycle {
        create_before_destroy = true
      }
      iso_country_code            = "string"
      sender_id                   = "string"
      deletion_protection_enabled = false
      message_types               = ["string"]
      region                      = "string"
      tags = {
        "string" = "string"
      }
      timeouts = {
        create = "string"
        delete = "string"
        update = "string"
      }
    }
    
    var smsvoicev2SenderIdResource = new Smsvoicev2SenderId("smsvoicev2SenderIdResource", Smsvoicev2SenderIdArgs.builder()
        .isoCountryCode("string")
        .senderId("string")
        .deletionProtectionEnabled(false)
        .messageTypes("string")
        .region("string")
        .tags(Map.of("string", "string"))
        .timeouts(Smsvoicev2SenderIdTimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .update("string")
            .build())
        .build());
    
    smsvoicev2_sender_id_resource = aws.pinpoint.Smsvoicev2SenderId("smsvoicev2SenderIdResource",
        iso_country_code="string",
        sender_id="string",
        deletion_protection_enabled=False,
        message_types=["string"],
        region="string",
        tags={
            "string": "string",
        },
        timeouts={
            "create": "string",
            "delete": "string",
            "update": "string",
        })
    
    const smsvoicev2SenderIdResource = new aws.pinpoint.Smsvoicev2SenderId("smsvoicev2SenderIdResource", {
        isoCountryCode: "string",
        senderId: "string",
        deletionProtectionEnabled: false,
        messageTypes: ["string"],
        region: "string",
        tags: {
            string: "string",
        },
        timeouts: {
            create: "string",
            "delete": "string",
            update: "string",
        },
    });
    
    type: aws:pinpoint:Smsvoicev2SenderId
    properties:
        deletionProtectionEnabled: false
        isoCountryCode: string
        messageTypes:
            - string
        region: string
        senderId: string
        tags:
            string: string
        timeouts:
            create: string
            delete: string
            update: string
    

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

    IsoCountryCode string
    Two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    SenderId string

    Alphanumeric sender ID to request. Must be between 3 and 11 characters long, contain only upper case letters, numbers, and dashes, and cannot be numeric-only. AWS stores sender IDs in upper case, so upper case is required here to keep configuration, state, and resource identity consistent.

    The following arguments are optional:

    DeletionProtectionEnabled bool
    Whether deletion protection is enabled. When set to true, the sender ID cannot be deleted. Defaults to false.
    MessageTypes List<string>
    Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Defaults to ["TRANSACTIONAL"] if not specified.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts Smsvoicev2SenderIdTimeouts
    IsoCountryCode string
    Two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    SenderId string

    Alphanumeric sender ID to request. Must be between 3 and 11 characters long, contain only upper case letters, numbers, and dashes, and cannot be numeric-only. AWS stores sender IDs in upper case, so upper case is required here to keep configuration, state, and resource identity consistent.

    The following arguments are optional:

    DeletionProtectionEnabled bool
    Whether deletion protection is enabled. When set to true, the sender ID cannot be deleted. Defaults to false.
    MessageTypes []string
    Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Defaults to ["TRANSACTIONAL"] if not specified.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts Smsvoicev2SenderIdTimeoutsArgs
    iso_country_code string
    Two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    sender_id string

    Alphanumeric sender ID to request. Must be between 3 and 11 characters long, contain only upper case letters, numbers, and dashes, and cannot be numeric-only. AWS stores sender IDs in upper case, so upper case is required here to keep configuration, state, and resource identity consistent.

    The following arguments are optional:

    deletion_protection_enabled bool
    Whether deletion protection is enabled. When set to true, the sender ID cannot be deleted. Defaults to false.
    message_types list(string)
    Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Defaults to ["TRANSACTIONAL"] if not specified.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags map(string)
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts object
    isoCountryCode String
    Two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    senderId String

    Alphanumeric sender ID to request. Must be between 3 and 11 characters long, contain only upper case letters, numbers, and dashes, and cannot be numeric-only. AWS stores sender IDs in upper case, so upper case is required here to keep configuration, state, and resource identity consistent.

    The following arguments are optional:

    deletionProtectionEnabled Boolean
    Whether deletion protection is enabled. When set to true, the sender ID cannot be deleted. Defaults to false.
    messageTypes List<String>
    Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Defaults to ["TRANSACTIONAL"] if not specified.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts Smsvoicev2SenderIdTimeouts
    isoCountryCode string
    Two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    senderId string

    Alphanumeric sender ID to request. Must be between 3 and 11 characters long, contain only upper case letters, numbers, and dashes, and cannot be numeric-only. AWS stores sender IDs in upper case, so upper case is required here to keep configuration, state, and resource identity consistent.

    The following arguments are optional:

    deletionProtectionEnabled boolean
    Whether deletion protection is enabled. When set to true, the sender ID cannot be deleted. Defaults to false.
    messageTypes string[]
    Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Defaults to ["TRANSACTIONAL"] if not specified.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts Smsvoicev2SenderIdTimeouts
    iso_country_code str
    Two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    sender_id str

    Alphanumeric sender ID to request. Must be between 3 and 11 characters long, contain only upper case letters, numbers, and dashes, and cannot be numeric-only. AWS stores sender IDs in upper case, so upper case is required here to keep configuration, state, and resource identity consistent.

    The following arguments are optional:

    deletion_protection_enabled bool
    Whether deletion protection is enabled. When set to true, the sender ID cannot be deleted. Defaults to false.
    message_types Sequence[str]
    Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Defaults to ["TRANSACTIONAL"] if not specified.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts Smsvoicev2SenderIdTimeoutsArgs
    isoCountryCode String
    Two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    senderId String

    Alphanumeric sender ID to request. Must be between 3 and 11 characters long, contain only upper case letters, numbers, and dashes, and cannot be numeric-only. AWS stores sender IDs in upper case, so upper case is required here to keep configuration, state, and resource identity consistent.

    The following arguments are optional:

    deletionProtectionEnabled Boolean
    Whether deletion protection is enabled. When set to true, the sender ID cannot be deleted. Defaults to false.
    messageTypes List<String>
    Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Defaults to ["TRANSACTIONAL"] if not specified.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts Property Map

    Outputs

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

    Arn string
    ARN of the sender ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    MonthlyLeasingPrice string
    Monthly leasing price, in US dollars.
    Registered bool
    Whether the sender ID is registered.
    RegistrationId string
    Unique identifier for the registration.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    Arn string
    ARN of the sender ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    MonthlyLeasingPrice string
    Monthly leasing price, in US dollars.
    Registered bool
    Whether the sender ID is registered.
    RegistrationId string
    Unique identifier for the registration.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn string
    ARN of the sender ID.
    id string
    The provider-assigned unique ID for this managed resource.
    monthly_leasing_price string
    Monthly leasing price, in US dollars.
    registered bool
    Whether the sender ID is registered.
    registration_id string
    Unique identifier for the registration.
    tags_all map(string)
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn String
    ARN of the sender ID.
    id String
    The provider-assigned unique ID for this managed resource.
    monthlyLeasingPrice String
    Monthly leasing price, in US dollars.
    registered Boolean
    Whether the sender ID is registered.
    registrationId String
    Unique identifier for the registration.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn string
    ARN of the sender ID.
    id string
    The provider-assigned unique ID for this managed resource.
    monthlyLeasingPrice string
    Monthly leasing price, in US dollars.
    registered boolean
    Whether the sender ID is registered.
    registrationId string
    Unique identifier for the registration.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn str
    ARN of the sender ID.
    id str
    The provider-assigned unique ID for this managed resource.
    monthly_leasing_price str
    Monthly leasing price, in US dollars.
    registered bool
    Whether the sender ID is registered.
    registration_id str
    Unique identifier for the registration.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    arn String
    ARN of the sender ID.
    id String
    The provider-assigned unique ID for this managed resource.
    monthlyLeasingPrice String
    Monthly leasing price, in US dollars.
    registered Boolean
    Whether the sender ID is registered.
    registrationId String
    Unique identifier for the registration.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

    Look up Existing Smsvoicev2SenderId Resource

    Get an existing Smsvoicev2SenderId 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?: Smsvoicev2SenderIdState, opts?: CustomResourceOptions): Smsvoicev2SenderId
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            deletion_protection_enabled: Optional[bool] = None,
            iso_country_code: Optional[str] = None,
            message_types: Optional[Sequence[str]] = None,
            monthly_leasing_price: Optional[str] = None,
            region: Optional[str] = None,
            registered: Optional[bool] = None,
            registration_id: Optional[str] = None,
            sender_id: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            timeouts: Optional[Smsvoicev2SenderIdTimeoutsArgs] = None) -> Smsvoicev2SenderId
    func GetSmsvoicev2SenderId(ctx *Context, name string, id IDInput, state *Smsvoicev2SenderIdState, opts ...ResourceOption) (*Smsvoicev2SenderId, error)
    public static Smsvoicev2SenderId Get(string name, Input<string> id, Smsvoicev2SenderIdState? state, CustomResourceOptions? opts = null)
    public static Smsvoicev2SenderId get(String name, Output<String> id, Smsvoicev2SenderIdState state, CustomResourceOptions options)
    resources:  _:    type: aws:pinpoint:Smsvoicev2SenderId    get:      id: ${id}
    import {
      to = aws_pinpoint_smsvoicev2_sender_id.example
      id = "${id}"
    }
    
    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 sender ID.
    DeletionProtectionEnabled bool
    Whether deletion protection is enabled. When set to true, the sender ID cannot be deleted. Defaults to false.
    IsoCountryCode string
    Two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    MessageTypes List<string>
    Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Defaults to ["TRANSACTIONAL"] if not specified.
    MonthlyLeasingPrice string
    Monthly leasing price, in US dollars.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Registered bool
    Whether the sender ID is registered.
    RegistrationId string
    Unique identifier for the registration.
    SenderId string

    Alphanumeric sender ID to request. Must be between 3 and 11 characters long, contain only upper case letters, numbers, and dashes, and cannot be numeric-only. AWS stores sender IDs in upper case, so upper case is required here to keep configuration, state, and resource identity consistent.

    The following arguments are optional:

    Tags Dictionary<string, string>
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    Timeouts Smsvoicev2SenderIdTimeouts
    Arn string
    ARN of the sender ID.
    DeletionProtectionEnabled bool
    Whether deletion protection is enabled. When set to true, the sender ID cannot be deleted. Defaults to false.
    IsoCountryCode string
    Two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    MessageTypes []string
    Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Defaults to ["TRANSACTIONAL"] if not specified.
    MonthlyLeasingPrice string
    Monthly leasing price, in US dollars.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Registered bool
    Whether the sender ID is registered.
    RegistrationId string
    Unique identifier for the registration.
    SenderId string

    Alphanumeric sender ID to request. Must be between 3 and 11 characters long, contain only upper case letters, numbers, and dashes, and cannot be numeric-only. AWS stores sender IDs in upper case, so upper case is required here to keep configuration, state, and resource identity consistent.

    The following arguments are optional:

    Tags map[string]string
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    Timeouts Smsvoicev2SenderIdTimeoutsArgs
    arn string
    ARN of the sender ID.
    deletion_protection_enabled bool
    Whether deletion protection is enabled. When set to true, the sender ID cannot be deleted. Defaults to false.
    iso_country_code string
    Two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    message_types list(string)
    Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Defaults to ["TRANSACTIONAL"] if not specified.
    monthly_leasing_price string
    Monthly leasing price, in US dollars.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    registered bool
    Whether the sender ID is registered.
    registration_id string
    Unique identifier for the registration.
    sender_id string

    Alphanumeric sender ID to request. Must be between 3 and 11 characters long, contain only upper case letters, numbers, and dashes, and cannot be numeric-only. AWS stores sender IDs in upper case, so upper case is required here to keep configuration, state, and resource identity consistent.

    The following arguments are optional:

    tags map(string)
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all map(string)
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    timeouts object
    arn String
    ARN of the sender ID.
    deletionProtectionEnabled Boolean
    Whether deletion protection is enabled. When set to true, the sender ID cannot be deleted. Defaults to false.
    isoCountryCode String
    Two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    messageTypes List<String>
    Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Defaults to ["TRANSACTIONAL"] if not specified.
    monthlyLeasingPrice String
    Monthly leasing price, in US dollars.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    registered Boolean
    Whether the sender ID is registered.
    registrationId String
    Unique identifier for the registration.
    senderId String

    Alphanumeric sender ID to request. Must be between 3 and 11 characters long, contain only upper case letters, numbers, and dashes, and cannot be numeric-only. AWS stores sender IDs in upper case, so upper case is required here to keep configuration, state, and resource identity consistent.

    The following arguments are optional:

    tags Map<String,String>
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    timeouts Smsvoicev2SenderIdTimeouts
    arn string
    ARN of the sender ID.
    deletionProtectionEnabled boolean
    Whether deletion protection is enabled. When set to true, the sender ID cannot be deleted. Defaults to false.
    isoCountryCode string
    Two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    messageTypes string[]
    Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Defaults to ["TRANSACTIONAL"] if not specified.
    monthlyLeasingPrice string
    Monthly leasing price, in US dollars.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    registered boolean
    Whether the sender ID is registered.
    registrationId string
    Unique identifier for the registration.
    senderId string

    Alphanumeric sender ID to request. Must be between 3 and 11 characters long, contain only upper case letters, numbers, and dashes, and cannot be numeric-only. AWS stores sender IDs in upper case, so upper case is required here to keep configuration, state, and resource identity consistent.

    The following arguments are optional:

    tags {[key: string]: string}
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    timeouts Smsvoicev2SenderIdTimeouts
    arn str
    ARN of the sender ID.
    deletion_protection_enabled bool
    Whether deletion protection is enabled. When set to true, the sender ID cannot be deleted. Defaults to false.
    iso_country_code str
    Two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    message_types Sequence[str]
    Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Defaults to ["TRANSACTIONAL"] if not specified.
    monthly_leasing_price str
    Monthly leasing price, in US dollars.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    registered bool
    Whether the sender ID is registered.
    registration_id str
    Unique identifier for the registration.
    sender_id str

    Alphanumeric sender ID to request. Must be between 3 and 11 characters long, contain only upper case letters, numbers, and dashes, and cannot be numeric-only. AWS stores sender IDs in upper case, so upper case is required here to keep configuration, state, and resource identity consistent.

    The following arguments are optional:

    tags Mapping[str, str]
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    timeouts Smsvoicev2SenderIdTimeoutsArgs
    arn String
    ARN of the sender ID.
    deletionProtectionEnabled Boolean
    Whether deletion protection is enabled. When set to true, the sender ID cannot be deleted. Defaults to false.
    isoCountryCode String
    Two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
    messageTypes List<String>
    Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Defaults to ["TRANSACTIONAL"] if not specified.
    monthlyLeasingPrice String
    Monthly leasing price, in US dollars.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    registered Boolean
    Whether the sender ID is registered.
    registrationId String
    Unique identifier for the registration.
    senderId String

    Alphanumeric sender ID to request. Must be between 3 and 11 characters long, contain only upper case letters, numbers, and dashes, and cannot be numeric-only. AWS stores sender IDs in upper case, so upper case is required here to keep configuration, state, and resource identity consistent.

    The following arguments are optional:

    tags Map<String>
    Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    timeouts Property Map

    Supporting Types

    Smsvoicev2SenderIdTimeouts, Smsvoicev2SenderIdTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Import

    Identity Schema

    Required

    • senderId (String) Sender ID.
    • isoCountryCode (String) Two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

    Optional

    • accountId (String) AWS Account where this resource is managed.
    • region (String) Region where this resource is managed.

    Using pulumi import, import an End User Messaging SMS Sender ID using the senderId and isoCountryCode, separated by a comma. For example:

    $ pulumi import aws:pinpoint/smsvoicev2SenderId:Smsvoicev2SenderId example "MYSENDERID,US"
    

    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 logo
    Viewing docs for AWS v7.46.0
    published on Thursday, Sep 10, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial