AwsCustomResourceProps
- class aws_cdk.custom_resources.AwsCustomResourceProps(*, function_name=None, install_latest_aws_sdk=None, log_group=None, log_retention=None, memory_size=None, on_create=None, on_delete=None, on_update=None, policy=None, removal_policy=None, resource_type=None, role=None, service_timeout=None, timeout=None, vpc=None, vpc_subnets=None)
Bases:
object
Properties for AwsCustomResource.
Note that at least onCreate, onUpdate or onDelete must be specified.
- Parameters:
function_name (
Optional
[str
]) – A name for the singleton Lambda function implementing this custom resource. The function name will remain the same after the first AwsCustomResource is created in a stack. Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the function’s name. For more information, see Name Type.install_latest_aws_sdk (
Optional
[bool
]) – Whether to install the latest AWS SDK v2. If not specified, this uses whatever JavaScript SDK version is the default in AWS Lambda at the time of execution. Otherwise, installs the latest version from ‘npmjs.com’. The installation takes around 60 seconds and requires internet connectivity. The default can be controlled using the context key@aws-cdk/customresources:installLatestAwsSdkDefault
is. Default: - The value of@aws-cdk/customresources:installLatestAwsSdkDefault
, otherwisetrue
log_group (
Optional
[ILogGroup
]) – The Log Group used for logging of events emitted by the custom resource’s lambda function. Providing a user-controlled log group was rolled out to commercial regions on 2023-11-16. If you are deploying to another type of region, please check regional availability first. Default: - a default log group created by AWS Lambdalog_retention (
Optional
[RetentionDays
]) – The number of days log events of the singleton Lambda function implementing this custom resource are kept in CloudWatch Logs. This is a legacy API and we strongly recommend you migrate tologGroup
if you can.logGroup
allows you to create a fully customizable log group and instruct the Lambda function to send logs to it. Default: logs.RetentionDays.INFINITEmemory_size (
Union
[int
,float
,None
]) – The memory size for the singleton Lambda function implementing this custom resource. Default: 512 mega in case if installLatestAwsSdk is false.on_create (
Union
[AwsSdkCall
,Dict
[str
,Any
],None
]) – The AWS SDK call to make when the resource is created. Default: - the call when the resource is updatedon_delete (
Union
[AwsSdkCall
,Dict
[str
,Any
],None
]) – The AWS SDK call to make when the resource is deleted. Default: - no callon_update (
Union
[AwsSdkCall
,Dict
[str
,Any
],None
]) – The AWS SDK call to make when the resource is updated. Default: - no callpolicy (
Optional
[AwsCustomResourcePolicy
]) – The policy that will be added to the execution role of the Lambda function implementing this custom resource provider. The custom resource also implementsiam.IGrantable
, making it possible to use thegrantXxx()
methods. As this custom resource uses a singleton Lambda function, it’s important to note the that function’s role will eventually accumulate the permissions/grants from all resources. Note that a policy must be specified ifrole
is not provided, as by default a new role is created which requires policy changes to access resources. Default: - no policy addedremoval_policy (
Optional
[RemovalPolicy
]) – The policy to apply when this resource is removed from the application. Default: cdk.RemovalPolicy.Destroyresource_type (
Optional
[str
]) – Cloudformation Resource type. Default: - Custom::AWSrole (
Optional
[IRole
]) – The execution role for the singleton Lambda function implementing this custom resource provider. This role will apply to allAwsCustomResource
instances in the stack. The role must be assumable by thelambda.amazonaws.com
service principal. Default: - a new role is createdservice_timeout (
Optional
[Duration
]) – The maximum time that can elapse before a custom resource operation times out. You should not need to set this property. It is intended to allow quick turnaround even if the implementor of the custom resource forgets to include atry/catch
. We have included thetry/catch
, and AWS service calls usually do not take an hour to complete. The value must be between 1 second and 3600 seconds. Default: Duration.seconds(3600)timeout (
Optional
[Duration
]) – The timeout for the singleton Lambda function implementing this custom resource. Default: Duration.minutes(2)vpc (
Optional
[IVpc
]) – The vpc to provision the lambda function in. Default: - the function is not provisioned inside a vpc.vpc_subnets (
Union
[SubnetSelection
,Dict
[str
,Any
],None
]) – Which subnets from the VPC to place the lambda function in. Only used if ‘vpc’ is supplied. Note: internet access for Lambdas requires a NAT gateway, so picking Public subnets is not allowed. Default: - the Vpc default strategy if not specified
- ExampleMetadata:
infused
Example:
get_parameter = cr.AwsCustomResource(self, "GetParameter", on_update=cr.AwsSdkCall( # will also be called for a CREATE event service="SSM", action="GetParameter", parameters={ "Name": "my-parameter", "WithDecryption": True }, physical_resource_id=cr.PhysicalResourceId.of(Date.now().to_string())), policy=cr.AwsCustomResourcePolicy.from_sdk_calls( resources=cr.AwsCustomResourcePolicy.ANY_RESOURCE ) ) # Use the value in another construct with get_parameter.get_response_field("Parameter.Value")
Attributes
- function_name
A name for the singleton Lambda function implementing this custom resource.
The function name will remain the same after the first AwsCustomResource is created in a stack.
- Default:
AWS CloudFormation generates a unique physical ID and uses that
ID for the function’s name. For more information, see Name Type.
- install_latest_aws_sdk
Whether to install the latest AWS SDK v2.
If not specified, this uses whatever JavaScript SDK version is the default in AWS Lambda at the time of execution.
Otherwise, installs the latest version from ‘npmjs.com’. The installation takes around 60 seconds and requires internet connectivity.
The default can be controlled using the context key
@aws-cdk/customresources:installLatestAwsSdkDefault
is.- Default:
The value of
@aws-cdk/customresources:installLatestAwsSdkDefault
, otherwisetrue
- log_group
The Log Group used for logging of events emitted by the custom resource’s lambda function.
Providing a user-controlled log group was rolled out to commercial regions on 2023-11-16. If you are deploying to another type of region, please check regional availability first.
- Default:
a default log group created by AWS Lambda
- log_retention
The number of days log events of the singleton Lambda function implementing this custom resource are kept in CloudWatch Logs.
This is a legacy API and we strongly recommend you migrate to
logGroup
if you can.logGroup
allows you to create a fully customizable log group and instruct the Lambda function to send logs to it.- Default:
logs.RetentionDays.INFINITE
- memory_size
The memory size for the singleton Lambda function implementing this custom resource.
- Default:
512 mega in case if installLatestAwsSdk is false.
- on_create
The AWS SDK call to make when the resource is created.
- Default:
the call when the resource is updated
- on_delete
The AWS SDK call to make when the resource is deleted.
- Default:
no call
- on_update
The AWS SDK call to make when the resource is updated.
- Default:
no call
- policy
The policy that will be added to the execution role of the Lambda function implementing this custom resource provider.
The custom resource also implements
iam.IGrantable
, making it possible to use thegrantXxx()
methods.As this custom resource uses a singleton Lambda function, it’s important to note the that function’s role will eventually accumulate the permissions/grants from all resources.
Note that a policy must be specified if
role
is not provided, as by default a new role is created which requires policy changes to access resources.- Default:
no policy added
- See:
Policy.fromSdkCalls
- removal_policy
The policy to apply when this resource is removed from the application.
- Default:
cdk.RemovalPolicy.Destroy
- resource_type
Cloudformation Resource type.
- Default:
Custom::AWS
- role
The execution role for the singleton Lambda function implementing this custom resource provider.
This role will apply to all
AwsCustomResource
instances in the stack. The role must be assumable by thelambda.amazonaws.com
service principal.- Default:
a new role is created
- service_timeout
The maximum time that can elapse before a custom resource operation times out.
You should not need to set this property. It is intended to allow quick turnaround even if the implementor of the custom resource forgets to include a
try/catch
. We have included thetry/catch
, and AWS service calls usually do not take an hour to complete.The value must be between 1 second and 3600 seconds.
- Default:
Duration.seconds(3600)
- timeout
The timeout for the singleton Lambda function implementing this custom resource.
- Default:
Duration.minutes(2)
- vpc
The vpc to provision the lambda function in.
- Default:
the function is not provisioned inside a vpc.
- vpc_subnets
Which subnets from the VPC to place the lambda function in.
Only used if ‘vpc’ is supplied. Note: internet access for Lambdas requires a NAT gateway, so picking Public subnets is not allowed.
- Default:
the Vpc default strategy if not specified