Package software.amazon.awscdk.customresources

Class AwsCustomResourceProps.Builder

java.lang.Object

software.amazon.awscdk.customresources.AwsCustomResourceProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AwsCustomResourceProps>

Enclosing interface:

AwsCustomResourceProps

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

A builder for AwsCustomResourceProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AwsCustomResourceProps	build()	Builds the configured instance.
AwsCustomResourceProps.Builder	functionName(String functionName)	Sets the value of AwsCustomResourceProps.getFunctionName()
AwsCustomResourceProps.Builder	installLatestAwsSdk(Boolean installLatestAwsSdk)	Sets the value of AwsCustomResourceProps.getInstallLatestAwsSdk()
AwsCustomResourceProps.Builder	logGroup(ILogGroup logGroup)	Sets the value of AwsCustomResourceProps.getLogGroup()
AwsCustomResourceProps.Builder	logRetention(RetentionDays logRetention)	Sets the value of AwsCustomResourceProps.getLogRetention()
AwsCustomResourceProps.Builder	onCreate(AwsSdkCall onCreate)	Sets the value of AwsCustomResourceProps.getOnCreate()
AwsCustomResourceProps.Builder	onDelete(AwsSdkCall onDelete)	Sets the value of AwsCustomResourceProps.getOnDelete()
AwsCustomResourceProps.Builder	onUpdate(AwsSdkCall onUpdate)	Sets the value of AwsCustomResourceProps.getOnUpdate()
AwsCustomResourceProps.Builder	policy(AwsCustomResourcePolicy policy)	Sets the value of AwsCustomResourceProps.getPolicy()
AwsCustomResourceProps.Builder	removalPolicy(RemovalPolicy removalPolicy)	Sets the value of AwsCustomResourceProps.getRemovalPolicy()
AwsCustomResourceProps.Builder	resourceType(String resourceType)	Sets the value of AwsCustomResourceProps.getResourceType()
AwsCustomResourceProps.Builder	role(IRole role)	Sets the value of AwsCustomResourceProps.getRole()
AwsCustomResourceProps.Builder	timeout(Duration timeout)	Sets the value of AwsCustomResourceProps.getTimeout()
AwsCustomResourceProps.Builder	vpc(IVpc vpc)	Sets the value of AwsCustomResourceProps.getVpc()
AwsCustomResourceProps.Builder	vpcSubnets(SubnetSelection vpcSubnets)	Sets the value of AwsCustomResourceProps.getVpcSubnets()

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

functionName

@Stability(Stable)
public AwsCustomResourceProps.Builder functionName(String functionName)

Sets the value of AwsCustomResourceProps.getFunctionName()

Parameters:

functionName - A name for the singleton Lambda function implementing this custom resource. The function name will remain the same after the first AwsCustomResource is created in a stack.

Returns:

this

installLatestAwsSdk

@Stability(Stable)
public AwsCustomResourceProps.Builder installLatestAwsSdk(Boolean installLatestAwsSdk)

Sets the value of AwsCustomResourceProps.getInstallLatestAwsSdk()

Parameters:

installLatestAwsSdk - Whether to install the latest AWS SDK v2. If not specified, this uses whatever JavaScript SDK version is the default in AWS Lambda at the time of execution.

Otherwise, installs the latest version from 'npmjs.com'. The installation takes around 60 seconds and requires internet connectivity.

The default can be controlled using the context key @aws-cdk/customresources:installLatestAwsSdkDefault is.

Returns:

this

logGroup

@Stability(Stable)
public AwsCustomResourceProps.Builder logGroup(ILogGroup logGroup)

Sets the value of AwsCustomResourceProps.getLogGroup()

Parameters:

logGroup - 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.

Returns:

this

logRetention

@Stability(Stable)
public AwsCustomResourceProps.Builder logRetention(RetentionDays logRetention)

Sets the value of AwsCustomResourceProps.getLogRetention()

Parameters:

logRetention - The number of days log events of the singleton Lambda function implementing this custom resource are kept in CloudWatch Logs. 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.

Returns:

this

onCreate

@Stability(Stable)
public AwsCustomResourceProps.Builder onCreate(AwsSdkCall onCreate)

Sets the value of AwsCustomResourceProps.getOnCreate()

Parameters:

onCreate - The AWS SDK call to make when the resource is created.

Returns:

this

onDelete

@Stability(Stable)
public AwsCustomResourceProps.Builder onDelete(AwsSdkCall onDelete)

Sets the value of AwsCustomResourceProps.getOnDelete()

Parameters:

onDelete - The AWS SDK call to make when the resource is deleted.

Returns:

this

onUpdate

@Stability(Stable)
public AwsCustomResourceProps.Builder onUpdate(AwsSdkCall onUpdate)

Sets the value of AwsCustomResourceProps.getOnUpdate()

Parameters:

onUpdate - The AWS SDK call to make when the resource is updated.

Returns:

this

policy

@Stability(Stable)
public AwsCustomResourceProps.Builder policy(AwsCustomResourcePolicy policy)

Sets the value of AwsCustomResourceProps.getPolicy()

Parameters:

policy - The policy that will be added to the execution role of the Lambda function implementing this custom resource provider. The custom resource also implements iam.IGrantable, making it possible to use the grantXxx() methods.

As this custom resource uses a singleton Lambda function, it's important to note the that function's role will eventually accumulate the permissions/grants from all resources.

Note that a policy must be specified if role is not provided, as by default a new role is created which requires policy changes to access resources.

Returns:

this

removalPolicy

@Stability(Stable)
public AwsCustomResourceProps.Builder removalPolicy(RemovalPolicy removalPolicy)

Sets the value of AwsCustomResourceProps.getRemovalPolicy()

Parameters:

removalPolicy - The policy to apply when this resource is removed from the application.

Returns:

this

resourceType

@Stability(Stable)
public AwsCustomResourceProps.Builder resourceType(String resourceType)

Sets the value of AwsCustomResourceProps.getResourceType()

Parameters:

resourceType - Cloudformation Resource type.

Returns:

this

role

@Stability(Stable)
public AwsCustomResourceProps.Builder role(IRole role)

Sets the value of AwsCustomResourceProps.getRole()

Parameters:

role - The execution role for the singleton Lambda function implementing this custom resource provider. This role will apply to all AwsCustomResource instances in the stack. The role must be assumable by the lambda.amazonaws.com service principal.

Returns:

this

timeout

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

Sets the value of AwsCustomResourceProps.getTimeout()

Parameters:

timeout - The timeout for the singleton Lambda function implementing this custom resource.

Returns:

this

vpc

@Stability(Stable)
public AwsCustomResourceProps.Builder vpc(IVpc vpc)

Sets the value of AwsCustomResourceProps.getVpc()

Parameters:

vpc - The vpc to provision the lambda function in.

Returns:

this

vpcSubnets

@Stability(Stable)
public AwsCustomResourceProps.Builder vpcSubnets(SubnetSelection vpcSubnets)

Sets the value of AwsCustomResourceProps.getVpcSubnets()

Parameters:

vpcSubnets - Which subnets from the VPC to place the lambda function in. Only used if 'vpc' is supplied. Note: internet access for Lambdas requires a NAT gateway, so picking Public subnets is not allowed.

Returns:

this

build

@Stability(Stable)
public AwsCustomResourceProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of AwsCustomResourceProps

Throws:

NullPointerException - if any required attribute was not provided