CfnCertificateProps

class aws_cdk.aws_transfer.CfnCertificateProps(*, certificate, usage, active_date=None, certificate_chain=None, description=None, inactive_date=None, private_key=None, tags=None)

Bases: object

Properties for defining a CfnCertificate.

Parameters:
  • certificate (str) – The file name for the certificate.

  • usage (str) – Specifies whether this certificate is used for signing or encryption.

  • active_date (Optional[str]) – An optional date that specifies when the certificate becomes active.

  • certificate_chain (Optional[str]) – The list of certificates that make up the chain for the certificate.

  • description (Optional[str]) – The name or description that’s used to identity the certificate.

  • inactive_date (Optional[str]) – An optional date that specifies when the certificate becomes inactive.

  • private_key (Optional[str]) – The file that contains the private key for the certificate that’s being imported.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Key-value pairs that can be used to group and search for certificates.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_transfer as transfer

cfn_certificate_props = transfer.CfnCertificateProps(
    certificate="certificate",
    usage="usage",

    # the properties below are optional
    active_date="activeDate",
    certificate_chain="certificateChain",
    description="description",
    inactive_date="inactiveDate",
    private_key="privateKey",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

active_date

An optional date that specifies when the certificate becomes active.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-activedate

certificate

The file name for the certificate.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-certificate

certificate_chain

The list of certificates that make up the chain for the certificate.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-certificatechain

description

The name or description that’s used to identity the certificate.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-description

inactive_date

An optional date that specifies when the certificate becomes inactive.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-inactivedate

private_key

The file that contains the private key for the certificate that’s being imported.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-privatekey

tags

Key-value pairs that can be used to group and search for certificates.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-tags

usage

Specifies whether this certificate is used for signing or encryption.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-transfer-certificate.html#cfn-transfer-certificate-usage