Package software.amazon.awscdk.services.apigateway

Class CfnClientCertificate

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.apigateway.CfnClientCertificate
All Implemented Interfaces:
IInspectable, IClientCertificateRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:04.081Z") @Stability(Stable) public class CfnClientCertificate extends CfnResource implements IInspectable, IClientCertificateRef, ITaggable
The AWS::ApiGateway::ClientCertificate resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.

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.apigateway.*;
 CfnClientCertificate cfnClientCertificate = CfnClientCertificate.Builder.create(this, "MyCfnClientCertificate")
         .description("description")
         .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

    • CfnClientCertificate

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

    • CfnClientCertificate

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

    • CfnClientCertificate

      @Stability(Stable) public CfnClientCertificate(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnClientCertificateProps props)
      Create a new AWS::ApiGateway::ClientCertificate.

      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.

    • CfnClientCertificate

      @Stability(Stable) public CfnClientCertificate(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::ApiGateway::ClientCertificate.

      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

    • arnForClientCertificate

      @Stability(Stable) @NotNull public static String arnForClientCertificate(@NotNull IClientCertificateRef resource)
      Parameters:
      resource - This parameter is required.

    • fromClientCertificateId

      @Stability(Stable) @NotNull public static IClientCertificateRef fromClientCertificateId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String clientCertificateId)
      Creates a new IClientCertificateRef from a clientCertificateId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      clientCertificateId - This parameter is required.

    • isCfnClientCertificate

      @Stability(Stable) @NotNull public static Boolean isCfnClientCertificate(@NotNull Object x)
      Checks whether the given object is a CfnClientCertificate.

      Parameters:
      x - This parameter is required.

    • 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.

    • getAttrClientCertificateId

      @Stability(Stable) @NotNull public String getAttrClientCertificateId()
      The ID for the client certificate.

      For example: abc123 .

    • getCfnProperties

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

    • getClientCertificateRef

      @Stability(Stable) @NotNull public ClientCertificateReference getClientCertificateRef()
      A reference to a ClientCertificate resource.
      Specified by:
      getClientCertificateRef in interface IClientCertificateRef

    • getTags

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

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the client certificate.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the client certificate.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The collection of tags.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The collection of tags.