IntegManifest Struct
Definitions for the integration testing manifest.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { cloud_assembly_schema } from 'aws-cdk-lib';
const integManifest: cloud_assembly_schema.IntegManifest = {
testCases: {
testCasesKey: {
stacks: ['stacks'],
// the properties below are optional
allowDeleteFailures: false,
allowDestroy: ['allowDestroy'],
assertionStack: 'assertionStack',
assertionStackName: 'assertionStackName',
cdkCommandOptions: {
deploy: {
args: {
all: false,
app: 'app',
assetMetadata: false,
caBundlePath: 'caBundlePath',
changeSetName: 'changeSetName',
ci: false,
color: false,
concurrency: 123,
context: {
contextKey: 'context',
},
debug: false,
ec2Creds: false,
exclusively: false,
execute: false,
force: false,
ignoreErrors: false,
json: false,
lookups: false,
notices: false,
notificationArns: ['notificationArns'],
output: 'output',
outputsFile: 'outputsFile',
parameters: {
parametersKey: 'parameters',
},
pathMetadata: false,
profile: 'profile',
proxy: 'proxy',
requireApproval: cloud_assembly_schema.RequireApproval.NEVER,
reuseAssets: ['reuseAssets'],
roleArn: 'roleArn',
rollback: false,
stacks: ['stacks'],
staging: false,
strict: false,
toolkitStackName: 'toolkitStackName',
trace: false,
usePreviousParameters: false,
verbose: false,
versionReporting: false,
},
enabled: false,
expectedMessage: 'expectedMessage',
expectError: false,
},
destroy: {
args: {
all: false,
app: 'app',
assetMetadata: false,
caBundlePath: 'caBundlePath',
color: false,
context: {
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: ['stacks'],
staging: false,
strict: false,
trace: false,
verbose: false,
versionReporting: false,
},
enabled: false,
expectedMessage: 'expectedMessage',
expectError: false,
},
},
diffAssets: false,
hooks: {
postDeploy: ['postDeploy'],
postDestroy: ['postDestroy'],
preDeploy: ['preDeploy'],
preDestroy: ['preDestroy'],
},
regions: ['regions'],
stackUpdateWorkflow: false,
},
},
version: 'version',
// the properties below are optional
enableLookups: false,
synthContext: {
synthContextKey: 'synthContext',
},
};
python
from aws_cdk.cloud_assembly_schema import IntegManifest, TestCase, CdkCommands, DeployCommand, DeployOptions, DestroyCommand, DestroyOptions, Hooks
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import cloud_assembly_schema
integ_manifest = IntegManifest(
test_cases={
"test_cases_key": TestCase(
stacks=["stacks"],
# the properties below are optional
allow_delete_failures=False,
allow_destroy=["allowDestroy"],
assertion_stack="assertionStack",
assertion_stack_name="assertionStackName",
cdk_command_options=CdkCommands(
deploy=DeployCommand(
args=DeployOptions(
all=False,
app="app",
asset_metadata=False,
ca_bundle_path="caBundlePath",
change_set_name="changeSetName",
ci=False,
color=False,
concurrency=123,
context={
"context_key": "context"
},
debug=False,
ec2_creds=False,
exclusively=False,
execute=False,
force=False,
ignore_errors=False,
json=False,
lookups=False,
notices=False,
notification_arns=["notificationArns"],
output="output",
outputs_file="outputsFile",
parameters={
"parameters_key": "parameters"
},
path_metadata=False,
profile="profile",
proxy="proxy",
require_approval=cloud_assembly_schema.RequireApproval.NEVER,
reuse_assets=["reuseAssets"],
role_arn="roleArn",
rollback=False,
stacks=["stacks"],
staging=False,
strict=False,
toolkit_stack_name="toolkitStackName",
trace=False,
use_previous_parameters=False,
verbose=False,
version_reporting=False
),
enabled=False,
expected_message="expectedMessage",
expect_error=False
),
destroy=DestroyCommand(
args=DestroyOptions(
all=False,
app="app",
asset_metadata=False,
ca_bundle_path="caBundlePath",
color=False,
context={
"context_key": "context"
},
debug=False,
ec2_creds=False,
exclusively=False,
force=False,
ignore_errors=False,
json=False,
lookups=False,
notices=False,
output="output",
path_metadata=False,
profile="profile",
proxy="proxy",
role_arn="roleArn",
stacks=["stacks"],
staging=False,
strict=False,
trace=False,
verbose=False,
version_reporting=False
),
enabled=False,
expected_message="expectedMessage",
expect_error=False
)
),
diff_assets=False,
hooks=Hooks(
post_deploy=["postDeploy"],
post_destroy=["postDestroy"],
pre_deploy=["preDeploy"],
pre_destroy=["preDestroy"]
),
regions=["regions"],
stack_update_workflow=False
)
},
version="version",
# the properties below are optional
enable_lookups=False,
synth_context={
"synth_context_key": "synthContext"
}
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.cloud_assembly_schema.*;
IntegManifest integManifest = IntegManifest.builder()
.testCases(Map.of(
"testCasesKey", TestCase.builder()
.stacks(List.of("stacks"))
// the properties below are optional
.allowDeleteFailures(false)
.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)
.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()))
.version("version")
// the properties below are optional
.enableLookups(false)
.synthContext(Map.of(
"synthContextKey", "synthContext"))
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Cloud_assembly_schema;
var integManifest = new IntegManifest {
TestCases = new Dictionary<string, TestCase> {
{ "testCasesKey", new TestCase {
Stacks = new [] { "stacks" },
// the properties below are optional
AllowDeleteFailures = false,
AllowDestroy = new [] { "allowDestroy" },
AssertionStack = "assertionStack",
AssertionStackName = "assertionStackName",
CdkCommandOptions = new CdkCommands {
Deploy = new DeployCommand {
Args = new DeployOptions {
All = false,
App = "app",
AssetMetadata = false,
CaBundlePath = "caBundlePath",
ChangeSetName = "changeSetName",
Ci = false,
Color = false,
Concurrency = 123,
Context = new Dictionary<string, string> {
{ "contextKey", "context" }
},
Debug = false,
Ec2Creds = false,
Exclusively = false,
Execute = false,
Force = false,
IgnoreErrors = false,
Json = false,
Lookups = false,
Notices = false,
NotificationArns = new [] { "notificationArns" },
Output = "output",
OutputsFile = "outputsFile",
Parameters = new Dictionary<string, string> {
{ "parametersKey", "parameters" }
},
PathMetadata = false,
Profile = "profile",
Proxy = "proxy",
RequireApproval = RequireApproval.NEVER,
ReuseAssets = new [] { "reuseAssets" },
RoleArn = "roleArn",
Rollback = false,
Stacks = new [] { "stacks" },
Staging = false,
Strict = false,
ToolkitStackName = "toolkitStackName",
Trace = false,
UsePreviousParameters = false,
Verbose = false,
VersionReporting = false
},
Enabled = false,
ExpectedMessage = "expectedMessage",
ExpectError = false
},
Destroy = new DestroyCommand {
Args = new DestroyOptions {
All = false,
App = "app",
AssetMetadata = false,
CaBundlePath = "caBundlePath",
Color = false,
Context = new Dictionary<string, string> {
{ "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 = new [] { "stacks" },
Staging = false,
Strict = false,
Trace = false,
Verbose = false,
VersionReporting = false
},
Enabled = false,
ExpectedMessage = "expectedMessage",
ExpectError = false
}
},
DiffAssets = false,
Hooks = new Hooks {
PostDeploy = new [] { "postDeploy" },
PostDestroy = new [] { "postDestroy" },
PreDeploy = new [] { "preDeploy" },
PreDestroy = new [] { "preDestroy" }
},
Regions = new [] { "regions" },
StackUpdateWorkflow = false
} }
},
Version = "version",
// the properties below are optional
EnableLookups = false,
SynthContext = new Dictionary<string, string> {
{ "synthContextKey", "synthContext" }
}
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
integManifest := &IntegManifest{
TestCases: map[string]TestCase{
"testCasesKey": &TestCase{
"stacks": []*string{
jsii.String("stacks"),
},
// the properties below are optional
"allowDeleteFailures": jsii.Boolean(false),
"allowDestroy": []*string{
jsii.String("allowDestroy"),
},
"assertionStack": jsii.String("assertionStack"),
"assertionStackName": jsii.String("assertionStackName"),
"cdkCommandOptions": &CdkCommands{
"deploy": &DeployCommand{
"args": &DeployOptions{
"all": jsii.Boolean(false),
"app": jsii.String("app"),
"assetMetadata": jsii.Boolean(false),
"caBundlePath": jsii.String("caBundlePath"),
"changeSetName": jsii.String("changeSetName"),
"ci": jsii.Boolean(false),
"color": jsii.Boolean(false),
"concurrency": jsii.Number(123),
"context": map[string]*string{
"contextKey": jsii.String("context"),
},
"debug": jsii.Boolean(false),
"ec2Creds": jsii.Boolean(false),
"exclusively": jsii.Boolean(false),
"execute": jsii.Boolean(false),
"force": jsii.Boolean(false),
"ignoreErrors": jsii.Boolean(false),
"json": jsii.Boolean(false),
"lookups": jsii.Boolean(false),
"notices": jsii.Boolean(false),
"notificationArns": []*string{
jsii.String("notificationArns"),
},
"output": jsii.String("output"),
"outputsFile": jsii.String("outputsFile"),
"parameters": map[string]*string{
"parametersKey": jsii.String("parameters"),
},
"pathMetadata": jsii.Boolean(false),
"profile": jsii.String("profile"),
"proxy": jsii.String("proxy"),
"requireApproval": awscdk.cloud_assembly_schema.RequireApproval_NEVER,
"reuseAssets": []*string{
jsii.String("reuseAssets"),
},
"roleArn": jsii.String("roleArn"),
"rollback": jsii.Boolean(false),
"stacks": []*string{
jsii.String("stacks"),
},
"staging": jsii.Boolean(false),
"strict": jsii.Boolean(false),
"toolkitStackName": jsii.String("toolkitStackName"),
"trace": jsii.Boolean(false),
"usePreviousParameters": jsii.Boolean(false),
"verbose": jsii.Boolean(false),
"versionReporting": jsii.Boolean(false),
},
"enabled": jsii.Boolean(false),
"expectedMessage": jsii.String("expectedMessage"),
"expectError": jsii.Boolean(false),
},
"destroy": &DestroyCommand{
"args": &DestroyOptions{
"all": jsii.Boolean(false),
"app": jsii.String("app"),
"assetMetadata": jsii.Boolean(false),
"caBundlePath": jsii.String("caBundlePath"),
"color": jsii.Boolean(false),
"context": map[string]*string{
"contextKey": jsii.String("context"),
},
"debug": jsii.Boolean(false),
"ec2Creds": jsii.Boolean(false),
"exclusively": jsii.Boolean(false),
"force": jsii.Boolean(false),
"ignoreErrors": jsii.Boolean(false),
"json": jsii.Boolean(false),
"lookups": jsii.Boolean(false),
"notices": jsii.Boolean(false),
"output": jsii.String("output"),
"pathMetadata": jsii.Boolean(false),
"profile": jsii.String("profile"),
"proxy": jsii.String("proxy"),
"roleArn": jsii.String("roleArn"),
"stacks": []*string{
jsii.String("stacks"),
},
"staging": jsii.Boolean(false),
"strict": jsii.Boolean(false),
"trace": jsii.Boolean(false),
"verbose": jsii.Boolean(false),
"versionReporting": jsii.Boolean(false),
},
"enabled": jsii.Boolean(false),
"expectedMessage": jsii.String("expectedMessage"),
"expectError": jsii.Boolean(false),
},
},
"diffAssets": jsii.Boolean(false),
"hooks": &Hooks{
"postDeploy": []*string{
jsii.String("postDeploy"),
},
"postDestroy": []*string{
jsii.String("postDestroy"),
},
"preDeploy": []*string{
jsii.String("preDeploy"),
},
"preDestroy": []*string{
jsii.String("preDestroy"),
},
},
"regions": []*string{
jsii.String("regions"),
},
"stackUpdateWorkflow": jsii.Boolean(false),
},
},
Version: jsii.String("version"),
// the properties below are optional
EnableLookups: jsii.Boolean(false),
SynthContext: map[string]*string{
"synthContextKey": jsii.String("synthContext"),
},
}
Properties
enableLookupsoptionalbooleanenable_lookupsoptionalboolenableLookupsoptionalBooleanEnableLookupsoptionalboolEnableLookupsoptional*bool= false#Enable lookups for this test.
If lookups are enabled then stackUpdateWorkflow must be set to false. Lookups should only be enabled when you are explicitly testing lookups.
synthContextoptional{ [key: string]: string }synth_contextoptionaltyping.Mapping[str, str]synthContextoptionalMap<String, String>SynthContextoptionalIDictionary<string, string>SynthContextoptional*map[string]*string#Additional context to use when performing a synth.
Default: no additional context
Any context provided here will override any default context
testCases{ [key: string]: TestCase }test_casestyping.Mapping[str, TestCase]testCasesMap<String, TestCase>TestCasesIDictionary<string, TestCase>TestCases*map[string]TestCaserequired#test cases.
Version of the manifest.