ListResourceScanRelatedResourcesRequest Class

Container for the parameters to the ListResourceScanRelatedResources operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CloudFormation.AmazonCloudFormationRequest
      Amazon.CloudFormation.Model.ListResourceScanRelatedResourcesRequest

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

Syntax

public class ListResourceScanRelatedResourcesRequest : AmazonCloudFormationRequest
         IAmazonWebServiceRequest

The ListResourceScanRelatedResourcesRequest type exposes the following members

Constructors

	Name	Description
	ListResourceScanRelatedResourcesRequest()

Properties

Name	Type	Description
MaxResults	System.Nullable<System.Int32>	Gets and sets the property 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 `ListResourceScanRelatedResources` API action will return up to 100 results in each response. The maximum value is 100.
NextToken	System.String	Gets and sets the property NextToken. A string that identifies the next page of resource scan results.
Resources	System.Collections.Generic.List<Amazon.CloudFormation.Model.ScannedResourceIdentifier>	Gets and sets the property Resources. The list of resources for which you want to get the related resources. Up to 100 resources can be provided. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
ResourceScanId	System.String	Gets and sets the property ResourceScanId. The Amazon Resource Name (ARN) of the resource scan.

Examples

This example lists the resources related to the passed in resources

To list resource scan related resources


var client = new AmazonCloudFormationClient();
var response = client.ListResourceScanRelatedResources(new ListResourceScanRelatedResourcesRequest 
{
    ResourceScanId = "arn:aws:cloudformation:us-east-1:123456789012:resourceScan/c19304f6-c4f1-4ff8-8e1f-35162e41d7e1",
    Resources = new List<ScannedResourceIdentifier> {
        new ScannedResourceIdentifier {
            ResourceIdentifier = new Dictionary<string, string> {
                { "BucketName", "jazz-bucket" }
            },
            ResourceType = "AWS::S3::Bucket"
        },
        new ScannedResourceIdentifier {
            ResourceIdentifier = new Dictionary<string, string> {
                { "DhcpOptionsId", "random-id123" }
            },
            ResourceType = "AWS::EC2::DHCPOptions"
        }
    }
});

List<ScannedResource> relatedResources = response.RelatedResources;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer