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.

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

Jump to bottom

docs(custom-resource): add example for AwsApiCall #26621

Merged
merged 10 commits into from
Aug 10, 2023
Merged

docs(custom-resource): add example for AwsApiCall #26621

Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
0436331
docs(custom-resource): add example for AwsApiCall in v2 and v3
ymhiroki Aug 3, 2023
8b55145
rm trailing space
ymhiroki Aug 3, 2023
59549c3
Merge branch 'main' into doc-custom-resource
ymhiroki Aug 4, 2023
01e014d
update comment
ymhiroki Aug 8, 2023
5b4c4eb
Merge branch 'doc-custom-resource' of github.com:ymhiroki/aws-cdk int…
ymhiroki Aug 8, 2023
22236f8
Merge branch 'main' into doc-custom-resource
ymhiroki Aug 8, 2023
aef579a
update example
ymhiroki Aug 8, 2023
eadd768
Merge branch 'doc-custom-resource' of github.com:ymhiroki/aws-cdk int…
ymhiroki Aug 8, 2023
489e46d
Merge branch 'main' into doc-custom-resource
ymhiroki Aug 8, 2023
e89c2c3
Merge branch 'main' into doc-custom-resource
mergify[bot] Aug 10, 2023
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
35 changes: 35 additions & 0 deletions packages/aws-cdk-lib/custom-resources/lib/aws-custom-resource/aws-custom-resource.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,41 @@ export class PhysicalResourceId {

/**
* An AWS SDK call.
*
* @example
*
* // In AWS SDK for JavaScript v2
* new cr.AwsCustomResource(this, 'GetParameterV2', {
* onUpdate: { // will also be called for a CREATE event
* service: 'SSM',
* action: 'getParameter',
* parameters: {
* Name: 'my-parameter',
* WithDecryption: true,
* },
* physicalResourceId: cr.PhysicalResourceId.fromResponse('Parameter.ARN'),
* },
* policy: cr.AwsCustomResourcePolicy.fromSdkCalls({
* resources: cr.AwsCustomResourcePolicy.ANY_RESOURCE,
* }),
* });
*
* // In AWS SDK for JavaScript v3
* new cr.AwsCustomResource(this, 'GetParameterV3', {
* onUpdate: {
* service: '@aws-sdk/client-ssm', // 'SSM' in v2
* action: 'GetParameterCommand', // 'getParameter' in v2
* parameters: {
* Name: 'my-parameter',
* WithDecryption: true,
* },
* physicalResourceId: cr.PhysicalResourceId.fromResponse('Parameter.ARN'),
* },
* policy: cr.AwsCustomResourcePolicy.fromSdkCalls({
* resources: cr.AwsCustomResourcePolicy.ANY_RESOURCE,
* }),
* });
*
*/
export interface AwsSdkCall {
/**
Expand Down
Loading