All Products
Search
Document Center

Cloud Migration Hub:Fields collected from AWS

Last Updated:Aug 15, 2024

This topic describes the basic information that the aws-scanner tool of Cloud Migration Hub (CMH) collects from your assets in Amazon Web Services (AWS).

Overview

The aws-scanner tool uses AWS SDK to collect resource information. The version of the SDK is AWS SDK for Java API Reference - 2.17.180

Availability Zone

Examples of the key fields collected by Availability Zone are as follows:

  • regionName

  • zoneName

  • zoneId

  • state

  • tags

VPC (Amazon VPC)

The following key fields about the Amazon Virtual Private Cloud (Amazon VPC) service are collected:

  • vpcId

  • ownerId

  • dhcpOptionsId

  • cidrBlock

  • state

  • region

  • tags

Security Group

The following key fields about security groups are collected:

  • groupId

  • groupName

  • vpcId

  • ownerId

  • securityGroupRulesNum

  • region

  • tags

NAT

The following key fields about NAT gateways are collected:

  • natGatewayId

  • vpcId

  • subnetId

  • state

  • publicIp

  • privateIp

  • region

  • tags

ELB (Elastic Load Balancing)

The following key fields about the Elastic Load Balancing (ELB) service are collected:

  • loadBalancerName

  • vpcId

  • type

  • ipAddressType

  • dnsName

  • state

  • region

  • tags

EC2 (Amazon EC2)

The following key fields about the Amazon Elastic Compute Cloud (Amazon EC2) service are collected:

  • instanceId

  • instanceType

  • instanceName

  • state

  • region

  • memory

  • cpuCore

  • imageId

  • operatingSystem

  • diskDevice

  • diskSpace

  • privateIpAddress

  • publicIpAddress

  • ipv6Address

  • publicDnsName

  • vpcId

  • subnetId

  • securityGroups

  • availabilityZone

  • tags

RDS (Amazon RDS)

The following key fields about the Amazon Relational Database Service (Amazon RDS) service are collected:

  • dbInstanceIdentifier

  • dbName

  • masterUsername

  • engine

  • engineVersion

  • dbInstanceClass

  • cpu

  • memory

  • storage

  • maximumStorage

  • domainName

  • port

  • availabilityZone

  • subnet

  • vpcSecurityGroups

  • status

  • region

  • vpcId

  • tags

ElastiCache (Amazon ElastiCache)

The following key fields about the Amazon ElastiCache service are collected:

  • cacheClusterId

  • numCacheNode

  • engine

  • engineVersion

  • securityGroups

  • clusterStatus

  • nodeType

  • az

  • subnetGroupName

  • replicationGroupId

  • cacheParameterGroupName

  • arn

  • region

  • tags

  • vpcId

  • subnet

S3 (Amazon S3)

The following key fields about the Amazon Simple Storage Service (Amazon S3) service are collected:

  • bucketName

  • creationDate

  • bucketSize

  • objectTotal

  • accessControl

  • tags

  • lifecycleConfigurationCount

  • replicationCount

  • inventoryConfigurationCount

  • region

  • standardCount

  • standardSize

  • reducedRedundancyCount

  • reducedRedundancySize

  • glacierCount

  • glacierSize

  • standardIaCount

  • standardIaSize

  • oneZoneIaCount

  • oneZoneIaSize

  • intelligentTieringCount

  • intelligentTieringSize

  • deepArchiveCount

  • deepArchiveSize

  • outPostsCount

  • outPostsSize

Athena (Amazon Athena)

The following key fields about the Amazon Athena service are collected:

  • catalogName

  • databaseName

  • name

  • createTime

  • lastAccessTime

  • tableType

  • columnSize

  • region

DocumentDB (Amazon DocumentDB)

The following key fields about the Amazon DocumentDB service are collected:

  • dbClusterIdendifier

  • engine

  • engineVersion

  • status

  • endpoint

  • multiAZ

  • availabilityZones

  • hostedZoneId

  • dbSubnetGroup

  • preferredBackupWindow

  • preferredMaintenanceWindow

  • dbClusterMembers

  • dbClusterParameterGroup

  • replicationSourceIdentifier

  • readerEndpoint

  • readReplicaIdentifiers

  • vpcSecurityGroupId

  • vpcId

  • region

  • tags

EFS (Amazon EFS)

The following key fields about the Amazon Elastic File System (EFS) service are collected:

  • fileSystemId

  • name

  • availabilityZoneId

  • availabilityZoneName

  • creationTime

  • performanceModeAsString

  • throughputMode

  • numberOfMountTargets

  • capacity

  • provisionedThroughputInMibps

  • region

  • tags

EKS (Amazon EKS)

The following key fields about the Amazon Elastic Kubernetes Service (EKS) service are collected:

  • clusterName

  • version

  • status

  • platformVersion

  • createdAt

  • identity

  • vpcId

  • clusterSecurityGroupId

  • subnetIds

  • securityGroupIds

  • endpointPrivateAccess

  • endpointPublicAccess

  • ipFamily

  • serviceIpv4Cidr

  • serviceIpv6Cidr

  • tags

  • region

