software.amazon.awscdk.services.iam

Class CfnServerCertificate

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iam.CfnServerCertificate

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.744Z")
 @Stability(value=Stable)
public class CfnServerCertificate
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IAM::ServerCertificate`.

Uploads a server certificate entity for the AWS account . The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.

We recommend that you use AWS Certificate Manager to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to AWS resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the AWS Certificate Manager User Guide .

For more information about working with server certificates, see Working with server certificates in the IAM User Guide . This topic includes a list of AWS services that can use the server certificates that you manage with IAM.

For information about the number of server certificates you can upload, see IAM and AWS STS quotas in the IAM User Guide .

Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling UploadServerCertificate . For information about setting up signatures and authorization through the API, see Signing AWS API requests in the AWS General Reference . For general information about using the Query API with IAM, see Calling the API by making HTTP query requests in the IAM User Guide .

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.*;
 CfnServerCertificate cfnServerCertificate = CfnServerCertificate.Builder.create(this, "MyCfnServerCertificate")
         .certificateBody("certificateBody")
         .certificateChain("certificateChain")
         .path("path")
         .privateKey("privateKey")
         .serverCertificateName("serverCertificateName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnServerCertificate.Builder A fluent builder for CfnServerCertificate.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnServerCertificate(software.constructs.Construct scope, String id) Create a new `AWS::IAM::ServerCertificate`.
	CfnServerCertificate(software.constructs.Construct scope, String id, CfnServerCertificateProps props) Create a new `AWS::IAM::ServerCertificate`.
protected	CfnServerCertificate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnServerCertificate(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() Returns the Amazon Resource Name (ARN) for the specified `AWS::IAM::ServerCertificate` resource.
String	getCertificateBody() The contents of the public key certificate.
String	getCertificateChain() The contents of the public key certificate chain.
protected Map<String,Object>	getCfnProperties()
String	getPath() The path for the server certificate.
String	getPrivateKey() The contents of the private key in PEM-encoded format.
String	getServerCertificateName() The name for the server certificate.
TagManager	getTags() A list of tags that are attached to the server certificate.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCertificateBody(String value) The contents of the public key certificate.
void	setCertificateChain(String value) The contents of the public key certificate chain.
void	setPath(String value) The path for the server certificate.
void	setPrivateKey(String value) The contents of the private key in PEM-encoded format.
void	setServerCertificateName(String value) The name for the server certificate.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnServerCertificate

protected CfnServerCertificate(software.amazon.jsii.JsiiObjectRef objRef)

CfnServerCertificate

protected CfnServerCertificate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnServerCertificate

@Stability(value=Stable)
public CfnServerCertificate(@NotNull
                                                     software.constructs.Construct scope,
                                                     @NotNull
                                                     String id,
                                                     @Nullable
                                                     CfnServerCertificateProps props)

Create a new `AWS::IAM::ServerCertificate`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnServerCertificate

@Stability(value=Stable)
public CfnServerCertificate(@NotNull
                                                     software.constructs.Construct scope,
                                                     @NotNull
                                                     String id)

Create a new `AWS::IAM::ServerCertificate`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

Returns the Amazon Resource Name (ARN) for the specified `AWS::IAM::ServerCertificate` resource.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager 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 .

getCertificateBody

@Stability(value=Stable)
 @Nullable
public String getCertificateBody()

The contents of the public key certificate.

setCertificateBody

@Stability(value=Stable)
public void setCertificateBody(@Nullable
                                                        String value)

The contents of the public key certificate.

getCertificateChain

@Stability(value=Stable)
 @Nullable
public String getCertificateChain()

The contents of the public key certificate chain.

setCertificateChain

@Stability(value=Stable)
public void setCertificateChain(@Nullable
                                                         String value)

The contents of the public key certificate chain.

getPath

@Stability(value=Stable)
 @Nullable
public 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 ! ( \ u0021 ) through the DEL character ( \ u007F ), 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/ ).

setPath

@Stability(value=Stable)
public void setPath(@Nullable
                                             String value)

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.

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

getPrivateKey

@Stability(value=Stable)
 @Nullable
public 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 ( \ 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 )

setPrivateKey

@Stability(value=Stable)
public void setPrivateKey(@Nullable
                                                   String value)

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 )

getServerCertificateName

@Stability(value=Stable)
 @Nullable
public 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: _+=,.@-

setServerCertificateName

@Stability(value=Stable)
public void setServerCertificateName(@Nullable
                                                              String value)

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