AWS CDK Reference

Appearance

v2.277.0

EndpointType Enum ​

Source
aws-apigateway/lib/restapi.ts

Example ​

ts
declare const acmCertificateForExampleCom: any;

new apigateway.DomainName(this, 'custom-domain', {
  domainName: 'example.com',
  certificate: acmCertificateForExampleCom,
  endpointType: apigateway.EndpointType.EDGE, // default is REGIONAL
  securityPolicy: apigateway.SecurityPolicy.TLS_1_2
});
python
# acm_certificate_for_example_com: Any


apigateway.DomainName(self, "custom-domain",
    domain_name="example.com",
    certificate=acm_certificate_for_example_com,
    endpoint_type=apigateway.EndpointType.EDGE,  # default is REGIONAL
    security_policy=apigateway.SecurityPolicy.TLS_1_2
)
java
Object acmCertificateForExampleCom;


DomainName.Builder.create(this, "custom-domain")
        .domainName("example.com")
        .certificate(acmCertificateForExampleCom)
        .endpointType(EndpointType.EDGE) // default is REGIONAL
        .securityPolicy(SecurityPolicy.TLS_1_2)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
var acmCertificateForExampleCom;


new DomainName(this, "custom-domain", new DomainNameProps {
    DomainName = "example.com",
    Certificate = acmCertificateForExampleCom,
    EndpointType = EndpointType.EDGE,  // default is REGIONAL
    SecurityPolicy = SecurityPolicy.TLS_1_2
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var acmCertificateForExampleCom interface{}


apigateway.NewDomainName(this, jsii.String("custom-domain"), &DomainNameProps{
	DomainName: jsii.String("example.com"),
	Certificate: acmCertificateForExampleCom,
	EndpointType: apigateway.EndpointType_EDGE,
	 // default is REGIONAL
	SecurityPolicy: apigateway.SecurityPolicy_TLS_1_2,
})

Members ​

MemberDescription
EDGEFor an edge-optimized API and its custom domain name.
REGIONALFor a regional API and its custom domain name.
PRIVATEFor a private API and its custom domain name.

Referenced by ​