Class: Aws::MailManager::Types::RelayAuthentication

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

Overview

Note:

RelayAuthentication is a union - when making an API calls you must set exactly one of the members.

Note:

RelayAuthentication is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RelayAuthentication corresponding to the set member.

Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored, or specify an empty NoAuthentication structure if the relay destination server does not require SMTP credential authentication.

See Also:

Direct Known Subclasses

NoAuthentication, SecretArn, Unknown

Defined Under Namespace

Classes: NoAuthentication, SecretArn, Unknown

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#no_authentication ⇒ Types::NoAuthentication

Keep an empty structure if the relay destination server does not require SMTP credential authentication.

Returns:

  • (Types::NoAuthentication) 


2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2572

class RelayAuthentication < Struct.new(
  :no_authentication,
  :secret_arn,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class NoAuthentication < RelayAuthentication; end
  class SecretArn < RelayAuthentication; end
  class Unknown < RelayAuthentication; end
end

#secret_arn ⇒ String

The ARN of the secret created in secrets manager where the relay server's SMTP credentials are stored.

Returns:

  • (String) 


2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2572

class RelayAuthentication < Struct.new(
  :no_authentication,
  :secret_arn,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class NoAuthentication < RelayAuthentication; end
  class SecretArn < RelayAuthentication; end
  class Unknown < RelayAuthentication; end
end

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

  • (Object) —

    the current value of unknown



2572
2573
2574
 
# File 'gems/aws-sdk-mailmanager/lib/aws-sdk-mailmanager/types.rb', line 2572

def unknown
  @unknown
end