aws_cloudformation_stack

account_id

Type: STRING

capabilities

Type: UNORDERED_LIST_STRING
Provider name: Capabilities
Description: The capabilities allowed in the stack.

change_set_id

Type: STRING
Provider name: ChangeSetId
Description: The unique ID of the change set.

creation_time

Type: TIMESTAMP
Provider name: CreationTime
Description: The time at which the stack was created.

deletion_time

Type: TIMESTAMP
Provider name: DeletionTime
Description: The time the stack was deleted.

description

Type: STRING
Provider name: Description
Description: A user-defined description associated with the stack.

detailed_status

Type: STRING
Provider name: DetailedStatus
Description: The detailed status of the resource or stack. If CONFIGURATION_COMPLETE is present, the resource or resource configuration phase has completed and the stabilization of the resources is in progress. The stack sets CONFIGURATION_COMPLETE when all of the resources in the stack have reached that event. For more information, see CloudFormation stack deployment in the CloudFormation User Guide.

disable_rollback

Type: BOOLEAN
Provider name: DisableRollback
Description: Boolean to enable or disable rollback on stack creation failures:

  • true: disable rollback.
  • false: enable rollback.

drift_information

Type: STRUCT
Provider name: DriftInformation
Description: Information about whether a stack’s actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

  • last_check_timestamp
    Type: TIMESTAMP
    Provider name: LastCheckTimestamp
    Description: Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.
  • stack_drift_status
    Type: STRING
    Provider name: StackDriftStatus
    Description: Status of the stack’s actual configuration compared to its expected template configuration.
    • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.
    • NOT_CHECKED: CloudFormation hasn’t checked if the stack differs from its expected template configuration.
    • IN_SYNC: The stack’s actual configuration matches its expected template configuration.
    • UNKNOWN: This value is reserved for future use.

enable_termination_protection

Type: BOOLEAN
Provider name: EnableTerminationProtection
Description: Whether termination protection is enabled for the stack. For nested stacks, termination protection is set on the root stack and can’t be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the CloudFormation User Guide.

last_updated_time

Type: TIMESTAMP
Provider name: LastUpdatedTime
Description: The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

notification_arns

Type: UNORDERED_LIST_STRING
Provider name: NotificationARNs
Description: Amazon SNS topic Amazon Resource Names (ARNs) to which stack related events are published.

outputs

Type: UNORDERED_LIST_STRUCT
Provider name: Outputs
Description: A list of output structures.

  • description
    Type: STRING
    Provider name: Description
    Description: User defined description associated with the output.
  • export_name
    Type: STRING
    Provider name: ExportName
    Description: The name of the export associated with the output.
  • output_key
    Type: STRING
    Provider name: OutputKey
    Description: The key associated with the output.
  • output_value
    Type: STRING
    Provider name: OutputValue
    Description: The value associated with the output.

parameters

Type: UNORDERED_LIST_STRUCT
Provider name: Parameters
Description: A list of Parameter structures.

  • parameter_key
    Type: STRING
    Provider name: ParameterKey
    Description: The key associated with the parameter. If you don’t specify a key and value for a particular parameter, CloudFormation uses the default value that’s specified in your template.
  • parameter_value
    Type: STRING
    Provider name: ParameterValue
    Description: The input value associated with the parameter.
  • resolved_value
    Type: STRING
    Provider name: ResolvedValue
    Description: Read-only. The value that corresponds to a SSM parameter key. This field is returned only for SSM parameter types in the template.
  • use_previous_value
    Type: BOOLEAN
    Provider name: UsePreviousValue
    Description: During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.

parent_id

Type: STRING
Provider name: ParentId
Description: For nested stacks–stacks created as resources for another stack–the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack. For more information, see Working with Nested Stacks in the CloudFormation User Guide.

retain_except_on_create

Type: BOOLEAN
Provider name: RetainExceptOnCreate
Description: When set to true, newly created resources are deleted when the operation rolls back. This includes newly created resources marked with a deletion policy of Retain.
Default: false

role_arn

Type: STRING
Provider name: RoleARN
Description: The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that’s associated with the stack. During a stack operation, CloudFormation uses this role’s credentials to make calls on your behalf.

rollback_configuration

Type: STRUCT
Provider name: RollbackConfiguration
Description: The rollback triggers for CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

  • monitoring_time_in_minutes
    Type: INT32
    Provider name: MonitoringTimeInMinutes
    Description: The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources. The default is 0 minutes. If you specify a monitoring period but don’t specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary. If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.
  • rollback_triggers
    Type: UNORDERED_LIST_STRUCT
    Provider name: RollbackTriggers
    Description: The triggers to monitor during stack creation or update actions. By default, CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:
    • To use the rollback triggers previously specified for this stack, if any, don’t specify this parameter.
    • To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you’ve specified before (for example, when creating the stack or during a previous stack update). Any triggers that you don’t include in the updated list of triggers are no longer applied to the stack.
    • To remove all currently specified triggers, specify an empty list for this parameter.
    If a specified trigger is missing, the entire stack operation fails and is rolled back.
    • arn
      Type: STRING
      Provider name: Arn
      Description: The Amazon Resource Name (ARN) of the rollback trigger. If a specified trigger is missing, the entire stack operation fails and is rolled back.
    • type
      Type: STRING
      Provider name: Type
      Description: The resource type of the rollback trigger. Specify either AWS::CloudWatch::Alarm or AWS::CloudWatch::CompositeAlarm resource types.

root_id

Type: STRING
Provider name: RootId
Description: For nested stacks–stacks created as resources for another stack–the stack ID of the top-level stack to which the nested stack ultimately belongs. For more information, see Working with Nested Stacks in the CloudFormation User Guide.

stack_id

Type: STRING
Provider name: StackId
Description: Unique identifier of the stack.

stack_name

Type: STRING
Provider name: StackName
Description: The name associated with the stack.

stack_status

Type: STRING
Provider name: StackStatus
Description: Current status of the stack.

stack_status_reason

Type: STRING
Provider name: StackStatusReason
Description: Success/failure message associated with the stack status.

tags

Type: UNORDERED_LIST_STRING

timeout_in_minutes

Type: INT32
Provider name: TimeoutInMinutes
Description: The amount of time within which stack creation should complete.