Interface IEndpointOptions
(experimental) properties for creating a domain name endpoint.
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public interface IEndpointOptions
Syntax (vb)
Public Interface IEndpointOptions
Remarks
Stability: Experimental
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGatewayv2;
using Amazon.CDK.AWS.CertificateManager;
Certificate certificate;
var endpointOptions = new EndpointOptions {
Certificate = certificate,
// the properties below are optional
CertificateName = "certificateName",
EndpointType = EndpointType.EDGE,
OwnershipCertificate = certificate,
SecurityPolicy = SecurityPolicy.TLS_1_0
};
Synopsis
Properties
Certificate | (experimental) The ACM certificate for this domain name. |
CertificateName | (experimental) The user-friendly name of the certificate that will be used by the endpoint for this domain name. |
EndpointType | (experimental) The type of endpoint for this DomainName. |
OwnershipCertificate | (experimental) A public certificate issued by ACM to validate that you own a custom domain. |
SecurityPolicy | (experimental) The Transport Layer Security (TLS) version + cipher suite for this domain name. |
Properties
Certificate
(experimental) The ACM certificate for this domain name.
ICertificate Certificate { get; }
Property Value
Remarks
Certificate can be both ACM issued or imported.
Stability: Experimental
CertificateName
(experimental) The user-friendly name of the certificate that will be used by the endpoint for this domain name.
virtual string CertificateName { get; }
Property Value
System.String
Remarks
Default: - No friendly certificate name
Stability: Experimental
EndpointType
(experimental) The type of endpoint for this DomainName.
virtual Nullable<EndpointType> EndpointType { get; }
Property Value
System.Nullable<EndpointType>
Remarks
Default: EndpointType.REGIONAL
Stability: Experimental
OwnershipCertificate
(experimental) A public certificate issued by ACM to validate that you own a custom domain.
virtual ICertificate OwnershipCertificate { get; }
Property Value
Remarks
This parameter is required
only when you configure mutual TLS authentication and you specify an ACM imported or private CA certificate
for certificate
. The ownership certificate validates that you have permissions to use the domain name.
Default: - only required when configuring mTLS
Stability: Experimental
SecurityPolicy
(experimental) The Transport Layer Security (TLS) version + cipher suite for this domain name.
virtual Nullable<SecurityPolicy> SecurityPolicy { get; }
Property Value
System.Nullable<SecurityPolicy>
Remarks
Default: SecurityPolicy.TLS_1_2
Stability: Experimental