software.amazon.awscdk.customresources

Class ProviderProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.customresources.ProviderProps.Jsii$Proxy

All Implemented Interfaces:

ProviderProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

ProviderProps

@Stability(value=Experimental)
 @Internal
public static final class ProviderProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements ProviderProps

An implementation for 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

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(IFunction onEventHandler, IFunction isCompleteHandler, RetentionDays logRetention, Duration queryInterval, IRole role, List<? extends ISecurityGroup> securityGroups, Duration totalTimeout, IVpc vpc, SubnetSelection vpcSubnets) Constructor that initializes the object based on literal property values passed by the ProviderProps.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 Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
IFunction	getIsCompleteHandler() (experimental) The AWS Lambda function to invoke in order to determine if the operation is complete.
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).
Duration	getQueryInterval() (experimental) Time between calls to the `isComplete` handler which determines if the resource has been stabilized.
IRole	getRole() (experimental) AWS Lambda execution role.
List<ISecurityGroup>	getSecurityGroups() (experimental) Security groups to attach to the provider functions.
Duration	getTotalTimeout() (experimental) Total timeout for the entire operation.
IVpc	getVpc() (experimental) The vpc to provision the lambda functions in.
SubnetSelection	getVpcSubnets() (experimental) Which subnets from the VPC to place the lambda functions in.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.customresources.ProviderProps

builder

Constructor Detail

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

protected Jsii$Proxy(IFunction onEventHandler,
                     IFunction isCompleteHandler,
                     RetentionDays logRetention,
                     Duration queryInterval,
                     IRole role,
                     List<? extends ISecurityGroup> securityGroups,
                     Duration totalTimeout,
                     IVpc vpc,
                     SubnetSelection vpcSubnets)

Constructor that initializes the object based on literal property values passed by the ProviderProps.Builder.

Method Detail

getOnEventHandler

public final IFunction getOnEventHandler()

Description copied from interface: ProviderProps

(experimental) 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. The PhysicalResourceId property must be included in the response.

Specified by:

getOnEventHandler in interface ProviderProps

getIsCompleteHandler

public final IFunction getIsCompleteHandler()

Description copied from interface: ProviderProps

(experimental) 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.

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 interface ProviderProps

getLogRetention

public final RetentionDays getLogRetention()

Description copied from interface: ProviderProps

(experimental) 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.

Default: logs.RetentionDays.INFINITE

Specified by:

getLogRetention in interface ProviderProps

getQueryInterval

public final Duration getQueryInterval()

Description copied from interface: ProviderProps

(experimental) 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.

Default: Duration.seconds(5)

Specified by:

getQueryInterval in interface ProviderProps

getRole

public final IRole getRole()

Description copied from interface: ProviderProps

(experimental) 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 interface ProviderProps

getSecurityGroups

public final List<ISecurityGroup> getSecurityGroups()

Description copied from interface: ProviderProps

(experimental) 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 interface ProviderProps

getTotalTimeout

public final Duration getTotalTimeout()

Description copied from interface: ProviderProps

(experimental) Total timeout for the entire operation.

The maximum timeout is 2 hours (yes, it can exceed the AWS Lambda 15 minutes)

Default: Duration.minutes(30)

Specified by:

getTotalTimeout in interface ProviderProps

getVpc

public final IVpc getVpc()

Description copied from interface: ProviderProps

(experimental) The vpc to provision the lambda functions in.

Default: - functions are not provisioned inside a vpc.

Specified by:

getVpc in interface ProviderProps

getVpcSubnets

public final SubnetSelection getVpcSubnets()

Description copied from interface: ProviderProps

(experimental) 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 interface ProviderProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object