Class: Aws::PinpointSMSVoiceV2::Types::CreatePoolRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


519
520
521
522
523
524
525
526
527
528
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 519

class CreatePoolRequest < Struct.new(
  :origination_identity,
  :iso_country_code,
  :message_type,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection_enabled ⇒ Boolean

By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action.

Returns:

  • (Boolean) 


519
520
521
522
523
524
525
526
527
528
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 519

class CreatePoolRequest < Struct.new(
  :origination_identity,
  :iso_country_code,
  :message_type,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#iso_country_code ⇒ String

The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.

Returns:

  • (String) 


519
520
521
522
523
524
525
526
527
528
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 519

class CreatePoolRequest < Struct.new(
  :origination_identity,
  :iso_country_code,
  :message_type,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#message_type ⇒ String

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

Returns:

  • (String) 


519
520
521
522
523
524
525
526
527
528
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 519

class CreatePoolRequest < Struct.new(
  :origination_identity,
  :iso_country_code,
  :message_type,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#origination_identity ⇒ String

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

Returns:

  • (String) 


519
520
521
522
523
524
525
526
527
528
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 519

class CreatePoolRequest < Struct.new(
  :origination_identity,
  :iso_country_code,
  :message_type,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

An array of tags (key and value pairs) associated with the pool.

Returns:



519
520
521
522
523
524
525
526
527
528
 
# File 'gems/aws-sdk-pinpointsmsvoicev2/lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 519

class CreatePoolRequest < Struct.new(
  :origination_identity,
  :iso_country_code,
  :message_type,
  :deletion_protection_enabled,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end