@aws-cdk/aws-cloudfront

property ALLOW_ALL

static readonly ALLOW_ALL: AllowedMethods;

• All supported HTTP methods

property ALLOW_GET_HEAD

static readonly ALLOW_GET_HEAD: AllowedMethods;

• HEAD and GET

property ALLOW_GET_HEAD_OPTIONS

static readonly ALLOW_GET_HEAD_OPTIONS: AllowedMethods;

• HEAD, GET, and OPTIONS

property methods

readonly methods: string[];

• HTTP methods supported

property behavior

readonly behavior: string;

• The behavior of cookies: allow all, none, an allow list, or a deny list.

property cookies

readonly cookies?: string[];

• The cookies to allow or deny, if the behavior is an allow or deny list.

method all

static all: () => CacheCookieBehavior;

• All cookies in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

method allowList

static allowList: (...cookies: string[]) => CacheCookieBehavior;

• Only the provided cookies are included in the cache key and automatically included in requests that CloudFront sends to the origin.

method denyList

static denyList: (...cookies: string[]) => CacheCookieBehavior;

• All cookies except the provided cookies are included in the cache key and automatically included in requests that CloudFront sends to the origin.

method none

static none: () => CacheCookieBehavior;

• Cookies in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin.

property CACHE_GET_HEAD

static readonly CACHE_GET_HEAD: CachedMethods;

• HEAD and GET

property CACHE_GET_HEAD_OPTIONS

static readonly CACHE_GET_HEAD_OPTIONS: CachedMethods;

• HEAD, GET, and OPTIONS

property methods

readonly methods: string[];

• HTTP methods supported

property behavior

readonly behavior: string;

• If no headers will be passed, or an allow list of headers.

property headers

readonly headers?: string[];

• The headers for the allow/deny list, if applicable.

method allowList

static allowList: (...headers: string[]) => CacheHeaderBehavior;

• Listed headers are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

method none

static none: () => CacheHeaderBehavior;

• HTTP headers are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin.

constructor

constructor(scope: Construct, id: string, props?: CachePolicyProps);

property AMPLIFY

static readonly AMPLIFY: ICachePolicy;

• This policy is designed for use with an origin that is an AWS Amplify web app.

property cachePolicyId

readonly cachePolicyId: string;

property CACHING_DISABLED

static readonly CACHING_DISABLED: ICachePolicy;

• Disables caching. This policy is useful for dynamic content and for requests that are not cacheable.

property CACHING_OPTIMIZED

static readonly CACHING_OPTIMIZED: ICachePolicy;

• Optimize cache efficiency by minimizing the values that CloudFront includes in the cache key. Query strings and cookies are not included in the cache key, and only the normalized 'Accept-Encoding' header is included.

property CACHING_OPTIMIZED_FOR_UNCOMPRESSED_OBJECTS

static readonly CACHING_OPTIMIZED_FOR_UNCOMPRESSED_OBJECTS: ICachePolicy;

• Optimize cache efficiency by minimizing the values that CloudFront includes in the cache key. Query strings and cookies are not included in the cache key, and only the normalized 'Accept-Encoding' header is included. Disables cache compression.

property ELEMENTAL_MEDIA_PACKAGE

static readonly ELEMENTAL_MEDIA_PACKAGE: ICachePolicy;

• Designed for use with an origin that is an AWS Elemental MediaPackage endpoint.

method fromCachePolicyId

static fromCachePolicyId: (
    scope: Construct,
    id: string,
    cachePolicyId: string
) => ICachePolicy;

• Imports a Cache Policy from its id.

property behavior

readonly behavior: string;

• The behavior of query strings -- allow all, none, only an allow list, or a deny list.

property queryStrings

readonly queryStrings?: string[];

• The query strings to allow or deny, if the behavior is an allow or deny list.

method all

static all: () => CacheQueryStringBehavior;

• All query strings in viewer requests are included in the cache key and are automatically included in requests that CloudFront sends to the origin.

method allowList

static allowList: (...queryStrings: string[]) => CacheQueryStringBehavior;

• Only the provided queryStrings are included in the cache key and automatically included in requests that CloudFront sends to the origin.

method denyList

