@propulsionworks/cloudformation 0.0.1 → 0.1.0

package/out/exports/resources.generated/aws-cloudfront-cachepolicy.d.ts

@@ -0,0 +1,178 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type CloudFrontCachePolicy = ResourceDefinitionWithAttributes<"AWS::CloudFront::CachePolicy", CloudFrontCachePolicyProps, CloudFrontCachePolicyAttribs>;
+/**
+ * A cache policy.
+ *
+ * When it's attached to a cache behavior, the cache policy determines the following:
+ *
+ * - The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
+ * - The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
+ *
+ * The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a valid object in its cache that matches the request's cache key. If you want to send values to the origin but *not* include them in the cache key, use `OriginRequestPolicy` .
+ */
+export type CloudFrontCachePolicyProps = {
+    /**
+     * The cache policy configuration.
+     */
+    CachePolicyConfig: CachePolicyConfig;
+};
+export type CloudFrontCachePolicyAttribs = {
+    /**
+     * The unique identifier for the cache policy. For example: `2766f7b2-75c5-41c6-8f06-bf4303a2f2f5` .
+     */
+    Id: string;
+    /**
+     * The date and time when the cache policy was last modified.
+     */
+    LastModifiedTime: string;
+};
+/**
+ * A cache policy configuration.
+ *
+ * This configuration determines the following:
+ *
+ * - The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
+ * - The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
+ *
+ * The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find a valid object in its cache that matches the request's cache key. If you want to send values to the origin but *not* include them in the cache key, use `OriginRequestPolicy` .
+ */
+export type CachePolicyConfig = {
+    /**
+     * A comment to describe the cache policy. The comment cannot be longer than 128 characters.
+     */
+    Comment?: string | undefined;
+    /**
+     * The default amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value as the object's time to live (TTL) only when the origin does *not* send `Cache-Control` or `Expires` headers with the object. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide* .
+     *
+     * The default value for this field is 86400 seconds (one day). If the value of `MinTTL` is more than 86400 seconds, then the default value for this field is the same as the value of `MinTTL` .
+     * @min 0
+     */
+    DefaultTTL: number;
+    /**
+     * The maximum amount of time, in seconds, that objects stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. CloudFront uses this value only when the origin sends `Cache-Control` or `Expires` headers with the object. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide* .
+     *
+     * The default value for this field is 31536000 seconds (one year). If the value of `MinTTL` or `DefaultTTL` is more than 31536000 seconds, then the default value for this field is the same as the value of `DefaultTTL` .
+     * @min 0
+     */
+    MaxTTL: number;
+    /**
+     * The minimum amount of time, in seconds, that you want objects to stay in the CloudFront cache before CloudFront sends another request to the origin to see if the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide* .
+     * @min 0
+     */
+    MinTTL: number;
+    /**
+     * A unique name to identify the cache policy.
+     */
+    Name: string;
+    /**
+     * The HTTP headers, cookies, and URL query strings to include in the cache key. The values included in the cache key are also included in requests that CloudFront sends to the origin.
+     */
+    ParametersInCacheKeyAndForwardedToOrigin: ParametersInCacheKeyAndForwardedToOrigin;
+};
+/**
+ * An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin.
+ */
+export type CookiesConfig = {
+    /**
+     * Determines whether any cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:
+     *
+     * - `none` – No cookies in viewer requests are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to `none` , any cookies that are listed in an `OriginRequestPolicy` *are* included in origin requests.
+     * - `whitelist` – Only the cookies in viewer requests that are listed in the `CookieNames` type are included in the cache key and in requests that CloudFront sends to the origin.
+     * - `allExcept` – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, **except** for those that are listed in the `CookieNames` type, which are not included.
+     * - `all` – All cookies in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.
+     * @pattern ^(none|whitelist|allExcept|all)$
+     */
+    CookieBehavior: string;
+    /**
+     * Contains a list of cookie names.
+     */
+    Cookies?: string[] | undefined;
+};
+/**
+ * An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin.
+ */
+export type HeadersConfig = {
+    /**
+     * Determines whether any HTTP headers are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:
+     *
+     * - `none` – No HTTP headers are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to `none` , any headers that are listed in an `OriginRequestPolicy` *are* included in origin requests.
+     * - `whitelist` – Only the HTTP headers that are listed in the `Headers` type are included in the cache key and in requests that CloudFront sends to the origin.
+     * @pattern ^(none|whitelist)$
+     */
+    HeaderBehavior: string;
+    /**
+     * Contains a list of HTTP header names.
+     */
+    Headers?: string[] | undefined;
+};
+/**
+ * This object determines the values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
+ *
+ * The headers, cookies, and query strings that are included in the cache key are also included in requests that CloudFront sends to the origin. CloudFront sends a request when it can't find an object in its cache that matches the request's cache key. If you want to send values to the origin but *not* include them in the cache key, use `OriginRequestPolicy` .
+ */
+export type ParametersInCacheKeyAndForwardedToOrigin = {
+    /**
+     * An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin.
+     */
+    CookiesConfig: CookiesConfig;
+    /**
+     * A flag that can affect whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
+     *
+     * This field is related to the `EnableAcceptEncodingGzip` field. If one or both of these fields is `true` *and* the viewer request includes the `Accept-Encoding` header, then CloudFront does the following:
+     *
+     * - Normalizes the value of the viewer's `Accept-Encoding` header
+     * - Includes the normalized header in the cache key
+     * - Includes the normalized header in the request to the origin, if a request is necessary
+     *
+     * For more information, see [Compression support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) in the *Amazon CloudFront Developer Guide* .
+     *
+     * If you set this value to `true` , and this cache behavior also has an origin request policy attached, do not include the `Accept-Encoding` header in the origin request policy. CloudFront always includes the `Accept-Encoding` header in origin requests when the value of this field is `true` , so including this header in an origin request policy has no effect.
+     *
+     * If both of these fields are `false` , then CloudFront treats the `Accept-Encoding` header the same as any other HTTP header in the viewer request. By default, it's not included in the cache key and it's not included in origin requests. In this case, you can manually add `Accept-Encoding` to the headers whitelist like any other HTTP header.
+     */
+    EnableAcceptEncodingBrotli?: boolean | undefined;
+    /**
+     * A flag that can affect whether the `Accept-Encoding` HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.
+     *
+     * This field is related to the `EnableAcceptEncodingBrotli` field. If one or both of these fields is `true` *and* the viewer request includes the `Accept-Encoding` header, then CloudFront does the following:
+     *
+     * - Normalizes the value of the viewer's `Accept-Encoding` header
+     * - Includes the normalized header in the cache key
+     * - Includes the normalized header in the request to the origin, if a request is necessary
+     *
+     * For more information, see [Compression support](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) in the *Amazon CloudFront Developer Guide* .
+     *
+     * If you set this value to `true` , and this cache behavior also has an origin request policy attached, do not include the `Accept-Encoding` header in the origin request policy. CloudFront always includes the `Accept-Encoding` header in origin requests when the value of this field is `true` , so including this header in an origin request policy has no effect.
+     *
+     * If both of these fields are `false` , then CloudFront treats the `Accept-Encoding` header the same as any other HTTP header in the viewer request. By default, it's not included in the cache key and it's not included in origin requests. In this case, you can manually add `Accept-Encoding` to the headers whitelist like any other HTTP header.
+     */
+    EnableAcceptEncodingGzip: boolean;
+    /**
+     * An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin.
+     */
+    HeadersConfig: HeadersConfig;
+    /**
+     * An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and in requests that CloudFront sends to the origin.
+     */
+    QueryStringsConfig: QueryStringsConfig;
+};
+/**
+ * An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and in requests that CloudFront sends to the origin.
+ */
+export type QueryStringsConfig = {
+    /**
+     * Determines whether any URL query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin. Valid values are:
+     *
+     * - `none` – No query strings in viewer requests are included in the cache key or in requests that CloudFront sends to the origin. Even when this field is set to `none` , any query strings that are listed in an `OriginRequestPolicy` *are* included in origin requests.
+     * - `whitelist` – Only the query strings in viewer requests that are listed in the `QueryStringNames` type are included in the cache key and in requests that CloudFront sends to the origin.
+     * - `allExcept` – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin, **except** those that are listed in the `QueryStringNames` type, which are not included.
+     * - `all` – All query strings in viewer requests are included in the cache key and in requests that CloudFront sends to the origin.
+     * @pattern ^(none|whitelist|allExcept|all)$
+     */
+    QueryStringBehavior: string;
+    /**
+     * Contains a list of query string names.
+     */
+    QueryStrings?: string[] | undefined;
+};
+//# sourceMappingURL=aws-cloudfront-cachepolicy.d.ts.map

