@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:46.214Z") public class DomainName extends Resource implements IDomainName
Example:
import software.amazon.awscdk.services.certificatemanager.*; 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();
Modifier and Type | Class and Description |
---|---|
static class |
DomainName.Builder
(experimental) A fluent builder for
DomainName . |
IDomainName.Jsii$Default, IDomainName.Jsii$Proxy
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) |
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,
java.lang.String id,
DomainNameAttributes attrs)
(experimental) Import from attributes.
|
java.lang.String |
getName()
(experimental) The custom domain name.
|
java.lang.String |
getRegionalDomainName()
(experimental) The domain name associated with the regional endpoint for this custom domain name.
|
java.lang.String |
getRegionalHostedZoneId()
(experimental) The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
|
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
applyRemovalPolicy, getEnv, getStack
getNode
protected DomainName(software.amazon.jsii.JsiiObjectRef objRef)
protected DomainName(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public DomainName(software.constructs.Construct scope, java.lang.String id, DomainNameProps props)
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.public static IDomainName fromDomainNameAttributes(software.constructs.Construct scope, java.lang.String id, DomainNameAttributes attrs)
scope
- This parameter is required.id
- This parameter is required.attrs
- This parameter is required.public void addEndpoint(EndpointOptions options)
options
- domain name endpoint properties to be set. This parameter is required.public java.lang.String getName()
getName
in interface IDomainName
public java.lang.String getRegionalDomainName()
getRegionalDomainName
in interface IDomainName
public java.lang.String getRegionalHostedZoneId()
getRegionalHostedZoneId
in interface IDomainName