Package software.amazon.awscdk.services.cloudfront

Interface CfnDistributionTenantProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDistributionTenantProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-05-20T23:52:51.634Z")
@Stability(Stable)
public interface CfnDistributionTenantProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.cloudfront.*;
 CfnDistributionTenantProps cfnDistributionTenantProps = CfnDistributionTenantProps.builder()
         .distributionId("distributionId")
         .domains(List.of("domains"))
         .name("name")
         // the properties below are optional
         .connectionGroupId("connectionGroupId")
         .customizations(CustomizationsProperty.builder()
                 .certificate(CertificateProperty.builder()
                         .arn("arn")
                         .build())
                 .geoRestrictions(GeoRestrictionCustomizationProperty.builder()
                         .locations(List.of("locations"))
                         .restrictionType("restrictionType")
                         .build())
                 .webAcl(WebAclCustomizationProperty.builder()
                         .action("action")
                         .arn("arn")
                         .build())
                 .build())
         .enabled(false)
         .managedCertificateRequest(ManagedCertificateRequestProperty.builder()
                 .certificateTransparencyLoggingPreference("certificateTransparencyLoggingPreference")
                 .primaryDomainName("primaryDomainName")
                 .validationTokenHost("validationTokenHost")
                 .build())
         .parameters(List.of(ParameterProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDistributionTenantProps.Builder	A builder for CfnDistributionTenantProps
static final class	CfnDistributionTenantProps.Jsii$Proxy	An implementation for CfnDistributionTenantProps

Method Summary

Modifier and Type	Method	Description
static CfnDistributionTenantProps.Builder	builder()
default String	getConnectionGroupId()	The ID of the connection group for the distribution tenant.
default Object	getCustomizations()	Customizations for the distribution tenant.
String	getDistributionId()	The ID of the multi-tenant distribution.
List<String>	getDomains()	The domains associated with the distribution tenant.
default Object	getEnabled()	Indicates whether the distribution tenant is in an enabled state.
default Object	getManagedCertificateRequest()	An object that represents the request for the Amazon CloudFront managed ACM certificate.
String	getName()	The name of the distribution tenant.
default Object	getParameters()	A list of parameter values to add to the resource.
default List<CfnTag>	getTags()	A complex type that contains zero or more Tag elements.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDistributionId

@Stability(Stable)
@NotNull
String getDistributionId()

The ID of the multi-tenant distribution.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#cfn-cloudfront-distributiontenant-distributionid

getDomains

@Stability(Stable)
@NotNull
List<String> getDomains()

The domains associated with the distribution tenant.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#cfn-cloudfront-distributiontenant-domains

getName

@Stability(Stable)
@NotNull
String getName()

The name of the distribution tenant.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#cfn-cloudfront-distributiontenant-name

getConnectionGroupId

@Stability(Stable)
@Nullable
default String getConnectionGroupId()

The ID of the connection group for the distribution tenant.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#cfn-cloudfront-distributiontenant-connectiongroupid

getCustomizations

@Stability(Stable)
@Nullable
default Object getCustomizations()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#cfn-cloudfront-distributiontenant-customizations

getEnabled

@Stability(Stable)
@Nullable
default Object getEnabled()

Indicates whether the distribution tenant is in an enabled state.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#cfn-cloudfront-distributiontenant-enabled

getManagedCertificateRequest

@Stability(Stable)
@Nullable
default Object getManagedCertificateRequest()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#cfn-cloudfront-distributiontenant-managedcertificaterequest

getParameters

@Stability(Stable)
@Nullable
default Object getParameters()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#cfn-cloudfront-distributiontenant-parameters

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A complex type that contains zero or more Tag elements.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distributiontenant.html#cfn-cloudfront-distributiontenant-tags

builder

@Stability(Stable)
static CfnDistributionTenantProps.Builder builder()

Returns:

a CfnDistributionTenantProps.Builder of CfnDistributionTenantProps