Package software.amazon.awscdk

Class CustomResourceProviderProps.Builder

java.lang.Object

software.amazon.awscdk.CustomResourceProviderProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CustomResourceProviderProps>

Enclosing interface:

CustomResourceProviderProps

@Stability(Stable)
public static final class CustomResourceProviderProps.Builder
extends Object
implements software.amazon.jsii.Builder<CustomResourceProviderProps>

A builder for CustomResourceProviderProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CustomResourceProviderProps	build()	Builds the configured instance.
CustomResourceProviderProps.Builder	codeDirectory(String codeDirectory)	Sets the value of CustomResourceProviderProps.getCodeDirectory()
CustomResourceProviderProps.Builder	description(String description)	Sets the value of CustomResourceProviderOptions.getDescription()
CustomResourceProviderProps.Builder	environment(Map<String,String> environment)	Sets the value of CustomResourceProviderOptions.getEnvironment()
CustomResourceProviderProps.Builder	memorySize(Size memorySize)	Sets the value of CustomResourceProviderOptions.getMemorySize()
CustomResourceProviderProps.Builder	policyStatements(List<? extends Object> policyStatements)	Sets the value of CustomResourceProviderOptions.getPolicyStatements()
CustomResourceProviderProps.Builder	runtime(CustomResourceProviderRuntime runtime)	Sets the value of CustomResourceProviderProps.getRuntime()
CustomResourceProviderProps.Builder	timeout(Duration timeout)	Sets the value of CustomResourceProviderOptions.getTimeout()
CustomResourceProviderProps.Builder	useCfnResponseWrapper(Boolean useCfnResponseWrapper)	Sets the value of CustomResourceProviderOptions.getUseCfnResponseWrapper()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

codeDirectory

@Stability(Stable)
public CustomResourceProviderProps.Builder codeDirectory(String codeDirectory)

Sets the value of CustomResourceProviderProps.getCodeDirectory()

Parameters:

codeDirectory - A local file system directory with the provider's code. This parameter is required. The code will be bundled into a zip asset and wired to the provider's AWS Lambda function.

Returns:

this

runtime

@Stability(Stable)
public CustomResourceProviderProps.Builder runtime(CustomResourceProviderRuntime runtime)

Sets the value of CustomResourceProviderProps.getRuntime()

Parameters:

runtime - The AWS Lambda runtime and version to use for the provider. This parameter is required.

Returns:

this

description

@Stability(Stable)
public CustomResourceProviderProps.Builder description(String description)

Sets the value of CustomResourceProviderOptions.getDescription()

Parameters:

description - A description of the function.

Returns:

this

environment

@Stability(Stable)
public CustomResourceProviderProps.Builder environment(Map<String,String> environment)

Sets the value of CustomResourceProviderOptions.getEnvironment()

Parameters:

environment - Key-value pairs that are passed to Lambda as Environment.

Returns:

this

memorySize

@Stability(Stable)
public CustomResourceProviderProps.Builder memorySize(Size memorySize)

Sets the value of CustomResourceProviderOptions.getMemorySize()

Parameters:

memorySize - The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation.

Returns:

this

policyStatements

@Stability(Stable)
public CustomResourceProviderProps.Builder policyStatements(List<? extends Object> policyStatements)

Sets the value of CustomResourceProviderOptions.getPolicyStatements()

Parameters:

policyStatements - A set of IAM policy statements to include in the inline policy of the provider's lambda function. Please note: these are direct IAM JSON policy blobs, not iam.PolicyStatement objects like you will see in the rest of the CDK.

Returns:

this

timeout

@Stability(Stable)
public CustomResourceProviderProps.Builder timeout(Duration timeout)

Sets the value of CustomResourceProviderOptions.getTimeout()

Parameters:

timeout - AWS Lambda timeout for the provider.

Returns:

this

useCfnResponseWrapper

@Stability(Stable)
public CustomResourceProviderProps.Builder useCfnResponseWrapper(Boolean useCfnResponseWrapper)

Sets the value of CustomResourceProviderOptions.getUseCfnResponseWrapper()

Parameters:

useCfnResponseWrapper - Whether or not the cloudformation response wrapper (nodejs-entrypoint.ts) is used. If set to true, nodejs-entrypoint.js is bundled in the same asset as the custom resource and set as the entrypoint. If set to false, the custom resource provided is the entrypoint.

Returns:

this

build

@Stability(Stable)
public CustomResourceProviderProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CustomResourceProviderProps

Throws:

NullPointerException - if any required attribute was not provided