SynthesisOptions

class aws_cdk.core.SynthesisOptions(*, runtime_info=None, outdir=None, skip_validation=None, validate_on_synthesis=None)

Bases: AssemblyBuildOptions

(deprecated) Options for synthesis.

Parameters:

runtime_info (Union[RuntimeInfo, Dict[str, Any], None]) – (deprecated) Include the specified runtime information (module versions) in manifest. Default: - if this option is not specified, runtime info will not be included
outdir (Optional[str]) – (deprecated) The output directory into which to synthesize the cloud assembly. Default: - creates a temporary directory
skip_validation (Optional[bool]) – (deprecated) Whether synthesis should skip the validation phase. Default: false
validate_on_synthesis (Optional[bool]) – (deprecated) Whether the stack should be validated after synthesis to check for error metadata. Default: - false

Deprecated:

use app.synth() or stage.synth() instead

Stability:

deprecated

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.core as cdk

synthesis_options = cdk.SynthesisOptions(
    outdir="outdir",
    runtime_info=RuntimeInfo(
        libraries={
            "libraries_key": "libraries"
        }
    ),
    skip_validation=False,
    validate_on_synthesis=False
)

Attributes

outdir

(deprecated) The output directory into which to synthesize the cloud assembly.

Default:

creates a temporary directory

Stability:

deprecated

runtime_info

(deprecated) Include the specified runtime information (module versions) in manifest.

Default:

if this option is not specified, runtime info will not be included

Deprecated:

All template modifications that should result from this should have already been inserted into the template.

Stability:: deprecated

skip_validation

(deprecated) Whether synthesis should skip the validation phase.

Default:: false
Stability:: deprecated

validate_on_synthesis

(deprecated) Whether the stack should be validated after synthesis to check for error metadata.

Default:

false

Stability:

deprecated