package/out/exports/resources.generated/aws-cloudfront-cloudfrontoriginaccessidentity.d.ts

@@ -0,0 +1,31 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type CloudFrontCloudFrontOriginAccessIdentity = ResourceDefinitionWithAttributes<"AWS::CloudFront::CloudFrontOriginAccessIdentity", CloudFrontCloudFrontOriginAccessIdentityProps, CloudFrontCloudFrontOriginAccessIdentityAttribs>;
+/**
+ * The request to create a new origin access identity (OAI). An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see [Restricting Access to Amazon S3 Content by Using an Origin Access Identity](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the *Amazon CloudFront Developer Guide* .
+ */
+export type CloudFrontCloudFrontOriginAccessIdentityProps = {
+    /**
+     * The current configuration information for the identity.
+     */
+    CloudFrontOriginAccessIdentityConfig: CloudFrontOriginAccessIdentityConfig;
+};
+export type CloudFrontCloudFrontOriginAccessIdentityAttribs = {
+    /**
+     * The ID for the origin access identity, for example, `E74FTE3AJFJ256A` .
+     */
+    Id: 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: string;
+};
+/**
+ * Origin access identity configuration. Send a `GET` request to the `/ *CloudFront API version* /CloudFront/identity ID/config` resource.
+ */
+export type CloudFrontOriginAccessIdentityConfig = {
+    /**
+     * A comment to describe the origin access identity. The comment cannot be longer than 128 characters.
+     */
+    Comment: string;
+};
+//# sourceMappingURL=aws-cloudfront-cloudfrontoriginaccessidentity.d.ts.map

