CfnServerCertificateProps

class aws_cdk.aws_iam.CfnServerCertificateProps(*, certificate_body=None, certificate_chain=None, path=None, private_key=None, server_certificate_name=None, tags=None)

Bases: object

Properties for defining a CfnServerCertificate.

Parameters
  • certificate_body (Optional[str]) – The contents of the public key certificate.

  • certificate_chain (Optional[str]) – The contents of the public key certificate chain.

  • path (Optional[str]) – The path for the server certificate. For more information about paths, see IAM identifiers in the IAM User Guide . This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its regex pattern ) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! ( \ u0021 ) through the DEL character ( \ u007F ), including most punctuation characters, digits, and upper and lowercased letters. .. epigraph:: If you are uploading a server certificate specifically for use with Amazon CloudFront distributions, you must specify a path using the path parameter. The path must begin with /cloudfront and must include a trailing slash (for example, /cloudfront/test/ ).

  • private_key (Optional[str]) –

    The contents of the private key in PEM-encoded format. The regex pattern used to validate this parameter is a string of characters consisting of the following: - Any printable ASCII character ranging from the space character ( \ u0020 ) through the end of the ASCII character range - The printable characters in the Basic Latin and Latin-1 Supplement character set (through \ u00FF ) - The special characters tab ( \ u0009 ), line feed ( \ u000A ), and carriage return ( \ u000D )

  • server_certificate_name (Optional[str]) –

    The name for the server certificate. Do not include the path in this value. The name of the certificate cannot contain any spaces. This parameter allows (through its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

  • tags (Optional[Sequence[CfnTag]]) – A list of tags that are attached to the server certificate. For more information about tagging, see Tagging IAM resources in the IAM User Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servercertificate.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_iam as iam

cfn_server_certificate_props = iam.CfnServerCertificateProps(
    certificate_body="certificateBody",
    certificate_chain="certificateChain",
    path="path",
    private_key="privateKey",
    server_certificate_name="serverCertificateName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

certificate_body

The contents of the public key certificate.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servercertificate.html#cfn-iam-servercertificate-certificatebody

Return type

Optional[str]

certificate_chain

The contents of the public key certificate chain.

Link

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

Return type

Optional[str]

path

The path for the server certificate.

For more information about paths, see IAM identifiers in the IAM User Guide .

This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its regex pattern ) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! ( \ u0021 ) through the DEL character ( \ u007F ), including most punctuation characters, digits, and upper and lowercased letters. .. epigraph:

If you are uploading a server certificate specifically for use with Amazon CloudFront distributions, you must specify a path using the ``path`` parameter. The path must begin with ``/cloudfront`` and must include a trailing slash (for example, ``/cloudfront/test/`` ).
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servercertificate.html#cfn-iam-servercertificate-path

Return type

Optional[str]

private_key

The contents of the private key in PEM-encoded format.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character ( \ u0020 ) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \ u00FF )

  • The special characters tab ( \ u0009 ), line feed ( \ u000A ), and carriage return ( \ u000D )

Link

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

Return type

Optional[str]

server_certificate_name

The name for the server certificate.

Do not include the path in this value. The name of the certificate cannot contain any spaces.

This parameter allows (through its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servercertificate.html#cfn-iam-servercertificate-servercertificatename

Return type

Optional[str]

tags

A list of tags that are attached to the server certificate.

For more information about tagging, see Tagging IAM resources in the IAM User Guide .

Link

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

Return type

Optional[List[CfnTag]]