aws.pinpoint.Smsvoicev2Pool

Whether deletion protection is enabled. When true, the pool cannot be deleted.

IsoCountryCode string

Two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the pool. Cannot be changed after creation.

OptOutListName string

Name of the opt-out list associated with the pool.

Region string

Region where this resource will be managed. Defaults to the region set in the provider configuration.

Whether the pool relies on self-managed opt-out handling. When false, AWS auto-replies to HELP/STOP requests and manages the opt-out list.

Timeouts Smsvoicev2PoolTimeouts

Whether shared routes are enabled for the pool. When true, messages may use shared phone numbers or sender IDs in countries that allow it.

Tags Dictionary<string, string>

Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TwoWayChannelArn string

Destination for incoming messages. Specify an ARN to receive incoming messages, or connect.[region].amazonaws.com (with [region] replaced by the AWS Region of the Amazon Connect instance) to set Amazon Connect as the inbound destination.

ARN of the IAM role that End User Messaging SMS assumes to publish inbound messages to the two-way channel.

Whether inbound message reception is enabled for the pool. When true, twoWayChannelArn must be set.

MessageType string

Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Cannot be changed after creation.

OriginationIdentities []string

Set of origination identity ARNs (phone number ARNs or sender ID ARNs) associated with the pool. At least one identity is required at creation.

The following arguments are optional:

Whether deletion protection is enabled. When true, the pool cannot be deleted.

IsoCountryCode string

Two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the pool. Cannot be changed after creation.

OptOutListName string

Name of the opt-out list associated with the pool.

Region string

Region where this resource will be managed. Defaults to the region set in the provider configuration.

Whether the pool relies on self-managed opt-out handling. When false, AWS auto-replies to HELP/STOP requests and manages the opt-out list.

Timeouts Smsvoicev2PoolTimeoutsArgs

Whether shared routes are enabled for the pool. When true, messages may use shared phone numbers or sender IDs in countries that allow it.

Tags map[string]string

Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TwoWayChannelArn string

ARN of the IAM role that End User Messaging SMS assumes to publish inbound messages to the two-way channel.

Whether inbound message reception is enabled for the pool. When true, twoWayChannelArn must be set.

message_type string

Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Cannot be changed after creation.

origination_identities list(string)

Set of origination identity ARNs (phone number ARNs or sender ID ARNs) associated with the pool. At least one identity is required at creation.

The following arguments are optional:

Whether deletion protection is enabled. When true, the pool cannot be deleted.

iso_country_code string

Two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the pool. Cannot be changed after creation.

opt_out_list_name string

Name of the opt-out list associated with the pool.

region string

Region where this resource will be managed. Defaults to the region set in the provider configuration.

Whether the pool relies on self-managed opt-out handling. When false, AWS auto-replies to HELP/STOP requests and manages the opt-out list.

Whether shared routes are enabled for the pool. When true, messages may use shared phone numbers or sender IDs in countries that allow it.

tags map(string)

Map of tags to assign 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

two_way_channel_arn string

two_way_channel_role string

ARN of the IAM role that End User Messaging SMS assumes to publish inbound messages to the two-way channel.

Whether inbound message reception is enabled for the pool. When true, twoWayChannelArn must be set.

messageType String

Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Cannot be changed after creation.

originationIdentities List<String>

Set of origination identity ARNs (phone number ARNs or sender ID ARNs) associated with the pool. At least one identity is required at creation.

The following arguments are optional:

Whether deletion protection is enabled. When true, the pool cannot be deleted.

isoCountryCode String

Two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the pool. Cannot be changed after creation.

optOutListName String

Name of the opt-out list associated with the pool.

region String

Region where this resource will be managed. Defaults to the region set in the provider configuration.

Whether the pool relies on self-managed opt-out handling. When false, AWS auto-replies to HELP/STOP requests and manages the opt-out list.

Whether shared routes are enabled for the pool. When true, messages may use shared phone numbers or sender IDs in countries that allow it.

tags Map<String,String>

Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

twoWayChannelArn String

ARN of the IAM role that End User Messaging SMS assumes to publish inbound messages to the two-way channel.

twoWayEnabled Boolean

Whether inbound message reception is enabled for the pool. When true, twoWayChannelArn must be set.

messageType string

Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Cannot be changed after creation.

originationIdentities string[]

