You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(custom-resources): remove section about experimental SDKv3 support (#26631)
`AwsCustomResource` now uses Node18/SDKv3 by default. This support is no longer experimental, and it does not require passing in different string values into the properties of the custom resource.
The V2 strings can be used to interact with the V3 SDK.
----
*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Copy file name to clipboardExpand all lines: packages/aws-cdk-lib/custom-resources/README.md
+1-33
Original file line number
Diff line number
Diff line change
@@ -431,7 +431,7 @@ Path to data must be specified using a dot notation, e.g. to get the string valu
431
431
of the `Title` attribute for the first item returned by `dynamodb.query` it should
432
432
be `Items.0.Title.S`.
433
433
434
-
To make sure that the newest API calls are available the latest AWS SDK v2 is installed
434
+
To make sure that the newest API calls are available the latest AWS SDK v3 is installed
435
435
in the Lambda function implementing the custom resource. The installation takes around 60
436
436
seconds. If you prefer to optimize for speed, you can disable the installation by setting
437
437
the `installLatestAwsSdk` prop to `false`.
@@ -648,35 +648,3 @@ const getParameter = new cr.AwsCustomResource(this, 'AssociateVPCWithHostedZone'
648
648
}),
649
649
});
650
650
```
651
-
652
-
#### Using AWS SDK for JavaScript v3
653
-
654
-
`AwsCustomResource` experimentally supports AWS SDK for JavaScript v3 (NODEJS_18_X or higher). In AWS SDK for JavaScript v3, packages are installed for each service. Therefore, specify the package name for `service`. Also, `action` specifies the XxxClient operations provided in the package. This example is the same as `SSM.getParameter` in v2.
655
-
656
-
```ts
657
-
import*asregionInfofrom'aws-cdk-lib/region-info';
658
-
659
-
classMyFactimplementsregionInfo.IFact {
660
-
publicreadonly region ='us-east-1';
661
-
publicreadonly name =regionInfo.FactName.DEFAULT_CR_NODE_VERSION;
662
-
publicreadonly value =lambda.Runtime.NODEJS_18_X.name;
663
-
}
664
-
665
-
// change custom resource default runtime
666
-
regionInfo.Fact.register(newMyFact(), true);
667
-
668
-
newcr.AwsCustomResource(this, 'GetParameter', {
669
-
resourceType: 'Custom::SSMParameter',
670
-
onUpdate: {
671
-
service: '@aws-sdk/client-ssm', // 'SSM' in v2
672
-
action: 'GetParameterCommand', // 'getParameter' in v2
0 commit comments