Class: Aws::EndUserMessaging::Types::CreateNotifyCodeConfigurationInput

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:client_token]

Instance Attribute Summary collapse

Instance Attribute Details

#channel_parameters ⇒ Types::ChannelParameters

The channel-specific parameters used to render and deliver the one-time passcode. Provide parameters for any subset of channels. Each member configures one delivery route, and the route that is selected at send time uses the matching channel.

Returns:



508
509
510
511
512
513
514
515
516
517
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 508

class CreateNotifyCodeConfigurationInput < Struct.new(
  :notify_code_configuration_name,
  :code_configuration_parameters,
  :channel_parameters,
  :deletion_protection_enabled,
  :client_token,
  :tags)
  SENSITIVE = [:client_token]
  include Aws::Structure
end

#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.

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

Returns:

  • (String) 


508
509
510
511
512
513
514
515
516
517
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 508

class CreateNotifyCodeConfigurationInput < Struct.new(
  :notify_code_configuration_name,
  :code_configuration_parameters,
  :channel_parameters,
  :deletion_protection_enabled,
  :client_token,
  :tags)
  SENSITIVE = [:client_token]
  include Aws::Structure
end

#code_configuration_parameters ⇒ Types::CodeConfigurationParameters

The passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. Each member is optional. When you omit a member, no value is applied at create time and the default is applied when a passcode is sent.

Returns:



508
509
510
511
512
513
514
515
516
517
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 508

class CreateNotifyCodeConfigurationInput < Struct.new(
  :notify_code_configuration_name,
  :code_configuration_parameters,
  :channel_parameters,
  :deletion_protection_enabled,
  :client_token,
  :tags)
  SENSITIVE = [:client_token]
  include Aws::Structure
end

#deletion_protection_enabled ⇒ Boolean

Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

Returns:

  • (Boolean) 


508
509
510
511
512
513
514
515
516
517
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 508

class CreateNotifyCodeConfigurationInput < Struct.new(
  :notify_code_configuration_name,
  :code_configuration_parameters,
  :channel_parameters,
  :deletion_protection_enabled,
  :client_token,
  :tags)
  SENSITIVE = [:client_token]
  include Aws::Structure
end

#notify_code_configuration_name ⇒ String

The name of the notify code configuration.

Returns:

  • (String) 


508
509
510
511
512
513
514
515
516
517
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 508

class CreateNotifyCodeConfigurationInput < Struct.new(
  :notify_code_configuration_name,
  :code_configuration_parameters,
  :channel_parameters,
  :deletion_protection_enabled,
  :client_token,
  :tags)
  SENSITIVE = [:client_token]
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

An array of key and value pair tags that are associated with the resource.

Returns:



508
509
510
511
512
513
514
515
516
517
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 508

class CreateNotifyCodeConfigurationInput < Struct.new(
  :notify_code_configuration_name,
  :code_configuration_parameters,
  :channel_parameters,
  :deletion_protection_enabled,
  :client_token,
  :tags)
  SENSITIVE = [:client_token]
  include Aws::Structure
end