Metadata-Version: 2.1
Name: aws-cdk.aws-cloudfront
Version: 1.52.0
Summary: CDK Constructs for AWS CloudFront
Home-page: https://github.com/aws/aws-cdk
Author: Amazon Web Services
License: Apache-2.0
Project-URL: Source, https://github.com/aws/aws-cdk.git
Description: ## Amazon CloudFront Construct Library
        
        <!--BEGIN STABILITY BANNER-->---
        
        
        | Features | Stability |
        | --- | --- |
        | CFN Resources | ![Stable](https://img.shields.io/badge/stable-success.svg?style=for-the-badge) |
        | Higher level constructs for Distribution | ![Experimental](https://img.shields.io/badge/experimental-important.svg?style=for-the-badge) |
        | Higher level constructs for CloudFrontWebDistribution | ![Stable](https://img.shields.io/badge/stable-success.svg?style=for-the-badge) |
        
        > **CFN Resources:** All classes with the `Cfn` prefix in this module ([CFN Resources](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) are always stable and safe to use.
        
        > **Experimental:** Higher level constructs in this module that are marked as experimental are under active development. They are subject to non-backward compatible changes or removal in any future version. These are not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be announced in the release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.
        
        > **Stable:** Higher level constructs in this module that are marked stable will not undergo any breaking changes. They will strictly follow the [Semantic Versioning](https://semver.org/) model.
        
        ---
        <!--END STABILITY BANNER-->
        
        Amazon CloudFront is a web service that speeds up distribution of your static and dynamic web content, such as .html, .css, .js, and image files, to
        your users. CloudFront delivers your content through a worldwide network of data centers called edge locations. When a user requests content that
        you're serving with CloudFront, the user is routed to the edge location that provides the lowest latency, so that content is delivered with the best
        possible performance.
        
        ## Distribution API - Experimental
        
        ![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)
        
        The `Distribution` API is currently being built to replace the existing `CloudFrontWebDistribution` API. The `Distribution` API is optimized for the
        most common use cases of CloudFront distributions (e.g., single origin and behavior, few customizations) while still providing the ability for more
        advanced use cases. The API focuses on simplicity for the common use cases, and convenience methods for creating the behaviors and origins necessary
        for more complex use cases.
        
        ### Creating a distribution
        
        CloudFront distributions deliver your content from one or more origins; an origin is the location where you store the original version of your
        content. Origins can be created from S3 buckets or a custom origin (HTTP server). Each distribution has a default behavior which applies to all
        requests to that distribution, and routes requests to a primary origin.
        
        #### From an S3 Bucket
        
        An S3 bucket can be added as an origin. If the bucket is configured as a website endpoint, the distribution can use S3 redirects and S3 custom error
        documents.
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        import aws_cdk.aws_cloudfront as cloudfront
        
        # Creates a distribution for a S3 bucket.
        my_bucket = s3.Bucket(self, "myBucket")
        cloudfront.Distribution(self, "myDist",
            default_behavior=BehaviorOptions(origin=cloudfront.Origin.from_bucket(my_bucket))
        )
        ```
        
        The above will treat the bucket differently based on if `IBucket.isWebsite` is set or not. If the bucket is configured as a website, the bucket is
        treated as an HTTP origin, and the built-in S3 redirects and error pages can be used. Otherwise, the bucket is handled as a bucket origin and
        CloudFront's redirect and error handling will be used. In the latter case, the Origin wil create an origin access identity and grant it access to the
        underlying bucket. This can be used in conjunction with a bucket that is not public to require that your users access your content using CloudFront
        URLs and not S3 URLs directly.
        
        ### Domain Names and Certificates
        
        When you create a distribution, CloudFront assigns a domain name for the distribution, for example: `d111111abcdef8.cloudfront.net`; this value can
        be retrieved from `distribution.distributionDomainName`. CloudFront distributions use a default certificate (`*.cloudfront.net`) to support HTTPS by
        default. If you want to use your own domain name, such as `www.example.com`, you must associate a certificate with your distribution that contains
        your domain name. The certificate must be present in the AWS Certificate Manager (ACM) service in the US East (N. Virginia) region; the certificate
        may either be created by ACM, or created elsewhere and imported into ACM.
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        my_certificate = acm.DnsValidatedCertificate(self, "mySiteCert",
            domain_name="www.example.com",
            hosted_zone=hosted_zone
        )
        cloudfront.Distribution(self, "myDist",
            default_behavior={"origin": cloudfront.Origin.from_bucket(my_bucket)},
            certificate=my_certificate
        )
        ```
        
        ### Multiple Behaviors & Origins
        
        Each distribution has a default behavior which applies to all requests to that distribution; additional behaviors may be specified for a
        given URL path pattern. Behaviors allow routing with multiple origins, controlling which HTTP methods to support, whether to require users to
        use HTTPS, and what query strings or cookies to forward to your origin, among others.
        
        The properties of the default behavior can be adjusted as part of the distribution creation. The following example shows configuring the HTTP
        methods and viewer protocol policy of the cache.
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        my_web_distribution = cloudfront.Distribution(self, "myDist",
            default_behavior={
                "origin": cloudfront.Origin.from_bucket(my_bucket),
                "allowed_methods": AllowedMethods.ALLOW_ALL,
                "viewer_protocol_policy": ViewerProtocolPolicy.REDIRECT_TO_HTTPS
            }
        )
        ```
        
        Additional behaviors can be specified at creation, or added after the initial creation. Each additional behavior is associated with an origin,
        and enable customization for a specific set of resources based on a URL path pattern. For example, we can add a behavior to `myWebDistribution` to
        override the default time-to-live (TTL) for all of the images.
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        my_web_distribution.add_behavior("/images/*.jpg", cloudfront.Origin.from_bucket(my_other_bucket),
            viewer_protocol_policy=ViewerProtocolPolicy.REDIRECT_TO_HTTPS,
            default_ttl=cdk.Duration.days(7)
        )
        ```
        
        These behaviors can also be specified at distribution creation time.
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        bucket_origin = cloudfront.Origin.from_bucket(my_bucket)
        cloudfront.Distribution(self, "myDist",
            default_behavior={
                "origin": bucket_origin,
                "allowed_methods": AllowedMethods.ALLOW_ALL,
                "viewer_protocol_policy": ViewerProtocolPolicy.REDIRECT_TO_HTTPS
            },
            additional_behaviors={
                "/images/*.jpg": {
                    "origin": bucket_origin,
                    "viewer_protocol_policy": ViewerProtocolPolicy.REDIRECT_TO_HTTPS,
                    "default_ttl": cdk.Duration.days(7)
                }
            }
        )
        ```
        
        ## CloudFrontWebDistribution API - Stable
        
        ![cdk-constructs: Stable](https://img.shields.io/badge/cdk--constructs-stable-success.svg?style=for-the-badge)
        
        A CloudFront construct - for setting up the AWS CDN with ease!
        
        Example usage:
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        source_bucket = Bucket(self, "Bucket")
        
        distribution = CloudFrontWebDistribution(self, "MyDistribution",
            origin_configs=[{
                "s3_origin_source": {
                    "s3_bucket_source": source_bucket
                },
                "behaviors": [{"is_default_behavior": True}]
            }
            ]
        )
        ```
        
        ### Viewer certificate
        
        By default, CloudFront Web Distributions will answer HTTPS requests with CloudFront's default certificate, only containing the distribution `domainName` (e.g. d111111abcdef8.cloudfront.net).
        You can customize the viewer certificate property to provide a custom certificate and/or list of domain name aliases to fit your needs.
        
        See [Using Alternate Domain Names and HTTPS](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html) in the CloudFront User Guide.
        
        #### Default certificate
        
        You can customize the default certificate aliases. This is intended to be used in combination with CNAME records in your DNS zone.
        
        Example:
        
        ```python
        # Example automatically generated. See https://github.com/aws/jsii/issues/826
        s3_bucket_source = s3.Bucket(self, "Bucket")
        
        distribution = cloudfront.CloudFrontWebDistribution(self, "AnAmazingWebsiteProbably",
            origin_configs=[SourceConfiguration(
                s3_origin_source=S3OriginConfig(s3_bucket_source=s3_bucket_source),
                behaviors=[Behavior(is_default_behavior=True)]
            )],
            viewer_certificate=cloudfront.ViewerCertificate.from_cloud_front_default_certificate("www.example.com")
        )
        ```
        
        #### ACM certificate
        
        You can change the default certificate by one stored AWS Certificate Manager, or ACM.
        Those certificate can either be generated by AWS, or purchased by another CA imported into ACM.
        
        For more information, see [the aws-certificatemanager module documentation](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-certificatemanager-readme.html) or [Importing Certificates into AWS Certificate Manager](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the AWS Certificate Manager User Guide.
        
        Example:
        
        ```python
        # Example automatically generated. See https://github.com/aws/jsii/issues/826
        s3_bucket_source = s3.Bucket(self, "Bucket")
        
        certificate = certificatemanager.Certificate(self, "Certificate",
            domain_name="example.com",
            subject_alternative_names=["*.example.com"]
        )
        
        distribution = cloudfront.CloudFrontWebDistribution(self, "AnAmazingWebsiteProbably",
            origin_configs=[SourceConfiguration(
                s3_origin_source=S3OriginConfig(s3_bucket_source=s3_bucket_source),
                behaviors=[Behavior(is_default_behavior=True)]
            )],
            viewer_certificate=cloudfront.ViewerCertificate.from_acm_certificate(certificate,
                aliases=["example.com", "www.example.com"],
                security_policy=cloudfront.SecurityPolicyProtocol.TLS_V1, # default
                ssl_method=cloudfront.SSLMethod.SNI
            )
        )
        ```
        
        #### IAM certificate
        
        You can also import a certificate into the IAM certificate store.
        
        See [Importing an SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cnames-and-https-procedures.html#cnames-and-https-uploading-certificates) in the CloudFront User Guide.
        
        Example:
        
        ```python
        # Example automatically generated. See https://github.com/aws/jsii/issues/826
        s3_bucket_source = s3.Bucket(self, "Bucket")
        
        distribution = cloudfront.CloudFrontWebDistribution(self, "AnAmazingWebsiteProbably",
            origin_configs=[SourceConfiguration(
                s3_origin_source=S3OriginConfig(s3_bucket_source=s3_bucket_source),
                behaviors=[Behavior(is_default_behavior=True)]
            )],
            viewer_certificate=cloudfront.ViewerCertificate.from_iam_certificate("certificateId",
                aliases=["example.com"],
                security_policy=cloudfront.SecurityPolicyProtocol.SSL_V3, # default
                ssl_method=cloudfront.SSLMethod.SNI
            )
        )
        ```
        
        #### Restrictions
        
        CloudFront supports adding restrictions to your distribution.
        
        See [Restricting the Geographic Distribution of Your Content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/georestrictions.html) in the CloudFront User Guide.
        
        Example:
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        cloudfront.CloudFrontWebDistribution(stack, "MyDistribution",
            # ...
            geo_restriction=GeoRestriction.whitelist("US", "UK")
        )
        ```
        
        ### Connection behaviors between CloudFront and your origin
        
        CloudFront provides you even more control over the connection behaviors between CloudFront and your origin. You can now configure the number of connection attempts CloudFront will make to your origin and the origin connection timeout for each attempt.
        
        See [Origin Connection Attempts](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts)
        
        See [Origin Connection Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout)
        
        Example usage:
        
        ```python
        # Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
        distribution = CloudFrontWebDistribution(self, "MyDistribution",
            origin_configs=[{...,
                "connection_attempts": 3,
                "connection_timeout": cdk.Duration.seconds(10)
            }
            ]
        )
        ```
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: JavaScript
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Typing :: Typed
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved
Requires-Python: >=3.6
Description-Content-Type: text/markdown
