Class CfnDomainName
The AWS::ApiGateway::DomainName
resource specifies a custom domain name for your API in API Gateway.
Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
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 .
CloudformationResource: AWS::ApiGateway::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.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"
} }
});
Synopsis
Constructors
CfnDomainName(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDomainName(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDomainName(Construct, String, ICfnDomainNameProps) |
Properties
AttrDistributionDomainName | The Amazon CloudFront distribution domain name that's mapped to the custom domain name. |
AttrDistributionHostedZoneId | The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. |
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. |
CertificateArn | The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DomainName | The custom domain name as an API host name, for example, |
EndpointConfiguration | The endpoint configuration of this DomainName showing the endpoint types of the domain name. |
MutualTlsAuthentication | The mutual TLS authentication configuration for a custom domain name. |
OwnershipVerificationCertificateArn | The ARN of the public certificate issued by ACM to validate ownership of your custom domain. |
RegionalCertificateArn | The reference to an AWS -managed certificate that will be used for validating the regional domain name. |
SecurityPolicy | The Transport Layer Security (TLS) version + cipher suite for this DomainName. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The collection of tags. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDomainName(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDomainName(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDomainName(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDomainName(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDomainName(Construct, String, ICfnDomainNameProps)
public CfnDomainName(Construct scope, string id, ICfnDomainNameProps props = null)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- 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
System.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
System.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
System.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
System.String
Remarks
CloudformationAttribute: RegionalHostedZoneId
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
System.String
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DomainName
The custom domain name as an API host name, for example, my-api.example.com
.
public virtual string DomainName { get; set; }
Property Value
System.String
EndpointConfiguration
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
public virtual object EndpointConfiguration { get; set; }
Property Value
System.Object
MutualTlsAuthentication
The mutual TLS authentication configuration for a custom domain name.
public virtual object MutualTlsAuthentication { get; set; }
Property Value
System.Object
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
System.String
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
System.String
SecurityPolicy
The Transport Layer Security (TLS) version + cipher suite for this DomainName.
public virtual string SecurityPolicy { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
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 System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>