Class: AWSCDK::SES::CfnMailManagerRelay::RelayAuthenticationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::SES::CfnMailManagerRelay::RelayAuthenticationProperty

Defined in:

ses/cfn_mail_manager_relay.rb

Overview

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.

This data type is a UNION, so only one of the following members can be specified when used or returned.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerrelay-relayauthentication.html

Instance Attribute Summary

• #no_authentication ⇒ Object^? readonly

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

• #secret_arn ⇒ String^? readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(no_authentication: nil, secret_arn: nil) ⇒ RelayAuthenticationProperty constructor

  A new instance of RelayAuthenticationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(no_authentication: nil, secret_arn: nil) ⇒ RelayAuthenticationProperty

Returns a new instance of RelayAuthenticationProperty.

Parameters:

• no_authentication (Object, nil) (defaults to: nil) —

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

• secret_arn (String, nil) (defaults to: nil) —

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

# File 'ses/cfn_mail_manager_relay.rb', line 607

def initialize(no_authentication: nil, secret_arn: nil)
  @no_authentication = no_authentication
  Jsii::Type.check_type(@no_authentication, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "noAuthentication") unless @no_authentication.nil?
  @secret_arn = secret_arn
  Jsii::Type.check_type(@secret_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretArn") unless @secret_arn.nil?
end

Instance Attribute Details

#no_authentication ⇒ Object^? (readonly)

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

Returns:

• (Object, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerrelay-relayauthentication.html#cfn-ses-mailmanagerrelay-relayauthentication-noauthentication

# File 'ses/cfn_mail_manager_relay.rb', line 618

def no_authentication
  @no_authentication
end

#secret_arn ⇒ String^? (readonly)

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

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerrelay-relayauthentication.html#cfn-ses-mailmanagerrelay-relayauthentication-secretarn

# File 'ses/cfn_mail_manager_relay.rb', line 623

def secret_arn
  @secret_arn
end

Class Method Details

.jsii_properties ⇒ Object

# File 'ses/cfn_mail_manager_relay.rb', line 625

def self.jsii_properties
  {
    :no_authentication => "noAuthentication",
    :secret_arn => "secretArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'ses/cfn_mail_manager_relay.rb', line 632

def to_jsii
  result = {}
  result.merge!({
    "noAuthentication" => @no_authentication,
    "secretArn" => @secret_arn,
  })
  result.compact
end