Skip to content

Experimental

Warning

This submodule is subject to non-backward compatible changes or removal in any future version. Breaking changes will be announced in the release notes, however will result in a minor version bump only.

Whilst you may use this package, you may need to update your source code when upgrading to a newer version.

API Reference

Structs

CdkGraphThreatComposerPluginOptions

Options for the Threat Composer CDK Graph plugin.

Initializer 

import aws.pdk.cdk_graph_plugin_threat_composer

aws.pdk.cdk_graph_plugin_threat_composer.CdkGraphThreatComposerPluginOptions(
  application_details: ThreatComposerApplicationDetails = None
)

Properties

Name Type Description
application_details ThreatComposerApplicationDetails Details about the application to include in the threat model.
application_detailsOptional 
application_details: ThreatComposerApplicationDetails

Details about the application to include in the threat model.

ThreatComposerApplicationDetails

Details about the application to include in the threat model.

Initializer 

import aws.pdk.cdk_graph_plugin_threat_composer

aws.pdk.cdk_graph_plugin_threat_composer.ThreatComposerApplicationDetails(
  description: str = None,
  name: str = None
)

Properties

Name Type Description
description str A description of the application.
name str The name of the application.
descriptionOptional 
description: str
  • Type: str

A description of the application.

nameOptional 
name: str
  • Type: str
  • Default: "My Application"

The name of the application.

Classes

CdkGraphThreatComposerPlugin

  • Implements: aws.pdk.cdk_graph_plugin_threat_composer.ICdkGraphPlugin

CdkGraphThreatComposerPlugin is a {@link ICdkGraphPluginCdkGraph Plugin} implementation for generating Threat Composer threat models.

awslabs/threat-composer

Initializers 

import aws.pdk.cdk_graph_plugin_threat_composer

aws.pdk.cdk_graph_plugin_threat_composer.CdkGraphThreatComposerPlugin(
  application_details: ThreatComposerApplicationDetails = None
)
Name Type Description
application_details ThreatComposerApplicationDetails Details about the application to include in the threat model.
application_detailsOptional

Details about the application to include in the threat model.

Properties

Name Type Description
id str Unique identifier for this plugin.
version str Plugin version.
dependencies typing.List[str] List of plugins this plugin depends on, including optional semver version (eg: ["foo", "bar@1.2"]).
threat_model_artifact aws.pdk.cdk_graph_plugin_threat_composer.CdkGraphArtifact Retrieve the threat model artifact.
bind aws.pdk.cdk_graph_plugin_threat_composer.IGraphPluginBindCallback Binds the plugin to the CdkGraph instance.
report aws.pdk.cdk_graph_plugin_threat_composer.IGraphReportCallback Generate asynchronous reports based on the graph.
idRequired 
id: str
  • Type: str

Unique identifier for this plugin.

versionRequired 
version: str
  • Type: str

Plugin version.

dependenciesOptional 
dependencies: typing.List[str]
  • Type: typing.List[str]

List of plugins this plugin depends on, including optional semver version (eg: ["foo", "bar@1.2"]).

threat_model_artifactOptional 
threat_model_artifact: CdkGraphArtifact
  • Type: aws.pdk.cdk_graph_plugin_threat_composer.CdkGraphArtifact

Retrieve the threat model artifact.

bindRequired 
bind: IGraphPluginBindCallback
  • Type: aws.pdk.cdk_graph_plugin_threat_composer.IGraphPluginBindCallback

Binds the plugin to the CdkGraph instance.

Enables plugins to receive base configs.

reportOptional 
report: IGraphReportCallback
  • Type: aws.pdk.cdk_graph_plugin_threat_composer.IGraphReportCallback

Generate asynchronous reports based on the graph.

This is not automatically called when synthesizing CDK. Developer must explicitly add await graphInstance.report() to the CDK bin or invoke this outside of the CDK synth. In either case, the plugin receives the in-memory graph interface when invoked, as the CdkGraph will deserialize the graph prior to invoking the plugin report.

Constants

Name Type Description
ID str Fixed ID of the threat-composer plugin.
VERSION str Curent semantic version of the threat-composer plugin.
IDRequired 
ID: str
  • Type: str

Fixed ID of the threat-composer plugin.

VERSIONRequired 
VERSION: str
  • Type: str

Curent semantic version of the threat-composer plugin.

Last update: 2024-11-17