Package software.amazon.awscdk.cfnpropertymixins.services.cloudformation

Class CfnStackPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.cloudformation.CfnStackPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:56.972Z") @Stability(Stable) public class CfnStackPropsMixin extends Mixin implements software.constructs.IMixin
The AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template.

For more information, see Nested stacks in the CloudFormation User Guide .

You can add output values from a nested stack within the containing template. You use the GetAtt function with the nested stack's logical name and the name of the output value in the nested stack in the format Outputs. *NestedStackOutputName* .

We strongly recommend that updates to nested stacks are run from the parent stack.

When you apply template changes to update a top-level stack, CloudFormation updates the top-level stack and initiates an update to its nested stacks. CloudFormation updates the resources of modified nested stacks, but doesn't update the resources of unmodified nested stacks.

For stacks that contain IAM resources, you must acknowledge IAM capabilities. Also, make sure that you have cancel update stack permissions, which are required if an update rolls back. For more information about IAM and CloudFormation , see Controlling access with AWS Identity and Access Management in the CloudFormation User Guide .

A subset of AWS::CloudFormation::Stack resource type properties listed below are available to customers using CloudFormation , AWS CDK , and Cloud Control to configure.

  • NotificationARNs
  • Parameters
  • Tags
  • TemplateURL
  • TimeoutInMinutes

These properties can be configured only when using Cloud Control . This is because the below properties are set by the parent stack, and thus cannot be configured using CloudFormation or AWS CDK but only Cloud Control .

  • Capabilities
  • Description
  • DisableRollback
  • EnableTerminationProtection
  • RoleARN
  • StackName
  • StackPolicyBody
  • StackPolicyURL
  • StackStatusReason
  • TemplateBody

Customers that configure AWS::CloudFormation::Stack using CloudFormation and AWS CDK can do so for nesting a CloudFormation stack as a resource in their top-level template.

These read-only properties can be accessed only when using Cloud Control .

  • ChangeSetId
  • CreationTime
  • LastUpdateTime
  • Outputs
  • ParentId
  • RootId
  • StackId
  • StackStatus

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.cloudformation.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnStackPropsMixin cfnStackPropsMixin = CfnStackPropsMixin.Builder.create(CfnStackMixinProps.builder()
         .notificationArns(List.of("notificationArns"))
         .parameters(Map.of(
                 "parametersKey", "parameters"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .templateUrl("templateUrl")
         .timeoutInMinutes(123)
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CfnStackPropsMixin.Builder
    A fluent builder for CfnStackPropsMixin.
    static interface 
    CfnStackPropsMixin.OutputProperty
    The Output data type.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.constructs.IMixin

    software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final List<String>
    CFN_PROPERTY_KEYS
     

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    CfnStackPropsMixin(CfnStackMixinProps props)
    Create a mixin to apply properties to AWS::CloudFormation::Stack.
     
    CfnStackPropsMixin(CfnStackMixinProps props, CfnPropertyMixinOptions options)
    Create a mixin to apply properties to AWS::CloudFormation::Stack.
    protected
    CfnStackPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    CfnStackPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    applyTo(software.constructs.IConstruct construct)
    Apply the mixin properties to the construct.
    protected CfnStackMixinProps
    getProps()
     
    protected IMergeStrategy
    getStrategy()
     
    Boolean
    supports(software.constructs.IConstruct construct)
    Check if this mixin supports the given construct.

    Methods inherited from class software.amazon.awscdk.Mixin

    isMixin

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnStackPropsMixin

      protected CfnStackPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnStackPropsMixin

      protected CfnStackPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnStackPropsMixin

      @Stability(Stable) public CfnStackPropsMixin(@NotNull CfnStackMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::CloudFormation::Stack.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnStackPropsMixin

      @Stability(Stable) public CfnStackPropsMixin(@NotNull CfnStackMixinProps props)
      Create a mixin to apply properties to AWS::CloudFormation::Stack.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnStackMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()