static denyList: (...queryStrings: string[]) => CacheQueryStringBehavior;

• All query strings except the provided queryStrings are included in the cache key and automatically included in requests that CloudFront sends to the origin.

method none

static none: () => CacheQueryStringBehavior;

• Query strings in viewer requests are not included in the cache key and are not automatically included in requests that CloudFront sends to the origin.

constructor

constructor(scope: cdk.Construct, id: string, props: CfnCachePolicyProps);

• Create a new AWS::CloudFront::CachePolicy.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrId

readonly attrId: string;

• The unique identifier for the cache policy. For example: 2766f7b2-75c5-41c6-8f06-bf4303a2f2f5 . Id

property attrLastModifiedTime

readonly attrLastModifiedTime: string;

• The date and time when the cache policy was last modified. LastModifiedTime

property cachePolicyConfig

cachePolicyConfig: any;

• The cache policy configuration.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cachepolicy.html#cfn-cloudfront-cachepolicy-cachepolicyconfig

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnCloudFrontOriginAccessIdentityProps
);

• Create a new AWS::CloudFront::CloudFrontOriginAccessIdentity.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrId

readonly attrId: string;

• The ID for the origin access identity, for example, E74FTE3AJFJ256A . Id

property attrS3CanonicalUserId

readonly attrS3CanonicalUserId: string;

• The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3. For example: b970b42360b81c8ddbd79d2f5df0069ba9033c8a79655752abe380cd6d63ba8bcf23384d568fcf89fc49700b5e11a0fd . S3CanonicalUserId

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property cloudFrontOriginAccessIdentityConfig

cloudFrontOriginAccessIdentityConfig: any;

• The current configuration information for the identity.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-cloudfrontoriginaccessidentity.html#cfn-cloudfront-cloudfrontoriginaccessidentity-cloudfrontoriginaccessidentityconfig

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnContinuousDeploymentPolicyProps
);

• Create a new AWS::CloudFront::ContinuousDeploymentPolicy.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrId

readonly attrId: string;

• The identifier of the cotinuous deployment policy. Id

property attrLastModifiedTime

readonly attrLastModifiedTime: string;

• The date and time when the continuous deployment policy was last modified. LastModifiedTime

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property continuousDeploymentPolicyConfig

continuousDeploymentPolicyConfig: any;

• Contains the configuration for a continuous deployment policy.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-continuousdeploymentpolicy.html#cfn-cloudfront-continuousdeploymentpolicy-continuousdeploymentpolicyconfig

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnDistributionProps);

• Create a new AWS::CloudFront::Distribution.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrDomainName

readonly attrDomainName: string;

• The domain name of the resource, such as d111111abcdef8.cloudfront.net . DomainName

property attrId

readonly attrId: string;

• The identifier for the distribution, for example EDFDVBD632BHDS5 . Id

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property distributionConfig

distributionConfig: any;

• The distribution's configuration.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html#cfn-cloudfront-distribution-distributionconfig

property tags

readonly tags: cdk.TagManager;

• A complex type that contains zero or more Tag elements.

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

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnFunctionProps);

• Create a new AWS::CloudFront::Function.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrFunctionArn

readonly attrFunctionArn: string;

• The ARN of the function. For example:

  arn:aws:cloudfront::123456789012:function/ExampleFunction .

  To get the function ARN, use the following syntax:

  !GetAtt *Function_Logical_ID* .FunctionMetadata.FunctionARN FunctionARN

property attrFunctionMetadataFunctionArn

readonly attrFunctionMetadataFunctionArn: string;

• The Amazon Resource Name (ARN) of the function. The ARN uniquely identifies the function. FunctionMetadata.FunctionARN

property attrStage

readonly attrStage: string;

• Stage

property autoPublish

autoPublish: any;

• A flag that determines whether to automatically publish the function to the LIVE stage when it’s created. To automatically publish to the LIVE stage, set this property to true .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-function.html#cfn-cloudfront-function-autopublish

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property functionCode

functionCode: string;

• The function code. For more information about writing a CloudFront function, see [Writing function code for CloudFront Functions](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html) in the *Amazon CloudFront Developer Guide* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-function.html#cfn-cloudfront-function-functioncode

