cloudformation_describe_stacks: Returns the description for the specified stack; if no stack...

Description Usage Arguments Value Request syntax

View source: R/cloudformation_operations.R

Description

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.

If the stack does not exist, an AmazonCloudFormationException is returned.

Usage

1
cloudformation_describe_stacks(StackName, NextToken)

Arguments

StackName

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

NextToken

A string that identifies the next page of stacks that you want to retrieve.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
list(
  Stacks = list(
    list(
      StackId = "string",
      StackName = "string",
      ChangeSetId = "string",
      Description = "string",
      Parameters = list(
        list(
          ParameterKey = "string",
          ParameterValue = "string",
          UsePreviousValue = TRUE|FALSE,
          ResolvedValue = "string"
        )
      ),
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      DeletionTime = as.POSIXct(
        "2015-01-01"
      ),
      LastUpdatedTime = as.POSIXct(
        "2015-01-01"
      ),
      RollbackConfiguration = list(
        RollbackTriggers = list(
          list(
            Arn = "string",
            Type = "string"
          )
        ),
        MonitoringTimeInMinutes = 123
      ),
      StackStatus = "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_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",
      StackStatusReason = "string",
      DisableRollback = TRUE|FALSE,
      NotificationARNs = list(
        "string"
      ),
      TimeoutInMinutes = 123,
      Capabilities = list(
        "CAPABILITY_IAM"|"CAPABILITY_NAMED_IAM"|"CAPABILITY_AUTO_EXPAND"
      ),
      Outputs = list(
        list(
          OutputKey = "string",
          OutputValue = "string",
          Description = "string",
          ExportName = "string"
        )
      ),
      RoleARN = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      EnableTerminationProtection = TRUE|FALSE,
      ParentId = "string",
      RootId = "string",
      DriftInformation = list(
        StackDriftStatus = "DRIFTED"|"IN_SYNC"|"UNKNOWN"|"NOT_CHECKED",
        LastCheckTimestamp = as.POSIXct(
          "2015-01-01"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

1
2
3
4
svc$describe_stacks(
  StackName = "string",
  NextToken = "string"
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.