Skip to content

List Resource Scan Related Resources

cloudformation_list_resource_scan_related_resources R Documentation

Description

Lists the related resources for a list of resources from a resource scan. The response indicates whether each returned resource is already managed by CloudFormation.

Usage

cloudformation_list_resource_scan_related_resources(ResourceScanId,
  Resources, NextToken, MaxResults)

Arguments

ResourceScanId

[required] The Amazon Resource Name (ARN) of the resource scan.

Resources

[required] The list of resources for which you want to get the related resources. Up to 100 resources can be provided.

NextToken

A string that identifies the next page of resource scan results.

MaxResults

If the number of available results exceeds this maximum, the response includes a NextToken value that you can use for the NextToken parameter to get the next set of results. By default the list_resource_scan_related_resources API action will return up to 100 results in each response. The maximum value is 100.

Value

A list with the following syntax:

list(
  RelatedResources = list(
    list(
      ResourceType = "string",
      ResourceIdentifier = list(
        "string"
      ),
      ManagedByStack = TRUE|FALSE
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_resource_scan_related_resources(
  ResourceScanId = "string",
  Resources = list(
    list(
      ResourceType = "string",
      ResourceIdentifier = list(
        "string"
      )
    )
  ),
  NextToken = "string",
  MaxResults = 123
)

Examples

## Not run: 
# This example lists the resources related to the passed in resources
svc$list_resource_scan_related_resources(
  ResourceScanId = "arn:aws:cloudformation:us-east-1:123456789012:resourceS...",
  Resources = list(
    list(
      ResourceIdentifier = list(
        BucketName = "jazz-bucket"
      ),
      ResourceType = "AWS::S3::Bucket"
    ),
    list(
      ResourceIdentifier = list(
        DhcpOptionsId = "random-id123"
      ),
      ResourceType = "AWS::EC2::DHCPOptions"
    )
  )
)

## End(Not run)