Class CfnDomainName.DomainNameConfigurationProperty
The DomainNameConfiguration
property type specifies the configuration for a an API's domain name.
Inheritance
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class DomainNameConfigurationProperty : Object, CfnDomainName.IDomainNameConfigurationProperty
Syntax (vb)
Public Class DomainNameConfigurationProperty
Inherits Object
Implements CfnDomainName.IDomainNameConfigurationProperty
Remarks
DomainNameConfiguration
is a property of the AWS::ApiGatewayV2::DomainName resource.
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 domainNameConfigurationProperty = new DomainNameConfigurationProperty {
CertificateArn = "certificateArn",
CertificateName = "certificateName",
EndpointType = "endpointType",
OwnershipVerificationCertificateArn = "ownershipVerificationCertificateArn",
SecurityPolicy = "securityPolicy"
};
Synopsis
Constructors
DomainNameConfigurationProperty() |
Properties
CertificateArn | An AWS -managed certificate that will be used by the edge-optimized endpoint for this domain name. |
CertificateName | The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name. |
EndpointType | The endpoint type. |
OwnershipVerificationCertificateArn | The Amazon resource name (ARN) for the public certificate issued by AWS Certificate Manager . |
SecurityPolicy | The Transport Layer Security (TLS) version of the security policy for this domain name. |
Constructors
DomainNameConfigurationProperty()
public DomainNameConfigurationProperty()
Properties
CertificateArn
An AWS -managed certificate that will be used by the edge-optimized endpoint for this domain name.
public string CertificateArn { get; set; }
Property Value
System.String
Remarks
AWS Certificate Manager is the only supported source.
CertificateName
The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
public string CertificateName { get; set; }
Property Value
System.String
Remarks
EndpointType
The endpoint type.
public string EndpointType { get; set; }
Property Value
System.String
Remarks
OwnershipVerificationCertificateArn
The Amazon resource name (ARN) for the public certificate issued by AWS Certificate Manager .
public string OwnershipVerificationCertificateArn { get; set; }
Property Value
System.String
Remarks
This ARN is used to validate custom domain ownership. It's required only if you configure mutual TLS and use either an ACM-imported or a private CA certificate ARN as the regionalCertificateArn.
SecurityPolicy
The Transport Layer Security (TLS) version of the security policy for this domain name.
public string SecurityPolicy { get; set; }
Property Value
System.String
Remarks
The valid values are TLS_1_0
and TLS_1_2
.