Class DomainName_
- Namespace
- Amazon.CDK.AWS.APIGateway
- Assembly
- Amazon.CDK.AWS.APIGateway.dll
public class DomainName_ : Resource, IDomainName, IResource, IConstruct, IConstruct, IDependable
- Inheritance
-
DomainName_
- Implements
-
IResourceIConstructIConstructIDependable
Examples
var acm;
new DomainName(this, "domain-name", new DomainNameProps {
DomainName = "example.com",
Certificate = acm.Certificate.FromCertificateArn(this, "cert", "arn:aws:acm:us-east-1:1111111:certificate/11-3336f1-44483d-adc7-9cd375c5169d"),
Mtls = new MTLSConfig {
Bucket = new Bucket(this, "bucket"),
Key = "truststore.pem",
Version = "version"
}
});
Remarks
ExampleMetadata: infused
Constructors
DomainName_(Construct, string, IDomainNameProps)
public DomainName_(Construct scope, string id, IDomainNameProps props)
Parameters
scope
Constructid
stringprops
IDomainNameProps
Properties
DomainName
The domain name (e.g. example.com
).
public virtual string DomainName { get; }
Property Value
DomainNameAliasDomainName
The Route53 alias target to use in order to connect a record set to this domain through an alias.
public virtual string DomainNameAliasDomainName { get; }
Property Value
DomainNameAliasHostedZoneId
The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias.
public virtual string DomainNameAliasHostedZoneId { get; }
Property Value
Methods
AddBasePathMapping(IRestApi, IBasePathMappingOptions?)
Maps this domain to an API endpoint.
public virtual BasePathMapping AddBasePathMapping(IRestApi targetApi, IBasePathMappingOptions? options = null)
Parameters
targetApi
IRestApiThat target API endpoint, requests will be mapped to the deployment stage.
options
IBasePathMappingOptionsOptions for mapping to base path with or without a stage.
Returns
FromDomainNameAttributes(Construct, string, IDomainNameAttributes)
Imports an existing domain name.
public static IDomainName FromDomainNameAttributes(Construct scope, string id, IDomainNameAttributes attrs)
Parameters
scope
Constructid
stringattrs
IDomainNameAttributes