CfnCertificatePropsMixin

class aws_cdk.mixins_preview.aws_transfer.mixins.CfnCertificatePropsMixin(props, *, strategy=None)

Bases: Mixin

Imports the signing and encryption certificates that you need to create local (AS2) profiles and partner profiles.

You can import both the certificate and its chain in the Certificate parameter.

After importing a certificate, AWS Transfer Family automatically creates a Amazon CloudWatch metric called DaysUntilExpiry that tracks the number of days until the certificate expires. The metric is based on the InactiveDate parameter and is published daily in the AWS/Transfer namespace. .. epigraph:

It can take up to a full day after importing a certificate for Transfer Family to emit the ``DaysUntilExpiry`` metric to your account. > If you use the ``Certificate`` parameter to upload both the certificate and its chain, don't use the ``CertificateChain`` parameter.

CloudWatch monitoring

The DaysUntilExpiry metric includes the following specifications:

Units: Count (days)
Dimensions: CertificateId (always present), Description (if provided during certificate import)
Statistics: Minimum, Maximum, Average
Frequency: Published daily

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html
CloudformationResource:: AWS::Transfer::Certificate
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_transfer import mixins as transfer_mixins

cfn_certificate_props_mixin = transfer_mixins.CfnCertificatePropsMixin(transfer_mixins.CfnCertificateMixinProps(
    active_date="activeDate",
    certificate="certificate",
    certificate_chain="certificateChain",
    description="description",
    inactive_date="inactiveDate",
    private_key="privateKey",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    usage="usage"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Transfer::Certificate.

Parameters:

props (Union[CfnCertificateMixinProps, 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 = ['activeDate', 'certificate', 'certificateChain', 'description', 'inactiveDate', 'privateKey', 'tags', 'usage']

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