CfnMailManagerIngressPointPropsMixin

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

Bases: Mixin

Resource to provision an ingress endpoint for receiving email.

An ingress endpoint serves as the entry point for incoming emails, allowing you to define how emails are received and processed within your AWS environment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-mailmanageringresspoint.html
CloudformationResource:: AWS::SES::MailManagerIngressPoint
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

cfn_mail_manager_ingress_point_props_mixin = ses_mixins.CfnMailManagerIngressPointPropsMixin(ses_mixins.CfnMailManagerIngressPointMixinProps(
    ingress_point_configuration=ses_mixins.CfnMailManagerIngressPointPropsMixin.IngressPointConfigurationProperty(
        secret_arn="secretArn",
        smtp_password="smtpPassword"
    ),
    ingress_point_name="ingressPointName",
    network_configuration=ses_mixins.CfnMailManagerIngressPointPropsMixin.NetworkConfigurationProperty(
        private_network_configuration=ses_mixins.CfnMailManagerIngressPointPropsMixin.PrivateNetworkConfigurationProperty(
            vpc_endpoint_id="vpcEndpointId"
        ),
        public_network_configuration=ses_mixins.CfnMailManagerIngressPointPropsMixin.PublicNetworkConfigurationProperty(
            ip_type="ipType"
        )
    ),
    rule_set_id="ruleSetId",
    status_to_update="statusToUpdate",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    traffic_policy_id="trafficPolicyId",
    type="type"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnMailManagerIngressPointMixinProps, 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 = ['ingressPointConfiguration', 'ingressPointName', 'networkConfiguration', 'ruleSetId', 'statusToUpdate', 'tags', 'trafficPolicyId', 'type']

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

IngressPointConfigurationProperty

class CfnMailManagerIngressPointPropsMixin.IngressPointConfigurationProperty(*, secret_arn=None, smtp_password=None)

Bases: object

The configuration of the ingress endpoint resource.

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

Parameters:

secret_arn (Optional[str]) – The SecretsManager::Secret ARN of the ingress endpoint resource.
smtp_password (Optional[str]) – The password of the ingress endpoint resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanageringresspoint-ingresspointconfiguration.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

ingress_point_configuration_property = ses_mixins.CfnMailManagerIngressPointPropsMixin.IngressPointConfigurationProperty(
    secret_arn="secretArn",
    smtp_password="smtpPassword"
)

Attributes

secret_arn

The SecretsManager::Secret ARN of the ingress endpoint resource.

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

smtp_password

The password of the ingress endpoint resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanageringresspoint-ingresspointconfiguration.html#cfn-ses-mailmanageringresspoint-ingresspointconfiguration-smtppassword

NetworkConfigurationProperty

class CfnMailManagerIngressPointPropsMixin.NetworkConfigurationProperty(*, private_network_configuration=None, public_network_configuration=None)

Bases: object

The network type (IPv4-only, Dual-Stack, PrivateLink) of the ingress endpoint resource.

Parameters:

private_network_configuration (Union[IResolvable, PrivateNetworkConfigurationProperty, Dict[str, Any], None]) – Specifies the network configuration for the private ingress point.
public_network_configuration (Union[IResolvable, PublicNetworkConfigurationProperty, Dict[str, Any], None]) – Specifies the network configuration for the public ingress point.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanageringresspoint-networkconfiguration.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

network_configuration_property = ses_mixins.CfnMailManagerIngressPointPropsMixin.NetworkConfigurationProperty(
    private_network_configuration=ses_mixins.CfnMailManagerIngressPointPropsMixin.PrivateNetworkConfigurationProperty(
        vpc_endpoint_id="vpcEndpointId"
    ),
    public_network_configuration=ses_mixins.CfnMailManagerIngressPointPropsMixin.PublicNetworkConfigurationProperty(
        ip_type="ipType"
    )
)

Attributes

private_network_configuration

Specifies the network configuration for the private ingress point.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanageringresspoint-networkconfiguration.html#cfn-ses-mailmanageringresspoint-networkconfiguration-privatenetworkconfiguration

public_network_configuration

Specifies the network configuration for the public ingress point.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanageringresspoint-networkconfiguration.html#cfn-ses-mailmanageringresspoint-networkconfiguration-publicnetworkconfiguration

PrivateNetworkConfigurationProperty

class CfnMailManagerIngressPointPropsMixin.PrivateNetworkConfigurationProperty(*, vpc_endpoint_id=None)

Bases: object

Specifies the network configuration for the private ingress point.

Parameters:: vpc_endpoint_id (Optional[str]) – The identifier of the VPC endpoint to associate with this private ingress point.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanageringresspoint-privatenetworkconfiguration.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

private_network_configuration_property = ses_mixins.CfnMailManagerIngressPointPropsMixin.PrivateNetworkConfigurationProperty(
    vpc_endpoint_id="vpcEndpointId"
)

Attributes

vpc_endpoint_id

The identifier of the VPC endpoint to associate with this private ingress point.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanageringresspoint-privatenetworkconfiguration.html#cfn-ses-mailmanageringresspoint-privatenetworkconfiguration-vpcendpointid

PublicNetworkConfigurationProperty

class CfnMailManagerIngressPointPropsMixin.PublicNetworkConfigurationProperty(*, ip_type=None)

Bases: object

Specifies the network configuration for the public ingress point.

Parameters:: ip_type (Optional[str]) – The IP address type for the public ingress point. Valid values are IPV4 and DUAL_STACK.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanageringresspoint-publicnetworkconfiguration.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

public_network_configuration_property = ses_mixins.CfnMailManagerIngressPointPropsMixin.PublicNetworkConfigurationProperty(
    ip_type="ipType"
)

Attributes

ip_type

The IP address type for the public ingress point.

Valid values are IPV4 and DUAL_STACK.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanageringresspoint-publicnetworkconfiguration.html#cfn-ses-mailmanageringresspoint-publicnetworkconfiguration-iptype