software.amazon.awscdk.customresources

Class ProviderProps.Builder

java.lang.Object

software.amazon.awscdk.customresources.ProviderProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ProviderProps>

Enclosing interface:

ProviderProps

@Stability(value=Experimental)
public static final class ProviderProps.Builder
extends Object
implements software.amazon.jsii.Builder<ProviderProps>

A builder for ProviderProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ProviderProps	build() Builds the configured instance.
ProviderProps.Builder	isCompleteHandler(IFunction isCompleteHandler) Sets the value of ProviderProps.getIsCompleteHandler()
ProviderProps.Builder	logRetention(RetentionDays logRetention) Sets the value of ProviderProps.getLogRetention()
ProviderProps.Builder	onEventHandler(IFunction onEventHandler) Sets the value of ProviderProps.getOnEventHandler()
ProviderProps.Builder	queryInterval(Duration queryInterval) Sets the value of ProviderProps.getQueryInterval()
ProviderProps.Builder	totalTimeout(Duration totalTimeout) Sets the value of ProviderProps.getTotalTimeout()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

onEventHandler

@Stability(value=Experimental)
public ProviderProps.Builder onEventHandler(IFunction onEventHandler)

Sets the value of ProviderProps.getOnEventHandler()

Parameters:

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.

Returns:

this

isCompleteHandler

@Stability(value=Experimental)
public ProviderProps.Builder isCompleteHandler(IFunction isCompleteHandler)

Sets the value of ProviderProps.getIsCompleteHandler()

Parameters:

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.

Returns:

this

logRetention

@Stability(value=Experimental)
public ProviderProps.Builder logRetention(RetentionDays logRetention)

Sets the value of ProviderProps.getLogRetention()

Parameters:

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.

Returns:

this

queryInterval

@Stability(value=Experimental)
public ProviderProps.Builder queryInterval(Duration queryInterval)

Sets the value of ProviderProps.getQueryInterval()

Parameters:

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.

Returns:

this

totalTimeout

@Stability(value=Experimental)
public ProviderProps.Builder totalTimeout(Duration totalTimeout)

Sets the value of ProviderProps.getTotalTimeout()

Parameters:

totalTimeout - Total timeout for the entire operation. The maximum timeout is 2 hours (yes, it can exceed the AWS Lambda 15 minutes)

Returns:

this

build

@Stability(value=Experimental)
public ProviderProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<ProviderProps>

Returns:

a new instance of ProviderProps

Throws:

NullPointerException - if any required attribute was not provided