Skip to content

docs(s3,kms): replace object-literal IResourceWithPolicyV2 example with named class #38461

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.

Sign up for GitHub

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

Open
AmariahAK wants to merge 1 commit into
base: main
Choose a base branch
from
+42 −20
Open

docs(s3,kms): replace object-literal IResourceWithPolicyV2 example with named class #38461

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 21 additions & 10 deletions packages/aws-cdk-lib/aws-kms/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,20 +293,31 @@ for the `AWS::KMS::Key` CloudFormation type:

```ts nofixture
import { CfnResource } from 'aws-cdk-lib';
import { IResourcePolicyFactory, IResourceWithPolicyV2, PolicyStatement, ResourceWithPolicies } from 'aws-cdk-lib/aws-iam';
import { Construct, IConstruct } from 'constructs';
import { AddToResourcePolicyResult, IResourcePolicyFactory, IResourceWithPolicyV2, PolicyStatement, ResourceWithPolicies } from 'aws-cdk-lib/aws-iam';
import { ResourceEnvironment } from 'aws-cdk-lib/interfaces';
import { Construct } from 'constructs';


declare const scope: Construct;

class MyResourceWithPolicy implements IResourceWithPolicyV2 {
public readonly env: ResourceEnvironment;
private readonly resource: CfnResource;

constructor(resource: CfnResource) {
this.resource = resource;
this.env = resource.env;
}

public addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult {
// custom implementation to add the statement to the resource policy
return { statementAdded: true, policyDependable: this.resource };
}
}

class MyFactory implements IResourcePolicyFactory {
forResource(resource: CfnResource): IResourceWithPolicyV2 {
return {
env: resource.env,
addToResourcePolicy(statement: PolicyStatement) {
// custom implementation to add the statement to the resource policy
return { statementAdded: true, policyDependable: resource };
}
}
public forResource(resource: CfnResource): IResourceWithPolicyV2 {
return new MyResourceWithPolicy(resource);
}
}

Expand Down
31 changes: 21 additions & 10 deletions packages/aws-cdk-lib/aws-s3/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,19 +194,30 @@ for the `AWS::S3::Bucket` CloudFormation type:

```ts nofixture
import { CfnResource } from 'aws-cdk-lib';
import { IResourcePolicyFactory, IResourceWithPolicyV2, PolicyStatement, ResourceWithPolicies } from 'aws-cdk-lib/aws-iam';
import { Construct, IConstruct } from 'constructs';
import { AddToResourcePolicyResult, IResourcePolicyFactory, IResourceWithPolicyV2, PolicyStatement, ResourceWithPolicies } from 'aws-cdk-lib/aws-iam';
import { ResourceEnvironment } from 'aws-cdk-lib/interfaces';
import { Construct } from 'constructs';

declare const scope: Construct;

class MyResourceWithPolicy implements IResourceWithPolicyV2 {
public readonly env: ResourceEnvironment;
private readonly resource: CfnResource;

constructor(resource: CfnResource) {
this.resource = resource;
this.env = resource.env;
}

public addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResult {
// custom implementation to add the statement to the resource policy
return { statementAdded: true, policyDependable: this.resource };
}
}

class MyFactory implements IResourcePolicyFactory {
forResource(resource: CfnResource): IResourceWithPolicyV2 {
return {
env: resource.env,
addToResourcePolicy(statement: PolicyStatement) {
// custom implementation to add the statement to the resource policy
return { statementAdded: true, policyDependable: resource };
}
}
public forResource(resource: CfnResource): IResourceWithPolicyV2 {
return new MyResourceWithPolicy(resource);
}
}

Expand Down
Loading