feat: Add URLs to docs for more AWS resources (#2729)

Similar to #2686 before it, this adds URLs to the docs for most (but not all) AWS tables.
cloudquery · Oct 17, 2022 · 665aea2 · 665aea2
1 parent 1a79f7c
commit 665aea2
Show file tree

Hide file tree

Showing 339 changed files with 1,358 additions and 1,058 deletions.
diff --git a/plugins/source/aws/codegen/recipes/ecr.go b/plugins/source/aws/codegen/recipes/ecr.go
@@ -47,10 +47,11 @@ func ECRResources() []*Resource {
 				}...),
 		},
 		{
-			SubService: "repositories",
-			Struct:     &types.Repository{},
-			SkipFields: []string{"RepositoryArn"},
-			Multiplex:  `client.ServiceAccountRegionMultiplexer("api.ecr")`,
+			SubService:  "repositories",
+			Struct:      &types.Repository{},
+			Description: "https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_Repository.html",
+			SkipFields:  []string{"RepositoryArn"},
+			Multiplex:   `client.ServiceAccountRegionMultiplexer("api.ecr")`,
 			ExtraColumns: append(
 				defaultRegionalColumns,
 				[]codegen.ColumnDefinition{
@@ -69,8 +70,9 @@ func ECRResources() []*Resource {
 			Relations: []string{"RepositoryImages()"},
 		},
 		{
-			SubService: "repository_images",
-			Struct:     &types.ImageDetail{},
+			SubService:  "repository_images",
+			Struct:      &types.ImageDetail{},
+			Description: "https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_ImageDetail.html",
 			ExtraColumns: append(
 				defaultRegionalColumns,
 				[]codegen.ColumnDefinition{

diff --git a/plugins/source/aws/codegen/recipes/ecrpublic.go b/plugins/source/aws/codegen/recipes/ecrpublic.go
@@ -9,10 +9,11 @@ import (
 func ECRPublicResources() []*Resource {
 	resources := []*Resource{
 		{
-			SubService: "repositories",
-			Struct:     &types.Repository{},
-			SkipFields: []string{"RepositoryArn"},
-			Multiplex:  `client.ServiceAccountRegionMultiplexer("api.ecr-public")`,
+			SubService:  "repositories",
+			Struct:      &types.Repository{},
+			Description: "https://docs.aws.amazon.com/AmazonECRPublic/latest/APIReference/API_Repository.html",
+			SkipFields:  []string{"RepositoryArn"},
+			Multiplex:   `client.ServiceAccountRegionMultiplexer("api.ecr-public")`,
 			ExtraColumns: append(
 				defaultRegionalColumns,
 				[]codegen.ColumnDefinition{
@@ -31,8 +32,9 @@ func ECRPublicResources() []*Resource {
 			Relations: []string{"RepositoryImages()"},
 		},
 		{
-			SubService: "repository_images",
-			Struct:     &types.ImageDetail{},
+			SubService:  "repository_images",
+			Struct:      &types.ImageDetail{},
+			Description: "https://docs.aws.amazon.com/AmazonECRPublic/latest/APIReference/API_ImageDetail.html",
 			ExtraColumns: append(
 				defaultRegionalColumns,
 				[]codegen.ColumnDefinition{

diff --git a/plugins/source/aws/codegen/recipes/ecs.go b/plugins/source/aws/codegen/recipes/ecs.go
@@ -13,9 +13,10 @@ import (
 func ECSResources() []*Resource {
 	resources := []*Resource{
 		{
-			SubService: "clusters",
-			Struct:     &types.Cluster{},
-			SkipFields: []string{"Tags", "ClusterArn"},
+			SubService:  "clusters",
+			Struct:      &types.Cluster{},
+			Description: "https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Cluster.html",
+			SkipFields:  []string{"Tags", "ClusterArn"},
 			ExtraColumns: append(
 				defaultRegionalColumns,
 				[]codegen.ColumnDefinition{
@@ -38,9 +39,10 @@ func ECSResources() []*Resource {
 			},
 		},
 		{
-			SubService: "cluster_tasks",
-			Struct:     &types.Task{},
-			SkipFields: []string{"Tags", "TaskArn"},
+			SubService:  "cluster_tasks",
+			Struct:      &types.Task{},
+			Description: "https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Task.html",
+			SkipFields:  []string{"Tags", "TaskArn"},
 			ExtraColumns: append(
 				defaultRegionalColumns,
 				[]codegen.ColumnDefinition{
@@ -59,9 +61,10 @@ func ECSResources() []*Resource {
 			Relations: []string{},
 		},
 		{
-			SubService: "cluster_services",
-			Struct:     &types.Service{},
-			SkipFields: []string{"Tags", "ServiceArn"},
+			SubService:  "cluster_services",
+			Struct:      &types.Service{},
+			Description: "https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Service.html",
+			SkipFields:  []string{"Tags", "ServiceArn"},
 			ExtraColumns: append(
 				defaultRegionalColumns,
 				[]codegen.ColumnDefinition{
@@ -80,9 +83,10 @@ func ECSResources() []*Resource {
 			Relations: []string{},
 		},
 		{
-			SubService: "cluster_container_instances",
-			Struct:     &types.ContainerInstance{},
-			SkipFields: []string{"Tags"},
+			SubService:  "cluster_container_instances",
+			Struct:      &types.ContainerInstance{},
+			Description: "https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerInstance.html",
+			SkipFields:  []string{"Tags"},
 			ExtraColumns: append(
 				defaultRegionalColumns,
 				[]codegen.ColumnDefinition{

diff --git a/plugins/source/aws/codegen/recipes/efs.go b/plugins/source/aws/codegen/recipes/efs.go
@@ -8,9 +8,10 @@ import (
 
 var efsResources = []*Resource{
 	{
-		SubService: "filesystems",
-		Struct:     &types.FileSystemDescription{},
-		SkipFields: []string{"FileSystemArn"},
+		SubService:  "filesystems",
+		Struct:      &types.FileSystemDescription{},
+		Description: "https://docs.aws.amazon.com/efs/latest/ug/API_FileSystemDescription.html",
+		SkipFields:  []string{"FileSystemArn"},
 		ExtraColumns: append(
 			defaultRegionalColumns,
 			[]codegen.ColumnDefinition{

diff --git a/plugins/source/aws/codegen/recipes/eks.go b/plugins/source/aws/codegen/recipes/eks.go
@@ -11,6 +11,7 @@ func EKSResources() []*Resource {
 		{
 			SubService:          "clusters",
 			Struct:              &types.Cluster{},
+			Description:         "https://docs.aws.amazon.com/eks/latest/APIReference/API_Cluster.html",
 			SkipFields:          []string{"Arn"},
 			PreResourceResolver: "getEksCluster",
 			ExtraColumns: append(

diff --git a/plugins/source/aws/codegen/recipes/elasticache.go b/plugins/source/aws/codegen/recipes/elasticache.go
@@ -9,9 +9,10 @@ import (
 func ElastiCacheResources() []*Resource {
 	resources := []*Resource{
 		{
-			SubService: "clusters",
-			Struct:     &types.CacheCluster{},
-			SkipFields: []string{"ARN"},
+			SubService:  "clusters",
+			Struct:      &types.CacheCluster{},
+			Description: "https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CacheCluster.html",
+			SkipFields:  []string{"ARN"},
 			ExtraColumns: append(
 				defaultRegionalColumns,
 				[]codegen.ColumnDefinition{
@@ -24,8 +25,9 @@ func ElastiCacheResources() []*Resource {
 				}...),
 		},
 		{
-			SubService: "engine_versions",
-			Struct:     &types.CacheEngineVersion{},
+			SubService:  "engine_versions",
+			Struct:      &types.CacheEngineVersion{},
+			Description: "https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CacheEngineVersion.html",
 			ExtraColumns: []codegen.ColumnDefinition{
 				{
 					Name:        "account_id",
@@ -44,9 +46,10 @@ func ElastiCacheResources() []*Resource {
 			},
 		},
 		{
-			SubService: "global_replication_groups",
-			Struct:     &types.GlobalReplicationGroup{},
-			SkipFields: []string{"ARN"},
+			SubService:  "global_replication_groups",
+			Struct:      &types.GlobalReplicationGroup{},
+			Description: "https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_GlobalReplicationGroup.html",
+			SkipFields:  []string{"ARN"},
 			ExtraColumns: append(
 				defaultRegionalColumns,
 				[]codegen.ColumnDefinition{
@@ -59,9 +62,10 @@ func ElastiCacheResources() []*Resource {
 				}...),
 		},
 		{
-			SubService: "parameter_groups",
-			Struct:     &types.CacheParameterGroup{},
-			SkipFields: []string{"ARN"},
+			SubService:  "parameter_groups",
+			Struct:      &types.CacheParameterGroup{},
+			Description: "https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_CacheParameterGroup.html",
+			SkipFields:  []string{"ARN"},
 			ExtraColumns: append(
 				defaultRegionalColumns,
 				[]codegen.ColumnDefinition{
@@ -74,9 +78,10 @@ func ElastiCacheResources() []*Resource {
 				}...),
 		},
 		{
-			SubService: "replication_groups",
-			Struct:     &types.ReplicationGroup{},
-			SkipFields: []string{"ARN"},
+			SubService:  "replication_groups",
+			Struct:      &types.ReplicationGroup{},
+			Description: "https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ReplicationGroup.html",
+			SkipFields:  []string{"ARN"},
 			ExtraColumns: append(
 				defaultRegionalColumns,
 				[]codegen.ColumnDefinition{
@@ -89,9 +94,10 @@ func ElastiCacheResources() []*Resource {
 				}...),
 		},
 		{
-			SubService: "reserved_cache_nodes_offerings",
-			Struct:     &types.ReservedCacheNodesOffering{},
-			SkipFields: []string{"ARN"},
+			SubService:  "reserved_cache_nodes_offerings",
+			Struct:      &types.ReservedCacheNodesOffering{},
+			Description: "https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ReservedCacheNodesOffering.html",
+			SkipFields:  []string{"ARN"},
 			ExtraColumns: append(
 				defaultRegionalColumns,
 				[]codegen.ColumnDefinition{
@@ -104,9 +110,10 @@ func ElastiCacheResources() []*Resource {
 				}...),
 		},
 		{
-			SubService: "reserved_cache_nodes",
-			Struct:     &types.ReservedCacheNode{},
-			SkipFields: []string{"ReservationARN"},
+			SubService:  "reserved_cache_nodes",
+			Struct:      &types.ReservedCacheNode{},
+			Description: "https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ReservedCacheNode.html",
+			SkipFields:  []string{"ReservationARN"},
 			ExtraColumns: append(
 				defaultRegionalColumns,
 				[]codegen.ColumnDefinition{
@@ -119,8 +126,9 @@ func ElastiCacheResources() []*Resource {
 				}...),
 		},
 		{
-			SubService: "service_updates",
-			Struct:     &types.ServiceUpdate{},
+			SubService:  "service_updates",
+			Struct:      &types.ServiceUpdate{},
+			Description: "https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ServiceUpdate.html",
 			ExtraColumns: append(
 				defaultRegionalColumns,
 				[]codegen.ColumnDefinition{
@@ -133,9 +141,10 @@ func ElastiCacheResources() []*Resource {
 				}...),
 		},
 		{
-			SubService: "snapshots",
-			Struct:     &types.Snapshot{},
-			SkipFields: []string{"ARN"},
+			SubService:  "snapshots",
+			Struct:      &types.Snapshot{},
+			Description: "https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_Snapshot.html",
+			SkipFields:  []string{"ARN"},
 			ExtraColumns: append(
 				defaultRegionalColumns,
 				[]codegen.ColumnDefinition{
@@ -148,9 +157,10 @@ func ElastiCacheResources() []*Resource {
 				}...),
 		},
 		{
-			SubService: "user_groups",
-			Struct:     &types.UserGroup{},
-			SkipFields: []string{"ARN"},
+			SubService:  "user_groups",
+			Struct:      &types.UserGroup{},
+			Description: "https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_UserGroup.html",
+			SkipFields:  []string{"ARN"},
 			ExtraColumns: append(
 				defaultRegionalColumns,
 				[]codegen.ColumnDefinition{
@@ -163,9 +173,10 @@ func ElastiCacheResources() []*Resource {
 				}...),
 		},
 		{
-			SubService: "users",
-			Struct:     &types.User{},
-			SkipFields: []string{"ARN"},
+			SubService:  "users",
+			Struct:      &types.User{},
+			Description: "https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_User.html",
+			SkipFields:  []string{"ARN"},
 			ExtraColumns: append(
 				defaultRegionalColumns,
 				[]codegen.ColumnDefinition{

diff --git a/plugins/source/aws/codegen/recipes/elasticbeanstalk.go b/plugins/source/aws/codegen/recipes/elasticbeanstalk.go
@@ -13,9 +13,10 @@ import (
 func ElasticbeanstalkResources() []*Resource {
 	resources := []*Resource{
 		{
-			SubService: "application_versions",
-			Struct:     &types.ApplicationVersionDescription{},
-			SkipFields: []string{"ApplicationVersionArn"},
+			SubService:  "application_versions",
+			Struct:      &types.ApplicationVersionDescription{},
+			Description: "https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ApplicationVersionDescription.html",
+			SkipFields:  []string{"ApplicationVersionArn"},
 			ExtraColumns: append(
 				defaultRegionalColumns,
 				[]codegen.ColumnDefinition{
@@ -28,9 +29,10 @@ func ElasticbeanstalkResources() []*Resource {
 				}...),
 		},
 		{
-			SubService: "applications",
-			Struct:     &types.ApplicationDescription{},
-			SkipFields: []string{"ApplicationArn", "DateCreated"},
+			SubService:  "applications",
+			Struct:      &types.ApplicationDescription{},
+			Description: "https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_ApplicationDescription.html",
+			SkipFields:  []string{"ApplicationArn", "DateCreated"},
 			ExtraColumns: append(
 				defaultRegionalColumns,
 				[]codegen.ColumnDefinition{
@@ -48,9 +50,10 @@ func ElasticbeanstalkResources() []*Resource {
 				}...),
 		},
 		{
-			SubService: "environments",
-			Struct:     &types.EnvironmentDescription{},
-			SkipFields: []string{"EnvironmentId", "EnvironmentArn"},
+			SubService:  "environments",
+			Struct:      &types.EnvironmentDescription{},
+			Description: "https://docs.aws.amazon.com/elasticbeanstalk/latest/APIReference/API_EnvironmentDescription.html",
+			SkipFields:  []string{"EnvironmentId", "EnvironmentArn"},
 			ExtraColumns: []codegen.ColumnDefinition{
 				{
 					Name:     "account_id",

diff --git a/plugins/source/aws/codegen/recipes/elbv1.go b/plugins/source/aws/codegen/recipes/elbv1.go
@@ -32,9 +32,10 @@ func ELBv1Resources() []*Resource {
 			},
 		},
 		{
-			SubService: "load_balancer_policies",
-			Struct:     &types.PolicyDescription{},
-			SkipFields: []string{"PolicyAttributeDescriptions"},
+			SubService:  "load_balancer_policies",
+			Struct:      &types.PolicyDescription{},
+			Description: "https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_PolicyDescription.html",
+			SkipFields:  []string{"PolicyAttributeDescriptions"},
 			ExtraColumns: append(
 				defaultRegionalColumns,
 				[]codegen.ColumnDefinition{