Class: Aws::PinpointSMSVoiceV2::Types::CreateNotifyConfigurationRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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) 


784
785
786
787
788
789
790
791
792
793
794
795
796
 
# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 784

class CreateNotifyConfigurationRequest < Struct.new(
  :display_name,
  :use_case,
  :default_template_id,
  :pool_id,
  :enabled_countries,
  :enabled_channels,
  :deletion_protection_enabled,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#default_template_id ⇒ String

The default template identifier to associate with the notify configuration. If specified, this template is used when sending messages without an explicit template identifier.

Returns:

  • (String) 


784
785
786
787
788
789
790
791
792
793
794
795
796
 
# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 784

class CreateNotifyConfigurationRequest < Struct.new(
  :display_name,
  :use_case,
  :default_template_id,
  :pool_id,
  :enabled_countries,
  :enabled_channels,
  :deletion_protection_enabled,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection_enabled ⇒ Boolean

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

Returns:

  • (Boolean) 


784
785
786
787
788
789
790
791
792
793
794
795
796
 
# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 784

class CreateNotifyConfigurationRequest < Struct.new(
  :display_name,
  :use_case,
  :default_template_id,
  :pool_id,
  :enabled_countries,
  :enabled_channels,
  :deletion_protection_enabled,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

The display name to associate with the notify configuration.

Returns:

  • (String) 


784
785
786
787
788
789
790
791
792
793
794
795
796
 
# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 784

class CreateNotifyConfigurationRequest < Struct.new(
  :display_name,
  :use_case,
  :default_template_id,
  :pool_id,
  :enabled_countries,
  :enabled_channels,
  :deletion_protection_enabled,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#enabled_channels ⇒ Array<String>

An array of channels to enable for the notify configuration. Supported values include SMS and VOICE.

Returns:

  • (Array<String>) 


784
785
786
787
788
789
790
791
792
793
794
795
796
 
# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 784

class CreateNotifyConfigurationRequest < Struct.new(
  :display_name,
  :use_case,
  :default_template_id,
  :pool_id,
  :enabled_countries,
  :enabled_channels,
  :deletion_protection_enabled,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#enabled_countries ⇒ Array<String>

An array of two-character ISO country codes, in ISO 3166-1 alpha-2 format, that are enabled for the notify configuration.

Returns:

  • (Array<String>) 


784
785
786
787
788
789
790
791
792
793
794
795
796
 
# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 784

class CreateNotifyConfigurationRequest < Struct.new(
  :display_name,
  :use_case,
  :default_template_id,
  :pool_id,
  :enabled_countries,
  :enabled_channels,
  :deletion_protection_enabled,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#pool_id ⇒ String

The identifier of the pool to associate with the notify configuration.

Returns:

  • (String) 


784
785
786
787
788
789
790
791
792
793
794
795
796
 
# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 784

class CreateNotifyConfigurationRequest < Struct.new(
  :display_name,
  :use_case,
  :default_template_id,
  :pool_id,
  :enabled_countries,
  :enabled_channels,
  :deletion_protection_enabled,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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

Returns:



784
785
786
787
788
789
790
791
792
793
794
795
796
 
# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 784

class CreateNotifyConfigurationRequest < Struct.new(
  :display_name,
  :use_case,
  :default_template_id,
  :pool_id,
  :enabled_countries,
  :enabled_channels,
  :deletion_protection_enabled,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#use_case ⇒ String

The use case for the notify configuration.

Returns:

  • (String) 


784
785
786
787
788
789
790
791
792
793
794
795
796
 
# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 784

class CreateNotifyConfigurationRequest < Struct.new(
  :display_name,
  :use_case,
  :default_template_id,
  :pool_id,
  :enabled_countries,
  :enabled_channels,
  :deletion_protection_enabled,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end