aws-cdk-lib.aws_sam.CfnApi.DomainConfigurationProperty

interface DomainConfigurationProperty

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

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 domainConfigurationProperty: sam.CfnApi.DomainConfigurationProperty = {
  certificateArn: 'certificateArn',
  domainName: 'domainName',

  // the properties below are optional
  basePath: ['basePath'],
  endpointConfiguration: 'endpointConfiguration',
  mutualTlsAuthentication: {
    truststoreUri: 'truststoreUri',
    truststoreVersion: 'truststoreVersion',
  },
  ownershipVerificationCertificateArn: 'ownershipVerificationCertificateArn',
  route53: {
    distributedDomainName: 'distributedDomainName',
    evaluateTargetHealth: false,
    hostedZoneId: 'hostedZoneId',
    hostedZoneName: 'hostedZoneName',
    ipV6: false,
  },
  securityPolicy: 'securityPolicy',
};

Properties

NameTypeDescription
certificateArnstringCfnApi.DomainConfigurationProperty.CertificateArn.
domainNamestringCfnApi.DomainConfigurationProperty.DomainName.
basePath?string[]CfnApi.DomainConfigurationProperty.BasePath.
endpointConfiguration?stringCfnApi.DomainConfigurationProperty.EndpointConfiguration.
mutualTlsAuthentication?IResolvable | MutualTlsAuthenticationPropertyCfnApi.DomainConfigurationProperty.MutualTlsAuthentication.
ownershipVerificationCertificateArn?stringCfnApi.DomainConfigurationProperty.OwnershipVerificationCertificateArn.
route53?IResolvable | Route53ConfigurationPropertyCfnApi.DomainConfigurationProperty.Route53.
securityPolicy?stringCfnApi.DomainConfigurationProperty.SecurityPolicy.

certificateArn

Type: string

CfnApi.DomainConfigurationProperty.CertificateArn.


domainName

Type: string

CfnApi.DomainConfigurationProperty.DomainName.


basePath?

Type: string[] (optional)

CfnApi.DomainConfigurationProperty.BasePath.


endpointConfiguration?

Type: string (optional)

CfnApi.DomainConfigurationProperty.EndpointConfiguration.


mutualTlsAuthentication?

Type: IResolvable | MutualTlsAuthenticationProperty (optional)

CfnApi.DomainConfigurationProperty.MutualTlsAuthentication.


ownershipVerificationCertificateArn?

Type: string (optional)

CfnApi.DomainConfigurationProperty.OwnershipVerificationCertificateArn.


route53?

Type: IResolvable | Route53ConfigurationProperty (optional)

CfnApi.DomainConfigurationProperty.Route53.


securityPolicy?

Type: string (optional)

CfnApi.DomainConfigurationProperty.SecurityPolicy.