@propulsionworks/cloudformation 0.0.2 → 0.1.1

package/out/exports/resources.generated/aws-s3-bucketpolicy.d.ts

@@ -0,0 +1,57 @@
+import type { ResourceDefinition, TemplatePolicyDocument } from "../main.ts";
+/**
+ * Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the `PutBucketPolicy` permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.
+ *
+ * If you don't have `PutBucketPolicy` permissions, Amazon S3 returns a `403 Access Denied` error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a `405 Method Not Allowed` error.
+ *
+ * > As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.
+ *
+ * When using the `AWS::S3::BucketPolicy` resource, you can create, update, and delete bucket policies for S3 buckets located in regions different from the stack's region. This cross-region bucket policy modification functionality is supported for backward compatibility with existing workflows.
+ *
+ * > If the [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) is not specified or set to `Delete` , the bucket policy will be removed when the stack is deleted. If set to `Retain` , the bucket policy will be preserved even after the stack is deleted.
+ *
+ * For example, a CloudFormation stack in `us-east-1` can use the `AWS::S3::BucketPolicy` resource to manage the bucket policy for an S3 bucket in `us-west-2` . The retention or removal of the bucket policy during the stack deletion is determined by the `DeletionPolicy` attribute specified in the stack template.
+ *
+ * For more information, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) .
+ *
+ * The following operations are related to `PutBucketPolicy` :
+ *
+ * - [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
+ * - [DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucketpolicy.html}
+ */
+export type S3BucketPolicy = ResourceDefinition<"AWS::S3::BucketPolicy", S3BucketPolicyProps>;
+/**
+ * Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the `PutBucketPolicy` permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.
+ *
+ * If you don't have `PutBucketPolicy` permissions, Amazon S3 returns a `403 Access Denied` error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a `405 Method Not Allowed` error.
+ *
+ * > As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.
+ *
+ * When using the `AWS::S3::BucketPolicy` resource, you can create, update, and delete bucket policies for S3 buckets located in regions different from the stack's region. This cross-region bucket policy modification functionality is supported for backward compatibility with existing workflows.
+ *
+ * > If the [DeletionPolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) is not specified or set to `Delete` , the bucket policy will be removed when the stack is deleted. If set to `Retain` , the bucket policy will be preserved even after the stack is deleted.
+ *
+ * For example, a CloudFormation stack in `us-east-1` can use the `AWS::S3::BucketPolicy` resource to manage the bucket policy for an S3 bucket in `us-west-2` . The retention or removal of the bucket policy during the stack deletion is determined by the `DeletionPolicy` attribute specified in the stack template.
+ *
+ * For more information, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) .
+ *
+ * The following operations are related to `PutBucketPolicy` :
+ *
+ * - [CreateBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
+ * - [DeleteBucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucketpolicy.html}
+ */
+export type S3BucketPolicyProps = {
+    /**
+     * The name of the Amazon S3 bucket to which the policy applies.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucketpolicy.html#cfn-s3-bucketpolicy-bucket}
+     */
+    Bucket: string;
+    /**
+     * A policy document containing permissions to add to the specified bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM. For more information, see the AWS::IAM::Policy [PolicyDocument](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-policydocument) resource description in this guide and [Access Policy Language Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-policy-language-overview.html) in the *Amazon S3 User Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucketpolicy.html#cfn-s3-bucketpolicy-policydocument}
+     */
+    PolicyDocument: TemplatePolicyDocument;
+};
+//# sourceMappingURL=aws-s3-bucketpolicy.d.ts.map

package/out/exports/resources.generated/aws-s3-multiregionaccesspoint.d.ts

