ProviderProps Struct
Initialization properties for the Provider construct.
Example
// Create custom resource handler entrypoint
const handler = new lambda.Function(this , 'my-handler', {
runtime: lambda.Runtime.NODEJS_20_X,
handler: 'index.handler',
code: lambda.Code.fromInline(`
exports.handler = async (event, context) => {
return {
PhysicalResourceId: '1234',
NoEcho: true,
Data: {
mySecret: 'secret-value',
hello: 'world',
ghToken: 'gho_xxxxxxx',
},
};
};`),
});
// Provision a custom resource provider framework
const provider = new cr.Provider(this , 'my-provider', {
onEventHandler: handler,
});
new CustomResource(this , 'my-cr', {
serviceToken: provider.serviceToken,
});
Properties
disableWaiterStateMachineLoggingoptionalbooleandisable_waiter_state_machine_loggingoptionalbooldisableWaiterStateMachineLoggingoptionalBooleanDisableWaiterStateMachineLoggingoptionalboolDisableWaiterStateMachineLoggingoptional*bool= true#frameworkCompleteAndTimeoutRoleoptionalIRoleframework_complete_and_timeout_roleoptionalIRoleframeworkCompleteAndTimeoutRoleoptionalIRoleFrameworkCompleteAndTimeoutRoleoptionalIRoleFrameworkCompleteAndTimeoutRoleoptionalIRole#Default: A default role will be created.
notes
Note that this role must be assumed by the 'lambda.amazonaws.com' service principal. To prevent circular dependency problem in the provider framework, please ensure you specify a different IAM Role for 'frameworkCompleteAndTimeoutRole' from 'frameworkOnEventRole'.
This property cannot be used with 'role' property
frameworkLambdaLoggingLeveloptionalApplicationLogLevelframework_lambda_logging_leveloptionalApplicationLogLevelframeworkLambdaLoggingLeveloptionalApplicationLogLevelFrameworkLambdaLoggingLeveloptionalApplicationLogLevelFrameworkLambdaLoggingLeveloptionalApplicationLogLevel#Default: true - Logging is disabled by default
frameworkOnEventRoleoptionalIRoleframework_on_event_roleoptionalIRoleframeworkOnEventRoleoptionalIRoleFrameworkOnEventRoleoptionalIRoleFrameworkOnEventRoleoptionalIRole#Default: A default role will be created.
Note that this role must be assumed by the 'lambda.amazonaws.com' service principal.
This property cannot be used with 'role' property
isCompleteHandleroptionalIFunctionis_complete_handleroptionalIFunctionisCompleteHandleroptionalIFunctionIsCompleteHandleroptionalIFunctionIsCompleteHandleroptionalIFunction#Default: provider is synchronous. This means that the onEvent handler is expected to finish all lifecycle operations within the initial invocation.
notes
This function will be called immediately after onEvent and then periodically based on the configured query interval as long as it returns false. If the function still returns false and the alloted timeout has passed, the operation will fail.
logGroupoptionalILogGroupReflog_groupoptionalILogGroupReflogGroupoptionalILogGroupRefLogGroupoptionalILogGroupRefLogGroupoptionalILogGroupRef#Default: a default log group created by AWS Lambda
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.
logRetentionoptionalRetentionDayslog_retentionoptionalRetentionDayslogRetentionoptionalRetentionDaysLogRetentionoptionalRetentionDaysLogRetentionoptionalRetentionDays= logs.RetentionDays.INFINITE#notes
When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to INFINITE.
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.
onEventHandlerIFunctionon_event_handlerIFunctiononEventHandlerIFunctionOnEventHandlerIFunctionOnEventHandlerIFunctionrequired#notes
This function is responsible to begin the requested resource operation (CREATE/UPDATE/DELETE) and return any additional properties to add to the event, which will later be passed to isComplete. The PhysicalResourceId property must be included in the response.
providerFunctionEnvEncryptionoptionalIKeyRefprovider_function_env_encryptionoptionalIKeyRefproviderFunctionEnvEncryptionoptionalIKeyRefProviderFunctionEnvEncryptionoptionalIKeyRefProviderFunctionEnvEncryptionoptionalIKeyRef#Default: AWS Lambda creates and uses an AWS managed customer master key (CMK)
providerFunctionNameoptionalstringprovider_function_nameoptionalstrproviderFunctionNameoptionalStringProviderFunctionNameoptionalstringProviderFunctionNameoptional*string#Default: CloudFormation default name from unique physical ID
The provider lambda function name.
queryIntervaloptionalDurationquery_intervaloptionalDurationqueryIntervaloptionalDurationQueryIntervaloptionalDurationQueryIntervaloptionalDuration= Duration.seconds(5)#The first isComplete will be called immediately after handler and then every queryInterval seconds, and until timeout has been reached or until isComplete returns true.
Default: A default role will be created.
The role is shared by provider framework's onEvent, isComplete lambda, and onTimeout Lambda functions. This role will be assumed by the AWS Lambda, so it must be assumable by the 'lambda.amazonaws.com' service principal.
securityGroupsoptionalISecurityGroup[]security_groupsoptionaltyping.List[ISecurityGroup]securityGroupsoptionalList<ISecurityGroup>SecurityGroupsoptionalISecurityGroup[]SecurityGroupsoptional*[]ISecurityGroup#Default: If vpc is not supplied, no security groups are attached. Otherwise, a dedicated security group is created for each function.
Only used if 'vpc' is supplied
totalTimeoutoptionalDurationtotal_timeoutoptionalDurationtotalTimeoutoptionalDurationTotalTimeoutoptionalDurationTotalTimeoutoptionalDuration= Duration.minutes(30)#The maximum timeout is 1 hour (yes, it can exceed the AWS Lambda 15 minutes)
Default: functions are not provisioned inside a vpc.
vpcSubnetsoptionalSubnetSelectionvpc_subnetsoptionalSubnetSelectionvpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelection#Default: the Vpc default strategy if not specified
Only used if 'vpc' is supplied. Note: internet access for Lambdas requires a NAT gateway, so picking Public subnets is not allowed.
waiterStateMachineLogOptionsoptionalLogOptionswaiter_state_machine_log_optionsoptionalLogOptionswaiterStateMachineLogOptionsoptionalLogOptionsWaiterStateMachineLogOptionsoptionalLogOptionsWaiterStateMachineLogOptionsoptionalLogOptions#Default: A default log group will be created if logging for the waiter state machine is enabled.