CloudFrontWebDistribution

class aws_cdk.aws_cloudfront.CloudFrontWebDistribution(scope, id, *, origin_configs, alias_configuration=None, comment=None, default_root_object=None, enable_ip_v6=None, error_configurations=None, geo_restriction=None, http_version=None, logging_config=None, price_class=None, viewer_certificate=None, viewer_protocol_policy=None, web_acl_id=None)

Bases: aws_cdk.core.Resource

Amazon CloudFront is a global content delivery network (CDN) service that securely delivers data, videos, applications, and APIs to your viewers with low latency and high transfer speeds.

CloudFront fronts user provided content and caches it at edge locations across the world.

Here’s how you can use this construct:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
from aws_cdk.aws_cloudfront import CloudFrontWebDistribution


source_bucket = Bucket(self, "Bucket")

distribution = CloudFrontWebDistribution(self, "MyDistribution",
    origin_configs=[SourceConfiguration(
        s3_origin_source=S3OriginConfig(
            s3_bucket_source=source_bucket
        ),
        behaviors=[Behavior(is_default_behavior=True)]
    )
    ]
)

This will create a CloudFront distribution that uses your S3Bucket as it’s origin.

You can customize the distribution using additional properties from the CloudFrontWebDistributionProps interface.

Resource

AWS::CloudFront::Distribution

Parameters
  • scope (Construct) –

  • id (str) –

  • origin_configs (Sequence[SourceConfiguration]) – The origin configurations for this distribution. Behaviors are a part of the origin.

  • alias_configuration (Optional[AliasConfiguration]) – (deprecated) AliasConfiguration is used to configured CloudFront to respond to requests on custom domain names. Default: - None.

  • comment (Optional[str]) – A comment for this distribution in the CloudFront console. Default: - No comment is added to distribution.

  • default_root_object (Optional[str]) – The default object to serve. Default: - “index.html” is served.

  • enable_ip_v6 (Optional[bool]) – If your distribution should have IPv6 enabled. Default: true

  • error_configurations (Optional[Sequence[CustomErrorResponseProperty]]) – How CloudFront should handle requests that are not successful (eg PageNotFound). By default, CloudFront does not replace HTTP status codes in the 4xx and 5xx range with custom error messages. CloudFront does not cache HTTP status codes. Default: - No custom error configuration.

  • geo_restriction (Optional[GeoRestriction]) – Controls the countries in which your content is distributed. Default: No geo restriction

  • http_version (Optional[HttpVersion]) – The max supported HTTP Versions. Default: HttpVersion.HTTP2

  • logging_config (Optional[LoggingConfiguration]) – Optional - if we should enable logging. You can pass an empty object ({}) to have us auto create a bucket for logging. Omission of this property indicates no logging is to be enabled. Default: - no logging is enabled by default.

  • price_class (Optional[PriceClass]) – The price class for the distribution (this impacts how many locations CloudFront uses for your distribution, and billing). Default: PriceClass.PRICE_CLASS_100 the cheapest option for CloudFront is picked by default.

  • viewer_certificate (Optional[ViewerCertificate]) – Specifies whether you want viewers to use HTTP or HTTPS to request your objects, whether you’re using an alternate domain name with HTTPS, and if so, if you’re using AWS Certificate Manager (ACM) or a third-party certificate authority. Default: ViewerCertificate.fromCloudFrontDefaultCertificate()

  • viewer_protocol_policy (Optional[ViewerProtocolPolicy]) – The default viewer policy for incoming clients. Default: RedirectToHTTPs

  • web_acl_id (Optional[str]) – Unique identifier that specifies the AWS WAF web ACL to associate with this CloudFront distribution. To specify a web ACL created using the latest version of AWS WAF, use the ACL ARN, for example arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a. To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example 473e64fd-f30b-4765-81a0-62ad96dd167a. Default: - No AWS Web Application Firewall web access control list (web ACL).

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DELETE), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters

policy (RemovalPolicy) –

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

distribution_domain_name

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.)

Return type

str

distribution_id

The distribution ID for this distribution.

Return type

str

domain_name

(deprecated) 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.

Stability

deprecated

Return type

str

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Return type

ResourceEnvironment

logging_bucket

The logging bucket for this CloudFront distribution.

If logging is not enabled for this distribution - this property will be undefined.

Return type

Optional[IBucket]

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

Static Methods

classmethod from_distribution_attributes(scope, id, *, distribution_id, domain_name)

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

Parameters
  • scope (Construct) –

  • id (str) –

  • distribution_id (str) – The distribution ID for this distribution.

  • domain_name (str) – The generated domain name of the Distribution, such as d111111abcdef8.cloudfront.net.

Return type

IDistribution

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool