Class ApiGatewayDomain
Defines an API Gateway domain name as the alias target.
Implements
Namespace: Amazon.CDK.AWS.Route53.Targets
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ApiGatewayDomain : DeputyBase, IAliasRecordTarget
Syntax (vb)
Public Class ApiGatewayDomain
Inherits DeputyBase
Implements IAliasRecordTarget
Remarks
Use the ApiGateway
class if you wish to map the alias to an REST API with a
domain name defined through the RestApiProps.domainName
prop.
ExampleMetadata: infused
Examples
var hostedZoneForExampleCom;
DomainName domainName;
using Amazon.CDK.AWS.Route53;
using Amazon.CDK.AWS.Route53.Targets;
new ARecord(this, "CustomDomainAliasRecord", new ARecordProps {
Zone = hostedZoneForExampleCom,
Target = RecordTarget.FromAlias(new ApiGatewayDomain(domainName))
});
Synopsis
Constructors
ApiGatewayDomain(IDomainName) | |
ApiGatewayDomain(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
ApiGatewayDomain(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Methods
Bind(IRecordSet, IHostedZone) | Return hosted zone ID and DNS name, usable for Route53 alias targets. |
Constructors
ApiGatewayDomain(IDomainName)
ApiGatewayDomain(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected ApiGatewayDomain(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
ApiGatewayDomain(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected ApiGatewayDomain(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Methods
Bind(IRecordSet, IHostedZone)
Return hosted zone ID and DNS name, usable for Route53 alias targets.
public virtual IAliasRecordTargetConfig Bind(IRecordSet record, IHostedZone zone = null)
Parameters
- record IRecordSet
- zone IHostedZone
Returns