CfnMailManagerRelayPropsMixin

class aws_cdk.mixins_preview.aws_ses.mixins.CfnMailManagerRelayPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource to create an SMTP relay, which can be used within a Mail Manager rule set to forward incoming emails to defined relay destinations.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanagerrelay.html
CloudformationResource:: AWS::SES::MailManagerRelay
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_ses import mixins as ses_mixins

# no_authentication: Any

cfn_mail_manager_relay_props_mixin = ses_mixins.CfnMailManagerRelayPropsMixin(ses_mixins.CfnMailManagerRelayMixinProps(
    authentication=ses_mixins.CfnMailManagerRelayPropsMixin.RelayAuthenticationProperty(
        no_authentication=no_authentication,
        secret_arn="secretArn"
    ),
    relay_name="relayName",
    server_name="serverName",
    server_port=123,
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::SES::MailManagerRelay.

Parameters:

props (Union[CfnMailManagerRelayMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['authentication', 'relayName', 'serverName', 'serverPort', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

RelayAuthenticationProperty

class CfnMailManagerRelayPropsMixin.RelayAuthenticationProperty(*, no_authentication=None, secret_arn=None)

Bases: object

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.

Parameters:

no_authentication (Any) – Keep an empty structure if the relay destination server does not require SMTP credential authentication.
secret_arn (Optional[str]) – The ARN of the secret created in secrets manager where the relay server’s SMTP credentials are stored.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_ses import mixins as ses_mixins

# no_authentication: Any

relay_authentication_property = ses_mixins.CfnMailManagerRelayPropsMixin.RelayAuthenticationProperty(
    no_authentication=no_authentication,
    secret_arn="secretArn"
)

Attributes

no_authentication

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

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

secret_arn

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

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