Class: Aws::EndUserMessaging::Types::CodeConfigurationParameters

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

Overview

The passcode policy parameters that are grouped for reuse across a notify code configuration and its create request. Each member is optional. When you omit a member on a create request, no value is applied at create time and the default is applied when a passcode is sent.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#code_length ⇒ Integer

The number of characters in the one-time passcode. Valid values range from 4 through 8. When you do not specify a value, the default is applied when a passcode is sent.

Returns:

  • (Integer) 


256
257
258
259
260
261
262
263
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 256

class CodeConfigurationParameters < Struct.new(
  :code_type,
  :code_length,
  :validity_period_minutes,
  :max_attempts)
  SENSITIVE = []
  include Aws::Structure
end

#code_type ⇒ String

The character set used to generate the one-time passcode. Valid values are NUMERIC (digits only), ALPHA (uppercase letters only), and ALPHANUMERIC (uppercase letters and digits). When you do not specify a value, the default is applied when a passcode is sent.

Returns:

  • (String) 


256
257
258
259
260
261
262
263
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 256

class CodeConfigurationParameters < Struct.new(
  :code_type,
  :code_length,
  :validity_period_minutes,
  :max_attempts)
  SENSITIVE = []
  include Aws::Structure
end

#max_attempts ⇒ Integer

The maximum number of validation attempts that are allowed before the verification is locked. Valid values range from 1 through 5. When you do not specify a value, the default is applied when a passcode is sent.

Returns:

  • (Integer) 


256
257
258
259
260
261
262
263
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 256

class CodeConfigurationParameters < Struct.new(
  :code_type,
  :code_length,
  :validity_period_minutes,
  :max_attempts)
  SENSITIVE = []
  include Aws::Structure
end

#validity_period_minutes ⇒ Integer

The length of time, in minutes, that the one-time passcode remains valid. Valid values range from 1 through 60. When you do not specify a value, the default is applied when a passcode is sent.

Returns:

  • (Integer) 


256
257
258
259
260
261
262
263
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 256

class CodeConfigurationParameters < Struct.new(
  :code_type,
  :code_length,
  :validity_period_minutes,
  :max_attempts)
  SENSITIVE = []
  include Aws::Structure
end