Package io.github.cdklabs.projen.awscdk

Class IntegrationTestOptions.Builder

java.lang.Object

io.github.cdklabs.projen.awscdk.IntegrationTestOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<IntegrationTestOptions>

Enclosing interface:

IntegrationTestOptions

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

A builder for IntegrationTestOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IntegrationTestOptions	build()	Builds the configured instance.
IntegrationTestOptions.Builder	cdkDeps(AwsCdkDeps cdkDeps)	Sets the value of IntegrationTestOptions.getCdkDeps()
IntegrationTestOptions.Builder	destroyAfterDeploy(Boolean destroyAfterDeploy)	Sets the value of IntegrationTestCommonOptions.getDestroyAfterDeploy()
IntegrationTestOptions.Builder	entrypoint(String entrypoint)	Sets the value of IntegrationTestBaseOptions.getEntrypoint()
IntegrationTestOptions.Builder	name(String name)	Sets the value of IntegrationTestBaseOptions.getName()
IntegrationTestOptions.Builder	pathMetadata(Boolean pathMetadata)	Sets the value of IntegrationTestCommonOptions.getPathMetadata()
IntegrationTestOptions.Builder	stacks(List<String> stacks)	Sets the value of IntegrationTestOptions.getStacks()
IntegrationTestOptions.Builder	tsconfigPath(String tsconfigPath)	Sets the value of IntegrationTestBaseOptions.getTsconfigPath()

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

cdkDeps

@Stability(Experimental)
public IntegrationTestOptions.Builder cdkDeps(AwsCdkDeps cdkDeps)

Sets the value of IntegrationTestOptions.getCdkDeps()

Parameters:

cdkDeps - AWS CDK dependency manager. This parameter is required.

Returns:

this

stacks

@Stability(Experimental)
public IntegrationTestOptions.Builder stacks(List<String> stacks)

Sets the value of IntegrationTestOptions.getStacks()

Parameters:

stacks - A list of stacks within the integration test to deploy/destroy.

Returns:

this

destroyAfterDeploy

@Stability(Experimental)
public IntegrationTestOptions.Builder destroyAfterDeploy(Boolean destroyAfterDeploy)

Sets the value of IntegrationTestCommonOptions.getDestroyAfterDeploy()

Parameters:

destroyAfterDeploy - Destroy the test app after a successful deployment. If disabled, leaves the app deployed in the dev account.

Returns:

this

pathMetadata

@Stability(Experimental)
public IntegrationTestOptions.Builder pathMetadata(Boolean pathMetadata)

Sets the value of IntegrationTestCommonOptions.getPathMetadata()

Parameters:

pathMetadata - Enables path metadata, adding aws:cdk:path, with the defining construct's path, to the CloudFormation metadata for each synthesized resource.

Returns:

this

entrypoint

@Stability(Experimental)
public IntegrationTestOptions.Builder entrypoint(String entrypoint)

Sets the value of IntegrationTestBaseOptions.getEntrypoint()

Parameters:

entrypoint - A path from the project root directory to a TypeScript file which contains the integration test app. This parameter is required. This is relative to the root directory of the project.

Returns:

this

tsconfigPath

@Stability(Experimental)
public IntegrationTestOptions.Builder tsconfigPath(String tsconfigPath)

Sets the value of IntegrationTestBaseOptions.getTsconfigPath()

Parameters:

tsconfigPath - The path of the tsconfig.json file to use when running integration test cdk apps. This parameter is required.

Returns:

this

name

@Stability(Experimental)
public IntegrationTestOptions.Builder name(String name)

Sets the value of IntegrationTestBaseOptions.getName()

Parameters:

name - Name of the integration test.

Returns:

this

build

@Stability(Experimental)
public IntegrationTestOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of IntegrationTestOptions

Throws:

NullPointerException - if any required attribute was not provided