Skip to content

Describe Change Set Hooks

cloudformation_describe_change_set_hooks R Documentation

Description

Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.

Usage

cloudformation_describe_change_set_hooks(ChangeSetName, StackName,
  NextToken, LogicalResourceId)

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 stack ID (ARN) of the change set you want to describe.

NextToken

A string, provided by the describe_change_set_hooks response output, that identifies the next page of information that you want to retrieve.

LogicalResourceId

If specified, lists only the hooks related to the specified LogicalResourceId.

Value

A list with the following syntax:

list(
  ChangeSetId = "string",
  ChangeSetName = "string",
  Hooks = list(
    list(
      InvocationPoint = "PRE_PROVISION",
      FailureMode = "FAIL"|"WARN",
      TypeName = "string",
      TypeVersionId = "string",
      TypeConfigurationVersionId = "string",
      TargetDetails = list(
        TargetType = "RESOURCE",
        ResourceTargetDetails = list(
          LogicalResourceId = "string",
          ResourceType = "string",
          ResourceAction = "Add"|"Modify"|"Remove"|"Import"|"Dynamic"
        )
      )
    )
  ),
  Status = "PLANNING"|"PLANNED"|"UNAVAILABLE",
  NextToken = "string",
  StackId = "string",
  StackName = "string"
)

Request syntax

svc$describe_change_set_hooks(
  ChangeSetName = "string",
  StackName = "string",
  NextToken = "string",
  LogicalResourceId = "string"
)