Set of origination identity ARNs (phone number ARNs or sender ID ARNs) associated with the pool. At least one identity is required at creation.

The following arguments are optional:

deletionProtectionEnabled boolean

Whether deletion protection is enabled. When true, the pool cannot be deleted.

isoCountryCode string

Two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the pool. Cannot be changed after creation.

optOutListName string

Name of the opt-out list associated with the pool.

region string

Region where this resource will be managed. Defaults to the region set in the provider configuration.

selfManagedOptOutsEnabled boolean

Whether the pool relies on self-managed opt-out handling. When false, AWS auto-replies to HELP/STOP requests and manages the opt-out list.

sharedRoutesEnabled boolean

Whether shared routes are enabled for the pool. When true, messages may use shared phone numbers or sender IDs in countries that allow it.

tags {[key: string]: string}

Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

twoWayChannelArn string

twoWayChannelRole string

ARN of the IAM role that End User Messaging SMS assumes to publish inbound messages to the two-way channel.

twoWayEnabled boolean

Whether inbound message reception is enabled for the pool. When true, twoWayChannelArn must be set.

message_type str

Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Cannot be changed after creation.

origination_identities Sequence[str]

Set of origination identity ARNs (phone number ARNs or sender ID ARNs) associated with the pool. At least one identity is required at creation.

The following arguments are optional:

Whether deletion protection is enabled. When true, the pool cannot be deleted.

iso_country_code str

Two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the pool. Cannot be changed after creation.

opt_out_list_name str

Name of the opt-out list associated with the pool.

region str

Region where this resource will be managed. Defaults to the region set in the provider configuration.

Whether the pool relies on self-managed opt-out handling. When false, AWS auto-replies to HELP/STOP requests and manages the opt-out list.

timeouts Smsvoicev2PoolTimeoutsArgs

Whether shared routes are enabled for the pool. When true, messages may use shared phone numbers or sender IDs in countries that allow it.

tags Mapping[str, str]

Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

two_way_channel_arn str

two_way_channel_role str

ARN of the IAM role that End User Messaging SMS assumes to publish inbound messages to the two-way channel.

Whether inbound message reception is enabled for the pool. When true, twoWayChannelArn must be set.

messageType String

Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Cannot be changed after creation.

originationIdentities List<String>

Set of origination identity ARNs (phone number ARNs or sender ID ARNs) associated with the pool. At least one identity is required at creation.

The following arguments are optional:

Whether deletion protection is enabled. When true, the pool cannot be deleted.

isoCountryCode String

Two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the pool. Cannot be changed after creation.

optOutListName String

Name of the opt-out list associated with the pool.

region String

Region where this resource will be managed. Defaults to the region set in the provider configuration.

Whether the pool relies on self-managed opt-out handling. When false, AWS auto-replies to HELP/STOP requests and manages the opt-out list.

timeouts Property Map

Whether shared routes are enabled for the pool. When true, messages may use shared phone numbers or sender IDs in countries that allow it.

tags Map<String>

Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

twoWayChannelArn String

ARN of the IAM role that End User Messaging SMS assumes to publish inbound messages to the two-way channel.

twoWayEnabled Boolean

Whether inbound message reception is enabled for the pool. When true, twoWayChannelArn must be set.

Outputs

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

Arn string: ARN of the pool.
Id string: The provider-assigned unique ID for this managed resource.
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 pool.
Id string: The provider-assigned unique ID for this managed resource.
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 pool.
id string: The provider-assigned unique ID for this managed resource.
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 pool.
id String: The provider-assigned unique ID for this managed resource.
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 pool.
id string: The provider-assigned unique ID for this managed resource.
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 pool.
id str: The provider-assigned unique ID for this managed resource.
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 pool.
id String: The provider-assigned unique ID for this managed resource.
tagsAll Map<String>: Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

Look up Existing Smsvoicev2Pool Resource

Get an existing Smsvoicev2Pool 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?: Smsvoicev2PoolState, opts?: CustomResourceOptions): Smsvoicev2Pool

@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_type: Optional[str] = None,
        opt_out_list_name: Optional[str] = None,
        origination_identities: Optional[Sequence[str]] = None,
        region: Optional[str] = None,
        self_managed_opt_outs_enabled: Optional[bool] = None,
        shared_routes_enabled: Optional[bool] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        timeouts: Optional[Smsvoicev2PoolTimeoutsArgs] = None,
        two_way_channel_arn: Optional[str] = None,
        two_way_channel_role: Optional[str] = None,
        two_way_enabled: Optional[bool] = None) -> Smsvoicev2Pool

