@Stability(value=Experimental) public static final class ProviderProps.Builder extends Object implements software.amazon.jsii.Builder<ProviderProps>
ProviderProps
Constructor and Description |
---|
Builder() |
@Stability(value=Experimental) public ProviderProps.Builder onEventHandler(IFunction onEventHandler)
ProviderProps.getOnEventHandler()
onEventHandler
- The AWS Lambda function to invoke for all resource lifecycle operations (CREATE/UPDATE/DELETE). This parameter is required.
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.this
@Stability(value=Experimental) public ProviderProps.Builder isCompleteHandler(IFunction isCompleteHandler)
ProviderProps.getIsCompleteHandler()
isCompleteHandler
- The AWS Lambda function to invoke in order to determine if the operation is complete.
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.this
@Stability(value=Experimental) public ProviderProps.Builder logRetention(RetentionDays logRetention)
ProviderProps.getLogRetention()
logRetention
- The number of days framework log events are kept in CloudWatch Logs.
When
updating this property, unsetting it doesn't remove the log retention policy.
To remove the retention policy, set the value to INFINITE
.this
@Stability(value=Experimental) public ProviderProps.Builder queryInterval(Duration queryInterval)
ProviderProps.getQueryInterval()
queryInterval
- Time between calls to the `isComplete` handler which determines if the resource has been stabilized.
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
.this
@Stability(value=Experimental) public ProviderProps.Builder role(IRole role)
ProviderProps.getRole()
role
- AWS Lambda execution role.
The role that will be assumed by the AWS Lambda.
Must be assumable by the 'lambda.amazonaws.com' service principal.this
@Stability(value=Experimental) public ProviderProps.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)
ProviderProps.getSecurityGroups()
securityGroups
- Security groups to attach to the provider functions.
Only used if 'vpc' is suppliedthis
@Stability(value=Experimental) public ProviderProps.Builder totalTimeout(Duration totalTimeout)
ProviderProps.getTotalTimeout()
totalTimeout
- Total timeout for the entire operation.
The maximum timeout is 2 hours (yes, it can exceed the AWS Lambda 15 minutes)this
@Stability(value=Experimental) public ProviderProps.Builder vpc(IVpc vpc)
ProviderProps.getVpc()
vpc
- The vpc to provision the lambda functions in.this
@Stability(value=Experimental) public ProviderProps.Builder vpcSubnets(SubnetSelection vpcSubnets)
ProviderProps.getVpcSubnets()
vpcSubnets
- Which subnets from the VPC to place the lambda functions in.
Only used if 'vpc' is supplied. Note: internet access for Lambdas
requires a NAT gateway, so picking Public subnets is not allowed.this
@Stability(value=Experimental) public ProviderProps build()
build
in interface software.amazon.jsii.Builder<ProviderProps>
ProviderProps
NullPointerException
- if any required attribute was not providedCopyright © 2021. All rights reserved.