software.amazon.awscdk.services.apigateway

Class DomainName

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.apigateway.DomainName

All Implemented Interfaces:

IConstruct, IDependable, IResource, IDomainName

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:47.607Z")
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 interface software.amazon.awscdk.services.apigateway.IDomainName

IDomainName.Jsii$Default, IDomainName.Jsii$Proxy

Constructor Summary

Constructors

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

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, java.lang.String id, DomainNameAttributes attrs) Imports an existing domain name.
java.lang.String	getDomainName() The domain name (e.g.
java.lang.String	getDomainNameAliasDomainName() The Route53 alias target to use in order to connect a record set to this domain through an alias.
java.lang.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.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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

Constructor Detail

DomainName

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

DomainName

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

DomainName

public DomainName(software.constructs.Construct scope,
                  java.lang.String id,
                  DomainNameProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromDomainNameAttributes

public static IDomainName fromDomainNameAttributes(software.constructs.Construct scope,
                                                   java.lang.String id,
                                                   DomainNameAttributes attrs)

Imports an existing domain name.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

addBasePathMapping

public BasePathMapping addBasePathMapping(IRestApi targetApi,
                                          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

public BasePathMapping addBasePathMapping(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

public java.lang.String getDomainName()

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

Specified by:

getDomainName in interface IDomainName

getDomainNameAliasDomainName

public java.lang.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

public java.lang.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