aws-cdk-lib.aws_sam.CfnHttpApi.HttpApiDomainConfigurationProperty

interface HttpApiDomainConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.SAM.CfnHttpApi.HttpApiDomainConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awssam#CfnHttpApi_HttpApiDomainConfigurationProperty
Javasoftware.amazon.awscdk.services.sam.CfnHttpApi.HttpApiDomainConfigurationProperty
Pythonaws_cdk.aws_sam.CfnHttpApi.HttpApiDomainConfigurationProperty
TypeScript aws-cdk-lib » aws_sam » CfnHttpApi » HttpApiDomainConfigurationProperty

Example

// 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',
};

Properties

NameTypeDescription
certificateArnstringCfnHttpApi.HttpApiDomainConfigurationProperty.CertificateArn.
domainNamestringCfnHttpApi.HttpApiDomainConfigurationProperty.DomainName.
basePath?stringCfnHttpApi.HttpApiDomainConfigurationProperty.BasePath.
endpointConfiguration?stringCfnHttpApi.HttpApiDomainConfigurationProperty.EndpointConfiguration.
mutualTlsAuthentication?IResolvable | MutualTlsAuthenticationPropertyCfnHttpApi.HttpApiDomainConfigurationProperty.MutualTlsAuthentication.
route53?IResolvable | Route53ConfigurationPropertyCfnHttpApi.HttpApiDomainConfigurationProperty.Route53.
securityPolicy?stringCfnHttpApi.HttpApiDomainConfigurationProperty.SecurityPolicy.

certificateArn

Type: string

CfnHttpApi.HttpApiDomainConfigurationProperty.CertificateArn.


domainName

Type: string

CfnHttpApi.HttpApiDomainConfigurationProperty.DomainName.


basePath?

Type: string (optional)

CfnHttpApi.HttpApiDomainConfigurationProperty.BasePath.


endpointConfiguration?

Type: string (optional)

CfnHttpApi.HttpApiDomainConfigurationProperty.EndpointConfiguration.


mutualTlsAuthentication?

Type: IResolvable | MutualTlsAuthenticationProperty (optional)

CfnHttpApi.HttpApiDomainConfigurationProperty.MutualTlsAuthentication.


route53?

Type: IResolvable | Route53ConfigurationProperty (optional)

CfnHttpApi.HttpApiDomainConfigurationProperty.Route53.


securityPolicy?

Type: string (optional)

CfnHttpApi.HttpApiDomainConfigurationProperty.SecurityPolicy.