software.amazon.awscdk.services.apigatewayv2

Class DomainName

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.apigatewayv2.DomainName

All Implemented Interfaces:

IDependable, IResource, IDomainName, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:46:59.798Z")
 @Stability(value=Experimental)
public class DomainName
extends Resource
implements IDomainName

(experimental) Custom domain resource for the API.

Example:

 import software.amazon.awscdk.core.*;
 import software.amazon.awscdk.services.apigatewayv2.integrations.HttpLambdaIntegration;
 Function handler;
 String certArn = "arn:aws:acm:us-east-1:111111111111:certificate";
 String domainName = "example.com";
 DomainName dn = DomainName.Builder.create(this, "DN")
         .domainName(domainName)
         .certificate(Certificate.fromCertificateArn(this, "cert", certArn))
         .build();
 HttpApi api = HttpApi.Builder.create(this, "HttpProxyProdApi")
         .defaultIntegration(new HttpLambdaIntegration("DefaultIntegration", handler))
         // https://${dn.domainName}/foo goes to prodApi $default stage
         .defaultDomainMapping(DomainMappingOptions.builder()
                 .domainName(dn)
                 .mappingKey("foo")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DomainName.Builder (experimental) A fluent builder for DomainName.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.IDomainName

IDomainName.Jsii$Default, IDomainName.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	DomainName(software.constructs.Construct scope, String id, DomainNameProps props)
protected	DomainName(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DomainName(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
void	addEndpoint(EndpointOptions options) (experimental) Adds an endpoint to a domain name.
static IDomainName	fromDomainNameAttributes(software.constructs.Construct scope, String id, DomainNameAttributes attrs) (experimental) Import from attributes.
String	getName() (experimental) The custom domain name.
String	getRegionalDomainName() (experimental) The domain name associated with the regional endpoint for this custom domain name.
String	getRegionalHostedZoneId() (experimental) The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

DomainName

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

DomainName

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

DomainName

@Stability(value=Experimental)
public DomainName(@NotNull
                                                 software.constructs.Construct scope,
                                                 @NotNull
                                                 String id,
                                                 @NotNull
                                                 DomainNameProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromDomainNameAttributes

@Stability(value=Experimental)
 @NotNull
public static IDomainName fromDomainNameAttributes(@NotNull
                                                                                            software.constructs.Construct scope,
                                                                                            @NotNull
                                                                                            String id,
                                                                                            @NotNull
                                                                                            DomainNameAttributes attrs)

(experimental) Import from attributes.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addEndpoint

@Stability(value=Experimental)
public void addEndpoint(@NotNull
                                                       EndpointOptions options)

(experimental) Adds an endpoint to a domain name.

Parameters:

options - domain name endpoint properties to be set. This parameter is required.

getName

@Stability(value=Experimental)
 @NotNull
public String getName()

(experimental) The custom domain name.

Specified by:

getName in interface IDomainName

getRegionalDomainName

@Stability(value=Experimental)
 @NotNull
public String getRegionalDomainName()

(experimental) The domain name associated with the regional endpoint for this custom domain name.

Specified by:

getRegionalDomainName in interface IDomainName

getRegionalHostedZoneId

@Stability(value=Experimental)
 @NotNull
public String getRegionalHostedZoneId()

(experimental) The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.

Specified by:

getRegionalHostedZoneId in interface IDomainName