Class CfnDomainNameProps

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

Properties for defining a CfnDomainName.

public class CfnDomainNameProps : ICfnDomainNameProps

Inheritance

object

CfnDomainNameProps

Implements

ICfnDomainNameProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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"
                 } }
             };

Remarks

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

ExampleMetadata: fixture=_generated

Constructors

CfnDomainNameProps()

public CfnDomainNameProps()

Properties

CertificateArn

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

public 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

DomainName

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

public 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 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 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 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 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 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 ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

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