Package software.amazon.awscdk.services.iam

Interface CfnServerCertificateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnServerCertificateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:08.125Z")
@Stability(Stable)
public interface CfnServerCertificateProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnServerCertificate.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iam.*;
 CfnServerCertificateProps cfnServerCertificateProps = CfnServerCertificateProps.builder()
         .certificateBody("certificateBody")
         .certificateChain("certificateChain")
         .path("path")
         .privateKey("privateKey")
         .serverCertificateName("serverCertificateName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnServerCertificateProps.Builder	A builder for CfnServerCertificateProps
static final class	CfnServerCertificateProps.Jsii$Proxy	An implementation for CfnServerCertificateProps

Method Summary

Modifier and Type	Method	Description
static CfnServerCertificateProps.Builder	builder()
default String	getCertificateBody()	The contents of the public key certificate.
default String	getCertificateChain()	The contents of the public key certificate chain.
default String	getPath()	The path for the server certificate.
default String	getPrivateKey()	The contents of the private key in PEM-encoded format.
default String	getServerCertificateName()	The name for the server certificate.
default List<CfnTag>	getTags()	A list of tags that are attached to the server certificate.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCertificateBody

@Stability(Stable)
@Nullable
default String getCertificateBody()

The contents of the public key certificate.

See Also:

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

getCertificateChain

@Stability(Stable)
@Nullable
default String getCertificateChain()

The contents of the public key certificate chain.

See Also:

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

getPath

@Stability(Stable)
@Nullable
default String getPath()

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 ! ( ! ) through the DEL character (  ), including most punctuation characters, digits, and upper and lowercased letters.

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/ ).

See Also:

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

getPrivateKey

@Stability(Stable)
@Nullable
default String getPrivateKey()

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 ( ) through the end of the ASCII character range
• The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ )
• The special characters tab ( ), line feed ( ), and carriage return ( )

See Also:

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

getServerCertificateName

@Stability(Stable)
@Nullable
default String getServerCertificateName()

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: _+=,.@-

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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 .

See Also:

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

builder

@Stability(Stable)
static CfnServerCertificateProps.Builder builder()

Returns:

a CfnServerCertificateProps.Builder of CfnServerCertificateProps