Class: Aws::EndUserMessaging::Types::UpdateCodeConfigurationParameters

Inherits:

Struct

• Object
• Struct
• Aws::EndUserMessaging::Types::UpdateCodeConfigurationParameters

Defined in:

gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb

Overview

The loose variant of the passcode policy parameters that is used only when you update a notify code configuration. When you omit a member, its current value is preserved.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #code_length ⇒ Integer

  The updated number of characters in the one-time passcode.

• #code_type ⇒ String

  The updated character set used to generate the one-time passcode.

• #max_attempts ⇒ Integer

  The updated maximum number of validation attempts that are allowed before the verification is locked.

• #validity_period_minutes ⇒ Integer

  The updated length of time, in minutes, that the one-time passcode remains valid.

Instance Attribute Details

#code_length ⇒ Integer

The updated number of characters in the one-time passcode. Valid values range from 4 through 8. Omit this member to preserve the current value.

Returns:

• (Integer)

# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 1888

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

#code_type ⇒ String

The updated character set used to generate the one-time passcode. Omit this member to preserve the current value.

Returns:

• (String)

# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 1888

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

#max_attempts ⇒ Integer

The updated maximum number of validation attempts that are allowed before the verification is locked. Valid values range from 1 through 5. Omit this member to preserve the current value.

Returns:

• (Integer)

# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 1888

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

#validity_period_minutes ⇒ Integer

The updated length of time, in minutes, that the one-time passcode remains valid. Valid values range from 1 through 60. Omit this member to preserve the current value.

Returns:

• (Integer)

# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 1888

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