Skip to content
v2.278.0

HttpApiDomainConfigurationProperty Struct ​

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_sam as sam } from 'aws-cdk-lib';
const httpApiDomainConfigurationProperty: sam.CfnHttpApi.HttpApiDomainConfigurationProperty = {
  certificateArn: 'certificateArn',
  domainName: 'domainName',

  // the properties below are optional
  basePath: 'basePath',
  endpointConfiguration: 'endpointConfiguration',
  mutualTlsAuthentication: {
    truststoreUri: 'truststoreUri',
    truststoreVersion: false,
  },
  route53: {
    distributedDomainName: 'distributedDomainName',
    evaluateTargetHealth: false,
    hostedZoneId: 'hostedZoneId',
    hostedZoneName: 'hostedZoneName',
    ipV6: false,
  },
  securityPolicy: 'securityPolicy',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_sam as sam

http_api_domain_configuration_property = sam.CfnHttpApi.HttpApiDomainConfigurationProperty(
    certificate_arn="certificateArn",
    domain_name="domainName",

    # the properties below are optional
    base_path="basePath",
    endpoint_configuration="endpointConfiguration",
    mutual_tls_authentication=sam.CfnHttpApi.MutualTlsAuthenticationProperty(
        truststore_uri="truststoreUri",
        truststore_version=False
    ),
    route53=sam.CfnHttpApi.Route53ConfigurationProperty(
        distributed_domain_name="distributedDomainName",
        evaluate_target_health=False,
        hosted_zone_id="hostedZoneId",
        hosted_zone_name="hostedZoneName",
        ip_v6=False
    ),
    security_policy="securityPolicy"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.sam.*;

HttpApiDomainConfigurationProperty httpApiDomainConfigurationProperty = HttpApiDomainConfigurationProperty.builder()
        .certificateArn("certificateArn")
        .domainName("domainName")

        // the properties below are optional
        .basePath("basePath")
        .endpointConfiguration("endpointConfiguration")
        .mutualTlsAuthentication(MutualTlsAuthenticationProperty.builder()
                .truststoreUri("truststoreUri")
                .truststoreVersion(false)
                .build())
        .route53(Route53ConfigurationProperty.builder()
                .distributedDomainName("distributedDomainName")
                .evaluateTargetHealth(false)
                .hostedZoneId("hostedZoneId")
                .hostedZoneName("hostedZoneName")
                .ipV6(false)
                .build())
        .securityPolicy("securityPolicy")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SAM;

var httpApiDomainConfigurationProperty = new HttpApiDomainConfigurationProperty {
    CertificateArn = "certificateArn",
    DomainName = "domainName",

    // the properties below are optional
    BasePath = "basePath",
    EndpointConfiguration = "endpointConfiguration",
    MutualTlsAuthentication = new MutualTlsAuthenticationProperty {
        TruststoreUri = "truststoreUri",
        TruststoreVersion = false
    },
    Route53 = new Route53ConfigurationProperty {
        DistributedDomainName = "distributedDomainName",
        EvaluateTargetHealth = false,
        HostedZoneId = "hostedZoneId",
        HostedZoneName = "hostedZoneName",
        IpV6 = false
    },
    SecurityPolicy = "securityPolicy"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

httpApiDomainConfigurationProperty := &HttpApiDomainConfigurationProperty{
	CertificateArn: jsii.String("certificateArn"),
	DomainName: jsii.String("domainName"),

	// the properties below are optional
	BasePath: jsii.String("basePath"),
	EndpointConfiguration: jsii.String("endpointConfiguration"),
	MutualTlsAuthentication: &MutualTlsAuthenticationProperty{
		TruststoreUri: jsii.String("truststoreUri"),
		TruststoreVersion: jsii.Boolean(false),
	},
	Route53: &Route53ConfigurationProperty{
		DistributedDomainName: jsii.String("distributedDomainName"),
		EvaluateTargetHealth: jsii.Boolean(false),
		HostedZoneId: jsii.String("hostedZoneId"),
		HostedZoneName: jsii.String("hostedZoneName"),
		IpV6: jsii.Boolean(false),
	},
	SecurityPolicy: jsii.String("securityPolicy"),
}

Properties ​

basePathoptionalstringbase_pathoptionalstrbasePathoptionalStringBasePathoptionalstringBasePathoptional*string #
certificateArnstringcertificate_arnstrcertificateArnStringCertificateArnstringCertificateArn*string required #
domainNamestringdomain_namestrdomainNameStringDomainNamestringDomainName*string required #
endpointConfigurationoptionalstringendpoint_configurationoptionalstrendpointConfigurationoptionalStringEndpointConfigurationoptionalstringEndpointConfigurationoptional*string #
mutualTlsAuthenticationoptionalIResolvable | CfnHttpApi.MutualTlsAuthenticationPropertymutual_tls_authenticationoptionaltyping.Union[IResolvable, MutualTlsAuthenticationProperty]mutualTlsAuthenticationoptionalIResolvableMutualTlsAuthenticationoptionalIResolvableMutualTlsAuthenticationoptionalinterface{} #
route53optionalIResolvable | CfnHttpApi.Route53ConfigurationPropertyroute53optionaltyping.Union[IResolvable, Route53ConfigurationProperty]route53optionalIResolvableRoute53optionalIResolvableRoute53optionalinterface{} #
securityPolicyoptionalstringsecurity_policyoptionalstrsecurityPolicyoptionalStringSecurityPolicyoptionalstringSecurityPolicyoptional*string #