interface IntegManifest

Language	Type name
.NET	Amazon.CDK.cloud_assembly_schema.IntegManifest
Go	github.com/aws/aws-cdk-go/awscdk/v2/cloudassemblyschema#IntegManifest
Java	software.amazon.awscdk.cloud_assembly_schema.IntegManifest
Python	aws_cdk.cloud_assembly_schema.IntegManifest
TypeScript (source)	aws-cdk-lib » cloud_assembly_schema » IntegManifest

Obtainable from Manifest.loadIntegManifest()

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 { cloud_assembly_schema } from 'aws-cdk-lib';
const integManifest: cloud_assembly_schema.IntegManifest = {
  testCases: {
    testCasesKey: {
      stacks: ['stacks'],

      // the properties below are optional
      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',
  },
};

Properties

Name	Type	Description
testCases	{ [string]: TestCase }	test cases.
version	string	Version of the manifest.
enableLookups?	boolean	Enable lookups for this test.
synthContext?	{ [string]: string }	Additional context to use when performing a synth.

---

testCases

Type: { [string]: TestCase }

test cases.

---

version

Type: string

Version of the manifest.

---

enableLookups?

Type: boolean (optional, default: 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 explicitely testing lookups.

---

synthContext?

Type: { [string]: string } (optional, default: no additional context)

Additional context to use when performing a synth.

Any context provided here will override any default context