Class ProviderProps.Jsii$Proxy
- All Implemented Interfaces:
ProviderProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
ProviderProps
ProviderProps
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.customresources.ProviderProps
ProviderProps.Builder, ProviderProps.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Jsii$Proxy
(ProviderProps.Builder builder) Constructor that initializes the object based on literal property values passed by theProviderProps.Builder
.protected
Jsii$Proxy
(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final Boolean
Whether logging for the waiter state machine is disabled.final IFunction
The AWS Lambda function to invoke in order to determine if the operation is complete.final ILogGroup
The Log Group used for logging of events emitted by the custom resource's lambda function.final RetentionDays
The number of days framework log events are kept in CloudWatch Logs.final IFunction
The AWS Lambda function to invoke for all resource lifecycle operations (CREATE/UPDATE/DELETE).final IKey
AWS KMS key used to encrypt provider lambda's environment variables.final String
Provider Lambda name.final Duration
Time between calls to theisComplete
handler which determines if the resource has been stabilized.final IRole
getRole()
AWS Lambda execution role.final List<ISecurityGroup>
Security groups to attach to the provider functions.final Duration
Total timeout for the entire operation.final IVpc
getVpc()
The vpc to provision the lambda functions in.final SubnetSelection
Which subnets from the VPC to place the lambda functions in.final LogOptions
Defines what execution history events of the waiter state machine are logged and where they are logged.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef
- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theProviderProps.Builder
.
-
-
Method Details
-
getOnEventHandler
Description copied from interface:ProviderProps
The AWS Lambda function to invoke for all resource lifecycle operations (CREATE/UPDATE/DELETE).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
. ThePhysicalResourceId
property must be included in the response.- Specified by:
getOnEventHandler
in interfaceProviderProps
-
getDisableWaiterStateMachineLogging
Description copied from interface:ProviderProps
Whether logging for the waiter state machine is disabled.Default: - false
- Specified by:
getDisableWaiterStateMachineLogging
in interfaceProviderProps
-
getIsCompleteHandler
Description copied from interface:ProviderProps
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 returnsfalse
. If the function still returnsfalse
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.
- Specified by:
getIsCompleteHandler
in interfaceProviderProps
-
getLogGroup
Description copied from interface:ProviderProps
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
- Specified by:
getLogGroup
in interfaceProviderProps
-
getLogRetention
Description copied from interface:ProviderProps
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 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
- Specified by:
getLogRetention
in interfaceProviderProps
-
getProviderFunctionEnvEncryption
Description copied from interface:ProviderProps
AWS KMS key used to encrypt provider lambda's environment variables.Default: - AWS Lambda creates and uses an AWS managed customer master key (CMK)
- Specified by:
getProviderFunctionEnvEncryption
in interfaceProviderProps
-
getProviderFunctionName
Description copied from interface:ProviderProps
Provider Lambda name.The provider lambda function name.
Default: - CloudFormation default name from unique physical ID
- Specified by:
getProviderFunctionName
in interfaceProviderProps
-
getQueryInterval
Description copied from interface:ProviderProps
Time between calls to theisComplete
handler which determines if the resource has been stabilized.The first
isComplete
will be called immediately afterhandler
and then everyqueryInterval
seconds, and untiltimeout
has been reached or untilisComplete
returnstrue
.Default: Duration.seconds(5)
- Specified by:
getQueryInterval
in interfaceProviderProps
-
getRole
Description copied from interface:ProviderProps
AWS Lambda execution role.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.
- Specified by:
getRole
in interfaceProviderProps
-
getSecurityGroups
Description copied from interface:ProviderProps
Security groups to attach to the provider functions.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.
- Specified by:
getSecurityGroups
in interfaceProviderProps
-
getTotalTimeout
Description copied from interface:ProviderProps
Total timeout for the entire operation.The maximum timeout is 1 hour (yes, it can exceed the AWS Lambda 15 minutes)
Default: Duration.minutes(30)
- Specified by:
getTotalTimeout
in interfaceProviderProps
-
getVpc
Description copied from interface:ProviderProps
The vpc to provision the lambda functions in.Default: - functions are not provisioned inside a vpc.
- Specified by:
getVpc
in interfaceProviderProps
-
getVpcSubnets
Description copied from interface:ProviderProps
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.
Default: - the Vpc default strategy if not specified
- Specified by:
getVpcSubnets
in interfaceProviderProps
-
getWaiterStateMachineLogOptions
Description copied from interface:ProviderProps
Defines what execution history events of the waiter state machine are logged and where they are logged.Default: - A default log group will be created if logging for the waiter state machine is enabled.
- Specified by:
getWaiterStateMachineLogOptions
in interfaceProviderProps
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-