NestedStackProps

class aws_cdk.core.NestedStackProps(*, notification_arns=None, parameters=None, timeout=None)

Bases: object

(experimental) Initialization props for the NestedStack construct.

Parameters
  • notification_arns (Optional[List[str]]) – (experimental) The Simple Notification Service (SNS) topics to publish stack related events. Default: - notifications are not sent for this stack.

  • parameters (Optional[Mapping[str, str]]) – (experimental) The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created. Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter. The nested stack construct will automatically synthesize parameters in order to bind references from the parent stack(s) into the nested stack. Default: - no user-defined parameters are passed to the nested stack

  • timeout (Optional[Duration]) – (experimental) The length of time that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE state. When CloudFormation detects that the nested stack has reached the CREATE_COMPLETE state, it marks the nested stack resource as CREATE_COMPLETE in the parent stack and resumes creating the parent stack. If the timeout period expires before the nested stack reaches CREATE_COMPLETE, CloudFormation marks the nested stack as failed and rolls back both the nested stack and parent stack. Default: - no timeout

Stability

experimental

Attributes

notification_arns

(experimental) The Simple Notification Service (SNS) topics to publish stack related events.

Default
  • notifications are not sent for this stack.

Stability

experimental

Return type

Optional[List[str]]

parameters

(experimental) The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created.

Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter.

The nested stack construct will automatically synthesize parameters in order to bind references from the parent stack(s) into the nested stack.

Default
  • no user-defined parameters are passed to the nested stack

Stability

experimental

Return type

Optional[Mapping[str, str]]

timeout

(experimental) The length of time that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE state.

When CloudFormation detects that the nested stack has reached the CREATE_COMPLETE state, it marks the nested stack resource as CREATE_COMPLETE in the parent stack and resumes creating the parent stack. If the timeout period expires before the nested stack reaches CREATE_COMPLETE, CloudFormation marks the nested stack as failed and rolls back both the nested stack and parent stack.

Default
  • no timeout

Stability

experimental

Return type

Optional[Duration]