Package io.github.cdklabs.projen.awscdk

Class IntegrationTest.Builder

java.lang.Object

io.github.cdklabs.projen.awscdk.IntegrationTest.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<IntegrationTest>

Enclosing class:

IntegrationTest

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

(experimental) A fluent builder for IntegrationTest.

Method Summary

Modifier and Type	Method	Description
IntegrationTest	build()
IntegrationTest.Builder	cdkDeps(AwsCdkDeps cdkDeps)	(experimental) AWS CDK dependency manager.
static IntegrationTest.Builder	create(Project project)
IntegrationTest.Builder	destroyAfterDeploy(Boolean destroyAfterDeploy)	(experimental) Destroy the test app after a successful deployment.
IntegrationTest.Builder	entrypoint(String entrypoint)	(experimental) A path from the project root directory to a TypeScript file which contains the integration test app.
IntegrationTest.Builder	name(String name)	(experimental) Name of the integration test.
IntegrationTest.Builder	pathMetadata(Boolean pathMetadata)	(experimental) Enables path metadata, adding aws:cdk:path, with the defining construct's path, to the CloudFormation metadata for each synthesized resource.
IntegrationTest.Builder	stacks(List<String> stacks)	(experimental) A list of stacks within the integration test to deploy/destroy.
IntegrationTest.Builder	tsconfigPath(String tsconfigPath)	(experimental) The path of the tsconfig.json file to use when running integration test cdk apps.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(Experimental)
public static IntegrationTest.Builder create(Project project)

Parameters:

project - This parameter is required.

Returns:

a new instance of IntegrationTest.Builder.

destroyAfterDeploy

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

(experimental) Destroy the test app after a successful deployment.

If disabled, leaves the app deployed in the dev account.

Default: true

Parameters:

destroyAfterDeploy - Destroy the test app after a successful deployment. This parameter is required.

Returns:

this

pathMetadata

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

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

Default: false

Parameters:

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

Returns:

this

entrypoint

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

(experimental) A path from the project root directory to a TypeScript file which contains the integration test app.

This is relative to the root directory of the project.

Example:

 "test/subdir/foo.integ.ts"
 

Parameters:

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

Returns:

this

tsconfigPath

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

(experimental) The path of the tsconfig.json file to use when running integration test cdk apps.

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 IntegrationTest.Builder name(String name)

(experimental) Name of the integration test.

Default: - Derived from the entrypoint filename.

Parameters:

name - Name of the integration test. This parameter is required.

Returns:

this

cdkDeps

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

(experimental) AWS CDK dependency manager.

Parameters:

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

Returns:

this

stacks

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

(experimental) A list of stacks within the integration test to deploy/destroy.

Default: ["**"]

Parameters:

stacks - A list of stacks within the integration test to deploy/destroy. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public IntegrationTest build()

Specified by:

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

Returns:

a newly built instance of IntegrationTest.