func GetSmsvoicev2Pool(ctx *Context, name string, id IDInput, state *Smsvoicev2PoolState, opts ...ResourceOption) (*Smsvoicev2Pool, error)

public static Smsvoicev2Pool Get(string name, Input<string> id, Smsvoicev2PoolState? state, CustomResourceOptions? opts = null)

public static Smsvoicev2Pool get(String name, Output<String> id, Smsvoicev2PoolState state, CustomResourceOptions options)

resources:  _:    type: aws:pinpoint:Smsvoicev2Pool    get:      id: ${id}

import {
  to = aws_pinpoint_smsvoicev2_pool.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 pool.

Whether deletion protection is enabled. When true, the pool cannot be deleted.

IsoCountryCode string

Two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the pool. Cannot be changed after creation.

MessageType string

Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Cannot be changed after creation.

OptOutListName string

Name of the opt-out list associated with the pool.

OriginationIdentities List<string>

Set of origination identity ARNs (phone number ARNs or sender ID ARNs) associated with the pool. At least one identity is required at creation.

The following arguments are optional:

Region string

Region where this resource will be managed. Defaults to the region set in the provider configuration.

Whether the pool relies on self-managed opt-out handling. When false, AWS auto-replies to HELP/STOP requests and manages the opt-out list.

Timeouts Smsvoicev2PoolTimeouts

Whether shared routes are enabled for the pool. When true, messages may use shared phone numbers or sender IDs in countries that allow it.

Tags Dictionary<string, string>

Map of tags to assign 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.

TwoWayChannelArn string

ARN of the IAM role that End User Messaging SMS assumes to publish inbound messages to the two-way channel.

Whether inbound message reception is enabled for the pool. When true, twoWayChannelArn must be set.

Arn string

ARN of the pool.

Whether deletion protection is enabled. When true, the pool cannot be deleted.

IsoCountryCode string

Two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the pool. Cannot be changed after creation.

MessageType string

Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Cannot be changed after creation.

OptOutListName string

Name of the opt-out list associated with the pool.

OriginationIdentities []string

Set of origination identity ARNs (phone number ARNs or sender ID ARNs) associated with the pool. At least one identity is required at creation.

The following arguments are optional:

Region string

Region where this resource will be managed. Defaults to the region set in the provider configuration.

Whether the pool relies on self-managed opt-out handling. When false, AWS auto-replies to HELP/STOP requests and manages the opt-out list.

Timeouts Smsvoicev2PoolTimeoutsArgs

Whether shared routes are enabled for the pool. When true, messages may use shared phone numbers or sender IDs in countries that allow it.

Tags map[string]string

Map of tags to assign 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.

TwoWayChannelArn string

ARN of the IAM role that End User Messaging SMS assumes to publish inbound messages to the two-way channel.

Whether inbound message reception is enabled for the pool. When true, twoWayChannelArn must be set.

arn string

ARN of the pool.

Whether deletion protection is enabled. When true, the pool cannot be deleted.

iso_country_code string

Two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the pool. Cannot be changed after creation.

message_type string

Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Cannot be changed after creation.

opt_out_list_name string

Name of the opt-out list associated with the pool.

origination_identities list(string)

Set of origination identity ARNs (phone number ARNs or sender ID ARNs) associated with the pool. At least one identity is required at creation.

The following arguments are optional:

region string

Region where this resource will be managed. Defaults to the region set in the provider configuration.

Whether the pool relies on self-managed opt-out handling. When false, AWS auto-replies to HELP/STOP requests and manages the opt-out list.

Whether shared routes are enabled for the pool. When true, messages may use shared phone numbers or sender IDs in countries that allow it.

tags map(string)

Map of tags to assign 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

two_way_channel_arn string

two_way_channel_role string

ARN of the IAM role that End User Messaging SMS assumes to publish inbound messages to the two-way channel.

Whether inbound message reception is enabled for the pool. When true, twoWayChannelArn must be set.

arn String

ARN of the pool.

Whether deletion protection is enabled. When true, the pool cannot be deleted.

isoCountryCode String

Two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the pool. Cannot be changed after creation.

messageType String

Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Cannot be changed after creation.

optOutListName String

Name of the opt-out list associated with the pool.

originationIdentities List<String>

Set of origination identity ARNs (phone number ARNs or sender ID ARNs) associated with the pool. At least one identity is required at creation.

The following arguments are optional:

region String

Region where this resource will be managed. Defaults to the region set in the provider configuration.

Whether the pool relies on self-managed opt-out handling. When false, AWS auto-replies to HELP/STOP requests and manages the opt-out list.

Whether shared routes are enabled for the pool. When true, messages may use shared phone numbers or sender IDs in countries that allow it.

tags Map<String,String>

Map of tags to assign 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.

twoWayChannelArn String

ARN of the IAM role that End User Messaging SMS assumes to publish inbound messages to the two-way channel.

twoWayEnabled Boolean

Whether inbound message reception is enabled for the pool. When true, twoWayChannelArn must be set.

arn string

ARN of the pool.

deletionProtectionEnabled boolean

Whether deletion protection is enabled. When true, the pool cannot be deleted.

isoCountryCode string

Two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the pool. Cannot be changed after creation.

messageType string

Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Cannot be changed after creation.

optOutListName string

Name of the opt-out list associated with the pool.

originationIdentities string[]

Set of origination identity ARNs (phone number ARNs or sender ID ARNs) associated with the pool. At least one identity is required at creation.

The following arguments are optional:

region string

Region where this resource will be managed. Defaults to the region set in the provider configuration.

selfManagedOptOutsEnabled boolean

Whether the pool relies on self-managed opt-out handling. When false, AWS auto-replies to HELP/STOP requests and manages the opt-out list.

sharedRoutesEnabled boolean

Whether shared routes are enabled for the pool. When true, messages may use shared phone numbers or sender IDs in countries that allow it.

tags {[key: string]: string}

Map of tags to assign 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.

twoWayChannelArn string

twoWayChannelRole string

ARN of the IAM role that End User Messaging SMS assumes to publish inbound messages to the two-way channel.

twoWayEnabled boolean

Whether inbound message reception is enabled for the pool. When true, twoWayChannelArn must be set.

arn str

ARN of the pool.

Whether deletion protection is enabled. When true, the pool cannot be deleted.

iso_country_code str

Two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the pool. Cannot be changed after creation.

message_type str

Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Cannot be changed after creation.

opt_out_list_name str

Name of the opt-out list associated with the pool.

origination_identities Sequence[str]

Set of origination identity ARNs (phone number ARNs or sender ID ARNs) associated with the pool. At least one identity is required at creation.

The following arguments are optional:

region str

Region where this resource will be managed. Defaults to the region set in the provider configuration.

Whether the pool relies on self-managed opt-out handling. When false, AWS auto-replies to HELP/STOP requests and manages the opt-out list.

timeouts Smsvoicev2PoolTimeoutsArgs

Whether shared routes are enabled for the pool. When true, messages may use shared phone numbers or sender IDs in countries that allow it.

tags Mapping[str, str]

Map of tags to assign 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.

two_way_channel_arn str

two_way_channel_role str

ARN of the IAM role that End User Messaging SMS assumes to publish inbound messages to the two-way channel.

Whether inbound message reception is enabled for the pool. When true, twoWayChannelArn must be set.

arn String

ARN of the pool.

Whether deletion protection is enabled. When true, the pool cannot be deleted.

isoCountryCode String

Two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the pool. Cannot be changed after creation.

messageType String

Type of message. Valid values are TRANSACTIONAL and PROMOTIONAL. Cannot be changed after creation.

optOutListName String

Name of the opt-out list associated with the pool.

originationIdentities List<String>

Set of origination identity ARNs (phone number ARNs or sender ID ARNs) associated with the pool. At least one identity is required at creation.

The following arguments are optional:

region String

Region where this resource will be managed. Defaults to the region set in the provider configuration.

Whether the pool relies on self-managed opt-out handling. When false, AWS auto-replies to HELP/STOP requests and manages the opt-out list.

timeouts Property Map

Whether shared routes are enabled for the pool. When true, messages may use shared phone numbers or sender IDs in countries that allow it.

tags Map<String>

Map of tags to assign 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.

twoWayChannelArn String