Interface ICfnDomainNameProps
Properties for defining a CfnDomainName
.
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnDomainNameProps
Syntax (vb)
Public Interface ICfnDomainNameProps
Remarks
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 cfnDomainNameProps = 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
Properties
CertificateArn | The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name. |
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 | The collection of tags. |
Properties
CertificateArn
The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name.
virtual string CertificateArn { get; }
Property Value
System.String
Remarks
AWS Certificate Manager is the only supported source.
DomainName
The custom domain name as an API host name, for example, my-api.example.com
.
virtual string DomainName { get; }
Property Value
System.String
Remarks
EndpointConfiguration
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
virtual object EndpointConfiguration { get; }
Property Value
System.Object
Remarks
MutualTlsAuthentication
The mutual TLS authentication configuration for a custom domain name.
virtual object MutualTlsAuthentication { get; }
Property Value
System.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.
OwnershipVerificationCertificateArn
The ARN of the public certificate issued by ACM to validate ownership of your custom domain.
virtual string OwnershipVerificationCertificateArn { get; }
Property Value
System.String
Remarks
Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.
RegionalCertificateArn
The reference to an AWS -managed certificate that will be used for validating the regional domain name.
virtual string RegionalCertificateArn { get; }
Property Value
System.String
Remarks
AWS Certificate Manager is the only supported source.
SecurityPolicy
The Transport Layer Security (TLS) version + cipher suite for this DomainName.
virtual string SecurityPolicy { get; }
Property Value
System.String
Remarks
The valid values are TLS_1_0
and TLS_1_2
.
Tags
The collection of tags.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
Each tag element is associated with a given resource.