feat(ses): add configurationSetArn property on configurationSet resource

[fredericbarthelet]

Issue

Closes #29902

Reason for this change

Adds configurationSetArn property on ConfigurationSet construct to ease up building Policy referencing such construct

Description of changes

Similar implementation to recently added emailIdentityArn property on EmailIdentity construct. The implementation leverages the use of stack.formatArn to build AWS::SES::ConfigurationSet arn

Description of how you validated changes

Did not add any test as this would basically mean testing formatArn function itself.

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

[aws-cdk-automation]

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

[fredericbarthelet]

Exemption Request

• Change to a README file: only the auto-generated doc for ConfigurationSet construct is affected by this PR
• Change to a test file: testing this would feel like testing formatArn method

[nmussy]

While I agree with your exemption request about the README and integ file changes, I think we need to cover the new property with a unit test

[nmussy]

I think a getter method would be cleaner here, and would avoid having to duplicate this code in the Import class:

public get configurationSetArn(): string {
  return this.stack.formatArn({
    service: 'ses',
    resource: 'configuration-set',
    resourceName: this.configurationSetName,
  });
}

[fredericbarthelet]

@nmussy thanks for your comment. Not sure about your proposal, do you want me to implement a base class ConfigurationSetBase that both Import and ConfigurationSet will extend in order for them to both have this method? Found references to this pattern in https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md#abstract-base
I'll implement something based on that. Let me know if you had something else in mind :)

I was originally inspired by EmailIdentity construct from aws-ses which has this duplicated code.

aws-cdk/packages/aws-cdk-lib/aws-ses/lib/email-identity.ts

Lines 392 to 396 in 31492c6

	public readonly emailIdentityArn = this.stack.formatArn({
	service: 'ses',
	resource: 'identity',
	resourceName: this.emailIdentityName,
	});

aws-cdk/packages/aws-cdk-lib/aws-ses/lib/email-identity.ts

Lines 500 to 504 in 31492c6

	this.emailIdentityArn = this.stack.formatArn({
	service: 'ses',
	resource: 'identity',
	resourceName: this.emailIdentityName,
	});

[fredericbarthelet]

@nmussy thanks for your review.

I deduplicated the code and added unit tests.
Let me know if I should add any additional changes.

Thanks :) !

[nmussy]

LGTM, just unsure about the @attribute tag 👍

[nmussy]

The @attribute might not be appropriate since it's derived from the resource ref, a maintainer should weigh in on this

[fredericbarthelet]

In case it helps, the exemple construct from the coding guideline uses @attribute for the ARN property even if it is computed manually (like in this case) :

• exempleResourceArn is tagged with @attribute

aws-cdk/packages/@aws-cdk/example-construct-library/lib/example-resource.ts

Lines 70 to 83 in 6fdc458

	/**
	* The ARN of example resource.
	* Equivalent to doing `{ 'Fn::GetAtt': ['LogicalId', 'Arn' ]}`
	* in CloudFormation if the underlying CloudFormation resource
	* surfaces the ARN as a return value -
	* if not, we usually construct the ARN "by hand" in the construct,
	* using the Fn::Join function.
	*
	* It needs to be annotated with '@attribute' if the underlying CloudFormation resource
	* surfaces the ARN as a return value.
	*
	* @attribute
	*/
	readonly exampleResourceArn: string;

• exempleResourceArn is constructed manually in from static methods and constructor
  

  aws-cdk/packages/@aws-cdk/example-construct-library/lib/example-resource.ts

  Lines 362 to 368 in 6fdc458

  	public readonly exampleResourceName = exampleResourceName;
  	// Since we have the name, we have to generate the ARN,
  	// using the Stack.formatArn helper method from the core library.
  	// We have to know the ARN components of ExampleResource in a few places, so,
  	// to avoid duplication, extract that into a module-private function
  	public readonly exampleResourceArn = core.Stack.of(scope)
  	.formatArn(exampleResourceArnComponents(exampleResourceName));

The only doubt I have is regarding this precision : It needs to be annotated with '@attribute' if the underlying CloudFormation resource surfaces the ARN as a return value.
CloudFormation does not surface AWS::SES::ConfigurationSet ARN.

[fredericbarthelet]

Any chance a maintainer can review and weigh in on the decision to keep or remove the @attribute annotation on configurationSetArn :)? @nmussy should I ping anybody in particular on this PR? Thanks

[nmussy]

They'll address it when they review the PR 👍

[aws-cdk-automation]

This PR has been in the CHANGES REQUESTED state for 3 weeks, and looks abandoned. To keep this PR from being closed, please continue work on it. If not, it will automatically be closed in a week.

[fredericbarthelet]

@nmussy any chance this PR can be reviewed before end of the week? It will apparently automatically be closed otherwise (see #29903 (comment)).
Thanks in advance for your help on that matter :)

[nmussy]

You need to file an exemption request comment to address the issues, see this comment. And I can't speak to review delays, I'm not a part of the CDK team, just a community member 👍

[aws-cdk-automation]

AWS CodeBuild CI Report

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

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

[aws-cdk-automation]

This PR has been deemed to be abandoned, and will be automatically closed. Please create a new PR for these changes if you think this decision has been made in error.

[aws-cdk-automation]

The pull request linter fails with the following errors:

❌ Features must contain a change to a README file.
❌ Features must contain a change to an integration test file and the resulting snapshot.

PRs must pass status checks before we can provide a meaningful review.

If you would like to request an exemption from the status checks or clarification on feedback, please leave a comment on this PR containing Exemption Request and/or Clarification Request.

✅ A exemption request has been requested. Please wait for a maintainer's review.