chore(s3): add validation on required properties for lifecycle rules

[go-to-k]

Issue # (if applicable)

Closes #.

Reason for this change

If there is a lifecycle rule that does not contain one of the specified properties, an error is raised.

const app = new App();
const stack = new Stack(app, 'aws-cdk-s3');

// An error occurs
new Bucket(stack, 'MyBucket', {
  lifecycleRules: [
    // is invalid
    {
      objectSizeLessThan: 300000,
      objectSizeGreaterThan: 200000,
    },
  ],
});

const app = new App();
const stack = new Stack(app, 'aws-cdk-s3');

// An error occurs
new Bucket(stack, 'MyBucket', {
  lifecycleRules: [
    // is valid
    {
      abortIncompleteMultipartUploadAfter: Duration.days(365),
    },
    // is invalid
    {
      objectSizeLessThan: 300000,
      objectSizeGreaterThan: 200000,
    },
  ],
});

A CFn message:

Invalid request provided: At least one of [ExpirationDate,ExpirationInDays,AbortIncompleteMultipartUpload,Transition,Transitions,NoncurrentVersionExpirationInDays,NoncurrentVersionTransition,NoncurrentVersionTransitions,NoncurrentVersionExpiration,ExpiredObjectDeleteMarker] needs to be specified

The properties in CFn properties:

• AbortIncompleteMultipartUpload
• ExpirationDate
• ExpirationInDays
• ExpiredObjectDeleteMarker
• NoncurrentVersionExpirationInDays
• NoncurrentVersionTransition
• NoncurrentVersionTransitions
• NoncurrentVersionExpiration
• Transition
• Transitions

The properties in L2 props:

• abortIncompleteMultipartUploadAfter
• expiration
• expirationDate
• expiredObjectDeleteMarker
• noncurrentVersionExpiration
• noncurrentVersionsToRetain
• noncurrentVersionTransitions
• transitions

Description of changes

Check whether a rule has required properties in lifecycleRules for L2 BucketProps.

     if (
        rule.abortIncompleteMultipartUploadAfter === undefined &&
        rule.expiration === undefined &&
        rule.expirationDate === undefined &&
        rule.expiredObjectDeleteMarker === undefined &&
        rule.noncurrentVersionExpiration === undefined &&
        rule.noncurrentVersionsToRetain === undefined &&
        rule.noncurrentVersionTransitions === undefined &&
        rule.transitions === undefined
      ) {
        throw new Error('All rules for `lifecycleRules` must have at least one of the following properties: `abortIncompleteMultipartUploadAfter`, `expiration`, `expirationDate`, `expiredObjectDeleteMarker`, `noncurrentVersionExpiration`, `noncurrentVersionsToRetain`, `noncurrentVersionTransitions`, or `transitions`');
      }

Description of how you validated changes

Unit tests.

Checklist

• My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

---

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

[go-to-k]

An error occurs in synthesize phase because the rendering is done as Lazy:

https://github.com/aws/aws-cdk/blob/v2.162.1/packages/aws-cdk-lib/aws-s3/lib/bucket.ts#L1941

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: c420097
• Result: SUCCEEDED
• Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

[sumupitchayan]

Thanks for the PR @go-to-k and the unit testing - I'm now wondering how we missed this validation in the first place.

This is certainly a big if statement here, but I suppose it has to be for this validation. Trying to think of other ways to format this ...

const ruleProperties = [
  rule.abortIncompleteMultipartUploadAfter,
  rule.expiration,
  rule.expirationDate,
  rule.expiredObjectDeleteMarker,
  rule.noncurrentVersionExpiration,
  rule.noncurrentVersionsToRetain,
  rule.noncurrentVersionTransitions,
  rule.transitions,
];

if (ruleProperties.every(prop => prop === undefined)) {
  throw new Error('All rules for `lifecycleRules` must have at least one of the following properties: `abortIncompleteMultipartUploadAfter`, `expiration`, `expirationDate`, `expiredObjectDeleteMarker`, `noncurrentVersionExpiration`, `noncurrentVersionsToRetain`, `noncurrentVersionTransitions`, or `transitions`');
}

Approving this PR 👍

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

[github-actions]

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.