Skip to content

docs: add missing resource types to adoption fields table #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mohitkumar-deliveryhero wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add missing resource types to adoption fields table #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions website/docs/guides/adoption.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,12 +98,16 @@ The `services.k8s.aws/adoption-fields` annotation specifies which fields ACK sho

| Resource Type | Adoption Field | Example |
|--------------|----------------|---------|
| DBCluster | `dbClusterIdentifier` | `{"dbClusterIdentifier": "my-db-cluster"}` |
| DynamoDB Table | `tableName` | `{"tableName": "my-table"}` |
| EKS Cluster | `name` | `{"name": "my-cluster"}` |
| IAM Policy | `arn` | `{"arn": "arn:aws:iam::123456789012:policy/my-policy"}` |
| IAM Role | `name` | `{"name": "my-role"}` |
| ReplicationGroup | `replicationGroupID` | `{"replicationGroupID": "my-redis-cluster"}` |
| S3 Bucket | `name` | `{"name": "my-bucket-name"}` |
| SNS Topic | `arn` | `{"arn": "arn:aws:sns:us-west-2:123456789012:my-topic"}` |
| SQS Queue | `queueURL` | `{"queueURL": "https://sqs.us-west-2.amazonaws.com/123456789012/my-queue"}` |
| VPC | `vpcID` | `{"vpcID": "vpc-123456789012"}` |
| SNS Topic | `arn` | `{"arn": "arn:aws:sns:us-west-2:123456789012:my-topic"}` |
| S3 Bucket | `name` | `{"name": "my-bucket-name"}` |
| DynamoDB Table | `tableName` | `{"tableName": "my-table"}` |

Refer to the [API Reference](/services) for the specific fields required for each resource type.

Expand Down