AWS cli documentation change
Summary
Updated CLI version reference, reordered parameters, added storage throughput documentation, expanded security-related parameter descriptions (CA certificate, IAM roles), and restructured response syntax documentation.
Security assessment
Changes include expanded documentation for --ca-certificate-identifier (SSL/TLS certificate management) and --custom-iam-instance-profile (IAM role requirements). While these relate to security configurations, there's no evidence of addressing a specific vulnerability. The changes improve documentation of existing security features rather than patching a vulnerability.
Diff
diff --git a/cli/latest/reference/rds/create-db-instance.md b/cli/latest/reference/rds/create-db-instance.md index 08f908ec4..03283020f 100644 --- a//cli/latest/reference/rds/create-db-instance.md +++ b//cli/latest/reference/rds/create-db-instance.md @@ -15 +15 @@ - * [AWS CLI 2.31.3 Command Reference](../../index.html) » + * [AWS CLI 2.31.5 Command Reference](../../index.html) » @@ -94,0 +95 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rds-20 + [--storage-throughput <value>] @@ -127,2 +127,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rds-20 - [--custom-iam-instance-profile <value>] - [--backup-target <value>] @@ -130 +129,4 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rds-20 - [--storage-throughput <value>] + [--backup-target <value>] + [--custom-iam-instance-profile <value>] + [--db-system-id <value>] + [--ca-certificate-identifier <value>] @@ -133,3 +134,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rds-20 - [--ca-certificate-identifier <value>] - [--db-system-id <value>] - [--dedicated-log-volume | --no-dedicated-log-volume] @@ -136,0 +136 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rds-20 + [--dedicated-log-volume | --no-dedicated-log-volume] @@ -719,0 +720,8 @@ Syntax: +`--storage-throughput` (integer) + +> The storage throughput value, in mebibyte per second (MiBps), for the DB instance. +> +> This setting applies only to the `gp3` storage type. +> +> This setting doesn’t apply to Amazon Aurora or RDS Custom DB instances. + @@ -1159 +1167 @@ JSON Syntax: -`--custom-iam-instance-profile` (string) +`--network-type` (string) @@ -1161,5 +1169 @@ JSON Syntax: -> The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. -> -> This setting is required for RDS Custom. -> -> Constraints: +> The network type of the DB instance. @@ -1167,3 +1171 @@ JSON Syntax: -> * The profile must exist in your account. -> * The profile must have an IAM role that Amazon EC2 has permissions to assume. -> * The instance profile name and the associated IAM role name must start with the prefix `AWSRDSCustom` . +> The network type is determined by the `DBSubnetGroup` specified for the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL` ). @@ -1171 +1173 @@ JSON Syntax: - +> For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the _Amazon RDS User Guide._ @@ -1173 +1175 @@ JSON Syntax: -> For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the _Amazon RDS User Guide_ . +> Valid Values: `IPV4 | DUAL` @@ -1191 +1193 @@ JSON Syntax: -`--network-type` (string) +`--custom-iam-instance-profile` (string) @@ -1193 +1195 @@ JSON Syntax: -> The network type of the DB instance. +> The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. @@ -1195 +1197 @@ JSON Syntax: -> The network type is determined by the `DBSubnetGroup` specified for the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL` ). +> This setting is required for RDS Custom. @@ -1197 +1199,5 @@ JSON Syntax: -> For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the _Amazon RDS User Guide._ +> Constraints: +> +> * The profile must exist in your account. +> * The profile must have an IAM role that Amazon EC2 has permissions to assume. +> * The instance profile name and the associated IAM role name must start with the prefix `AWSRDSCustom` . @@ -1199 +1204,0 @@ JSON Syntax: -> Valid Values: `IPV4 | DUAL` @@ -1201 +1206,2 @@ JSON Syntax: -`--storage-throughput` (integer) +> +> For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the _Amazon RDS User Guide_ . @@ -1203 +1209,7 @@ JSON Syntax: -> The storage throughput value, in mebibyte per second (MiBps), for the DB instance. +`--db-system-id` (string) + +> The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term “Oracle database instance” refers exclusively to the system global area (SGA) and Oracle background processes. If you don’t specify a SID, the value defaults to `RDSCDB` . The Oracle SID is also the name of your CDB. + +`--ca-certificate-identifier` (string) + +> The CA certificate identifier to use for the DB instance’s server certificate. @@ -1205 +1217 @@ JSON Syntax: -> This setting applies only to the `gp3` storage type. +> This setting doesn’t apply to RDS Custom DB instances. @@ -1207 +1219 @@ JSON Syntax: -> This setting doesn’t apply to Amazon Aurora or RDS Custom DB instances. +> For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the _Amazon RDS User Guide_ and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the _Amazon Aurora User Guide_ . @@ -1233,16 +1244,0 @@ JSON Syntax: -`--ca-certificate-identifier` (string) - -> The CA certificate identifier to use for the DB instance’s server certificate. -> -> This setting doesn’t apply to RDS Custom DB instances. -> -> For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the _Amazon RDS User Guide_ and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the _Amazon Aurora User Guide_ . - -`--db-system-id` (string) - -> The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term “Oracle database instance” refers exclusively to the system global area (SGA) and Oracle background processes. If you don’t specify a SID, the value defaults to `RDSCDB` . The Oracle SID is also the name of your CDB. - -`--dedicated-log-volume` | `--no-dedicated-log-volume` (boolean) - -> Indicates whether the DB instance has a dedicated log volume (DLV) enabled. - @@ -1259,0 +1256,4 @@ JSON Syntax: +`--dedicated-log-volume` | `--no-dedicated-log-volume` (boolean) + +> Indicates whether the DB instance has a dedicated log volume (DLV) enabled. + @@ -1538,4 +1537,0 @@ DBInstance -> (structure) -> AutomaticRestartTime -> (timestamp) -> ->> The time when a stopped DB instance is restarted automatically. -> @@ -1788,0 +1785,4 @@ DBInstance -> (structure) +>> StorageThroughput -> (integer) +>> +>>> The storage throughput of the DB instance. +>> @@ -1871,4 +1870,0 @@ DBInstance -> (structure) ->> IAMDatabaseAuthenticationEnabled -> (boolean) ->> ->>> Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. ->> @@ -1890 +1886 @@ DBInstance -> (structure) ->> StorageThroughput -> (integer) +>> MultiTenant -> (boolean) @@ -1892 +1888 @@ DBInstance -> (structure) ->>> The storage throughput of the DB instance. +>>> Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). @@ -1894 +1890 @@ DBInstance -> (structure) ->> Engine -> (string) +>> IAMDatabaseAuthenticationEnabled -> (boolean) @@ -1896 +1892 @@ DBInstance -> (structure) ->>> The database engine of the DB instance. +>>> Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. @@ -1902 +1898 @@ DBInstance -> (structure) ->> MultiTenant -> (boolean) +>> Engine -> (string) @@ -1904 +1900 @@ DBInstance -> (structure) ->>> Indicates whether the DB instance will change to the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE). +>>> The database engine of the DB instance. @@ -1966,0 +1963,6 @@ DBInstance -> (structure) +> StorageThroughput -> (integer) +> +>> The storage throughput for the DB instance. +>> +>> This setting applies only to the `gp3` storage type. +> @@ -2300 +2302 @@ DBInstance -> (structure) -> DBInstanceAutomatedBackupsReplications -> (list) +> AutomationMode -> (string) @@ -2302 +2304 @@ DBInstance -> (structure) ->> The list of replicated automated backups associated with the DB instance. +>> The automation mode of the RDS Custom DB instance: `full` or `all paused` . If `full` , the DB instance automates monitoring and instance recovery. If `all paused` , the instance pauses automation for the duration set by `--resume-full-automation-mode-minutes` . @@ -2304 +2306 @@ DBInstance -> (structure) ->> (structure) +>> Possible values: @@ -2306,5 +2308,8 @@ DBInstance -> (structure) ->>> Automated backups of a DB instance replicated to another Amazon Web Services Region. They consist of system backups, transaction logs, and database instance properties. ->>> ->>> DBInstanceAutomatedBackupsArn -> (string) ->>> ->>>> The Amazon Resource Name (ARN) of the replicated automated backups. +>> * `full` +>> * `all-paused` +>> + +> +> ResumeFullAutomationModeTime -> (timestamp) +> +>> The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440. @@ -2322 +2327 @@ DBInstance -> (structure) -> AwsBackupRecoveryPointArn -> (string) +> NetworkType -> (string) @@ -2324 +2329,7 @@ DBInstance -> (structure) ->> The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup. +>> The network type of the DB instance. +>> +>> The network type is determined by the `DBSubnetGroup` specified for the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL` ). +>> +>> For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the _Amazon RDS User Guide_ and [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the _Amazon Aurora User Guide._ +>> +>> Valid Values: `IPV4 | DUAL` @@ -2362 +2373 @@ DBInstance -> (structure) -> AutomationMode -> (string) +> AwsBackupRecoveryPointArn -> (string) @@ -2364,3 +2375,5 @@ DBInstance -> (structure) ->> The automation mode of the RDS Custom DB instance: `full` or `all paused` . If `full` , the DB instance automates monitoring and instance recovery. If `all paused` , the instance pauses automation for the duration set by `--resume-full-automation-mode-minutes` . ->> ->> Possible values: +>> The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup. +> +> DBInstanceAutomatedBackupsReplications -> (list) +> +>> The list of replicated automated backups associated with the DB instance.