package/out/exports/resources.generated/aws-cloudfront-connectiongroup.d.ts

@@ -0,0 +1,64 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type CloudFrontConnectionGroup = ResourceDefinitionWithAttributes<"AWS::CloudFront::ConnectionGroup", CloudFrontConnectionGroupProps, CloudFrontConnectionGroupAttribs>;
+/**
+ * The connection group for your distribution tenants. When you first create a distribution tenant and you don't specify a connection group, CloudFront will automatically create a default connection group for you. When you create a new distribution tenant and don't specify a connection group, the default one will be associated with your distribution tenant.
+ */
+export type CloudFrontConnectionGroupProps = {
+    /**
+     * The ID of the Anycast static IP list.
+     */
+    AnycastIpListId?: string | undefined;
+    /**
+     * Whether the connection group is enabled.
+     */
+    Enabled?: boolean | undefined;
+    /**
+     * IPv6 is enabled for the connection group.
+     */
+    Ipv6Enabled?: boolean | undefined;
+    /**
+     * The name of the connection group.
+     */
+    Name: string;
+    /**
+     * A complex type that contains zero or more `Tag` elements.
+     */
+    Tags?: Tag[] | undefined;
+};
+export type CloudFrontConnectionGroupAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the connection group.
+     */
+    Arn: string;
+    /**
+     * The date and time when the connection group was created.
+     * @format date-time
+     */
+    CreatedTime: string;
+    /**
+     * The current version of the connection group.
+     */
+    ETag: string;
+    /**
+     * The ID of the connection group.
+     */
+    Id: string;
+    /**
+     * Whether the connection group is the default connection group for the distribution tenants.
+     */
+    IsDefault: boolean;
+    /**
+     * The date and time when the connection group was updated.
+     * @format date-time
+     */
+    LastModifiedTime: string;
+    /**
+     * The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net.
+     */
+    RoutingEndpoint: string;
+    /**
+     * The status of the connection group.
+     */
+    Status: string;
+};
+//# sourceMappingURL=aws-cloudfront-connectiongroup.d.ts.map

package/out/exports/resources.generated/aws-cloudfront-continuousdeploymentpolicy.d.ts

