IntegManifest

class aws_cdk.cloud_assembly_schema.IntegManifest(*, test_cases, version, enable_lookups=None, synth_context=None)

Bases: object

Definitions for the integration testing manifest.

Parameters:
  • test_cases (Mapping[str, Union[TestCase, Dict[str, Any]]]) – test cases.

  • version (str) – Version of the manifest.

  • enable_lookups (Optional[bool]) – 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

  • synth_context (Optional[Mapping[str, str]]) – Additional context to use when performing a synth. Any context provided here will override any default context Default: - no additional context

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.cloud_assembly_schema as cloud_assembly_schema

integ_manifest = cloud_assembly_schema.IntegManifest(
    test_cases={
        "test_cases_key": cloud_assembly_schema.TestCase(
            stacks=["stacks"],

            # the properties below are optional
            allow_destroy=["allowDestroy"],
            assertion_stack="assertionStack",
            cdk_command_options=cloud_assembly_schema.CdkCommands(
                deploy=cloud_assembly_schema.DeployCommand(
                    args=cloud_assembly_schema.DeployOptions(
                        all=False,
                        app="app",
                        asset_metadata=False,
                        ca_bundle_path="caBundlePath",
                        change_set_name="changeSetName",
                        ci=False,
                        color=False,
                        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=cloud_assembly_schema.DestroyCommand(
                    args=cloud_assembly_schema.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=cloud_assembly_schema.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"
    }
)

Attributes

enable_lookups

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

synth_context

Additional context to use when performing a synth.

Any context provided here will override any default context

Default:
  • no additional context

test_cases

test cases.

version

Version of the manifest.