StackDeploymentProps

class aws_cdk.pipelines.StackDeploymentProps(*, absolute_template_path, construct_path, stack_artifact_id, stack_name, account=None, assets=None, assume_role_arn=None, execution_role_arn=None, region=None, tags=None, template_s3_uri=None)

Bases: object

Properties for a StackDeployment.

Parameters
  • absolute_template_path (str) – Template path on disk to cloud assembly (cdk.out).

  • construct_path (str) – Construct path for this stack.

  • stack_artifact_id (str) – Artifact ID for this stack.

  • stack_name (str) – Name for this stack.

  • account (Optional[str]) – Account where the stack should be deployed. Default: - Pipeline account

  • assets (Optional[Sequence[Union[StackAsset, Dict[str, Any]]]]) – Assets referenced by this stack. Default: - No assets

  • assume_role_arn (Optional[str]) – Role to assume before deploying this stack. Default: - Don’t assume any role

  • execution_role_arn (Optional[str]) – Execution role to pass to CloudFormation. Default: - No execution role

  • region (Optional[str]) – Region where the stack should be deployed. Default: - Pipeline region

  • tags (Optional[Mapping[str, str]]) – Tags to apply to the stack. Default: - No tags

  • template_s3_uri (Optional[str]) – The S3 URL which points to the template asset location in the publishing bucket. Default: - Stack template is not published

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.pipelines as pipelines

stack_deployment_props = pipelines.StackDeploymentProps(
    absolute_template_path="absoluteTemplatePath",
    construct_path="constructPath",
    stack_artifact_id="stackArtifactId",
    stack_name="stackName",

    # the properties below are optional
    account="account",
    assets=[pipelines.StackAsset(
        asset_id="assetId",
        asset_manifest_path="assetManifestPath",
        asset_selector="assetSelector",
        asset_type=pipelines.AssetType.FILE,
        is_template=False,

        # the properties below are optional
        asset_publishing_role_arn="assetPublishingRoleArn"
    )],
    assume_role_arn="assumeRoleArn",
    execution_role_arn="executionRoleArn",
    region="region",
    tags={
        "tags_key": "tags"
    },
    template_s3_uri="templateS3Uri"
)

Attributes

absolute_template_path

Template path on disk to cloud assembly (cdk.out).

Return type

str

account

Account where the stack should be deployed.

Default
  • Pipeline account

Return type

Optional[str]

assets

Assets referenced by this stack.

Default
  • No assets

Return type

Optional[List[StackAsset]]

assume_role_arn

Role to assume before deploying this stack.

Default
  • Don’t assume any role

Return type

Optional[str]

construct_path

Construct path for this stack.

Return type

str

execution_role_arn

Execution role to pass to CloudFormation.

Default
  • No execution role

Return type

Optional[str]

region

Region where the stack should be deployed.

Default
  • Pipeline region

Return type

Optional[str]

stack_artifact_id

Artifact ID for this stack.

Return type

str

stack_name

Name for this stack.

Return type

str

tags

Tags to apply to the stack.

Default
  • No tags

Return type

Optional[Mapping[str, str]]

template_s3_uri

The S3 URL which points to the template asset location in the publishing bucket.

Default
  • Stack template is not published

Return type

Optional[str]