Class CfnDomainName

The AWS::ApiGatewayV2::DomainName resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway).

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnDomainName

Implements

IInspectable

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Apigatewayv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDomainName : CfnResource, IInspectable, ITaggable

Syntax (vb)

Public Class CfnDomainName Inherits CfnResource Implements IInspectable, ITaggable

Remarks

You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html

CloudformationResource: AWS::ApiGatewayV2::DomainName

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Apigatewayv2;

             var cfnDomainName = new CfnDomainName(this, "MyCfnDomainName", new CfnDomainNameProps {
                 DomainName = "domainName",

                 // the properties below are optional
                 DomainNameConfigurations = new [] { new DomainNameConfigurationProperty {
                     CertificateArn = "certificateArn",
                     CertificateName = "certificateName",
                     EndpointType = "endpointType",
                     IpAddressType = "ipAddressType",
                     OwnershipVerificationCertificateArn = "ownershipVerificationCertificateArn",
                     SecurityPolicy = "securityPolicy"
                 } },
                 MutualTlsAuthentication = new MutualTlsAuthenticationProperty {
                     TruststoreUri = "truststoreUri",
                     TruststoreVersion = "truststoreVersion"
                 },
                 RoutingMode = "routingMode",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             });

Synopsis

Constructors

CfnDomainName(Construct, string, ICfnDomainNameProps)

The AWS::ApiGatewayV2::DomainName resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway).

Properties

AttrDomainNameArn	Represents an Amazon Resource Name (ARN).
AttrRegionalDomainName	The domain name associated with the regional endpoint for this custom domain name.
AttrRegionalHostedZoneId	The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::ApiGatewayV2::DomainName resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway).
DomainName	The custom domain name for your API in Amazon API Gateway.
DomainNameConfigurations	The domain name configurations.
MutualTlsAuthentication	The mutual TLS authentication configuration for a custom domain name.
RoutingMode	The routing mode API Gateway uses to route traffic to your APIs.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	The collection of tags associated with a domain name.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	The AWS::ApiGatewayV2::DomainName resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway).

Constructors

CfnDomainName(Construct, string, ICfnDomainNameProps)

The AWS::ApiGatewayV2::DomainName resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway).

public CfnDomainName(Construct scope, string id, ICfnDomainNameProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnDomainNameProps

Resource properties.

Remarks

You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html

CloudformationResource: AWS::ApiGatewayV2::DomainName

ExampleMetadata: fixture=_generated

Properties

AttrDomainNameArn

Represents an Amazon Resource Name (ARN).

public virtual string AttrDomainNameArn { get; }

Property Value

string

Remarks

CloudformationAttribute: DomainNameArn

AttrRegionalDomainName

The domain name associated with the regional endpoint for this custom domain name.

public virtual string AttrRegionalDomainName { get; }

Property Value

string

Remarks

You set up this association by adding a DNS record that points the custom domain name to this regional domain name.

CloudformationAttribute: RegionalDomainName

AttrRegionalHostedZoneId

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.

public virtual string AttrRegionalHostedZoneId { get; }

Property Value

string

Remarks

CloudformationAttribute: RegionalHostedZoneId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html

CloudformationResource: AWS::ApiGatewayV2::DomainName

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::ApiGatewayV2::DomainName resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway).

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html

CloudformationResource: AWS::ApiGatewayV2::DomainName

ExampleMetadata: fixture=_generated

DomainName

The custom domain name for your API in Amazon API Gateway.

public virtual string DomainName { get; set; }

Property Value

string

Remarks

You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html

CloudformationResource: AWS::ApiGatewayV2::DomainName

ExampleMetadata: fixture=_generated

DomainNameConfigurations

The domain name configurations.

public virtual object? DomainNameConfigurations { get; set; }

Property Value

object

Remarks

You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html

CloudformationResource: AWS::ApiGatewayV2::DomainName

ExampleMetadata: fixture=_generated

MutualTlsAuthentication

The mutual TLS authentication configuration for a custom domain name.

public virtual object? MutualTlsAuthentication { get; set; }

Property Value

object

Remarks

You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html

CloudformationResource: AWS::ApiGatewayV2::DomainName

ExampleMetadata: fixture=_generated

RoutingMode

The routing mode API Gateway uses to route traffic to your APIs.

public virtual string? RoutingMode { get; set; }

Property Value

string

Remarks

You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html

CloudformationResource: AWS::ApiGatewayV2::DomainName

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html

CloudformationResource: AWS::ApiGatewayV2::DomainName

ExampleMetadata: fixture=_generated

TagsRaw

The collection of tags associated with a domain name.

public virtual IDictionary<string, string>? TagsRaw { get; set; }

Property Value

IDictionary<string, string>

Remarks

You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html

CloudformationResource: AWS::ApiGatewayV2::DomainName

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html

CloudformationResource: AWS::ApiGatewayV2::DomainName

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::ApiGatewayV2::DomainName resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway).

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html

CloudformationResource: AWS::ApiGatewayV2::DomainName

ExampleMetadata: fixture=_generated

Implements

IInspectable

ITaggable