Constructs for implementing CDK custom resources
Project description
CDK Custom Resources
---This is a developer preview (public beta) module. Releases might lack important features and might have future breaking changes.
This API is still under active development and subject to non-backward compatible changes or removal in any future version. Use of the API is not recommended in production environments. Experimental APIs are not subject to the Semantic Versioning model.
This module is part of the AWS Cloud Development Kit project.
AWS Custom Resource
Sometimes a single API call can fill the gap in the CloudFormation coverage. In
this case you can use the AwsCustomResource
construct. This construct creates
a custom resource that can be customized to make specific API calls for the
CREATE
, UPDATE
and DELETE
events. Additionally, data returned by the API
call can be extracted and used in other constructs/resources (creating a real
CloudFormation dependency using Fn::GetAtt
under the hood).
The physical id of the custom resource can be specified or derived from the data returned by the API call.
The AwsCustomResource
uses the AWS SDK for JavaScript. Services, actions and
parameters can be found in the API documentation.
Path to data must be specified using a dot notation, e.g. to get the string value
of the Title
attribute for the first item returned by dynamodb.query
it should
be Items.0.Title.S
.
Examples
Verify a domain with SES:
# Example may have issues. See https://github.com/aws/jsii/issues/826
verify_domain_identity = AwsCustomResource(self, "VerifyDomainIdentity",
on_create={
"service": "SES",
"action": "verifyDomainIdentity",
"parameters": {
"Domain": "example.com"
},
"physical_resource_id_path": "VerificationToken"
}
)
route53.TxtRecord(zone, "SESVerificationRecord",
record_name="_amazonses.example.com",
record_value=verify_domain_identity.get_data("VerificationToken")
)
Get the latest version of a secure SSM parameter:
# Example may have issues. See https://github.com/aws/jsii/issues/826
get_parameter = AwsCustomResource(self, "GetParameter",
on_update={# will also be called for a CREATE event
"service": "SSM",
"action": "getParameter",
"parameters": {
"Name": "my-parameter",
"WithDecryption": True
},
"physical_resource_id": Date.now().to_string()}
)
# Use the value in another construct with
get_parameter.get_data("Parameter.Value")
IAM policy statements required to make the API calls are derived from the calls
and allow by default the actions to be made on all resources (*
). You can
restrict the permissions by specifying your own list of statements with the
policyStatements
prop.
Chained API calls can be achieved by creating dependencies:
# Example may have issues. See https://github.com/aws/jsii/issues/826
aws_custom1 = AwsCustomResource(self, "API1",
on_create={
"service": "...",
"action": "...",
"physical_resource_id": "..."
}
)
aws_custom2 = AwsCustomResource(self, "API2",
on_create={
"service": "...",
"action": "...",
"parameters": {
"text": aws_custom1.get_data("Items.0.text")
},
"physical_resource_id": "..."
}
)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aws-cdk.custom-resources-1.13.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 71ea17e2bf1df7cccdfb90b35d0ec4cc5950cca60d63e8b292ef4c68c34f5a43 |
|
MD5 | 1208dae6ff5e74b22dc099ecb7b0b0d5 |
|
BLAKE2b-256 | 78411ab7418d7a34641b7d24667a429d5ab7a7142a87d5f4071456cb53575a59 |
Hashes for aws_cdk.custom_resources-1.13.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0fa7c9a73c9c1301c6743aed585347253401e8b46537e41a53fac59451c3d172 |
|
MD5 | fb84b8ad14a2d33dac898a2ac1b2647c |
|
BLAKE2b-256 | 0c53e137ec671b3fde1aecc422ddd318219e77b3a8a6c1298cd92f1ac76cfd8d |