software.amazon.awscdk.cloudassembly.schema

Interface IntegManifest

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IntegManifest.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.860Z")
 @Stability(value=Stable)
public interface IntegManifest
extends software.amazon.jsii.JsiiSerializable

Definitions for the integration testing manifest.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cloudassembly.schema.*;
 IntegManifest integManifest = IntegManifest.builder()
         .testCases(Map.of(
                 "testCasesKey", TestCase.builder()
                         .stacks(List.of("stacks"))
                         // the properties below are optional
                         .allowDestroy(List.of("allowDestroy"))
                         .assertionStack("assertionStack")
                         .assertionStackName("assertionStackName")
                         .cdkCommandOptions(CdkCommands.builder()
                                 .deploy(DeployCommand.builder()
                                         .args(DeployOptions.builder()
                                                 .all(false)
                                                 .app("app")
                                                 .assetMetadata(false)
                                                 .caBundlePath("caBundlePath")
                                                 .changeSetName("changeSetName")
                                                 .ci(false)
                                                 .color(false)
                                                 .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()))
         .version("version")
         // the properties below are optional
         .enableLookups(false)
         .synthContext(Map.of(
                 "synthContextKey", "synthContext"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static IntegManifest.Builder	builder()
default Boolean	getEnableLookups() Enable lookups for this test.
default Map<String,String>	getSynthContext() Additional context to use when performing a synth.
Map<String,TestCase>	getTestCases() test cases.
String	getVersion() Version of the manifest.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getTestCases

@Stability(value=Stable)
 @NotNull
Map<String,TestCase> getTestCases()

test cases.

getVersion

@Stability(value=Stable)
 @NotNull
String getVersion()

Version of the manifest.

getEnableLookups

@Stability(value=Stable)
 @Nullable
default Boolean getEnableLookups()

Enable lookups for this test.

If lookups are enabled then stackUpdateWorkflow must be set to false. Lookups should only be enabled when you are explicitely testing lookups.

Default: false

getSynthContext

@Stability(value=Stable)
 @Nullable
default Map<String,String> getSynthContext()

Additional context to use when performing a synth.

Any context provided here will override any default context

Default: - no additional context

builder

@Stability(value=Stable)
static IntegManifest.Builder builder()

Returns:

a IntegManifest.Builder of IntegManifest