@@ -0,0 +1,106 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * The `AWS::S3::MultiRegionAccessPoint` resource creates an Amazon S3 Multi-Region Access Point. To learn more about Multi-Region Access Points, see [Multi-Region Access Points in Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPoints.html) in the in the *Amazon S3 User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspoint.html}
+ */
+export type S3MultiRegionAccessPoint = ResourceDefinitionWithAttributes<"AWS::S3::MultiRegionAccessPoint", S3MultiRegionAccessPointProps, S3MultiRegionAccessPointAttribs>;
+/**
+ * The `AWS::S3::MultiRegionAccessPoint` resource creates an Amazon S3 Multi-Region Access Point. To learn more about Multi-Region Access Points, see [Multi-Region Access Points in Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/MultiRegionAccessPoints.html) in the in the *Amazon S3 User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspoint.html}
+ */
+export type S3MultiRegionAccessPointProps = {
+    /**
+     * The name of the Multi-Region Access Point.
+     * @minLength 3
+     * @maxLength 50
+     * @pattern ^[a-z0-9][-a-z0-9]{1,48}[a-z0-9]$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspoint.html#cfn-s3-multiregionaccesspoint-name}
+     */
+    Name?: string | undefined;
+    /**
+     * The PublicAccessBlock configuration that you want to apply to this Multi-Region Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers an object public, see [The Meaning of "Public"](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) in the *Amazon S3 User Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspoint.html#cfn-s3-multiregionaccesspoint-publicaccessblockconfiguration}
+     */
+    PublicAccessBlockConfiguration?: PublicAccessBlockConfiguration | undefined;
+    /**
+     * A collection of the Regions and buckets associated with the Multi-Region Access Point.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspoint.html#cfn-s3-multiregionaccesspoint-regions}
+     */
+    Regions: Region[];
+};
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspoint.html#aws-resource-s3-multiregionaccesspoint-return-values}
+ */
+export type S3MultiRegionAccessPointAttribs = {
+    /**
+     * The alias for the Multi-Region Access Point. For more information about the distinction between the name and the alias of an Multi-Region Access Point, see [Managing Multi-Region Access Points](https://docs.aws.amazon.com/AmazonS3/latest/userguide/CreatingMultiRegionAccessPoints.html#multi-region-access-point-naming) in the *Amazon S3 User Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspoint.html#cfn-s3-multiregionaccesspoint-alias}
+     */
+    Alias: string;
+    /**
+     * The timestamp of when the Multi-Region Access Point is created.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspoint.html#cfn-s3-multiregionaccesspoint-createdat}
+     */
+    CreatedAt: string;
+};
+/**
+ * The PublicAccessBlock configuration that you want to apply to this Amazon S3 Multi-Region Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers an object public, see [The Meaning of "Public"](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) in the *Amazon S3 User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-multiregionaccesspoint-publicaccessblockconfiguration.html}
+ */
+export type PublicAccessBlockConfiguration = {
+    /**
+     * Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to `TRUE` causes the following behavior:
+     *
+     * - PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL is public.
+     * - PUT Object calls fail if the request includes a public ACL.
+     * - PUT Bucket calls fail if the request includes a public ACL.
+     *
+     * Enabling this setting doesn't affect existing policies or ACLs.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-multiregionaccesspoint-publicaccessblockconfiguration.html#cfn-s3-multiregionaccesspoint-publicaccessblockconfiguration-blockpublicacls}
+     */
+    BlockPublicAcls?: boolean | undefined;
+    /**
+     * Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to `TRUE` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.
+     *
+     * Enabling this setting doesn't affect existing bucket policies.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-multiregionaccesspoint-publicaccessblockconfiguration.html#cfn-s3-multiregionaccesspoint-publicaccessblockconfiguration-blockpublicpolicy}
+     */
+    BlockPublicPolicy?: boolean | undefined;
+    /**
+     * Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to `TRUE` causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket.
+     *
+     * Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-multiregionaccesspoint-publicaccessblockconfiguration.html#cfn-s3-multiregionaccesspoint-publicaccessblockconfiguration-ignorepublicacls}
+     */
+    IgnorePublicAcls?: boolean | undefined;
+    /**
+     * Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to `TRUE` restricts access to this bucket to only AWS service principals and authorized users within this account if the bucket has a public policy.
+     *
+     * Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-multiregionaccesspoint-publicaccessblockconfiguration.html#cfn-s3-multiregionaccesspoint-publicaccessblockconfiguration-restrictpublicbuckets}
+     */
+    RestrictPublicBuckets?: boolean | undefined;
+};
+/**
+ * A bucket associated with a specific Region when creating Multi-Region Access Points.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-multiregionaccesspoint-region.html}
+ */
+export type Region = {
+    /**
+     * The name of the associated bucket for the Region.
+     * @minLength 3
+     * @maxLength 63
+     * @pattern ^[a-z0-9][a-z0-9//.//-]*[a-z0-9]$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-multiregionaccesspoint-region.html#cfn-s3-multiregionaccesspoint-region-bucket}
+     */
+    Bucket: string;
+    /**
+     * The AWS account ID that owns the Amazon S3 bucket that's associated with this Multi-Region Access Point.
+     * @minLength 12
+     * @maxLength 12
+     * @pattern ^[0-9]{12}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-multiregionaccesspoint-region.html#cfn-s3-multiregionaccesspoint-region-bucketaccountid}
+     */
+    BucketAccountId?: string | undefined;
+};
+//# sourceMappingURL=aws-s3-multiregionaccesspoint.d.ts.map

