SynthesizeStackArtifactOptions

class aws_cdk.core.SynthesizeStackArtifactOptions(*, additional_dependencies=None, assume_role_arn=None, assume_role_external_id=None, bootstrap_stack_version_ssm_parameter=None, cloud_formation_execution_role_arn=None, lookup_role=None, parameters=None, requires_bootstrap_stack_version=None, stack_template_asset_object_url=None)

Bases: object

Stack artifact options.

A subset of cxschema.AwsCloudFormationStackProperties of optional settings that need to be configurable by synthesizers, plus additionalDependencies.

Parameters:

additional_dependencies (Optional[Sequence[str]]) – Identifiers of additional dependencies. Default: - No additional dependencies
assume_role_arn (Optional[str]) – The role that needs to be assumed to deploy the stack. Default: - No role is assumed (current credentials are used)
assume_role_external_id (Optional[str]) – The externalID to use with the assumeRoleArn. Default: - No externalID is used
bootstrap_stack_version_ssm_parameter (Optional[str]) – SSM parameter where the bootstrap stack version number can be found. Only used if requiresBootstrapStackVersion is set. - If this value is not set, the bootstrap stack name must be known at deployment time so the stack version can be looked up from the stack outputs. - If this value is set, the bootstrap stack can have any name because we won’t need to look it up. Default: - Bootstrap stack version number looked up
cloud_formation_execution_role_arn (Optional[str]) – The role that is passed to CloudFormation to execute the change set. Default: - No role is passed (currently assumed role/credentials are used)
lookup_role (Union[BootstrapRole, Dict[str, Any], None]) – The role to use to look up values from the target AWS account. Default: - None
parameters (Optional[Mapping[str, str]]) – Values for CloudFormation stack parameters that should be passed when the stack is deployed. Default: - No parameters
requires_bootstrap_stack_version (Union[int, float, None]) – Version of bootstrap stack required to deploy this stack. Default: - No bootstrap stack required
stack_template_asset_object_url (Optional[str]) – If the stack template has already been included in the asset manifest, its asset URL. Default: - Not uploaded yet, upload just before deploying

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

synthesize_stack_artifact_options = cdk.SynthesizeStackArtifactOptions(
    additional_dependencies=["additionalDependencies"],
    assume_role_arn="assumeRoleArn",
    assume_role_external_id="assumeRoleExternalId",
    bootstrap_stack_version_ssm_parameter="bootstrapStackVersionSsmParameter",
    cloud_formation_execution_role_arn="cloudFormationExecutionRoleArn",
    lookup_role=BootstrapRole(
        arn="arn",

        # the properties below are optional
        assume_role_external_id="assumeRoleExternalId",
        bootstrap_stack_version_ssm_parameter="bootstrapStackVersionSsmParameter",
        requires_bootstrap_stack_version=123
    ),
    parameters={
        "parameters_key": "parameters"
    },
    requires_bootstrap_stack_version=123,
    stack_template_asset_object_url="stackTemplateAssetObjectUrl"
)

Attributes

additional_dependencies

Identifiers of additional dependencies.

Default:

No additional dependencies

assume_role_arn

The role that needs to be assumed to deploy the stack.

Default:

No role is assumed (current credentials are used)

assume_role_external_id

The externalID to use with the assumeRoleArn.

Default:

No externalID is used

bootstrap_stack_version_ssm_parameter

SSM parameter where the bootstrap stack version number can be found.

Only used if requiresBootstrapStackVersion is set.

If this value is not set, the bootstrap stack name must be known at deployment time so the stack version can be looked up from the stack outputs.
If this value is set, the bootstrap stack can have any name because we won’t need to look it up.

Default:

Bootstrap stack version number looked up

cloud_formation_execution_role_arn

The role that is passed to CloudFormation to execute the change set.

Default:

No role is passed (currently assumed role/credentials are used)

lookup_role

The role to use to look up values from the target AWS account.

Default:

None

parameters

Values for CloudFormation stack parameters that should be passed when the stack is deployed.

Default:

No parameters

requires_bootstrap_stack_version

Version of bootstrap stack required to deploy this stack.

Default:

No bootstrap stack required

stack_template_asset_object_url

If the stack template has already been included in the asset manifest, its asset URL.

Default:

Not uploaded yet, upload just before deploying