class CfnDistributionPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Lightsail.Mixins.CfnDistributionPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awslightsail/mixins#CfnDistributionPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.lightsail.mixins.CfnDistributionPropsMixin
Python	aws_cdk.mixins_preview.aws_lightsail.mixins.CfnDistributionPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_lightsail » mixins » CfnDistributionPropsMixin

Implements IMixin

Extends Mixin

The AWS::Lightsail::Distribution resource specifies a content delivery network (CDN) distribution.

You can create distributions only in the us-east-1 AWS Region.

A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance, static content hosted on a Lightsail bucket, or through a Lightsail load balancer.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-distribution.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as lightsail_mixins } from '@aws-cdk/mixins-preview/aws-lightsail';
const cfnDistributionPropsMixin = new lightsail_mixins.CfnDistributionPropsMixin({
  bundleId: 'bundleId',
  cacheBehaviors: [{
    behavior: 'behavior',
    path: 'path',
  }],
  cacheBehaviorSettings: {
    allowedHttpMethods: 'allowedHttpMethods',
    cachedHttpMethods: 'cachedHttpMethods',
    defaultTtl: 123,
    forwardedCookies: {
      cookiesAllowList: ['cookiesAllowList'],
      option: 'option',
    },
    forwardedHeaders: {
      headersAllowList: ['headersAllowList'],
      option: 'option',
    },
    forwardedQueryStrings: {
      option: false,
      queryStringsAllowList: ['queryStringsAllowList'],
    },
    maximumTtl: 123,
    minimumTtl: 123,
  },
  certificateName: 'certificateName',
  defaultCacheBehavior: {
    behavior: 'behavior',
  },
  distributionName: 'distributionName',
  ipAddressType: 'ipAddressType',
  isEnabled: false,
  origin: {
    name: 'name',
    protocolPolicy: 'protocolPolicy',
    regionName: 'regionName',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnDistributionPropsMixin(props: CfnDistributionMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnDistributionMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::Lightsail::Distribution.

Properties

Name	Type	Description
props	CfnDistributionMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnDistributionMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.