Class: Aws::EndUserMessaging::Types::NotifyCodeConfiguration

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

Overview

Contains the settings of a notify code configuration, which is a reusable one-time passcode policy.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#channel_parameters ⇒ Types::ChannelParameters

The channel-specific parameters used to render and deliver the one-time passcode. A configuration can carry parameters for every channel at once, and the send route selects the matching channel at send time.

Returns:



1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 1308

class NotifyCodeConfiguration < Struct.new(
  :notify_code_configuration_id,
  :notify_code_configuration_arn,
  :notify_code_configuration_name,
  :code_configuration_parameters,
  :channel_parameters,
  :deletion_protection_enabled,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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.

Returns:



1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 1308

class NotifyCodeConfiguration < Struct.new(
  :notify_code_configuration_id,
  :notify_code_configuration_arn,
  :notify_code_configuration_name,
  :code_configuration_parameters,
  :channel_parameters,
  :deletion_protection_enabled,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The time when the resource was created, in Unix epoch time.

Returns:

  • (Time) 


1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 1308

class NotifyCodeConfiguration < Struct.new(
  :notify_code_configuration_id,
  :notify_code_configuration_arn,
  :notify_code_configuration_name,
  :code_configuration_parameters,
  :channel_parameters,
  :deletion_protection_enabled,
  :created_at,
  :updated_at)
  SENSITIVE = []
  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) 


1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 1308

class NotifyCodeConfiguration < Struct.new(
  :notify_code_configuration_id,
  :notify_code_configuration_arn,
  :notify_code_configuration_name,
  :code_configuration_parameters,
  :channel_parameters,
  :deletion_protection_enabled,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#notify_code_configuration_arn ⇒ String

The Amazon Resource Name (ARN) of the notify code configuration.

Returns:

  • (String) 


1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 1308

class NotifyCodeConfiguration < Struct.new(
  :notify_code_configuration_id,
  :notify_code_configuration_arn,
  :notify_code_configuration_name,
  :code_configuration_parameters,
  :channel_parameters,
  :deletion_protection_enabled,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#notify_code_configuration_id ⇒ String

The unique identifier of the notify code configuration.

Returns:

  • (String) 


1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 1308

class NotifyCodeConfiguration < Struct.new(
  :notify_code_configuration_id,
  :notify_code_configuration_arn,
  :notify_code_configuration_name,
  :code_configuration_parameters,
  :channel_parameters,
  :deletion_protection_enabled,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#notify_code_configuration_name ⇒ String

The name of the notify code configuration.

Returns:

  • (String) 


1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 1308

class NotifyCodeConfiguration < Struct.new(
  :notify_code_configuration_id,
  :notify_code_configuration_arn,
  :notify_code_configuration_name,
  :code_configuration_parameters,
  :channel_parameters,
  :deletion_protection_enabled,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The time when the resource was last updated, in Unix epoch time.

Returns:

  • (Time) 


1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 1308

class NotifyCodeConfiguration < Struct.new(
  :notify_code_configuration_id,
  :notify_code_configuration_arn,
  :notify_code_configuration_name,
  :code_configuration_parameters,
  :channel_parameters,
  :deletion_protection_enabled,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end