software.amazon.awscdk.services.apigateway

Class DomainName

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.apigateway.DomainName

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.158Z")
 @Stability(value=Stable)
public class DomainName
extends Resource
implements IDomainName

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	Class and Description
static class	DomainName.Builder 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.apigateway.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
BasePathMapping	addBasePathMapping(IRestApi targetApi) Maps this domain to an API endpoint.
BasePathMapping	addBasePathMapping(IRestApi targetApi, BasePathMappingOptions options) Maps this domain to an API endpoint.
static IDomainName	fromDomainNameAttributes(software.constructs.Construct scope, String id, DomainNameAttributes attrs) Imports an existing domain name.
String	getDomainName() The domain name (e.g.
String	getDomainNameAliasDomainName() The Route53 alias target to use in order to connect a record set to this domain through an alias.
String	getDomainNameAliasHostedZoneId() The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias.

Methods inherited from class software.amazon.awscdk.Resource

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

Methods inherited from class software.constructs.Construct

getNode, isConstruct, 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.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.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=Stable)
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=Stable)
 @NotNull
public static IDomainName fromDomainNameAttributes(@NotNull
                                                                                      software.constructs.Construct scope,
                                                                                      @NotNull
                                                                                      String id,
                                                                                      @NotNull
                                                                                      DomainNameAttributes attrs)

Imports an existing domain name.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addBasePathMapping

@Stability(value=Stable)
 @NotNull
public BasePathMapping addBasePathMapping(@NotNull
                                                                             IRestApi targetApi,
                                                                             @Nullable
                                                                             BasePathMappingOptions options)

Maps this domain to an API endpoint.

Parameters:

targetApi - That target API endpoint, requests will be mapped to the deployment stage. This parameter is required.

options - Options for mapping to base path with or without a stage.

addBasePathMapping

@Stability(value=Stable)
 @NotNull
public BasePathMapping addBasePathMapping(@NotNull
                                                                             IRestApi targetApi)

Maps this domain to an API endpoint.

Parameters:

targetApi - That target API endpoint, requests will be mapped to the deployment stage. This parameter is required.

getDomainName

@Stability(value=Stable)
 @NotNull
public String getDomainName()

The domain name (e.g. `example.com`).

Specified by:

getDomainName in interface IDomainName

getDomainNameAliasDomainName

@Stability(value=Stable)
 @NotNull
public String getDomainNameAliasDomainName()

The Route53 alias target to use in order to connect a record set to this domain through an alias.

Specified by:

getDomainNameAliasDomainName in interface IDomainName

getDomainNameAliasHostedZoneId

@Stability(value=Stable)
 @NotNull
public String getDomainNameAliasHostedZoneId()

The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias.

Specified by:

getDomainNameAliasHostedZoneId in interface IDomainName