software.amazon.awscdk.customresources

Class AwsCustomResource.Builder

java.lang.Object

software.amazon.awscdk.customresources.AwsCustomResource.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AwsCustomResource>

Enclosing class:

AwsCustomResource

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

A fluent builder for AwsCustomResource.

Method Summary

Modifier and Type	Method and Description
AwsCustomResource	build()
static AwsCustomResource.Builder	create(software.constructs.Construct scope, String id)
AwsCustomResource.Builder	functionName(String functionName) A name for the singleton Lambda function implementing this custom resource.
AwsCustomResource.Builder	installLatestAwsSdk(Boolean installLatestAwsSdk) Whether to install the latest AWS SDK v2.
AwsCustomResource.Builder	logRetention(RetentionDays logRetention) The number of days log events of the singleton Lambda function implementing this custom resource are kept in CloudWatch Logs.
AwsCustomResource.Builder	onCreate(AwsSdkCall onCreate) The AWS SDK call to make when the resource is created.
AwsCustomResource.Builder	onDelete(AwsSdkCall onDelete) The AWS SDK call to make when the resource is deleted.
AwsCustomResource.Builder	onUpdate(AwsSdkCall onUpdate) The AWS SDK call to make when the resource is updated.
AwsCustomResource.Builder	policy(AwsCustomResourcePolicy policy) The policy that will be added to the execution role of the Lambda function implementing this custom resource provider.
AwsCustomResource.Builder	resourceType(String resourceType) Cloudformation Resource type.
AwsCustomResource.Builder	role(IRole role) The execution role for the singleton Lambda function implementing this custom resource provider.
AwsCustomResource.Builder	timeout(Duration timeout) The timeout for the singleton Lambda function implementing this custom resource.
AwsCustomResource.Builder	vpc(IVpc vpc) The vpc to provision the lambda function in.
AwsCustomResource.Builder	vpcSubnets(SubnetSelection vpcSubnets) Which subnets from the VPC to place the lambda function in.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static AwsCustomResource.Builder create(software.constructs.Construct scope,
                                                                        String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of AwsCustomResource.Builder.

functionName

@Stability(value=Stable)
public AwsCustomResource.Builder functionName(String 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.

Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the function's name. For more information, see Name Type.

Parameters:

functionName - A name for the singleton Lambda function implementing this custom resource. This parameter is required.

Returns:

this

installLatestAwsSdk

@Stability(value=Stable)
public AwsCustomResource.Builder installLatestAwsSdk(Boolean installLatestAwsSdk)

Whether to install the latest AWS SDK v2. Allows to use the latest API calls documented at https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html.

The installation takes around 60 seconds.

Default: true

Parameters:

installLatestAwsSdk - Whether to install the latest AWS SDK v2. Allows to use the latest API calls documented at https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html. This parameter is required.

Returns:

this

logRetention

@Stability(value=Stable)
public AwsCustomResource.Builder logRetention(RetentionDays logRetention)

The number of days log events of the singleton Lambda function implementing this custom resource are kept in CloudWatch Logs.

Default: logs.RetentionDays.INFINITE

Parameters:

logRetention - The number of days log events of the singleton Lambda function implementing this custom resource are kept in CloudWatch Logs. This parameter is required.

Returns:

this

onCreate

@Stability(value=Stable)
public AwsCustomResource.Builder onCreate(AwsSdkCall onCreate)

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

Default: - the call when the resource is updated

Parameters:

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

Returns:

this

onDelete

@Stability(value=Stable)
public AwsCustomResource.Builder onDelete(AwsSdkCall onDelete)

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

Default: - no call

Parameters:

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

Returns:

this

onUpdate

@Stability(value=Stable)
public AwsCustomResource.Builder onUpdate(AwsSdkCall onUpdate)

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

Default: - no call

Parameters:

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

Returns:

this

policy

@Stability(value=Stable)
public AwsCustomResource.Builder policy(AwsCustomResourcePolicy 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.

Default: - no policy added

Parameters:

policy - The policy that will be added to the execution role of the Lambda function implementing this custom resource provider. This parameter is required.

Returns:

this

See Also:

Policy.fromSdkCalls

resourceType

@Stability(value=Stable)
public AwsCustomResource.Builder resourceType(String resourceType)

Cloudformation Resource type.

Default: - Custom::AWS

Parameters:

resourceType - Cloudformation Resource type. This parameter is required.

Returns:

this

role

@Stability(value=Stable)
public AwsCustomResource.Builder role(IRole 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.

Default: - a new role is created

Parameters:

role - The execution role for the singleton Lambda function implementing this custom resource provider. This parameter is required.

Returns:

this

timeout

@Stability(value=Stable)
public AwsCustomResource.Builder timeout(Duration timeout)

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

Default: Duration.minutes(2)

Parameters:

timeout - The timeout for the singleton Lambda function implementing this custom resource. This parameter is required.

Returns:

this

vpc

@Stability(value=Stable)
public AwsCustomResource.Builder vpc(IVpc vpc)

The vpc to provision the lambda function in.

Default: - the function is not provisioned inside a vpc.

Parameters:

vpc - The vpc to provision the lambda function in. This parameter is required.

Returns:

this

vpcSubnets

@Stability(value=Stable)
public AwsCustomResource.Builder vpcSubnets(SubnetSelection 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.

Default: - the Vpc default strategy if not specified

Parameters:

vpcSubnets - Which subnets from the VPC to place the lambda function in. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public AwsCustomResource build()

Specified by:

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