@Generated(value="jsii-pacmak/1.30.0 (build adae23f)", date="2021-06-30T10:01:44.019Z") @Stability(value=Experimental) public interface ProviderProps extends software.amazon.jsii.JsiiSerializable
| Modifier and Type | Interface and Description |
|---|---|
static class |
ProviderProps.Builder
A builder for
ProviderProps |
static class |
ProviderProps.Jsii$Proxy
An implementation for
ProviderProps |
| Modifier and Type | Method and Description |
|---|---|
static ProviderProps.Builder |
builder() |
default IFunction |
getIsCompleteHandler()
(experimental) The AWS Lambda function to invoke in order to determine if the operation is complete.
|
default RetentionDays |
getLogRetention()
(experimental) The number of days framework log events are kept in CloudWatch Logs.
|
IFunction |
getOnEventHandler()
(experimental) The AWS Lambda function to invoke for all resource lifecycle operations (CREATE/UPDATE/DELETE).
|
default Duration |
getQueryInterval()
(experimental) Time between calls to the `isComplete` handler which determines if the resource has been stabilized.
|
default IRole |
getRole()
(experimental) AWS Lambda execution role.
|
default List<ISecurityGroup> |
getSecurityGroups()
(experimental) Security groups to attach to the provider functions.
|
default Duration |
getTotalTimeout()
(experimental) Total timeout for the entire operation.
|
default IVpc |
getVpc()
(experimental) The vpc to provision the lambda functions in.
|
default SubnetSelection |
getVpcSubnets()
(experimental) Which subnets from the VPC to place the lambda functions in.
|
@Stability(value=Experimental) @NotNull IFunction getOnEventHandler()
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.
@Stability(value=Experimental) @Nullable default IFunction getIsCompleteHandler()
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.
Default: - provider is synchronous. This means that the `onEvent` handler is expected to finish all lifecycle operations within the initial invocation.
@Stability(value=Experimental) @Nullable default RetentionDays getLogRetention()
When
updating this property, unsetting it doesn't remove the log retention policy.
To remove the retention policy, set the value to INFINITE.
Default: logs.RetentionDays.INFINITE
@Stability(value=Experimental) @Nullable default Duration getQueryInterval()
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: Duration.seconds(5)
@Stability(value=Experimental) @Nullable default IRole getRole()
The role that will be assumed by the AWS Lambda. Must be assumable by the 'lambda.amazonaws.com' service principal.
Default: - A default role will be created.
@Stability(value=Experimental) @Nullable default List<ISecurityGroup> getSecurityGroups()
Only used if 'vpc' is supplied
Default: - If `vpc` is not supplied, no security groups are attached. Otherwise, a dedicated security group is created for each function.
@Stability(value=Experimental) @Nullable default Duration getTotalTimeout()
The maximum timeout is 2 hours (yes, it can exceed the AWS Lambda 15 minutes)
Default: Duration.minutes(30)
@Stability(value=Experimental) @Nullable default IVpc getVpc()
Default: - functions are not provisioned inside a vpc.
@Stability(value=Experimental) @Nullable default SubnetSelection getVpcSubnets()
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
@Stability(value=Experimental) static ProviderProps.Builder builder()
ProviderProps.Builder of ProviderPropsCopyright © 2021. All rights reserved.