describe

Get detailed information about a specific AWS resource, formatted as Markdown.

Usage

cloudops-tools describe <type> <region> <id> [options]

Arguments

Argument	Description	Required
`type`	Resource type (e.g., `ec2`, `rds`, `lambda`, `vpc`)	Yes
`region`	AWS region where the resource exists	Yes
`id`	Resource identifier (instance ID, ARN, etc.)	Yes

Options

Option	Description	Default
`--debug`	Show raw error output with stack traces	`false`

Supported Resource Types

Type	Description	ID Format
`ec2`	EC2 instances	`i-xxxxxxxxxxxxxxxxx`
`rds`	RDS database instances	DB instance identifier
`lambda`	Lambda functions	Function name or ARN
`vpc`	VPC networks	`vpc-xxxxxxxxxxxxxxxxx`
`dynamodb`	DynamoDB tables	Table name

Examples

# Describe an EC2 instance
cloudops-tools describe ec2 us-east-1 i-1234567890abcdef0

# Describe an RDS database
cloudops-tools describe rds eu-west-1 my-database

# Describe a Lambda function
cloudops-tools describe lambda us-west-2 my-function

# Describe a VPC
cloudops-tools describe vpc us-east-1 vpc-0123456789abcdef0

# Describe a DynamoDB table
cloudops-tools describe dynamodb eu-central-1 my-table

# With debug output
cloudops-tools describe ec2 us-east-1 i-1234567890abcdef0 --debug

Output

The command outputs detailed resource information in Markdown format, including:

Resource metadata (ID, ARN, creation date)
Configuration details
Tags
Associated resources
Security settings
Network configuration

Batch Describe with --describe Flag

You can also describe all resources of a type in a region using the main command's --describe flag:

# Describe all RDS instances in eu-south-2
cloudops-tools --describe rds --region eu-south-2

# Describe all EC2 instances
cloudops-tools --describe ec2 --region us-east-1

# Describe all Lambda functions
cloudops-tools --describe lambda --region eu-west-1

# Describe all VPCs
cloudops-tools --describe vpc --region ap-southeast-1

# Describe all DynamoDB tables
cloudops-tools --describe dynamodb --region us-west-2

This writes a Markdown file to inventory-output/{account-id}/describe-{type}-{region}-{timestamp}.md