Skip to content

Describe Change Set

cloudformation_describe_change_set R Documentation

Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set

Description

Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the CloudFormation User Guide.

Usage

cloudformation_describe_change_set(ChangeSetName, StackName, NextToken,
  IncludePropertyValues)

Arguments

ChangeSetName

[required] The name or Amazon Resource Name (ARN) of the change set that you want to describe.

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.

NextToken

A string (provided by the describe_change_set response output) that identifies the next page of information that you want to retrieve.

IncludePropertyValues

If true, the returned changes include detailed changes in the property values.

Value

A list with the following syntax:

list(
  ChangeSetName = "string",
  ChangeSetId = "string",
  StackId = "string",
  StackName = "string",
  Description = "string",
  Parameters = list(
    list(
      ParameterKey = "string",
      ParameterValue = "string",
      UsePreviousValue = TRUE|FALSE,
      ResolvedValue = "string"
    )
  ),
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  ExecutionStatus = "UNAVAILABLE"|"AVAILABLE"|"EXECUTE_IN_PROGRESS"|"EXECUTE_COMPLETE"|"EXECUTE_FAILED"|"OBSOLETE",
  Status = "CREATE_PENDING"|"CREATE_IN_PROGRESS"|"CREATE_COMPLETE"|"DELETE_PENDING"|"DELETE_IN_PROGRESS"|"DELETE_COMPLETE"|"DELETE_FAILED"|"FAILED",
  StatusReason = "string",
  NotificationARNs = list(
    "string"
  ),
  RollbackConfiguration = list(
    RollbackTriggers = list(
      list(
        Arn = "string",
        Type = "string"
      )
    ),
    MonitoringTimeInMinutes = 123
  ),
  Capabilities = list(
    "CAPABILITY_IAM"|"CAPABILITY_NAMED_IAM"|"CAPABILITY_AUTO_EXPAND"
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  Changes = list(
    list(
      Type = "Resource",
      HookInvocationCount = 123,
      ResourceChange = list(
        PolicyAction = "Delete"|"Retain"|"Snapshot"|"ReplaceAndDelete"|"ReplaceAndRetain"|"ReplaceAndSnapshot",
        Action = "Add"|"Modify"|"Remove"|"Import"|"Dynamic",
        LogicalResourceId = "string",
        PhysicalResourceId = "string",
        ResourceType = "string",
        Replacement = "True"|"False"|"Conditional",
        Scope = list(
          "Properties"|"Metadata"|"CreationPolicy"|"UpdatePolicy"|"DeletionPolicy"|"UpdateReplacePolicy"|"Tags"
        ),
        Details = list(
          list(
            Target = list(
              Attribute = "Properties"|"Metadata"|"CreationPolicy"|"UpdatePolicy"|"DeletionPolicy"|"UpdateReplacePolicy"|"Tags",
              Name = "string",
              RequiresRecreation = "Never"|"Conditionally"|"Always",
              Path = "string",
              BeforeValue = "string",
              AfterValue = "string",
              AttributeChangeType = "Add"|"Remove"|"Modify"
            ),
            Evaluation = "Static"|"Dynamic",
            ChangeSource = "ResourceReference"|"ParameterReference"|"ResourceAttribute"|"DirectModification"|"Automatic",
            CausingEntity = "string"
          )
        ),
        ChangeSetId = "string",
        ModuleInfo = list(
          TypeHierarchy = "string",
          LogicalIdHierarchy = "string"
        ),
        BeforeContext = "string",
        AfterContext = "string"
      )
    )
  ),
  NextToken = "string",
  IncludeNestedStacks = TRUE|FALSE,
  ParentChangeSetId = "string",
  RootChangeSetId = "string",
  OnStackFailure = "DO_NOTHING"|"ROLLBACK"|"DELETE",
  ImportExistingResources = TRUE|FALSE
)

Request syntax

svc$describe_change_set(
  ChangeSetName = "string",
  StackName = "string",
  NextToken = "string",
  IncludePropertyValues = TRUE|FALSE
)