aws_rds
Automate AWS RDS database management tasks including creating, deleting, starting, stopping, and listing instances using Ansible playbooks. Configure regions, storage, security, and backups efficiently.
Instructions
Manage AWS RDS database instances
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | ||
| allocatedStorage | No | ||
| backupRetentionPeriod | No | ||
| dbEngine | No | ||
| dbInstanceClass | No | ||
| dbInstanceIdentifier | No | ||
| dbSubnetGroupName | No | ||
| masterPassword | No | ||
| masterUsername | No | ||
| multiAZ | No | ||
| region | Yes | ||
| skipFinalSnapshot | No | ||
| tags | No | ||
| vpcSecurityGroupIds | No |
Implementation Reference
- The handler function rdsOperations implements the core logic for the aws_rds tool by destructuring input args, generating an Ansible playbook based on the action (list, create, delete, start, stop), and executing it using executeAwsPlaybook.export async function rdsOperations(args: RDSOptions): Promise<string> { await verifyAwsCredentials(); const { action, region, dbInstanceIdentifier, dbEngine, dbInstanceClass, allocatedStorage, masterUsername, masterPassword, vpcSecurityGroupIds, dbSubnetGroupName, tags, multiAZ, backupRetentionPeriod, skipFinalSnapshot } = args; let playbookContent = `--- - name: AWS RDS ${action} operation hosts: localhost connection: local gather_facts: no tasks:`; switch (action) { case 'list': playbookContent += ` - name: List RDS instances amazon.aws.rds_instance_info: region: "${region}" register: rds_info - name: Display RDS instances debug: var: rds_info.instances`; break; case 'create': playbookContent += ` - name: Create RDS instance amazon.aws.rds_instance: region: "${region}" db_instance_identifier: "${dbInstanceIdentifier}" engine: "${dbEngine}" db_instance_class: "${dbInstanceClass}" allocated_storage: ${allocatedStorage} master_username: "${masterUsername}" master_user_password: "${masterPassword}" state: present ${formatYamlParams({ vpc_security_group_ids: vpcSecurityGroupIds, db_subnet_group_name: dbSubnetGroupName, tags, multi_az: multiAZ, backup_retention_period: backupRetentionPeriod, // Add other relevant RDS params here if needed })} register: rds_result - name: Display RDS instance details debug: var: rds_result`; break; case 'delete': playbookContent += ` - name: Delete RDS instance amazon.aws.rds_instance: region: "${region}" db_instance_identifier: "${dbInstanceIdentifier}" state: absent skip_final_snapshot: ${skipFinalSnapshot ? 'yes' : 'no'} register: rds_delete - name: Display deletion result debug: var: rds_delete`; break; case 'start': playbookContent += ` - name: Start RDS instance amazon.aws.rds_instance: region: "${region}" db_instance_identifier: "${dbInstanceIdentifier}" state: started register: rds_start - name: Display start result debug: var: rds_start`; break; case 'stop': playbookContent += ` - name: Stop RDS instance amazon.aws.rds_instance: region: "${region}" db_instance_identifier: "${dbInstanceIdentifier}" state: stopped register: rds_stop - name: Display stop result debug: var: rds_stop`; break; default: throw new AnsibleError(`Unsupported RDS action: ${action}`); } // Execute the generated playbook return executeAwsPlaybook(`rds-${action}`, playbookContent); }
- Zod schema RDSSchema and RDSActionEnum defining the input validation for aws_rds tool parameters including action, region, DB instance details, etc.export const RDSSchema = z.object({ action: RDSActionEnum, region: z.string().min(1, 'AWS region is required'), dbInstanceIdentifier: z.string().optional(), dbEngine: z.string().optional(), dbInstanceClass: z.string().optional(), allocatedStorage: z.number().optional(), masterUsername: z.string().optional(), masterPassword: z.string().optional(), vpcSecurityGroupIds: z.array(z.string()).optional(), dbSubnetGroupName: z.string().optional(), tags: z.record(z.string()).optional(), multiAZ: z.boolean().optional(), backupRetentionPeriod: z.number().optional(), skipFinalSnapshot: z.boolean().optional() // Added based on usage in aws.ts }); export type RDSOptions = z.infer<typeof RDSSchema>;
- src/sysoperator/index.ts:116-120 (registration)Registration of aws_rds tool in the toolDefinitions Record, specifying its description, input schema (aws.RDSSchema), and handler function (aws.rdsOperations).aws_rds: { description: 'Manage AWS RDS database instances', schema: aws.RDSSchema, handler: aws.rdsOperations, },
- Shared helper function executeAwsPlaybook used by all AWS tools including aws_rds to dynamically execute generated Ansible playbooks in temporary directories.async function executeAwsPlaybook( operationName: string, playbookContent: string, extraParams: string = '', tempFiles: { filename: string, content: string }[] = [] // For additional files like templates, policies ): Promise<string> { let tempDir: string | undefined; try { // Create a unique temporary directory tempDir = await createTempDirectory(`ansible-aws-${operationName}`); // Write the main playbook file const playbookPath = await writeTempFile(tempDir, 'playbook.yml', playbookContent); // Write any additional temporary files for (const file of tempFiles) { await writeTempFile(tempDir, file.filename, file.content); } // Build the command const command = `ansible-playbook ${playbookPath} ${extraParams}`; console.error(`Executing: ${command}`); // Execute the playbook asynchronously const { stdout, stderr } = await execAsync(command); // Return stdout, or a success message if stdout is empty return stdout || `${operationName} completed successfully (no output).`; } catch (error: any) { // Handle execution errors const errorMessage = error.stderr || error.message || 'Unknown error'; throw new AnsibleExecutionError(`Ansible execution failed for ${operationName}: ${errorMessage}`, error.stderr); } finally { // Ensure cleanup happens even if errors occur if (tempDir) { await cleanupTempDirectory(tempDir); } } }