@@ -0,0 +1,139 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type CloudFrontContinuousDeploymentPolicy = ResourceDefinitionWithAttributes<"AWS::CloudFront::ContinuousDeploymentPolicy", CloudFrontContinuousDeploymentPolicyProps, CloudFrontContinuousDeploymentPolicyAttribs>;
+/**
+ * Creates a continuous deployment policy that routes a subset of production traffic from a primary distribution to a staging distribution.
+ *
+ * After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This enables you to test changes to a distribution's configuration before moving all of your production traffic to the new configuration.
+ *
+ * For more information, see [Using CloudFront continuous deployment to safely test CDN configuration changes](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/continuous-deployment.html) in the *Amazon CloudFront Developer Guide* .
+ */
+export type CloudFrontContinuousDeploymentPolicyProps = {
+    /**
+     * Contains the configuration for a continuous deployment policy.
+     */
+    ContinuousDeploymentPolicyConfig: ContinuousDeploymentPolicyConfig;
+};
+export type CloudFrontContinuousDeploymentPolicyAttribs = {
+    /**
+     * The identifier of the cotinuous deployment policy.
+     */
+    Id: string;
+    /**
+     * The date and time when the continuous deployment policy was last modified.
+     */
+    LastModifiedTime: string;
+};
+/**
+ * Contains the configuration for a continuous deployment policy.
+ */
+export type ContinuousDeploymentPolicyConfig = {
+    /**
+     * A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is `true` , this policy is enabled and in effect. When this value is `false` , this policy is not enabled and has no effect.
+     */
+    Enabled: boolean;
+    /**
+     * This configuration determines which HTTP requests are sent to the staging distribution. If the HTTP request contains a header and value that matches what you specify here, the request is sent to the staging distribution. Otherwise the request is sent to the primary distribution.
+     */
+    SingleHeaderPolicyConfig?: {
+        /**
+         * @minLength 1
+         * @maxLength 256
+         */
+        Header: string;
+        /**
+         * @minLength 1
+         * @maxLength 1783
+         */
+        Value: string;
+    } | undefined;
+    /**
+     * This configuration determines the percentage of HTTP requests that are sent to the staging distribution.
+     */
+    SingleWeightPolicyConfig?: {
+        SessionStickinessConfig?: SessionStickinessConfig | undefined;
+        /**
+         * @min 0
+         * @max 1
+         */
+        Weight: number;
+    } | undefined;
+    /**
+     * The CloudFront domain name of the staging distribution. For example: `d111111abcdef8.cloudfront.net` .
+     */
+    StagingDistributionDnsNames: string[];
+    /**
+     * Contains the parameters for routing production traffic from your primary to staging distributions.
+     */
+    TrafficConfig?: TrafficConfig | undefined;
+    /**
+     * The type of traffic configuration.
+     */
+    Type?: "SingleWeight" | "SingleHeader" | undefined;
+};
+/**
+ * Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values.
+ */
+export type SessionStickinessConfig = {
+    /**
+     * The amount of time after which you want sessions to cease if no requests are received. Allowed values are 300–3600 seconds (5–60 minutes).
+     * @min 300
+     * @max 3600
+     */
+    IdleTTL: number;
+    /**
+     * The maximum amount of time to consider requests from the viewer as being part of the same session. Allowed values are 300–3600 seconds (5–60 minutes).
+     * @min 300
+     * @max 3600
+     */
+    MaximumTTL: number;
+};
+/**
+ * Determines which HTTP requests are sent to the staging distribution.
+ */
+export type SingleHeaderConfig = {
+    /**
+     * The request header name that you want CloudFront to send to your staging distribution. The header must contain the prefix `aws-cf-cd-` .
+     * @minLength 1
+     * @maxLength 256
+     */
+    Header: string;
+    /**
+     * The request header value.
+     * @minLength 1
+     * @maxLength 1783
+     */
+    Value: string;
+};
+/**
+ * This configuration determines the percentage of HTTP requests that are sent to the staging distribution.
+ */
+export type SingleWeightConfig = {
+    /**
+     * Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values.
+     */
+    SessionStickinessConfig?: SessionStickinessConfig | undefined;
+    /**
+     * The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution.
+     * @min 0
+     * @max 1
+     */
+    Weight: number;
+};
+/**
+ * The traffic configuration of your continuous deployment.
+ */
+export type TrafficConfig = {
+    /**
+     * Determines which HTTP requests are sent to the staging distribution.
+     */
+    SingleHeaderConfig?: SingleHeaderConfig | undefined;
+    /**
+     * Contains the percentage of traffic to send to the staging distribution.
+     */
+    SingleWeightConfig?: SingleWeightConfig | undefined;
+    /**
+     * The type of traffic configuration.
+     */
+    Type: "SingleWeight" | "SingleHeader";
+};
+//# sourceMappingURL=aws-cloudfront-continuousdeploymentpolicy.d.ts.map