package/out/exports/resources.generated/aws-s3-multiregionaccesspointpolicy.d.ts

@@ -0,0 +1,39 @@
+import type { ResourceDefinitionWithAttributes, TemplatePolicyDocument } from "../main.ts";
+/**
+ * Applies an Amazon S3 access policy to an Amazon S3 Multi-Region Access Point.
+ *
+ * It is not possible to delete an access policy for a Multi-Region Access Point from the CloudFormation template. When you attempt to delete the policy, CloudFormation updates the policy using `DeletionPolicy:Retain` and `UpdateReplacePolicy:Retain` . CloudFormation updates the policy to only allow access to the account that created the bucket.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspointpolicy.html}
+ */
+export type S3MultiRegionAccessPointPolicy = ResourceDefinitionWithAttributes<"AWS::S3::MultiRegionAccessPointPolicy", S3MultiRegionAccessPointPolicyProps, S3MultiRegionAccessPointPolicyAttribs>;
+/**
+ * Applies an Amazon S3 access policy to an Amazon S3 Multi-Region Access Point.
+ *
+ * It is not possible to delete an access policy for a Multi-Region Access Point from the CloudFormation template. When you attempt to delete the policy, CloudFormation updates the policy using `DeletionPolicy:Retain` and `UpdateReplacePolicy:Retain` . CloudFormation updates the policy to only allow access to the account that created the bucket.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspointpolicy.html}
+ */
+export type S3MultiRegionAccessPointPolicyProps = {
+    /**
+     * The name of the Multi-Region Access Point.
+     * @minLength 3
+     * @maxLength 50
+     * @pattern ^[a-z0-9][-a-z0-9]{1,48}[a-z0-9]$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspointpolicy.html#cfn-s3-multiregionaccesspointpolicy-mrapname}
+     */
+    MrapName: string;
+    /**
+     * The access policy associated with the Multi-Region Access Point.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspointpolicy.html#cfn-s3-multiregionaccesspointpolicy-policy}
+     */
+    Policy: TemplatePolicyDocument;
+};
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-multiregionaccesspointpolicy.html#aws-resource-s3-multiregionaccesspointpolicy-return-values}
+ */
+export type S3MultiRegionAccessPointPolicyAttribs = {
+    /**
+     * Specifies whether the policy is public or not.
+     */
+    "PolicyStatus.IsPublic": "true" | "false";
+};
+//# sourceMappingURL=aws-s3-multiregionaccesspointpolicy.d.ts.map

package/out/exports/resources.generated/aws-s3-storagelens.d.ts

