AWS cli documentation change
Summary
Reordered parameters, updated CLI version references, restructured documentation for --custom-iam-instance-profile and --enable-customer-owned-ip flags, added/moved storage throughput documentation, and reorganized response field descriptions.
Security assessment
The changes include documentation updates for IAM instance profile requirements (enforcing 'AWSRDSCustom' prefix) and certificate details monitoring, which relate to security best practices. However, there is no explicit evidence of addressing a specific vulnerability or security incident in the diff.
Diff
diff --git a/cli/latest/reference/rds/create-db-instance-read-replica.md b/cli/latest/reference/rds/create-db-instance-read-replica.md index 804ccd991..0a1c0dff0 100644 --- a//cli/latest/reference/rds/create-db-instance-read-replica.md +++ b//cli/latest/reference/rds/create-db-instance-read-replica.md @@ -15 +15 @@ - * [AWS CLI 2.31.3 Command Reference](../../index.html) » + * [AWS CLI 2.31.5 Command Reference](../../index.html) » @@ -83,0 +84 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rds-20 + [--storage-throughput <value>] @@ -112,4 +112,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rds-20 - [--max-allocated-storage <value>] - [--custom-iam-instance-profile <value>] - [--network-type <value>] - [--storage-throughput <value>] @@ -116,0 +114,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rds-20 + [--network-type <value>] + [--max-allocated-storage <value>] @@ -117,0 +117 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rds-20 + [--custom-iam-instance-profile <value>] @@ -217,0 +218,6 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rds-20 +`--storage-throughput` (integer) + +> Specifies the storage throughput value for the read replica. +> +> This setting doesn’t apply to RDS Custom or Amazon Aurora DB instances. + @@ -647,7 +653 @@ Syntax: -`--max-allocated-storage` (integer) - -> The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. -> -> For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the _Amazon RDS User Guide_ . - -`--custom-iam-instance-profile` (string) +`--enable-customer-owned-ip` | `--no-enable-customer-owned-ip` (boolean) @@ -655,5 +655 @@ Syntax: -> The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements: -> -> * 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` . +> Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts read replica. @@ -661 +657 @@ Syntax: - +> A _CoIP_ provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the read replica from outside of its virtual private cloud (VPC) on your local network. @@ -663 +659 @@ 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_ . +> For more information about RDS on Outposts, see [Working with Amazon RDS on Amazon Web Services Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the _Amazon RDS User Guide_ . @@ -665 +661 @@ Syntax: -> This setting is required for RDS Custom DB instances. +> For more information about CoIPs, see [Customer-owned IP addresses](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) in the _Amazon Web Services Outposts User Guide_ . @@ -682,7 +678 @@ Syntax: -`--storage-throughput` (integer) - -> Specifies the storage throughput value for the read replica. -> -> This setting doesn’t apply to RDS Custom or Amazon Aurora DB instances. - -`--enable-customer-owned-ip` | `--no-enable-customer-owned-ip` (boolean) +`--max-allocated-storage` (integer) @@ -690,5 +680 @@ Syntax: -> Specifies whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts read replica. -> -> A _CoIP_ provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the read replica from outside of its virtual private cloud (VPC) on your local network. -> -> For more information about RDS on Outposts, see [Working with Amazon RDS on Amazon Web Services Outposts](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html) in the _Amazon RDS User Guide_ . +> The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. @@ -696 +682 @@ Syntax: -> For more information about CoIPs, see [Customer-owned IP addresses](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) in the _Amazon Web Services Outposts User Guide_ . +> For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the _Amazon RDS User Guide_ . @@ -708,0 +695,14 @@ Syntax: +`--custom-iam-instance-profile` (string) + +> The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements: +> +> * 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` . +> + +> +> 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_ . +> +> This setting is required for RDS Custom DB instances. + @@ -908,4 +907,0 @@ DBInstance -> (structure) -> AutomaticRestartTime -> (timestamp) -> ->> The time when a stopped DB instance is restarted automatically. -> @@ -1158,0 +1155,4 @@ DBInstance -> (structure) +>> StorageThroughput -> (integer) +>> +>>> The storage throughput of the DB instance. +>> @@ -1241,4 +1240,0 @@ DBInstance -> (structure) ->> IAMDatabaseAuthenticationEnabled -> (boolean) ->> ->>> Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled. ->> @@ -1260 +1256 @@ DBInstance -> (structure) ->> StorageThroughput -> (integer) +>> MultiTenant -> (boolean) @@ -1262 +1258 @@ 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). @@ -1264 +1260 @@ DBInstance -> (structure) ->> Engine -> (string) +>> IAMDatabaseAuthenticationEnabled -> (boolean) @@ -1266 +1262 @@ 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. @@ -1272 +1268 @@ DBInstance -> (structure) ->> MultiTenant -> (boolean) +>> Engine -> (string) @@ -1274 +1270 @@ 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. @@ -1336,0 +1333,6 @@ DBInstance -> (structure) +> StorageThroughput -> (integer) +> +>> The storage throughput for the DB instance. +>> +>> This setting applies only to the `gp3` storage type. +> @@ -1670 +1672 @@ DBInstance -> (structure) -> DBInstanceAutomatedBackupsReplications -> (list) +> AutomationMode -> (string) @@ -1672 +1674 @@ 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` . @@ -1674 +1676 @@ DBInstance -> (structure) ->> (structure) +>> Possible values: @@ -1676,5 +1678,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. @@ -1692 +1697 @@ DBInstance -> (structure) -> AwsBackupRecoveryPointArn -> (string) +> NetworkType -> (string) @@ -1694 +1699,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` @@ -1732 +1743 @@ DBInstance -> (structure) -> AutomationMode -> (string) +> AwsBackupRecoveryPointArn -> (string) @@ -1734,3 +1745,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. @@ -1738,2 +1751 @@ DBInstance -> (structure) ->> * `full` ->> * `all-paused` +>> (structure) @@ -1741 +1753,5 @@ 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. @@ -1743 +1759 @@ DBInstance -> (structure) -> ResumeFullAutomationModeTime -> (timestamp) +> BackupTarget -> (string) @@ -1745 +1761,5 @@ DBInstance -> (structure) ->> 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. +>> The location where automated backups and manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region. +> +> AutomaticRestartTime -> (timestamp) +> +>> The time when a stopped DB instance is restarted automatically. @@ -1759,14 +1778,0 @@ DBInstance -> (structure) -> BackupTarget -> (string) -> ->> The location where automated backups and manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region. -> -> NetworkType -> (string) ->