Table of Contents

Class CfnDomainName

Namespace
Amazon.CDK.AWS.APIGateway
Assembly
Amazon.CDK.AWS.APIGateway.dll

A CloudFormation AWS::ApiGateway::DomainName.

public class CfnDomainName : CfnResource, IInspectable
Inheritance
CfnDomainName
Implements
IInspectable

Examples

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

             var cfnDomainName = new CfnDomainName(this, "MyCfnDomainName", new CfnDomainNameProps {
                 CertificateArn = "certificateArn",
                 DomainName = "domainName",
                 EndpointConfiguration = new EndpointConfigurationProperty {
                     Types = new [] { "types" }
                 },
                 MutualTlsAuthentication = new MutualTlsAuthenticationProperty {
                     TruststoreUri = "truststoreUri",
                     TruststoreVersion = "truststoreVersion"
                 },
                 OwnershipVerificationCertificateArn = "ownershipVerificationCertificateArn",
                 RegionalCertificateArn = "regionalCertificateArn",
                 SecurityPolicy = "securityPolicy",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Remarks

The AWS::ApiGateway::DomainName resource specifies a custom domain name for your API in API Gateway.

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 .

CloudformationResource: AWS::ApiGateway::DomainName

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html

ExampleMetadata: fixture=_generated

Constructors

CfnDomainName(Construct, string, ICfnDomainNameProps?)

Create a new AWS::ApiGateway::DomainName.

public CfnDomainName(Construct scope, string id, ICfnDomainNameProps? props = null)

Parameters

scope Construct
  • scope in which this resource is defined.
id string
  • scoped id of the resource.
props ICfnDomainNameProps
  • resource properties.

Properties

AttrDistributionDomainName

The Amazon CloudFront distribution domain name that's mapped to the custom domain name.

public virtual string AttrDistributionDomainName { get; }

Property Value

string

Remarks

This is only applicable for endpoints whose type is EDGE .

Example: d111111abcdef8.cloudfront.net

CloudformationAttribute: DistributionDomainName

AttrDistributionHostedZoneId

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint.

public virtual string AttrDistributionHostedZoneId { get; }

Property Value

string

Remarks

The only valid value is Z2FDTNDATAQYW2 for all regions.

CloudformationAttribute: DistributionHostedZoneId

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

CertificateArn

The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name.

public virtual string? CertificateArn { get; set; }

Property Value

string

Remarks

AWS Certificate Manager is the only supported source.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn

CfnProperties 

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

Property Value

IDictionary<string, object>

DomainName

The custom domain name as an API host name, for example, my-api.example.com .

public virtual string? DomainName { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-domainname

EndpointConfiguration

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

public virtual object? EndpointConfiguration { get; set; }

Property Value

object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-endpointconfiguration

MutualTlsAuthentication

The mutual TLS authentication configuration for a custom domain name.

public virtual object? MutualTlsAuthentication { get; set; }

Property Value

object

Remarks

If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication

OwnershipVerificationCertificateArn

The ARN of the public certificate issued by ACM to validate ownership of your custom domain.

public virtual string? OwnershipVerificationCertificateArn { get; set; }

Property Value

string

Remarks

Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-ownershipverificationcertificatearn

RegionalCertificateArn

The reference to an AWS -managed certificate that will be used for validating the regional domain name.

public virtual string? RegionalCertificateArn { get; set; }

Property Value

string

Remarks

AWS Certificate Manager is the only supported source.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-regionalcertificatearn

SecurityPolicy

The Transport Layer Security (TLS) version + cipher suite for this DomainName.

public virtual string? SecurityPolicy { get; set; }

Property Value

string

Remarks

The valid values are TLS_1_0 and TLS_1_2 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-securitypolicy

Tags

The collection of tags.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

Each tag element is associated with a given resource.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-tags

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.

RenderProperties(IDictionary<string, object>) 

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

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>