Package software.amazon.awscdk.services.apigateway

Interface MTLSConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

MTLSConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:02.629Z")
@Stability(Stable)
public interface MTLSConfig
extends software.amazon.jsii.JsiiSerializable

The mTLS authentication configuration for a custom domain name.

Example:

 Object acm;
 DomainName.Builder.create(this, "domain-name")
         .domainName("example.com")
         .certificate(acm.Certificate.fromCertificateArn(this, "cert", "arn:aws:acm:us-east-1:1111111:certificate/11-3336f1-44483d-adc7-9cd375c5169d"))
         .mtls(MTLSConfig.builder()
                 .bucket(new Bucket(this, "bucket"))
                 .key("truststore.pem")
                 .version("version")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MTLSConfig.Builder	builder()
IBucket	getBucket()	The bucket that the trust store is hosted in.
String	getKey()	The key in S3 to look at for the trust store.
default String	getVersion()	The version of the S3 object that contains your truststore.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucket

@Stability(Stable)
@NotNull
IBucket getBucket()

The bucket that the trust store is hosted in.

getKey

@Stability(Stable)
@NotNull
String getKey()

The key in S3 to look at for the trust store.

getVersion

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

The version of the S3 object that contains your truststore.

To specify a version, you must have versioning enabled for the S3 bucket.

Default: - latest version

builder

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

Returns:

a MTLSConfig.Builder of MTLSConfig