Class DomainName_

Inheritance
System.Object
Resource
DomainName_
Implements
Constructs.IConstruct
Constructs.IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class DomainName_ : Resource, IDomainName, IResource
Syntax (vb)
Public Class DomainName_
    Inherits Resource
    Implements IDomainName, IResource
Remarks

ExampleMetadata: infused

Examples
RestApi api;


var domainName = DomainName.FromDomainNameAttributes(this, "DomainName", new DomainNameAttributes {
    DomainName = "domainName",
    DomainNameAliasHostedZoneId = "domainNameAliasHostedZoneId",
    DomainNameAliasTarget = "domainNameAliasTarget"
});

new BasePathMapping(this, "BasePathMapping", new BasePathMappingProps {
    DomainName = domainName,
    RestApi = api
});

Synopsis

Constructors

DomainName_(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
DomainName_(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
DomainName_(Construct, String, IDomainNameProps)

Properties

DomainName

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

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

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

Methods

AddApiMapping(IStage, IApiMappingOptions)

Maps this domain to an API endpoint.
AddBasePathMapping(IRestApi, IBasePathMappingOptions)

Maps this domain to an API endpoint.
FromDomainNameAttributes(Construct, String, IDomainNameAttributes)

Imports an existing domain name.

Constructors

DomainName_(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected DomainName_(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

DomainName_(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected DomainName_(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

DomainName_(Construct, String, IDomainNameProps)

public DomainName_(Construct scope, string id, IDomainNameProps props)
Parameters
scope Constructs.Construct
id System.String
props IDomainNameProps

Properties

DomainName

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

public virtual string DomainName { get; }
Property Value

System.String

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

System.String

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

System.String

Methods

AddApiMapping(IStage, IApiMappingOptions)

Maps this domain to an API endpoint.

public virtual void AddApiMapping(IStage targetStage, IApiMappingOptions options = null)
Parameters
targetStage IStage

the target API stage.

options IApiMappingOptions

Options for mapping to a stage.

Remarks

This uses the ApiMapping from ApiGatewayV2 which supports multi-level paths, but also only supports:

    AddBasePathMapping(IRestApi, IBasePathMappingOptions)

    Maps this domain to an API endpoint.

    public virtual BasePathMapping AddBasePathMapping(IRestApi targetApi, IBasePathMappingOptions options = null)
    Parameters
    targetApi IRestApi

    That target API endpoint, requests will be mapped to the deployment stage.

    options IBasePathMappingOptions

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

    Returns

    BasePathMapping

    Remarks

    This uses the BasePathMapping from ApiGateway v1 which does not support multi-level paths.

    If you need to create a mapping for a multi-level path use addApiMapping instead.

    FromDomainNameAttributes(Construct, String, IDomainNameAttributes)

    Imports an existing domain name.

    public static IDomainName FromDomainNameAttributes(Construct scope, string id, IDomainNameAttributes attrs)
    Parameters
    scope Constructs.Construct
    id System.String
    attrs IDomainNameAttributes
    Returns

    IDomainName

    Implements

    Constructs.IConstruct
    Constructs.IDependable