interface CfnDistributionTenantProps

Language	Type name
.NET	`Amazon.CDK.AWS.CloudFront.CfnDistributionTenantProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscloudfront#CfnDistributionTenantProps`
Java	`software.amazon.awscdk.services.cloudfront.CfnDistributionTenantProps`
Python	`aws_cdk.aws_cloudfront.CfnDistributionTenantProps`
TypeScript	`aws-cdk-lib` » `aws_cloudfront` » `CfnDistributionTenantProps`

Properties for defining a CfnDistributionTenant.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudfront as cloudfront } from 'aws-cdk-lib';
const cfnDistributionTenantProps: cloudfront.CfnDistributionTenantProps = {
  distributionId: 'distributionId',
  domains: ['domains'],
  name: 'name',

  // the properties below are optional
  connectionGroupId: 'connectionGroupId',
  customizations: {
    certificate: {
      arn: 'arn',
    },
    geoRestrictions: {
      locations: ['locations'],
      restrictionType: 'restrictionType',
    },
    webAcl: {
      action: 'action',
      arn: 'arn',
    },
  },
  enabled: false,
  managedCertificateRequest: {
    certificateTransparencyLoggingPreference: 'certificateTransparencyLoggingPreference',
    primaryDomainName: 'primaryDomainName',
    validationTokenHost: 'validationTokenHost',
  },
  parameters: [{
    name: 'name',
    value: 'value',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
distributionId	`string`	The ID of the multi-tenant distribution.
domains	`string[]`	The domains associated with the distribution tenant.
name	`string`	The name of the distribution tenant.
connectionGroupId?	`string`	The ID of the connection group for the distribution tenant.
customizations?	`IResolvable` `\|` `CustomizationsProperty`	Customizations for the distribution tenant.
enabled?	`boolean \|` `IResolvable`	Indicates whether the distribution tenant is in an enabled state.
managedCertificateRequest?	`IResolvable` `\|` `ManagedCertificateRequestProperty`	An object that represents the request for the Amazon CloudFront managed ACM certificate.
parameters?	`IResolvable` `\|` `IResolvable` `\|` `ParameterProperty[]`	A list of parameter values to add to the resource.
tags?	`CfnTag[]`	A complex type that contains zero or more `Tag` elements.

distributionId

Type: string

The ID of the multi-tenant distribution.

domains

Type: string[]

The domains associated with the distribution tenant.

name

Type: string

The name of the distribution tenant.

connectionGroupId?

Type: string (optional)

The ID of the connection group for the distribution tenant.

If you don't specify a connection group, CloudFront uses the default connection group.

customizations?

Type: IResolvable | CustomizationsProperty (optional)

Customizations for the distribution tenant.

For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and AWS WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.

enabled?

Type: boolean | IResolvable (optional)

Indicates whether the distribution tenant is in an enabled state.

If disabled, the distribution tenant won't serve traffic.

managedCertificateRequest?

Type: IResolvable | ManagedCertificateRequestProperty (optional)

An object that represents the request for the Amazon CloudFront managed ACM certificate.

parameters?

Type: IResolvable | IResolvable | ParameterProperty[] (optional)

A list of parameter values to add to the resource.

A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.

tags?

Type: CfnTag[] (optional)

A complex type that contains zero or more Tag elements.