AWS Native is in preview. AWS Classic is fully supported.
aws-native.cloudformation.Stack
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
The AWS::CloudFormation::Stack resource nests a stack as a resource in a top-level template.
Create Stack Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Stack(name: string, args?: StackArgs, opts?: CustomResourceOptions);
@overload
def Stack(resource_name: str,
args: Optional[StackArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Stack(resource_name: str,
opts: Optional[ResourceOptions] = None,
capabilities: Optional[Sequence[StackCapabilitiesItem]] = None,
description: Optional[str] = None,
disable_rollback: Optional[bool] = None,
enable_termination_protection: Optional[bool] = None,
notification_arns: Optional[Sequence[str]] = None,
parameters: Optional[Mapping[str, str]] = None,
role_arn: Optional[str] = None,
stack_name: Optional[str] = None,
stack_policy_body: Optional[Any] = None,
stack_policy_url: Optional[str] = None,
stack_status_reason: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
template_body: Optional[Any] = None,
template_url: Optional[str] = None,
timeout_in_minutes: Optional[int] = None)
func NewStack(ctx *Context, name string, args *StackArgs, opts ...ResourceOption) (*Stack, error)
public Stack(string name, StackArgs? args = null, CustomResourceOptions? opts = null)
type: aws-native:cloudformation:Stack
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args StackArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args StackArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args StackArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args StackArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args StackArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const stackResource = new aws_native.cloudformation.Stack("stackResource", {
capabilities: [aws_native.cloudformation.StackCapabilitiesItem.CapabilityIam],
description: "string",
disableRollback: false,
enableTerminationProtection: false,
notificationArns: ["string"],
parameters: {
string: "string",
},
roleArn: "string",
stackName: "string",
stackPolicyBody: "any",
stackPolicyUrl: "string",
stackStatusReason: "string",
tags: [{
key: "string",
value: "string",
}],
templateBody: "any",
templateUrl: "string",
timeoutInMinutes: 0,
});
Coming soon!
Stack Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Stack resource accepts the following input properties:
- Capabilities
List<Pulumi.
Aws Native. Cloud Formation. Stack Capabilities Item> - Description string
- Disable
Rollback bool - Enable
Termination boolProtection - Notification
Arns List<string> - Parameters Dictionary<string, string>
- Role
Arn string - Stack
Name string - Stack
Policy objectBody - Search the CloudFormation User Guide for
AWS::CloudFormation::Stack
for more information about the expected schema for this property. - Stack
Policy stringUrl - Stack
Status stringReason - List<Pulumi.
Aws Native. Inputs. Tag> - Template
Body object - Search the CloudFormation User Guide for
AWS::CloudFormation::Stack
for more information about the expected schema for this property. - Template
Url string - Timeout
In intMinutes
- Capabilities
[]Stack
Capabilities Item - Description string
- Disable
Rollback bool - Enable
Termination boolProtection - Notification
Arns []string - Parameters map[string]string
- Role
Arn string - Stack
Name string - Stack
Policy interface{}Body - Search the CloudFormation User Guide for
AWS::CloudFormation::Stack
for more information about the expected schema for this property. - Stack
Policy stringUrl - Stack
Status stringReason - Tag
Args - Template
Body interface{} - Search the CloudFormation User Guide for
AWS::CloudFormation::Stack
for more information about the expected schema for this property. - Template
Url string - Timeout
In intMinutes
- capabilities
List<Stack
Capabilities Item> - description String
- disable
Rollback Boolean - enable
Termination BooleanProtection - notification
Arns List<String> - parameters Map<String,String>
- role
Arn String - stack
Name String - stack
Policy ObjectBody - Search the CloudFormation User Guide for
AWS::CloudFormation::Stack
for more information about the expected schema for this property. - stack
Policy StringUrl - stack
Status StringReason - List<Tag>
- template
Body Object - Search the CloudFormation User Guide for
AWS::CloudFormation::Stack
for more information about the expected schema for this property. - template
Url String - timeout
In IntegerMinutes
- capabilities
Stack
Capabilities Item[] - description string
- disable
Rollback boolean - enable
Termination booleanProtection - notification
Arns string[] - parameters {[key: string]: string}
- role
Arn string - stack
Name string - stack
Policy anyBody - Search the CloudFormation User Guide for
AWS::CloudFormation::Stack
for more information about the expected schema for this property. - stack
Policy stringUrl - stack
Status stringReason - Tag[]
- template
Body any - Search the CloudFormation User Guide for
AWS::CloudFormation::Stack
for more information about the expected schema for this property. - template
Url string - timeout
In numberMinutes
- capabilities
Sequence[Stack
Capabilities Item] - description str
- disable_
rollback bool - enable_
termination_ boolprotection - notification_
arns Sequence[str] - parameters Mapping[str, str]
- role_
arn str - stack_
name str - stack_
policy_ Anybody - Search the CloudFormation User Guide for
AWS::CloudFormation::Stack
for more information about the expected schema for this property. - stack_
policy_ strurl - stack_
status_ strreason - Sequence[Tag
Args] - template_
body Any - Search the CloudFormation User Guide for
AWS::CloudFormation::Stack
for more information about the expected schema for this property. - template_
url str - timeout_
in_ intminutes
- capabilities List<"CAPABILITY_IAM" | "CAPABILITY_NAMED_IAM" | "CAPABILITY_AUTO_EXPAND">
- description String
- disable
Rollback Boolean - enable
Termination BooleanProtection - notification
Arns List<String> - parameters Map<String>
- role
Arn String - stack
Name String - stack
Policy AnyBody - Search the CloudFormation User Guide for
AWS::CloudFormation::Stack
for more information about the expected schema for this property. - stack
Policy StringUrl - stack
Status StringReason - List<Property Map>
- template
Body Any - Search the CloudFormation User Guide for
AWS::CloudFormation::Stack
for more information about the expected schema for this property. - template
Url String - timeout
In NumberMinutes
Outputs
All input properties are implicitly available as output properties. Additionally, the Stack resource produces the following output properties:
- Change
Set stringId - Creation
Time string - Id string
- The provider-assigned unique ID for this managed resource.
- Last
Update stringTime - Outputs
List<Pulumi.
Aws Native. Cloud Formation. Outputs. Stack Output> - Parent
Id string - Root
Id string - Stack
Id string - Stack
Status Pulumi.Aws Native. Cloud Formation. Stack Status
- Change
Set stringId - Creation
Time string - Id string
- The provider-assigned unique ID for this managed resource.
- Last
Update stringTime - Outputs
[]Stack
Output Type - Parent
Id string - Root
Id string - Stack
Id string - Stack
Status StackStatus
- change
Set StringId - creation
Time String - id String
- The provider-assigned unique ID for this managed resource.
- last
Update StringTime - outputs
List<Stack
Output> - parent
Id String - root
Id String - stack
Id String - stack
Status StackStatus
- change
Set stringId - creation
Time string - id string
- The provider-assigned unique ID for this managed resource.
- last
Update stringTime - outputs
Stack
Output[] - parent
Id string - root
Id string - stack
Id string - stack
Status StackStatus
- change_
set_ strid - creation_
time str - id str
- The provider-assigned unique ID for this managed resource.
- last_
update_ strtime - outputs
Sequence[Stack
Output] - parent_
id str - root_
id str - stack_
id str - stack_
status StackStatus
- change
Set StringId - creation
Time String - id String
- The provider-assigned unique ID for this managed resource.
- last
Update StringTime - outputs List<Property Map>
- parent
Id String - root
Id String - stack
Id String - stack
Status "CREATE_IN_PROGRESS" | "CREATE_FAILED" | "CREATE_COMPLETE" | "ROLLBACK_IN_PROGRESS" | "ROLLBACK_FAILED" | "ROLLBACK_COMPLETE" | "DELETE_IN_PROGRESS" | "DELETE_FAILED" | "DELETE_COMPLETE" | "UPDATE_IN_PROGRESS" | "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS" | "UPDATE_COMPLETE" | "UPDATE_FAILED" | "UPDATE_ROLLBACK_IN_PROGRESS" | "UPDATE_ROLLBACK_FAILED" | "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS" | "UPDATE_ROLLBACK_COMPLETE" | "REVIEW_IN_PROGRESS" | "IMPORT_IN_PROGRESS" | "IMPORT_COMPLETE" | "IMPORT_ROLLBACK_IN_PROGRESS" | "IMPORT_ROLLBACK_FAILED" | "IMPORT_ROLLBACK_COMPLETE"
Supporting Types
StackCapabilitiesItem, StackCapabilitiesItemArgs
- Capability
Iam - CAPABILITY_IAM
- Capability
Named Iam - CAPABILITY_NAMED_IAM
- Capability
Auto Expand - CAPABILITY_AUTO_EXPAND
- Stack
Capabilities Item Capability Iam - CAPABILITY_IAM
- Stack
Capabilities Item Capability Named Iam - CAPABILITY_NAMED_IAM
- Stack
Capabilities Item Capability Auto Expand - CAPABILITY_AUTO_EXPAND
- Capability
Iam - CAPABILITY_IAM
- Capability
Named Iam - CAPABILITY_NAMED_IAM
- Capability
Auto Expand - CAPABILITY_AUTO_EXPAND
- Capability
Iam - CAPABILITY_IAM
- Capability
Named Iam - CAPABILITY_NAMED_IAM
- Capability
Auto Expand - CAPABILITY_AUTO_EXPAND
- CAPABILITY_IAM
- CAPABILITY_IAM
- CAPABILITY_NAMED_IAM
- CAPABILITY_NAMED_IAM
- CAPABILITY_AUTO_EXPAND
- CAPABILITY_AUTO_EXPAND
- "CAPABILITY_IAM"
- CAPABILITY_IAM
- "CAPABILITY_NAMED_IAM"
- CAPABILITY_NAMED_IAM
- "CAPABILITY_AUTO_EXPAND"
- CAPABILITY_AUTO_EXPAND
StackOutput, StackOutputArgs
- Description string
- Export
Name string - Output
Key string - Output
Value string
- Description string
- Export
Name string - Output
Key string - Output
Value string
- description String
- export
Name String - output
Key String - output
Value String
- description string
- export
Name string - output
Key string - output
Value string
- description str
- export_
name str - output_
key str - output_
value str
- description String
- export
Name String - output
Key String - output
Value String
StackStatus, StackStatusArgs
- Create
In Progress - CREATE_IN_PROGRESS
- Create
Failed - CREATE_FAILED
- Create
Complete - CREATE_COMPLETE
- Rollback
In Progress - ROLLBACK_IN_PROGRESS
- Rollback
Failed - ROLLBACK_FAILED
- Rollback
Complete - ROLLBACK_COMPLETE
- Delete
In Progress - DELETE_IN_PROGRESS
- Delete
Failed - DELETE_FAILED
- Delete
Complete - DELETE_COMPLETE
- Update
In Progress - UPDATE_IN_PROGRESS
- Update
Complete Cleanup In Progress - UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
- Update
Complete - UPDATE_COMPLETE
- Update
Failed - UPDATE_FAILED
- Update
Rollback In Progress - UPDATE_ROLLBACK_IN_PROGRESS
- Update
Rollback Failed - UPDATE_ROLLBACK_FAILED
- Update
Rollback Complete Cleanup In Progress - UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS
- Update
Rollback Complete - UPDATE_ROLLBACK_COMPLETE
- Review
In Progress - REVIEW_IN_PROGRESS
- Import
In Progress - IMPORT_IN_PROGRESS
- Import
Complete - IMPORT_COMPLETE
- Import
Rollback In Progress - IMPORT_ROLLBACK_IN_PROGRESS
- Import
Rollback Failed - IMPORT_ROLLBACK_FAILED
- Import
Rollback Complete - IMPORT_ROLLBACK_COMPLETE
- Stack
Status Create In Progress - CREATE_IN_PROGRESS
- Stack
Status Create Failed - CREATE_FAILED
- Stack
Status Create Complete - CREATE_COMPLETE
- Stack
Status Rollback In Progress - ROLLBACK_IN_PROGRESS
- Stack
Status Rollback Failed - ROLLBACK_FAILED
- Stack
Status Rollback Complete - ROLLBACK_COMPLETE
- Stack
Status Delete In Progress - DELETE_IN_PROGRESS
- Stack
Status Delete Failed - DELETE_FAILED
- Stack
Status Delete Complete - DELETE_COMPLETE
- Stack
Status Update In Progress - UPDATE_IN_PROGRESS
- Stack
Status Update Complete Cleanup In Progress - UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
- Stack
Status Update Complete - UPDATE_COMPLETE
- Stack
Status Update Failed - UPDATE_FAILED
- Stack
Status Update Rollback In Progress - UPDATE_ROLLBACK_IN_PROGRESS
- Stack
Status Update Rollback Failed - UPDATE_ROLLBACK_FAILED
- Stack
Status Update Rollback Complete Cleanup In Progress - UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS
- Stack
Status Update Rollback Complete - UPDATE_ROLLBACK_COMPLETE
- Stack
Status Review In Progress - REVIEW_IN_PROGRESS
- Stack
Status Import In Progress - IMPORT_IN_PROGRESS
- Stack
Status Import Complete - IMPORT_COMPLETE
- Stack
Status Import Rollback In Progress - IMPORT_ROLLBACK_IN_PROGRESS
- Stack
Status Import Rollback Failed - IMPORT_ROLLBACK_FAILED
- Stack
Status Import Rollback Complete - IMPORT_ROLLBACK_COMPLETE
- Create
In Progress - CREATE_IN_PROGRESS
- Create
Failed - CREATE_FAILED
- Create
Complete - CREATE_COMPLETE
- Rollback
In Progress - ROLLBACK_IN_PROGRESS
- Rollback
Failed - ROLLBACK_FAILED
- Rollback
Complete - ROLLBACK_COMPLETE
- Delete
In Progress - DELETE_IN_PROGRESS
- Delete
Failed - DELETE_FAILED
- Delete
Complete - DELETE_COMPLETE
- Update
In Progress - UPDATE_IN_PROGRESS
- Update
Complete Cleanup In Progress - UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
- Update
Complete - UPDATE_COMPLETE
- Update
Failed - UPDATE_FAILED
- Update
Rollback In Progress - UPDATE_ROLLBACK_IN_PROGRESS
- Update
Rollback Failed - UPDATE_ROLLBACK_FAILED
- Update
Rollback Complete Cleanup In Progress - UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS
- Update
Rollback Complete - UPDATE_ROLLBACK_COMPLETE
- Review
In Progress - REVIEW_IN_PROGRESS
- Import
In Progress - IMPORT_IN_PROGRESS
- Import
Complete - IMPORT_COMPLETE
- Import
Rollback In Progress - IMPORT_ROLLBACK_IN_PROGRESS
- Import
Rollback Failed - IMPORT_ROLLBACK_FAILED
- Import
Rollback Complete - IMPORT_ROLLBACK_COMPLETE
- Create
In Progress - CREATE_IN_PROGRESS
- Create
Failed - CREATE_FAILED
- Create
Complete - CREATE_COMPLETE
- Rollback
In Progress - ROLLBACK_IN_PROGRESS
- Rollback
Failed - ROLLBACK_FAILED
- Rollback
Complete - ROLLBACK_COMPLETE
- Delete
In Progress - DELETE_IN_PROGRESS
- Delete
Failed - DELETE_FAILED
- Delete
Complete - DELETE_COMPLETE
- Update
In Progress - UPDATE_IN_PROGRESS
- Update
Complete Cleanup In Progress - UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
- Update
Complete - UPDATE_COMPLETE
- Update
Failed - UPDATE_FAILED
- Update
Rollback In Progress - UPDATE_ROLLBACK_IN_PROGRESS
- Update
Rollback Failed - UPDATE_ROLLBACK_FAILED
- Update
Rollback Complete Cleanup In Progress - UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS
- Update
Rollback Complete - UPDATE_ROLLBACK_COMPLETE
- Review
In Progress - REVIEW_IN_PROGRESS
- Import
In Progress - IMPORT_IN_PROGRESS
- Import
Complete - IMPORT_COMPLETE
- Import
Rollback In Progress - IMPORT_ROLLBACK_IN_PROGRESS
- Import
Rollback Failed - IMPORT_ROLLBACK_FAILED
- Import
Rollback Complete - IMPORT_ROLLBACK_COMPLETE
- CREATE_IN_PROGRESS
- CREATE_IN_PROGRESS
- CREATE_FAILED
- CREATE_FAILED
- CREATE_COMPLETE
- CREATE_COMPLETE
- ROLLBACK_IN_PROGRESS
- ROLLBACK_IN_PROGRESS
- ROLLBACK_FAILED
- ROLLBACK_FAILED
- ROLLBACK_COMPLETE
- ROLLBACK_COMPLETE
- DELETE_IN_PROGRESS
- DELETE_IN_PROGRESS
- DELETE_FAILED
- DELETE_FAILED
- DELETE_COMPLETE
- DELETE_COMPLETE
- UPDATE_IN_PROGRESS
- UPDATE_IN_PROGRESS
- UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
- UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
- UPDATE_COMPLETE
- UPDATE_COMPLETE
- UPDATE_FAILED
- UPDATE_FAILED
- UPDATE_ROLLBACK_IN_PROGRESS
- UPDATE_ROLLBACK_IN_PROGRESS
- UPDATE_ROLLBACK_FAILED
- UPDATE_ROLLBACK_FAILED
- UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS
- UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS
- UPDATE_ROLLBACK_COMPLETE
- UPDATE_ROLLBACK_COMPLETE
- REVIEW_IN_PROGRESS
- REVIEW_IN_PROGRESS
- IMPORT_IN_PROGRESS
- IMPORT_IN_PROGRESS
- IMPORT_COMPLETE
- IMPORT_COMPLETE
- IMPORT_ROLLBACK_IN_PROGRESS
- IMPORT_ROLLBACK_IN_PROGRESS
- IMPORT_ROLLBACK_FAILED
- IMPORT_ROLLBACK_FAILED
- IMPORT_ROLLBACK_COMPLETE
- IMPORT_ROLLBACK_COMPLETE
- "CREATE_IN_PROGRESS"
- CREATE_IN_PROGRESS
- "CREATE_FAILED"
- CREATE_FAILED
- "CREATE_COMPLETE"
- CREATE_COMPLETE
- "ROLLBACK_IN_PROGRESS"
- ROLLBACK_IN_PROGRESS
- "ROLLBACK_FAILED"
- ROLLBACK_FAILED
- "ROLLBACK_COMPLETE"
- ROLLBACK_COMPLETE
- "DELETE_IN_PROGRESS"
- DELETE_IN_PROGRESS
- "DELETE_FAILED"
- DELETE_FAILED
- "DELETE_COMPLETE"
- DELETE_COMPLETE
- "UPDATE_IN_PROGRESS"
- UPDATE_IN_PROGRESS
- "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS"
- UPDATE_COMPLETE_CLEANUP_IN_PROGRESS
- "UPDATE_COMPLETE"
- UPDATE_COMPLETE
- "UPDATE_FAILED"
- UPDATE_FAILED
- "UPDATE_ROLLBACK_IN_PROGRESS"
- UPDATE_ROLLBACK_IN_PROGRESS
- "UPDATE_ROLLBACK_FAILED"
- UPDATE_ROLLBACK_FAILED
- "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"
- UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS
- "UPDATE_ROLLBACK_COMPLETE"
- UPDATE_ROLLBACK_COMPLETE
- "REVIEW_IN_PROGRESS"
- REVIEW_IN_PROGRESS
- "IMPORT_IN_PROGRESS"
- IMPORT_IN_PROGRESS
- "IMPORT_COMPLETE"
- IMPORT_COMPLETE
- "IMPORT_ROLLBACK_IN_PROGRESS"
- IMPORT_ROLLBACK_IN_PROGRESS
- "IMPORT_ROLLBACK_FAILED"
- IMPORT_ROLLBACK_FAILED
- "IMPORT_ROLLBACK_COMPLETE"
- IMPORT_ROLLBACK_COMPLETE
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.