Package software.amazon.awscdk.integtests.alpha

Interface IntegTestCaseProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TestOptions

All Known Implementing Classes:

IntegTestCaseProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-08-02T00:29:19.228Z")
@Stability(Experimental)
public interface IntegTestCaseProps
extends software.amazon.jsii.JsiiSerializable, TestOptions

(experimental) Properties of an integration test case.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.integtests.alpha.*;
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.cloudassembly.schema.*;
 Stack stack;
 IntegTestCaseProps integTestCaseProps = IntegTestCaseProps.builder()
         .stacks(List.of(stack))
         // the properties below are optional
         .allowDestroy(List.of("allowDestroy"))
         .assertionStack(stack)
         .cdkCommandOptions(CdkCommands.builder()
                 .deploy(DeployCommand.builder()
                         .args(DeployOptions.builder()
                                 .all(false)
                                 .app("app")
                                 .assetMetadata(false)
                                 .caBundlePath("caBundlePath")
                                 .changeSetName("changeSetName")
                                 .ci(false)
                                 .color(false)
                                 .concurrency(123)
                                 .context(Map.of(
                                         "contextKey", "context"))
                                 .debug(false)
                                 .ec2Creds(false)
                                 .exclusively(false)
                                 .execute(false)
                                 .force(false)
                                 .ignoreErrors(false)
                                 .json(false)
                                 .lookups(false)
                                 .notices(false)
                                 .notificationArns(List.of("notificationArns"))
                                 .output("output")
                                 .outputsFile("outputsFile")
                                 .parameters(Map.of(
                                         "parametersKey", "parameters"))
                                 .pathMetadata(false)
                                 .profile("profile")
                                 .proxy("proxy")
                                 .requireApproval(RequireApproval.NEVER)
                                 .reuseAssets(List.of("reuseAssets"))
                                 .roleArn("roleArn")
                                 .rollback(false)
                                 .stacks(List.of("stacks"))
                                 .staging(false)
                                 .strict(false)
                                 .toolkitStackName("toolkitStackName")
                                 .trace(false)
                                 .usePreviousParameters(false)
                                 .verbose(false)
                                 .versionReporting(false)
                                 .build())
                         .enabled(false)
                         .expectedMessage("expectedMessage")
                         .expectError(false)
                         .build())
                 .destroy(DestroyCommand.builder()
                         .args(DestroyOptions.builder()
                                 .all(false)
                                 .app("app")
                                 .assetMetadata(false)
                                 .caBundlePath("caBundlePath")
                                 .color(false)
                                 .context(Map.of(
                                         "contextKey", "context"))
                                 .debug(false)
                                 .ec2Creds(false)
                                 .exclusively(false)
                                 .force(false)
                                 .ignoreErrors(false)
                                 .json(false)
                                 .lookups(false)
                                 .notices(false)
                                 .output("output")
                                 .pathMetadata(false)
                                 .profile("profile")
                                 .proxy("proxy")
                                 .roleArn("roleArn")
                                 .stacks(List.of("stacks"))
                                 .staging(false)
                                 .strict(false)
                                 .trace(false)
                                 .verbose(false)
                                 .versionReporting(false)
                                 .build())
                         .enabled(false)
                         .expectedMessage("expectedMessage")
                         .expectError(false)
                         .build())
                 .build())
         .diffAssets(false)
         .hooks(Hooks.builder()
                 .postDeploy(List.of("postDeploy"))
                 .postDestroy(List.of("postDestroy"))
                 .preDeploy(List.of("preDeploy"))
                 .preDestroy(List.of("preDestroy"))
                 .build())
         .regions(List.of("regions"))
         .stackUpdateWorkflow(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	IntegTestCaseProps.Builder	A builder for IntegTestCaseProps
static final class	IntegTestCaseProps.Jsii$Proxy	An implementation for IntegTestCaseProps

Method Summary

Modifier and Type	Method	Description
static IntegTestCaseProps.Builder	builder()
default Stack	getAssertionStack()	(experimental) Specify a stack to use for assertions.
List<Stack>	getStacks()	(experimental) Stacks to be deployed during the test.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.cloudassembly.schema.TestOptions

getAllowDestroy, getCdkCommandOptions, getDiffAssets, getHooks, getRegions, getStackUpdateWorkflow

Method Details

getStacks

@Stability(Experimental)
@NotNull
List<Stack> getStacks()

(experimental) Stacks to be deployed during the test.

getAssertionStack

@Stability(Experimental)
@Nullable
default Stack getAssertionStack()

(experimental) Specify a stack to use for assertions.

Default: - a stack is created for you

builder

@Stability(Experimental)
static IntegTestCaseProps.Builder builder()

Returns:

a IntegTestCaseProps.Builder of IntegTestCaseProps