AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

The ResourceChange structure describes the resource and the action that CloudFormation will perform on it if you execute this change set.

Inheritance Hierarchy

System.Object
  Amazon.CloudFormation.Model.ResourceChange

Namespace: Amazon.CloudFormation.Model
Assembly: AWSSDK.CloudFormation.dll
Version: 3.x.y.z

Syntax

C#
public class ResourceChange

The ResourceChange type exposes the following members

Constructors

NameDescription
Public Method ResourceChange()

Properties

NameTypeDescription
Public Property Action Amazon.CloudFormation.ChangeAction

Gets and sets the property Action.

The action that CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), Remove (deletes a resource), Import (imports a resource), or Dynamic (exact action for the resource can't be determined).

Public Property AfterContext System.String

Gets and sets the property AfterContext.

An encoded JSON string containing the context of the resource after the change is executed.

Public Property BeforeContext System.String

Gets and sets the property BeforeContext.

An encoded JSON string containing the context of the resource before the change is executed.

Public Property ChangeSetId System.String

Gets and sets the property ChangeSetId.

The change set ID of the nested change set.

Public Property Details System.Collections.Generic.List<Amazon.CloudFormation.Model.ResourceChangeDetail>

Gets and sets the property Details.

For the Modify action, a list of ResourceChangeDetail structures that describes the changes that CloudFormation will make to the resource.

Public Property LogicalResourceId System.String

Gets and sets the property LogicalResourceId.

The resource's logical ID, which is defined in the stack's template.

Public Property ModuleInfo Amazon.CloudFormation.Model.ModuleInfo

Gets and sets the property ModuleInfo.

Contains information about the module from which the resource was created, if the resource was created from a module included in the stack template.

Public Property PhysicalResourceId System.String

Gets and sets the property PhysicalResourceId.

The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.

Public Property PolicyAction Amazon.CloudFormation.PolicyAction

Gets and sets the property PolicyAction.

The action that will be taken on the physical resource when the change set is executed.

  • Delete The resource will be deleted.

  • Retain The resource will be retained.

  • Snapshot The resource will have a snapshot taken.

  • ReplaceAndDelete The resource will be replaced and then deleted.

  • ReplaceAndRetain The resource will be replaced and then retained.

  • ReplaceAndSnapshot The resource will be replaced and then have a snapshot taken.

Public Property Replacement Amazon.CloudFormation.Replacement

Gets and sets the property Replacement.

For the Modify action, indicates whether 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.

Public Property ResourceType System.String

Gets and sets the property ResourceType.

The type of CloudFormation resource, such as AWS::S3::Bucket.

Public Property Scope System.Collections.Generic.List<System.String>

Gets and sets the property 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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5