Package software.amazon.awscdk.services.appmesh

Interface MutualTlsValidation

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

MutualTlsValidation.Jsii$Proxy

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

Represents the properties needed to define TLS Validation context that is supported for mutual TLS authentication.

Example:

 Mesh mesh;
 VirtualNode node1 = VirtualNode.Builder.create(this, "node1")
         .mesh(mesh)
         .serviceDiscovery(ServiceDiscovery.dns("node"))
         .listeners(List.of(VirtualNodeListener.grpc(GrpcVirtualNodeListenerOptions.builder()
                 .port(80)
                 .tls(ListenerTlsOptions.builder()
                         .mode(TlsMode.STRICT)
                         .certificate(TlsCertificate.file("path/to/certChain", "path/to/privateKey"))
                         // Validate a file client certificates to enable mutual TLS authentication when a client provides a certificate.
                         .mutualTlsValidation(MutualTlsValidation.builder()
                                 .trust(TlsValidationTrust.file("path-to-certificate"))
                                 .build())
                         .build())
                 .build())))
         .build();
 String certificateAuthorityArn = "arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012";
 VirtualNode node2 = VirtualNode.Builder.create(this, "node2")
         .mesh(mesh)
         .serviceDiscovery(ServiceDiscovery.dns("node2"))
         .backendDefaults(BackendDefaults.builder()
                 .tlsClientPolicy(TlsClientPolicy.builder()
                         .ports(List.of(8080, 8081))
                         .validation(TlsValidation.builder()
                                 .subjectAlternativeNames(SubjectAlternativeNames.matchingExactly("mesh-endpoint.apps.local"))
                                 .trust(TlsValidationTrust.acm(List.of(CertificateAuthority.fromCertificateAuthorityArn(this, "certificate", certificateAuthorityArn))))
                                 .build())
                         // Provide a SDS client certificate when a server requests it and enable mutual TLS authentication.
                         .mutualTlsCertificate(TlsCertificate.sds("secret_certificate"))
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MutualTlsValidation.Builder	builder()
default SubjectAlternativeNames	getSubjectAlternativeNames()	Represents the subject alternative names (SANs) secured by the certificate.
MutualTlsValidationTrust	getTrust()	Reference to where to retrieve the trust chain.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTrust

@Stability(Stable)
@NotNull
MutualTlsValidationTrust getTrust()

Reference to where to retrieve the trust chain.

getSubjectAlternativeNames

@Stability(Stable)
@Nullable
default SubjectAlternativeNames getSubjectAlternativeNames()

Represents the subject alternative names (SANs) secured by the certificate.

SANs must be in the FQDN or URI format.

Default: - If you don't specify SANs on the terminating mesh endpoint, the Envoy proxy for that node doesn't verify the SAN on a peer client certificate. If you don't specify SANs on the originating mesh endpoint, the SAN on the certificate provided by the terminating endpoint must match the mesh endpoint service discovery configuration.

builder

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

Returns:

a MutualTlsValidation.Builder of MutualTlsValidation