String stackName
The name or the unique stack ID that is associated with the stack.
String type
The type of entity that AWS CloudFormation changes. Currently, the only
entity type is Resource.
ResourceChange resourceChange
A ResourceChange structure that describes the resource and
action that AWS CloudFormation will perform.
String stackId
The ID of the stack with which the change set is associated.
String stackName
The name of the stack with which the change set is associated.
String changeSetId
The ID of the change set.
String changeSetName
The name of the change set.
String status
The state of the change set, such as CREATE_IN_PROGRESS,
CREATE_COMPLETE, or FAILED.
String statusReason
A description of the change set's status. For example, if your change set
is in the FAILED state, AWS CloudFormation shows the error
message.
Date creationTime
The start time when the change set was created, in UTC.
String description
Descriptive information about the change set.
String stackName
The name or the unique ID of the stack that you want to continue rolling back.
String stackName
The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.
String templateBody
A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified.
Conditional: You must specify only TemplateBody or
TemplateURL.
String templateURL
The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.
Conditional: You must specify only TemplateBody or
TemplateURL.
Boolean usePreviousTemplate
Whether to reuse the template that is associated with the stack to create the change set.
com.amazonaws.internal.SdkInternalList<T> parameters
A list of Parameter structures that specify input parameters
for the change set. For more information, see the Parameter data type.
com.amazonaws.internal.SdkInternalList<T> capabilities
A list of capabilities that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.
Currently, the only valid value is CAPABILITY_IAM, which is
required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains
these resources, we recommend that you review all permissions associated
with them and edit their permissions if necessary. If your template
contains any of the listed resources and you don't specify this
parameter, this action returns an InsufficientCapabilities
error.
com.amazonaws.internal.SdkInternalList<T> resourceTypes
The template resource types that you have permissions to work with if you
execute this change set, such as AWS::EC2::Instance,
AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.
com.amazonaws.internal.SdkInternalList<T> notificationARNs
The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.
com.amazonaws.internal.SdkInternalList<T> tags
Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 10 tags.
String changeSetName
The name of the change set. The name must be unique among all change sets that are associated with the specified stack.
A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.
String clientToken
A unique identifier for this CreateChangeSet request.
Specify this token if you plan to retry requests so that AWS
CloudFormation knows that you're not attempting to create another change
set with the same name. You might retry CreateChangeSet
requests to ensure that AWS CloudFormation successfully received them.
String description
A description to help you identify this change set.
String id
The Amazon Resource Name (ARN) of the change set.
String stackName
The name that is associated with the stack. The name must be unique in the region in which you are creating the stack.
String templateBody
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the
TemplateURL parameter, but not both.
String templateURL
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the
TemplateURL parameter, but not both.
com.amazonaws.internal.SdkInternalList<T> parameters
A list of Parameter structures that specify input parameters
for the stack. For more information, see the Parameter data type.
Boolean disableRollback
Set to true to disable rollback of the stack if stack
creation failed. You can specify either DisableRollback or
OnFailure, but not both.
Default: false
Integer timeoutInMinutes
The amount of time that can pass before the stack status becomes
CREATE_FAILED; if DisableRollback is not set or is set to
false, the stack will be rolled back.
com.amazonaws.internal.SdkInternalList<T> notificationARNs
The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).
com.amazonaws.internal.SdkInternalList<T> capabilities
A list of capabilities that you must specify before AWS CloudFormation can create certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.
Currently, the only valid value is CAPABILITY_IAM, which is
required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains
these resources, we recommend that you review all permissions associated
with them and edit their permissions if necessary. If your template
contains any of the listed resources and you don't specify this
parameter, this action returns an InsufficientCapabilities
error.
com.amazonaws.internal.SdkInternalList<T> resourceTypes
The template resource types that you have permissions to work with for
this create stack action, such as AWS::EC2::Instance,
AWS::EC2::*, or Custom::MyCustomInstance. Use
the following syntax to describe template resource types:
AWS::* (for all AWS resource), Custom::* (for
all custom resources), Custom::logical_ID (for a
specific custom resource), AWS::service_name::* (for
all resources of a particular AWS service), and
AWS::service_name::resource_logical_ID (for a
specific AWS resource).
If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
String onFailure
Determines what action will be taken if stack creation fails. This must
be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either
OnFailure or DisableRollback, but not both.
Default: ROLLBACK
String stackPolicyBody
Structure containing the stack policy body. For more information, go to
Prevent Updates to Stack Resources in the AWS CloudFormation User
Guide. You can specify either the StackPolicyBody or the
StackPolicyURL parameter, but not both.
String stackPolicyURL
Location of a file containing the stack policy. The URL must point to a
policy (max size: 16KB) located in an S3 bucket in the same region as the
stack. You can specify either the StackPolicyBody or the
StackPolicyURL parameter, but not both.
com.amazonaws.internal.SdkInternalList<T> tags
Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 10 tags can be specified.
String stackId
Unique identifier of the stack.
String stackName
The name or the unique stack ID that is associated with the stack.
com.amazonaws.internal.SdkInternalList<T> retainResources
For stacks in the DELETE_FAILED state, a list of resource
logical IDs that are associated with the resources you want to retain.
During deletion, AWS CloudFormation deletes the stack but does not delete
the retained resources.
Retaining resources is useful when you cannot delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.
String nextToken
A string that identifies the next page of limits that you want to retrieve.
com.amazonaws.internal.SdkInternalList<T> accountLimits
An account limit structure that contain a list of AWS CloudFormation account limits and their values.
String nextToken
If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page exists, this value is null.
String changeSetName
The name or Amazon Resource Name (ARN) of the change set that you want to describe.
String stackName
If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.
String nextToken
A string (provided by the DescribeChangeSet response output) that identifies the next page of information that you want to retrieve.
String changeSetName
The name of the change set.
String changeSetId
The ARN of the change set.
String stackId
The ARN of the stack that is associated with the change set.
String stackName
The name of the stack that is associated with the change set.
String description
Information about the change set.
com.amazonaws.internal.SdkInternalList<T> parameters
A list of Parameter structures that describes the input
parameters and their values used to create the change set. For more
information, see the Parameter data type.
Date creationTime
The start time when the change set was created, in UTC.
String status
The current status of the change set, such as
CREATE_IN_PROGRESS, CREATE_COMPLETE, or
FAILED.
String statusReason
A description of the change set's status. For example, if your attempt to create a change set failed, AWS CloudFormation shows the error message.
com.amazonaws.internal.SdkInternalList<T> notificationARNs
The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
com.amazonaws.internal.SdkInternalList<T> capabilities
If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
com.amazonaws.internal.SdkInternalList<T> tags
If you execute the change set, the tags that will be associated with the stack.
com.amazonaws.internal.SdkInternalList<T> changes
A list of Change structures that describes the resources AWS
CloudFormation changes if you execute the change set.
String nextToken
If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.
String stackName
The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Default: There is no default value.
String nextToken
A string that identifies the next page of events that you want to retrieve.
com.amazonaws.internal.SdkInternalList<T> stackEvents
A list of StackEvents structures.
String nextToken
If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page exists, this value is null.
String stackName
The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Default: There is no default value.
String logicalResourceId
The logical name of the resource as specified in the template.
Default: There is no default value.
StackResourceDetail stackResourceDetail
A StackResourceDetail structure containing the description
of the specified resource in the specified stack.
String stackName
The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Default: There is no default value.
Required: Conditional. If you do not specify StackName, you
must specify PhysicalResourceId.
String logicalResourceId
The logical name of the resource as specified in the template.
Default: There is no default value.
String physicalResourceId
The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
For example, for an Amazon Elastic Compute Cloud (EC2) instance,
PhysicalResourceId corresponds to the
InstanceId. You can pass the EC2 InstanceId to
DescribeStackResources to find which stack the instance
belongs to and what other resources are part of the stack.
Required: Conditional. If you do not specify
PhysicalResourceId, you must specify StackName.
Default: There is no default value.
com.amazonaws.internal.SdkInternalList<T> stackResources
A list of StackResource structures.
String stackName
The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Default: There is no default value.
String nextToken
A string that identifies the next page of stacks that you want to retrieve.
com.amazonaws.internal.SdkInternalList<T> stacks
A list of stack structures.
String nextToken
If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.
String templateBody
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)
Conditional: You must pass TemplateBody or
TemplateURL. If both are passed, only
TemplateBody is used.
String templateURL
Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must pass TemplateURL or
TemplateBody. If both are passed, only
TemplateBody is used.
com.amazonaws.internal.SdkInternalList<T> parameters
A list of Parameter structures that specify input
parameters.
String url
An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
String stackName
The name or unique stack ID that is associated with the stack whose policy you want to get.
String stackPolicyBody
Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide.)
String stackName
The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Default: There is no default value.
String templateBody
Structure containing the template body. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)
String templateBody
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify only one of the following parameters:
StackName, TemplateBody, or
TemplateURL.
String templateURL
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify only one of the following parameters:
StackName, TemplateBody, or
TemplateURL.
String stackName
The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.
Conditional: You must specify only one of the following parameters:
StackName, TemplateBody, or
TemplateURL.
com.amazonaws.internal.SdkInternalList<T> parameters
A list of parameter declarations that describe various properties for each parameter.
String description
The value that is defined in the Description property of the
template.
com.amazonaws.internal.SdkInternalList<T> capabilities
The capabilities found within the template. Currently, AWS CloudFormation supports only the CAPABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.
String capabilitiesReason
The list of resources that generated the values in the
Capabilities response element.
com.amazonaws.internal.SdkInternalList<T> resourceTypes
A list of all the template resource types that are defined in the
template, such as AWS::EC2::Instance,
AWS::Dynamo::Table, and
Custom::MyCustomInstance.
String version
The AWS template format version, which identifies the capabilities of the template.
String metadata
The value that is defined for the Metadata property of the
template.
String stackName
The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.
String nextToken
A string (provided by the ListChangeSets response output) that identifies the next page of change sets that you want to retrieve.
com.amazonaws.internal.SdkInternalList<T> summaries
A list of ChangeSetSummary structures that provides the ID
and status of each change set for the specified stack.
String nextToken
If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional page, this value is null.
String stackName
The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
Default: There is no default value.
String nextToken
A string that identifies the next page of stack resources that you want to retrieve.
com.amazonaws.internal.SdkInternalList<T> stackResourceSummaries
A list of StackResourceSummary structures.
String nextToken
If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page exists, this value is null.
String nextToken
A string that identifies the next page of stacks that you want to retrieve.
com.amazonaws.internal.SdkInternalList<T> stackStatusFilters
Stack status to use as a filter. Specify one or more stack status codes
to list only stacks with the specified status codes. For a complete list
of stack status codes, see the StackStatus parameter of the
Stack data type.
com.amazonaws.internal.SdkInternalList<T> stackSummaries
A list of StackSummary structures containing information
about the specified stacks.
String nextToken
If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.
String parameterKey
The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.
String parameterValue
The value associated with the parameter.
Boolean usePreviousValue
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.
com.amazonaws.internal.SdkInternalList<T> allowedValues
A list of values that are permitted for a parameter.
String parameterKey
The name that is associated with the parameter.
String defaultValue
The default value of the parameter.
String parameterType
The type of parameter.
Boolean noEcho
Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console.
String description
The description that is associate with the parameter.
ParameterConstraints parameterConstraints
The criteria that AWS CloudFormation uses to validate parameter values.
String action
The action that AWS CloudFormation takes on the resource, such as
Add (adds a new resource), Modify (changes a
resource), or Remove (deletes a resource).
String logicalResourceId
The resource's logical ID, which is defined in the stack's template.
String physicalResourceId
The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.
String resourceType
The type of AWS CloudFormation resource, such as
AWS::S3::Bucket.
String replacement
For the Modify action, indicates whether AWS CloudFormation
will replace the resource by creating a new one and deleting the old one.
This value depends on the value of the RequiresRecreation
property in the ResourceTargetDefinition structure. For
example, if the RequiresRecreation field is
Always and the Evaluation field is
Static, Replacement is True. If
the RequiresRecreation field is Always and the
Evaluation field is Dynamic,
Replacement is Conditionally.
If you have multiple changes with different
RequiresRecreation values, the Replacement
value depends on the change with the most impact. A
RequiresRecreation value of Always has the most
impact, followed by Conditionally, and then
Never.
com.amazonaws.internal.SdkInternalList<T> scope
For the Modify action, indicates which resource attribute is
triggering this update, such as a change in the resource attribute's
Metadata, Properties, or Tags.
com.amazonaws.internal.SdkInternalList<T> details
For the Modify action, a list of
ResourceChangeDetail structures that describes the changes
that AWS CloudFormation will make to the resource.
ResourceTargetDefinition target
A ResourceTargetDefinition structure that describes the
field that AWS CloudFormation will change and whether the resource will
be recreated.
String evaluation
Indicates whether AWS CloudFormation can determine the target value, and whether the target value will change before you execute a change set.
For Static evaluations, AWS CloudFormation can determine
that the target value will change, and its value. For example, if you
directly modify the InstanceType property of an EC2
instance, AWS CloudFormation knows that this property value will change,
and its value, so this is a Static evaluation.
For Dynamic evaluations, cannot determine the target value
because it depends on the result of an intrinsic function, such as a
Ref or Fn::GetAtt intrinsic function, when the
stack is updated. For example, if your template includes a reference to a
resource that is conditionally recreated, the value of the reference (the
physical ID of the resource) might change, depending on if the resource
is recreated. If the resource is recreated, it will have a new physical
ID, so all references to that resource will also be updated.
String changeSource
The group to which the CausingEntity value belongs. There
are five entity groups:
ResourceReference entities are Ref
intrinsic functions that refer to resources in the template, such as
{ "Ref" : "MyEC2InstanceResource" }.ParameterReference entities are Ref
intrinsic functions that get template parameter values, such as
{ "Ref" : "MyPasswordParameter" }.ResourceAttribute entities are Fn::GetAtt
intrinsic functions that get resource attribute values, such as
{ "Fn::GetAtt" : [ "MyEC2InstanceResource", "PublicDnsName" ] }
.DirectModification entities are changes that are made
directly to the template.Automatic entities are
AWS::CloudFormation::Stack resource types, which are also
known as nested stacks. If you made no changes to the
AWS::CloudFormation::Stack resource, AWS CloudFormation sets
the ChangeSource to Automatic because the
nested stack's template might have changed. Changes to a nested stack's
template aren't visible to AWS CloudFormation until you run an update on
the parent stack.String causingEntity
The identity of the entity that triggered this change. This entity is a
member of the group that is specified by the ChangeSource
field. For example, if you modified the value of the
KeyPairName parameter, the CausingEntity is the
name of the parameter (KeyPairName).
If the ChangeSource value is DirectModification
, no value is given for CausingEntity.
String attribute
Indicates which resource attribute is triggering this update, such as a
change in the resource attribute's Metadata,
Properties, or Tags.
String name
If the Attribute value is Properties, the name
of the property. For all other attributes, the value is null.
String requiresRecreation
If the Attribute value is Properties, indicates
whether a change to this property causes the resource to be recreated.
The value can be Never, Always, or
Conditionally. To determine the conditions for a
Conditionally recreation, see the update behavior for that
property in the AWS CloudFormation User Guide.
String stackName
The name or unique stack ID that you want to associate a policy with.
String stackPolicyBody
Structure containing the stack policy body. For more information, go to
Prevent Updates to Stack Resources in the AWS CloudFormation User
Guide. You can specify either the StackPolicyBody or the
StackPolicyURL parameter, but not both.
String stackPolicyURL
Location of a file containing the stack policy. The URL must point to a
policy (maximum size: 16 KB) located in an S3 bucket in the same region
as the stack. You can specify either the StackPolicyBody or
the StackPolicyURL parameter, but not both.
String stackName
The stack name or unique stack ID that includes the resource that you want to signal.
String logicalResourceId
The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.
String uniqueId
A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.
String status
The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update.
String stackId
Unique identifier of the stack.
String stackName
The name associated with the stack.
String description
A user-defined description associated with the stack.
com.amazonaws.internal.SdkInternalList<T> parameters
A list of Parameter structures.
Date creationTime
The time at which the stack was created.
Date lastUpdatedTime
The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
String stackStatus
Current status of the stack.
String stackStatusReason
Success/failure message associated with the stack status.
Boolean disableRollback
Boolean to enable or disable rollback on stack creation failures:
true: disable rollbackfalse: enable rollbackcom.amazonaws.internal.SdkInternalList<T> notificationARNs
SNS topic ARNs to which stack related events are published.
Integer timeoutInMinutes
The amount of time within which stack creation should complete.
com.amazonaws.internal.SdkInternalList<T> capabilities
The capabilities allowed in the stack.
com.amazonaws.internal.SdkInternalList<T> outputs
A list of output structures.
com.amazonaws.internal.SdkInternalList<T> tags
A list of Tags that specify information about the stack.
String stackId
The unique ID name of the instance of the stack.
String eventId
The unique ID of this event.
String stackName
The name associated with a stack.
String logicalResourceId
The logical name of the resource specified in the template.
String physicalResourceId
The name or unique identifier associated with the physical instance of the resource.
String resourceType
Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
Date timestamp
Time the status was updated.
String resourceStatus
Current status of the resource.
String resourceStatusReason
Success/failure message associated with the resource.
String resourceProperties
BLOB of the properties used to create the resource.
String stackName
The name associated with the stack.
String stackId
Unique identifier of the stack.
String logicalResourceId
The logical name of the resource specified in the template.
String physicalResourceId
The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
String resourceType
Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
Date timestamp
Time the status was updated.
String resourceStatus
Current status of the resource.
String resourceStatusReason
Success/failure message associated with the resource.
String description
User defined description associated with the resource.
String stackName
The name associated with the stack.
String stackId
Unique identifier of the stack.
String logicalResourceId
The logical name of the resource specified in the template.
String physicalResourceId
The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
String resourceType
Type of resource. ((For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
Date lastUpdatedTimestamp
Time the status was updated.
String resourceStatus
Current status of the resource.
String resourceStatusReason
Success/failure message associated with the resource.
String description
User defined description associated with the resource.
String metadata
The JSON format content of the Metadata attribute declared
for the resource. For more information, see Metadata Attribute in the AWS CloudFormation User Guide.
String logicalResourceId
The logical name of the resource specified in the template.
String physicalResourceId
The name or unique identifier that corresponds to a physical instance ID of the resource.
String resourceType
Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
Date lastUpdatedTimestamp
Time the status was updated.
String resourceStatus
Current status of the resource.
String resourceStatusReason
Success/failure message associated with the resource.
String stackId
Unique stack identifier.
String stackName
The name associated with the stack.
String templateDescription
The template description of the template used to create the stack.
Date creationTime
The time the stack was created.
Date lastUpdatedTime
The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
Date deletionTime
The time the stack was deleted.
String stackStatus
The current status of the stack.
String stackStatusReason
Success/Failure message associated with the stack status.
String key
Required. A string used to identify this tag. You can specify a
maximum of 128 characters for a tag key. Tags owned by Amazon Web
Services (AWS) have the reserved prefix: aws:.
String value
Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
String parameterKey
The name associated with the parameter.
String defaultValue
The default value associated with the parameter.
Boolean noEcho
Flag indicating whether the parameter should be displayed as plain text in logs and UIs.
String description
User defined description associated with the parameter.
String stackName
The name or unique stack ID of the stack to update.
String templateBody
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)
Conditional: You must specify either the TemplateBody or the
TemplateURL parameter, but not both.
String templateURL
Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must specify either the TemplateBody or the
TemplateURL parameter, but not both.
Boolean usePreviousTemplate
Reuse the existing template that is associated with the stack that you are updating.
String stackPolicyDuringUpdateBody
Structure containing the temporary overriding stack policy body. You can
specify either the StackPolicyDuringUpdateBody or the
StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
String stackPolicyDuringUpdateURL
Location of a file containing the temporary overriding stack policy. The
URL must point to a policy (max size: 16KB) located in an S3 bucket in
the same region as the stack. You can specify either the
StackPolicyDuringUpdateBody or the
StackPolicyDuringUpdateURL parameter, but not both.
If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.
com.amazonaws.internal.SdkInternalList<T> parameters
A list of Parameter structures that specify input parameters
for the stack. For more information, see the Parameter data type.
com.amazonaws.internal.SdkInternalList<T> capabilities
A list of capabilities that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.
Currently, the only valid value is CAPABILITY_IAM, which is
required for the following resources: AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::InstanceProfile, AWS::IAM::Policy, AWS::IAM::Role, AWS::IAM::User, and AWS::IAM::UserToGroupAddition. If your stack template contains
these resources, we recommend that you review all permissions associated
with them and edit their permissions if necessary. If your template
contains any of the listed resources and you don't specify this
parameter, this action returns an InsufficientCapabilities
error.
com.amazonaws.internal.SdkInternalList<T> resourceTypes
The template resource types that you have permissions to work with for
this update stack action, such as AWS::EC2::Instance,
AWS::EC2::*, or Custom::MyCustomInstance.
If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.
String stackPolicyBody
Structure containing a new stack policy body. You can specify either the
StackPolicyBody or the StackPolicyURL
parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
String stackPolicyURL
Location of a file containing the updated stack policy. The URL must
point to a policy (max size: 16KB) located in an S3 bucket in the same
region as the stack. You can specify either the
StackPolicyBody or the StackPolicyURL
parameter, but not both.
You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.
com.amazonaws.internal.SdkInternalList<T> notificationARNs
Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack. Specify an empty list to remove all notification topics.
com.amazonaws.internal.SdkInternalList<T> tags
Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 10 tags.
If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
String stackId
Unique identifier of the stack.
String templateBody
Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must pass TemplateURL or
TemplateBody. If both are passed, only
TemplateBody is used.
String templateURL
Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.
Conditional: You must pass TemplateURL or
TemplateBody. If both are passed, only
TemplateBody is used.
com.amazonaws.internal.SdkInternalList<T> parameters
A list of TemplateParameter structures.
String description
The description found within the template.
com.amazonaws.internal.SdkInternalList<T> capabilities
The capabilities found within the template. Currently, AWS CloudFormation supports only the CAPABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.
String capabilitiesReason
The list of resources that generated the values in the
Capabilities response element.
Copyright © 2016. All rights reserved.