Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(efs): allow AccessPoint to set client token #31184

Merged
merged 5 commits into from
Oct 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -458,6 +458,7 @@
"Value": "test-efs-integ/FileSystem/AccessPoint"
}
],
"ClientToken": "client-token",
"FileSystemId": {
"Ref": "FileSystem8A8E25C0"
},
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ fileSystem.addAccessPoint('AccessPoint', {
gid: '1000',
uid: '1000',
},
clientToken: 'client-token',
});

new integ.IntegTest(app, 'test-efs-integ-test', {
Expand Down
5 changes: 4 additions & 1 deletion packages/aws-cdk-lib/aws-efs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,10 @@ the access point can only access data in its own directory and below. To learn m
Use the `addAccessPoint` API to create an access point from a fileSystem.

```ts fixture=with-filesystem-instance
fileSystem.addAccessPoint('AccessPoint');
fileSystem.addAccessPoint('MyAccessPoint', {
// create a unique access point via an optional client token
clientToken: 'client-token',
});
```

By default, when you create an access point, the root(`/`) directory is exposed to the client
Expand Down
17 changes: 16 additions & 1 deletion packages/aws-cdk-lib/aws-efs/lib/access-point.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { Construct } from 'constructs';
import { IFileSystem } from './efs-file-system';
import { CfnAccessPoint } from './efs.generated';
import { ArnFormat, IResource, Resource, Stack, Tags } from '../../core';
import { ArnFormat, IResource, Resource, Stack, Tags, Token } from '../../core';

/**
* Represents an EFS AccessPoint
Expand Down Expand Up @@ -102,6 +102,15 @@ export interface AccessPointOptions {
* @default - user identity not enforced
*/
readonly posixUser?: PosixUser;

/**
* The opaque string specified in the request to ensure idempotent creation.
*
* @see https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-accesspoint.html#cfn-efs-accesspoint-clienttoken
*
* @default - No client token
*/
readonly clientToken?: string;
}

/**
Expand Down Expand Up @@ -201,6 +210,11 @@ export class AccessPoint extends AccessPointBase {
constructor(scope: Construct, id: string, props: AccessPointProps) {
super(scope, id);

const clientToken = props.clientToken;
if ((clientToken?.length === 0 || (clientToken && clientToken.length > 64)) && !Token.isUnresolved(clientToken)) {
perrylson marked this conversation as resolved.
Show resolved Hide resolved
throw new Error(`The length of \'clientToken\' must range from 1 to 64 characters, got: ${clientToken.length} characters`);
}

const resource = new CfnAccessPoint(this, 'Resource', {
fileSystemId: props.fileSystem.fileSystemId,
rootDirectory: {
Expand All @@ -216,6 +230,7 @@ export class AccessPoint extends AccessPointBase {
gid: props.posixUser.gid,
secondaryGids: props.posixUser.secondaryGids,
} : undefined,
clientToken,
});

Tags.of(this).add('Name', this.node.path);
Expand Down
29 changes: 29 additions & 0 deletions packages/aws-cdk-lib/aws-efs/test/access-point.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,35 @@ test('support tags for AccessPoint', () => {
});
});

test('allow client token to be set for AccessPoint', () => {
// WHEN
new AccessPoint(stack, 'MyAccessPoint', {
fileSystem,
clientToken: 'client-token',
});

// THEN
Template.fromStack(stack).hasResourceProperties('AWS::EFS::AccessPoint', {
ClientToken: 'client-token',
});
});

test('throw when client token has a length that is less than 1', () => {
expect(() => new AccessPoint(stack, 'MyAccessPoint', {
fileSystem,
clientToken: '',
},
)).toThrow(/The length of \'clientToken\' must range from 1 to 64 characters, got: 0 characters/);
});

test('throw when client token has a length that is greater than 64', () => {
expect(() => new AccessPoint(stack, 'MyAccessPoint', {
fileSystem,
clientToken: 'a'.repeat(65),
},
)).toThrow(/The length of \'clientToken\' must range from 1 to 64 characters, got: 65 characters/);
});

test('import an AccessPoint using fromAccessPointId', () => {
// WHEN
const ap = new AccessPoint(stack, 'MyAccessPoint', {
Expand Down