AWS AmazonRDS documentation change
Summary
Added S3 integration support for db2pd_command stored procedure output, including new parameters (s3_bucket_name, s3_prefix), usage requirements, and example for repeated memory monitoring.
Security assessment
The change adds documentation about securely storing diagnostic outputs in S3 buckets using VPC gateway endpoints and S3 integration, but does not address any specific security vulnerability.
Diff
diff --git a/AmazonRDS/latest/UserGuide/db2-sp-managing-databases.md b/AmazonRDS/latest/UserGuide/db2-sp-managing-databases.md index 8d45ebf1a..c47843088 100644 --- a//AmazonRDS/latest/UserGuide/db2-sp-managing-databases.md +++ b//AmazonRDS/latest/UserGuide/db2-sp-managing-databases.md @@ -1024 +1024 @@ The following example rolls forward to an online backup of the database without - 'logsfolder/, + 'logsfolder/', @@ -1136 +1136,4 @@ Collects information about an RDS for Db2 database. - db2 "call rdsadmin.db2pd_command('db2pd_cmd')" + db2 "call rdsadmin.db2pd_command( + 'db2pd_cmd', + 's3_bucket_name', + 's3_prefix')" @@ -1175,2 +1177,0 @@ The following options aren't supported: - * `-everything` - @@ -1193,2 +1193,0 @@ The following options aren't supported: - * `-repeat` - @@ -1205,0 +1205,12 @@ The use of the `stacks` option isn't supported, for example, `db2pd -edus interv +The following parameters are optional: + +`s3_bucket_name` + + +The name of the Amazon S3 bucket where you want to upload the output file. The data type is `varchar`. If neither `s3_bucket_name` nor `s3_prefix` is provided, the collected information can be retrieved by calling [rdsadmin.get_task_status](./db2-user-defined-functions.html#db2-udf-get-task-status). + +`s3_prefix` + + +The prefix of the path to Amazon S3 where RDS for Db2 uploads the output files. The data type is `varchar`. If prefix is specified, `s3_bucket_name` must also be provided. If omitted while `s3_bucket_name` is present, the output file is uploaded to the root directory of the specified bucket. + @@ -1213,0 +1225,13 @@ The output is restricted to a maximum of 2 GB. +Before calling the stored procedure, review the following requirements: + + * To upload the output to Amazon S3, you must have already configured the integration. For more information, see [Integrating an Amazon RDS for Db2 DB instance with Amazon S3](./db2-s3-integration.html). + + * For an RDS for Db2 DB instance to be able to interact with Amazon S3, you must have a VPC and an Amazon S3 gateway endpoint for private subnets to use. For more information, see [Step 1: Create a VPC gateway endpoint for Amazon S3](./db2-troubleshooting.html#db2-creating-endpoint) and [Step 2: Confirm that your VPC gateway endpoint for Amazon S3 exists](./db2-troubleshooting.html#db2-confirming-endpoint). + + * A valid Amazon S3 bucket destination is required for `-everything` and `-repeat` options. + + * For `-repeat` option: Default syntax is `'[command] -repeat [interval_seconds] [count]'`. The interval must be at least 1 second, and the count of execution must not exceed 100. The total execution time (`interval_seconds` × `count`) must not exceed 600 seconds. If no values are provided, the defaults are an interval of `5` seconds and a count of `10`. + + + + @@ -1245,0 +1270,10 @@ The following example returns the memory sets of an RDS for Db2 DB instance and +**Example 5: Returning repeated memory usage of DB instance** + +The following example returns the memory usage of an RDS for Db2 DB instance every 10 seconds for 6 times: + + + db2 "call rdsadmin.db2pd_command( + '-dbptnmem -repeat 10 6', + 'amzn-s3-demo-bucket', + 'db2pdResults')" +