property functionConfig

functionConfig: any;

• Contains configuration information about a CloudFront function.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-function.html#cfn-cloudfront-function-functionconfig

property functionMetadata

functionMetadata: any;

• Contains metadata about a CloudFront function.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-function.html#cfn-cloudfront-function-functionmetadata

property name

name: string;

• A name to identify the function.

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

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnKeyGroupProps);

• Create a new AWS::CloudFront::KeyGroup.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrId

readonly attrId: string;

• The identifier for the key group. Id

property attrLastModifiedTime

readonly attrLastModifiedTime: string;

• The date and time when the key group was last modified. LastModifiedTime

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property keyGroupConfig

keyGroupConfig: any;

• The key group configuration.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-keygroup.html#cfn-cloudfront-keygroup-keygroupconfig

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnMonitoringSubscriptionProps
);

• Create a new AWS::CloudFront::MonitoringSubscription.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property distributionId

distributionId: string;

• The ID of the distribution that you are enabling metrics for.

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

property monitoringSubscription

monitoringSubscription: any;

• A subscription configuration for additional CloudWatch metrics.

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

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnOriginAccessControlProps
);

• Create a new AWS::CloudFront::OriginAccessControl.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrId

readonly attrId: string;

• The unique identifier of the origin access control. Id

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property originAccessControlConfig

originAccessControlConfig: any;

• The origin access control.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-originaccesscontrol.html#cfn-cloudfront-originaccesscontrol-originaccesscontrolconfig

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnOriginRequestPolicyProps
);

• Create a new AWS::CloudFront::OriginRequestPolicy.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrId

readonly attrId: string;

• The unique identifier for the origin request policy. For example: befd7079-9bbc-4ebf-8ade-498a3694176c . Id

property attrLastModifiedTime

readonly attrLastModifiedTime: string;

• The date and time when the origin request policy was last modified. LastModifiedTime

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property originRequestPolicyConfig

originRequestPolicyConfig: any;

• The origin request policy configuration.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-originrequestpolicy.html#cfn-cloudfront-originrequestpolicy-originrequestpolicyconfig

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnPublicKeyProps);

• Create a new AWS::CloudFront::PublicKey.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrCreatedTime

readonly attrCreatedTime: string;

• The date and time when the public key was uploaded. CreatedTime

property attrId

readonly attrId: string;

• The identifier of the public key. Id

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property publicKeyConfig

publicKeyConfig: any;

• Configuration information about a public key that you can use with [signed URLs and signed cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) , or with [field-level encryption](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html) .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-publickey.html#cfn-cloudfront-publickey-publickeyconfig

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnRealtimeLogConfigProps);

• Create a new AWS::CloudFront::RealtimeLogConfig.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrArn

readonly attrArn: string;

• The Amazon Resource Name (ARN) of the real-time log configuration. For example: arn:aws:cloudfront::111122223333:realtime-log-config/ExampleNameForRealtimeLogConfig . Arn

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property endPoints

endPoints: any;

• Contains information about the Amazon Kinesis data stream where you are sending real-time log data for this real-time log configuration.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html#cfn-cloudfront-realtimelogconfig-endpoints

property fields

fields: string[];

• A list of fields that are included in each real-time log record. In an API response, the fields are provided in the same order in which they are sent to the Amazon Kinesis data stream.

  For more information about fields, see [Real-time log configuration fields](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields) in the *Amazon CloudFront Developer Guide* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html#cfn-cloudfront-realtimelogconfig-fields

property name

name: string;

• The unique name of this real-time log configuration.

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

property samplingRate

samplingRate: number;

• The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. The sampling rate is an integer between 1 and 100, inclusive.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-realtimelogconfig.html#cfn-cloudfront-realtimelogconfig-samplingrate

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnResponseHeadersPolicyProps
);

• Create a new AWS::CloudFront::ResponseHeadersPolicy.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrId

readonly attrId: string;

• The unique identifier for the response headers policy. For example: 57f99797-3b20-4e1b-a728-27972a74082a . Id

property attrLastModifiedTime

readonly attrLastModifiedTime: string;