@@ -0,0 +1,383 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * The AWS::S3::StorageLens resource creates an Amazon S3 Storage Lens configuration.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-storagelens.html}
+ */
+export type S3StorageLens = ResourceDefinitionWithAttributes<"AWS::S3::StorageLens", S3StorageLensProps, S3StorageLensAttribs>;
+/**
+ * The AWS::S3::StorageLens resource creates an Amazon S3 Storage Lens configuration.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-storagelens.html}
+ */
+export type S3StorageLensProps = {
+    /**
+     * This resource contains the details Amazon S3 Storage Lens configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-storagelens.html#cfn-s3-storagelens-storagelensconfiguration}
+     */
+    StorageLensConfiguration: StorageLensConfiguration;
+    /**
+     * A set of tags (key–value pairs) to associate with the Storage Lens configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-storagelens.html#cfn-s3-storagelens-tags}
+     */
+    Tags?: Tag[] | undefined;
+};
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-storagelens.html#aws-resource-s3-storagelens-return-values}
+ */
+export type S3StorageLensAttribs = {
+    /**
+     * This property contains the details of the ARN of the S3 Storage Lens configuration. This property is read-only.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-storagelensarn}
+     */
+    "StorageLensConfiguration.StorageLensArn": string;
+};
+/**
+ * This resource contains the details of the account-level metrics for Amazon S3 Storage Lens.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html}
+ */
+export type AccountLevel = {
+    /**
+     * This property contains the details of account-level activity metrics for S3 Storage Lens.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html#cfn-s3-storagelens-accountlevel-activitymetrics}
+     */
+    ActivityMetrics?: ActivityMetrics | undefined;
+    /**
+     * This property contains the details of account-level advanced cost optimization metrics for S3 Storage Lens.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html#cfn-s3-storagelens-accountlevel-advancedcostoptimizationmetrics}
+     */
+    AdvancedCostOptimizationMetrics?: AdvancedCostOptimizationMetrics | undefined;
+    /**
+     * This property contains the details of account-level advanced data protection metrics for S3 Storage Lens.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html#cfn-s3-storagelens-accountlevel-advanceddataprotectionmetrics}
+     */
+    AdvancedDataProtectionMetrics?: AdvancedDataProtectionMetrics | undefined;
+    /**
+     * This property contains the details of the account-level bucket-level configurations for Amazon S3 Storage Lens. To enable bucket-level configurations, make sure to also set the same metrics at the account level.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html#cfn-s3-storagelens-accountlevel-bucketlevel}
+     */
+    BucketLevel: BucketLevel;
+    /**
+     * This property contains the details of account-level detailed status code metrics for S3 Storage Lens.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html#cfn-s3-storagelens-accountlevel-detailedstatuscodesmetrics}
+     */
+    DetailedStatusCodesMetrics?: DetailedStatusCodesMetrics | undefined;
+    /**
+     * This property determines the scope of Storage Lens group data that is displayed in the Storage Lens dashboard.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html#cfn-s3-storagelens-accountlevel-storagelensgrouplevel}
+     */
+    StorageLensGroupLevel?: StorageLensGroupLevel | undefined;
+};
+/**
+ * This resource enables Amazon S3 Storage Lens activity metrics. Activity metrics show details about how your storage is requested, such as requests (for example, All requests, Get requests, Put requests), bytes uploaded or downloaded, and errors.
+ *
+ * For more information, see [Assessing your storage activity and usage with S3 Storage Lens](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the *Amazon S3 User Guide* . For a complete list of metrics, see [S3 Storage Lens metrics glossary](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) in the *Amazon S3 User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-activitymetrics.html}
+ */
+export type ActivityMetrics = {
+    /**
+     * A property that indicates whether the activity metrics is enabled.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-activitymetrics.html#cfn-s3-storagelens-activitymetrics-isenabled}
+     */
+    IsEnabled?: boolean | undefined;
+};
+/**
+ * This resource enables Amazon S3 Storage Lens advanced cost optimization metrics. Advanced cost optimization metrics provide insights that you can use to manage and optimize your storage costs, for example, lifecycle rule counts for transitions, expirations, and incomplete multipart uploads.
+ *
+ * For more information, see [Assessing your storage activity and usage with S3 Storage Lens](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the *Amazon S3 User Guide* . For a complete list of metrics, see [S3 Storage Lens metrics glossary](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) in the *Amazon S3 User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advancedcostoptimizationmetrics.html}
+ */
+export type AdvancedCostOptimizationMetrics = {
+    /**
+     * Indicates whether advanced cost optimization metrics are enabled.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advancedcostoptimizationmetrics.html#cfn-s3-storagelens-advancedcostoptimizationmetrics-isenabled}
+     */
+    IsEnabled?: boolean | undefined;
+};
+/**
+ * This resource enables Amazon S3 Storage Lens advanced data protection metrics. Advanced data protection metrics provide insights that you can use to perform audits and protect your data, for example replication rule counts within and across Regions.
+ *
+ * For more information, see [Assessing your storage activity and usage with S3 Storage Lens](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the *Amazon S3 User Guide* . For a complete list of metrics, see [S3 Storage Lens metrics glossary](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) in the *Amazon S3 User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advanceddataprotectionmetrics.html}
+ */
+export type AdvancedDataProtectionMetrics = {
+    /**
+     * Indicates whether advanced data protection metrics are enabled.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advanceddataprotectionmetrics.html#cfn-s3-storagelens-advanceddataprotectionmetrics-isenabled}
+     */
+    IsEnabled?: boolean | undefined;
+};
+/**
+ * This resource contains the details of the AWS Organization for Amazon S3 Storage Lens.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-awsorg.html}
+ */
+export type AwsOrg = {
+    /**
+     * This resource contains the ARN of the AWS Organization.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-awsorg.html#cfn-s3-storagelens-awsorg-arn}
+     */
+    Arn: string;
+};
+/**
+ * A property for the bucket-level storage metrics for Amazon S3 Storage Lens.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.html}
+ */
+export type BucketLevel = {
+    /**
+     * A property for bucket-level activity metrics for S3 Storage Lens.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.html#cfn-s3-storagelens-bucketlevel-activitymetrics}
+     */
+    ActivityMetrics?: ActivityMetrics | undefined;
+    /**
+     * A property for bucket-level advanced cost optimization metrics for S3 Storage Lens.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.html#cfn-s3-storagelens-bucketlevel-advancedcostoptimizationmetrics}
+     */
+    AdvancedCostOptimizationMetrics?: AdvancedCostOptimizationMetrics | undefined;
+    /**
+     * A property for bucket-level advanced data protection metrics for S3 Storage Lens.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.html#cfn-s3-storagelens-bucketlevel-advanceddataprotectionmetrics}
+     */
+    AdvancedDataProtectionMetrics?: AdvancedDataProtectionMetrics | undefined;
+    /**
+     * A property for bucket-level detailed status code metrics for S3 Storage Lens.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.html#cfn-s3-storagelens-bucketlevel-detailedstatuscodesmetrics}
+     */
+    DetailedStatusCodesMetrics?: DetailedStatusCodesMetrics | undefined;
+    /**
+     * A property for bucket-level prefix-level storage metrics for S3 Storage Lens.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.html#cfn-s3-storagelens-bucketlevel-prefixlevel}
+     */
+    PrefixLevel?: PrefixLevel | undefined;
+};
+/**
+ * This resource contains the details of the buckets and Regions for the Amazon S3 Storage Lens configuration.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketsandregions.html}
+ */
+export type BucketsAndRegions = {
+    /**
+     * This property contains the details of the buckets for the Amazon S3 Storage Lens configuration. This should be the bucket Amazon Resource Name(ARN). For valid values, see [Buckets ARN format here](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_Include.html#API_control_Include_Contents) in the *Amazon S3 API Reference* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketsandregions.html#cfn-s3-storagelens-bucketsandregions-buckets}
+     */
+    Buckets?: string[] | undefined;
+    /**
+     * This property contains the details of the Regions for the S3 Storage Lens configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketsandregions.html#cfn-s3-storagelens-bucketsandregions-regions}
+     */
+    Regions?: string[] | undefined;
+};
+/**
+ * This resource enables the Amazon CloudWatch publishing option for Amazon S3 Storage Lens metrics.
+ *
+ * For more information, see [Monitor S3 Storage Lens metrics in CloudWatch](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_view_metrics_cloudwatch.html) in the *Amazon S3 User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-cloudwatchmetrics.html}
+ */
+export type CloudWatchMetrics = {
+    /**
+     * This property identifies whether the CloudWatch publishing option for S3 Storage Lens is enabled.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-cloudwatchmetrics.html#cfn-s3-storagelens-cloudwatchmetrics-isenabled}
+     */
+    IsEnabled: boolean;
+};
+/**
+ * This resource contains the details of the Amazon S3 Storage Lens metrics export.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-dataexport.html}
+ */
+export type DataExport = {
+    /**
+     * This property enables the Amazon CloudWatch publishing option for S3 Storage Lens metrics.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-dataexport.html#cfn-s3-storagelens-dataexport-cloudwatchmetrics}
+     */
+    CloudWatchMetrics?: CloudWatchMetrics | undefined;
+    /**
+     * This property contains the details of the bucket where the S3 Storage Lens metrics export will be placed.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-dataexport.html#cfn-s3-storagelens-dataexport-s3bucketdestination}
+     */
+    S3BucketDestination?: S3BucketDestination | undefined;
+};
+/**
+ * This resource enables Amazon S3 Storage Lens detailed status code metrics. Detailed status code metrics generate metrics for HTTP status codes, such as `200 OK` , `403 Forbidden` , `503 Service Unavailable` and others.
+ *
+ * For more information, see [Assessing your storage activity and usage with S3 Storage Lens](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens.html) in the *Amazon S3 User Guide* . For a complete list of metrics, see [S3 Storage Lens metrics glossary](https://docs.aws.amazon.com/AmazonS3/latest/userguide/storage_lens_metrics_glossary.html) in the *Amazon S3 User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-detailedstatuscodesmetrics.html}
+ */
+export type DetailedStatusCodesMetrics = {
+    /**
+     * Indicates whether detailed status code metrics are enabled.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-detailedstatuscodesmetrics.html#cfn-s3-storagelens-detailedstatuscodesmetrics-isenabled}
+     */
+    IsEnabled?: boolean | undefined;
+};
+/**
+ * This resource contains the type of server-side encryption used to encrypt an Amazon S3 Storage Lens metrics export. For valid values, see the [StorageLensDataExportEncryption](https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_StorageLensDataExportEncryption.html) in the *Amazon S3 API Reference* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-encryption.html}
+ */
+export type Encryption = {
+    /**
+     * S3 default server-side encryption.
+     */
+    SSES3: Record<string, unknown>;
+} | {
+    SSEKMS: SSEKMS;
+};
+/**
+ * This resource contains the details of the prefix-level of the Amazon S3 Storage Lens.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevel.html}
+ */
+export type PrefixLevel = {
+    /**
+     * A property for the prefix-level storage metrics for Amazon S3 Storage Lens.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevel.html#cfn-s3-storagelens-prefixlevel-storagemetrics}
+     */
+    StorageMetrics: PrefixLevelStorageMetrics;
+};
+/**
+ * This resource contains the details of the prefix-level storage metrics for Amazon S3 Storage Lens.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevelstoragemetrics.html}
+ */
+export type PrefixLevelStorageMetrics = {
+    /**
+     * This property identifies whether the details of the prefix-level storage metrics for S3 Storage Lens are enabled.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevelstoragemetrics.html#cfn-s3-storagelens-prefixlevelstoragemetrics-isenabled}
+     */
+    IsEnabled?: boolean | undefined;
+    /**
+     * This property identifies whether the details of the prefix-level storage metrics for S3 Storage Lens are enabled.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevelstoragemetrics.html#cfn-s3-storagelens-prefixlevelstoragemetrics-selectioncriteria}
+     */
+    SelectionCriteria?: SelectionCriteria | undefined;
+};
+/**
+ * This resource contains the details of the bucket where the Amazon S3 Storage Lens metrics export will be placed.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html}
+ */
+export type S3BucketDestination = {
+    /**
+     * This property contains the details of the AWS account ID of the S3 Storage Lens export bucket destination.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-accountid}
+     */
+    AccountId: string;
+    /**
+     * This property contains the details of the ARN of the bucket destination of the S3 Storage Lens export.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-arn}
+     */
+    Arn: string;
+    /**
+     * This property contains the details of the encryption of the bucket destination of the Amazon S3 Storage Lens metrics export.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-encryption}
+     */
+    Encryption?: Encryption | undefined;
+    /**
+     * This property contains the details of the format of the S3 Storage Lens export bucket destination.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-format}
+     */
+    Format: "CSV" | "Parquet";
+    /**
+     * This property contains the details of the output schema version of the S3 Storage Lens export bucket destination.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-outputschemaversion}
+     */
+    OutputSchemaVersion: "V_1";
+    /**
+     * This property contains the details of the prefix of the bucket destination of the S3 Storage Lens export .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-prefix}
+     */
+    Prefix?: string | undefined;
+};
+/**
+ * Specifies the use of server-side encryption using an AWS Key Management Service key (SSE-KMS) to encrypt the delivered S3 Storage Lens metrics export file.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-ssekms.html}
+ */
+export type SSEKMS = {
+    /**
+     * Specifies the Amazon Resource Name (ARN) of the customer managed AWS KMS key to use for encrypting the S3 Storage Lens metrics export file. Amazon S3 only supports symmetric encryption keys. For more information, see [Special-purpose keys](https://docs.aws.amazon.com/kms/latest/developerguide/key-types.html) in the *AWS Key Management Service Developer Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-ssekms.html#cfn-s3-storagelens-ssekms-keyid}
+     */
+    KeyId: string;
+};
+/**
+ * This resource contains the details of the Amazon S3 Storage Lens selection criteria.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-selectioncriteria.html}
+ */
+export type SelectionCriteria = {
+    /**
+     * This property contains the details of the S3 Storage Lens delimiter being used.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-selectioncriteria.html#cfn-s3-storagelens-selectioncriteria-delimiter}
+     */
+    Delimiter?: string | undefined;
+    /**
+     * This property contains the details of the max depth that S3 Storage Lens will collect metrics up to.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-selectioncriteria.html#cfn-s3-storagelens-selectioncriteria-maxdepth}
+     */
+    MaxDepth?: number | undefined;
+    /**
+     * This property contains the details of the minimum storage bytes percentage threshold that S3 Storage Lens will collect metrics up to.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-selectioncriteria.html#cfn-s3-storagelens-selectioncriteria-minstoragebytespercentage}
+     */
+    MinStorageBytesPercentage?: number | undefined;
+};
+/**
+ * This is the property of the Amazon S3 Storage Lens configuration.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html}
+ */
+export type StorageLensConfiguration = {
+    /**
+     * This property contains the details of the account-level metrics for Amazon S3 Storage Lens configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-accountlevel}
+     */
+    AccountLevel: AccountLevel;
+    /**
+     * This property contains the details of the AWS Organization for the S3 Storage Lens configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-awsorg}
+     */
+    AwsOrg?: AwsOrg | undefined;
+    /**
+     * This property contains the details of this S3 Storage Lens configuration's metrics export.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-dataexport}
+     */
+    DataExport?: DataExport | undefined;
+    /**
+     * This property contains the details of the bucket and or Regions excluded for Amazon S3 Storage Lens configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-exclude}
+     */
+    Exclude?: BucketsAndRegions | undefined;
+    /**
+     * This property contains the details of the ID of the S3 Storage Lens configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-id}
+     */
+    Id: string;
+    /**
+     * This property contains the details of the bucket and or Regions included for Amazon S3 Storage Lens configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-include}
+     */
+    Include?: BucketsAndRegions | undefined;
+    /**
+     * This property contains the details of whether the Amazon S3 Storage Lens configuration is enabled.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.html#cfn-s3-storagelens-storagelensconfiguration-isenabled}
+     */
+    IsEnabled: boolean;
+};
+/**
+ * This resource determines the scope of Storage Lens group data that is displayed in the Storage Lens dashboard.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensgrouplevel.html}
+ */
+export type StorageLensGroupLevel = {
+    /**
+     * This property indicates which Storage Lens group ARNs to include or exclude in the Storage Lens group aggregation. If this value is left null, then all Storage Lens groups are selected.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensgrouplevel.html#cfn-s3-storagelens-storagelensgrouplevel-storagelensgroupselectioncriteria}
+     */
+    StorageLensGroupSelectionCriteria?: StorageLensGroupSelectionCriteria | undefined;
+};
+/**
+ * This resource indicates which Storage Lens group ARNs to include or exclude in the Storage Lens group aggregation. You can only attach Storage Lens groups to your dashboard if they're included in your Storage Lens group aggregation. If this value is left null, then all Storage Lens groups are selected.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensgroupselectioncriteria.html}
+ */
+export type StorageLensGroupSelectionCriteria = {
+    /**
+     * This property indicates which Storage Lens group ARNs to exclude from the Storage Lens group aggregation.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensgroupselectioncriteria.html#cfn-s3-storagelens-storagelensgroupselectioncriteria-exclude}
+     */
+    Exclude?: string[] | undefined;
+    /**
+     * This property indicates which Storage Lens group ARNs to include in the Storage Lens group aggregation.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensgroupselectioncriteria.html#cfn-s3-storagelens-storagelensgroupselectioncriteria-include}
+     */
+    Include?: string[] | undefined;
+};
+//# sourceMappingURL=aws-s3-storagelens.d.ts.map