Elasticsearch

The following key fields about the Elasticsearch service are collected:

  • domainName

  • engineType

  • version

  • instanceType

  • instanceCount

  • dedicatedMasterType

  • dedicatedMasterCount

  • volumeType

  • volumeSize

  • iops

  • vpcId

  • subnetIds

  • availabilityZones

  • securityGroupIds

  • region

  • tags

Global Accelerator (AWS Global Accelerator)

The following key fields about the AWS Global Accelerator service are collected:

  • name

  • dnsName

  • createdTime

  • status

  • enabled

  • ipAddressType

  • ipSet

  • region

MSK (Amazon MSK)

The following key fields about the Amazon Managed Streaming for Apache Kafka (Amazon MSK) service are collected:

  • clusterName

  • state

  • creationTime

  • currentVersion

  • clusterType

  • vpcId

  • securityGroups

  • clientSubnets

  • instanceType

  • volumeSize

  • configurationArn

  • configurationRevision

  • kafkaVersion

  • numberOfBrokerNodes

  • region

  • tags

Redshift (Amazon Redshift)

The following key fields about the Amazon Redshift service are collected:

  • id

  • dbName

  • clusterCreateTime

  • version

  • status

  • nodeType

  • numberOfNodes

  • totalStorageCapacityInMegaBytes

  • preferredMaintenanceWindow

  • node

  • availabilityZone

  • vpcId

  • elasticIpStatus

  • clusterSecurityGroupName

  • clusterSubnetGroupName

  • region

Security Group Rule

The following key fields about security group rules are collected:

  • groupId

  • securityGroupRuleId

  • isEgress

  • ipProtocol

  • portRange

  • source

  • description

  • region

API Reference for AWS Research Usage

Supported Resources

API used by

the client used

EC2

DescribeInstancesRequest/Response,DescribeInstanceTypesRequest/Response,DescribeImagesRequest/Response

Ec2Client

NAT

DescribeNatGatewaysResponse

Ec2Client

Security groups

DescribeSecurityGroupsResponse and DescribeSecurityGroupRulesIterable

Ec2Client

VPC

DescribeVpcsResponse

Ec2Client

Availability Zones (AZs)

DescribeAvailabilityZonesResponse

Ec2Client

Elastic Load Balancing (ELB)

DescribeTargetGroupsResponse, DescribeInstancesResponse, DescribeLoadBalancersResponse, and DescribeTagsRequest/Response

ElasticLoadBalancingV2Client and Ec2Client

RDS

DescribeDbInstancesRequest/Response

RdsClient

ElastiCache

DescribeCacheClustersResponse, DescribeCacheSubnetGroupsResponse, and ListTagsForResourceRequest/Response

ElastiCacheClient

S3

ListBucketsResponse, ListObjectsV2Request/Response, GetBucketTaggingRequest/Response, GetPublicAccessBlockRequest/Response, GetBucketLifecycleConfigurationRequest/Response, GetBucketReplicationRequest/Response, and ListBucketInventoryConfigurationsRequest/Response

S3Client

ElastiCache

DescribeCacheClustersResponse, DescribeCacheSubnetGroupsResponse, and ListTagsForResourceRequest/Response

ElastiCacheClient

DocumentDB

DescribeSecurityGroupsResponse, DescribeDbClustersResponse, and ListTagsForResourceRequest/Response

DocDbClient and Ec2Client

ES

DescribeCacheClustersResponse, DescribeCacheSubnetGroupsResponse, and ListTagsForResourceRequest/Response

ElastiCacheClient

KAFAKA

DescribeSecurityGroupsResponse and ListClustersV2Request/Response

KafkaClient and Ec2Client

SECURITY_GROUP_RULE

DescribeSecurityGroupRulesRequest/Response and DescribeSecurityGroupRulesIterable

Ec2Client

OLAPDB

DescribeClustersResponse

RedshiftClient

Eks

ListClustersRequest/Response and DescribeClusterRequest/Response

EksClient

GlobalAccelerator

ListAcceleratorsRequest/Response

GlobalAcceleratorClient

Athena

ListDataCatalogsRequest/Response, ListDatabasesRequest/Response, and ListTableMetadataRequest/Response

AthenaClient

Lambda

ListFunctionsRequest/Response and GetFunctionRequest/Response

LambdaClient

CloudFront

ListDistributionsResponse and ListTagsForResourceRequest/Response

CloudFrontClient

MQ

ListBrokersResponse and DescribeBrokerRequest/Response

MqClient

SQS

ListQueuesRequest/Response, GetQueueAttributesRequest/Response, and ListQueueTagsRequest/Response

SqsClient

AutoScaling

DescribeAutoScalingGroupsRequest/Response

AutoScalingClient

EIP

DescribeAddressesResponse

Ec2Client

If this topic is helpful for you, give it a like.