Package 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, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-21T06:34:09.243Z") @Stability(Stable) public class CfnServerCertificate extends CfnResource implements IInspectable, ITaggable
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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnServerCertificate

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

    • CfnServerCertificate

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

    • CfnServerCertificate

      @Stability(Stable) public CfnServerCertificate(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnServerCertificateProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnServerCertificate

      @Stability(Stable) public CfnServerCertificate(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      Returns the Amazon Resource Name (ARN) for the specified AWS::IAM::ServerCertificate resource.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getCertificateBody

      @Stability(Stable) @Nullable public String getCertificateBody()
      The contents of the public key certificate.

    • setCertificateBody

      @Stability(Stable) public void setCertificateBody(@Nullable String value)
      The contents of the public key certificate.

    • getCertificateChain

      @Stability(Stable) @Nullable public String getCertificateChain()
      The contents of the public key certificate chain.

    • setCertificateChain

      @Stability(Stable) public void setCertificateChain(@Nullable String value)
      The contents of the public key certificate chain.

    • getPath

      @Stability(Stable) @Nullable public String getPath()
      The path for the server certificate.

    • setPath

      @Stability(Stable) public void setPath(@Nullable String value)
      The path for the server certificate.

    • getPrivateKey

      @Stability(Stable) @Nullable public String getPrivateKey()
      The contents of the private key in PEM-encoded format.

    • setPrivateKey

      @Stability(Stable) public void setPrivateKey(@Nullable String value)
      The contents of the private key in PEM-encoded format.

    • getServerCertificateName

      @Stability(Stable) @Nullable public String getServerCertificateName()
      The name for the server certificate.

    • setServerCertificateName

      @Stability(Stable) public void setServerCertificateName(@Nullable String value)
      The name for the server certificate.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A list of tags that are attached to the server certificate.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A list of tags that are attached to the server certificate.