• The date and time when the response headers policy was last modified. LastModifiedTime

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property responseHeadersPolicyConfig

responseHeadersPolicyConfig: any;

• A response headers policy configuration.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-responseheaderspolicy.html#cfn-cloudfront-responseheaderspolicy-responseheaderspolicyconfig

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(
    scope: cdk.Construct,
    id: string,
    props: CfnStreamingDistributionProps
);

• Create a new AWS::CloudFront::StreamingDistribution.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrDomainName

readonly attrDomainName: string;

• The domain name of the resource, such as d111111abcdef8.cloudfront.net . DomainName

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property streamingDistributionConfig

streamingDistributionConfig: any;

• The current configuration information for the RTMP distribution.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-streamingdistribution.html#cfn-cloudfront-streamingdistribution-streamingdistributionconfig

property tags

readonly tags: cdk.TagManager;

• A complex type that contains zero or more Tag elements.

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

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: Construct, id: string, props: CloudFrontWebDistributionProps);

property distributionDomainName

readonly distributionDomainName: string;

• The domain name created by CloudFront for this distribution. If you are using aliases for your distribution, this is the domainName your DNS records should point to. (In Route53, you could create an ALIAS record to this value, for example.)

property distributionId

readonly distributionId: string;

• The distribution ID for this distribution.

property domainName

readonly domainName: string;

• The domain name created by CloudFront for this distribution. If you are using aliases for your distribution, this is the domainName your DNS records should point to. (In Route53, you could create an ALIAS record to this value, for example.)

  Deprecated

  - Use distributionDomainName instead.

property loggingBucket

readonly loggingBucket?: s3.IBucket;

• The logging bucket for this CloudFront distribution. If logging is not enabled for this distribution - this property will be undefined.

method fromDistributionAttributes

static fromDistributionAttributes: (
    scope: Construct,
    id: string,
    attrs: CloudFrontWebDistributionAttributes
) => IDistribution;

• Creates a construct that represents an external (imported) distribution.

constructor

constructor(scope: Construct, id: string, props: DistributionProps);

property distributionDomainName

readonly distributionDomainName: string;

property distributionId

readonly distributionId: string;

property domainName

readonly domainName: string;

method addBehavior

addBehavior: (
    pathPattern: string,
    origin: IOrigin,
    behaviorOptions?: AddBehaviorOptions
) => void;

• Adds a new behavior to this distribution for the given pathPattern.

  Parameter pathPattern

  the path pattern (e.g., 'images/*') that specifies which requests to apply the behavior to.

  Parameter origin

  the origin to use for this behavior

  Parameter behaviorOptions

  the options for the behavior at this path.

method fromDistributionAttributes

static fromDistributionAttributes: (
    scope: Construct,
    id: string,
    attrs: DistributionAttributes
) => IDistribution;

• Creates a Distribution construct that represents an external (imported) distribution.

constructor

constructor(scope: Construct, id: string, props: FunctionProps);

property functionArn

readonly functionArn: string;

• the ARN of the CloudFront function

property functionName

readonly functionName: string;

• the name of the CloudFront function

property functionStage

readonly functionStage: string;

• the deployment stage of the CloudFront function

method fromFunctionAttributes

static fromFunctionAttributes: (
    scope: Construct,
    id: string,
    attrs: FunctionAttributes
) => IFunction;

• Imports a function by its name and ARN

method fromFile

static fromFile: (options: FileCodeOptions) => FunctionCode;

• Code from external file for function

  Parameter options

  the options for the external file

  Returns

  code object with contents from file.

method fromInline

static fromInline: (code: string) => FunctionCode;

• Inline code for function

  Parameter code

  The actual function code

  Returns

  code object with inline code.

method render

abstract render: () => string;

• renders the function code

property locations

readonly locations: string[];

property restrictionType

readonly restrictionType: 'whitelist' | 'blacklist';

method allowlist

static allowlist: (...locations: string[]) => GeoRestriction;

• Allow specific countries which you want CloudFront to distribute your content.

  Parameter locations

  Two-letter, uppercase country code for a country that you want to allow. Include one element for each country. See ISO 3166-1-alpha-2 code on the *International Organization for Standardization* website