SynthesizeStackArtifactOptions¶
-
class
aws_cdk.core.
SynthesizeStackArtifactOptions
(*, additional_dependencies=None, assume_role_arn=None, bootstrap_stack_version_ssm_parameter=None, cloud_formation_execution_role_arn=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, plusadditionalDependencies
.- Parameters
additional_dependencies (
Optional
[Sequence
[str
]]) – Identifiers of additional dependencies. Default: - No additional dependenciesassume_role_arn (
Optional
[str
]) – The role that needs to be assumed to deploy the stack. Default: - No role is assumed (current credentials are used)bootstrap_stack_version_ssm_parameter (
Optional
[str
]) – SSM parameter where the bootstrap stack version number can be found. Only used ifrequiresBootstrapStackVersion
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 upcloud_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)parameters (
Optional
[Mapping
[str
,str
]]) – Values for CloudFormation stack parameters that should be passed when the stack is deployed. Default: - No parametersrequires_bootstrap_stack_version (
Union
[int
,float
,None
]) – Version of bootstrap stack required to deploy this stack. Default: - No bootstrap stack requiredstack_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
Attributes
-
additional_dependencies
¶ Identifiers of additional dependencies.
- Default
No additional dependencies
- Return type
Optional
[List
[str
]]
-
assume_role_arn
¶ The role that needs to be assumed to deploy the stack.
- Default
No role is assumed (current credentials are used)
- Return type
Optional
[str
]
-
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
- Return type
Optional
[str
]
-
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)
- Return type
Optional
[str
]
-
parameters
¶ Values for CloudFormation stack parameters that should be passed when the stack is deployed.
- Default
No parameters
- Return type
Optional
[Mapping
[str
,str
]]
-
requires_bootstrap_stack_version
¶ Version of bootstrap stack required to deploy this stack.
- Default
No bootstrap stack required
- Return type
Union
[int
,float
,None
]
-
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
- Return type
Optional
[str
]