AWS cli documentation change
Summary
Reorganized parameters and documentation structure for AWS CLI create-db-cluster command. Moved parameters like --deletion-protection, --enable-http-endpoint, and security-related fields in JSON output. Added validation constraints for --global-cluster-identifier and expanded certificate details.
Security assessment
Changes involve parameter reordering and documentation restructuring without introducing new security features or addressing vulnerabilities. Security-related parameters like --publicly-accessible and --deletion-protection were moved but not modified in functionality. CertificateDetails and IAM role references were relocated but not changed substantively.
Diff
diff --git a/cli/latest/reference/rds/create-db-cluster.md b/cli/latest/reference/rds/create-db-cluster.md index f160d5c0a..49cc86602 100644 --- a//cli/latest/reference/rds/create-db-cluster.md +++ b//cli/latest/reference/rds/create-db-cluster.md @@ -15 +15 @@ - * [AWS CLI 2.31.3 Command Reference](../../index.html) » + * [AWS CLI 2.31.5 Command Reference](../../index.html) » @@ -100,0 +101,6 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rds-20 + [--db-cluster-instance-class <value>] + [--allocated-storage <value>] + [--storage-type <value>] + [--iops <value>] + [--publicly-accessible | --no-publicly-accessible] + [--auto-minor-version-upgrade | --no-auto-minor-version-upgrade] @@ -108,6 +114,2 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rds-20 - [--db-cluster-instance-class <value>] - [--allocated-storage <value>] - [--storage-type <value>] - [--iops <value>] - [--publicly-accessible | --no-publicly-accessible] - [--auto-minor-version-upgrade | --no-auto-minor-version-upgrade] + [--network-type <value>] + [--serverless-v2-scaling-configuration <value>] @@ -121,2 +122,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rds-20 - [--serverless-v2-scaling-configuration <value>] - [--network-type <value>] @@ -126 +125,0 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rds-20 - [--master-user-secret-kms-key-id <value>] @@ -127,0 +127 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rds-20 + [--master-user-secret-kms-key-id <value>] @@ -669,52 +668,0 @@ JSON Syntax: -`--deletion-protection` | `--no-deletion-protection` (boolean) - -> Specifies whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection isn’t enabled. -> -> Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters - -`--global-cluster-identifier` (string) - -> The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster. -> -> Valid for Cluster Type: Aurora DB clusters only - -`--enable-http-endpoint` | `--no-enable-http-endpoint` (boolean) - -> Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn’t enabled. -> -> When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor. -> -> For more information, see [Using RDS Data API](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the _Amazon Aurora User Guide_ . -> -> Valid for Cluster Type: Aurora DB clusters only - -`--copy-tags-to-snapshot` | `--no-copy-tags-to-snapshot` (boolean) - -> Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. -> -> Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters - -`--domain` (string) - -> The Active Directory directory ID to create the DB cluster in. -> -> For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster. -> -> For more information, see [Kerberos authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the _Amazon Aurora User Guide_ . -> -> Valid for Cluster Type: Aurora DB clusters only - -`--domain-iam-role-name` (string) - -> The name of the IAM role to use when making API calls to the Directory Service. -> -> Valid for Cluster Type: Aurora DB clusters only - -`--enable-global-write-forwarding` | `--no-enable-global-write-forwarding` (boolean) - -> Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. -> -> You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then. -> -> Valid for Cluster Type: Aurora DB clusters only - @@ -818,0 +767,108 @@ JSON Syntax: +`--deletion-protection` | `--no-deletion-protection` (boolean) + +> Specifies whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection isn’t enabled. +> +> Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + +`--global-cluster-identifier` (string) + +> The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster. +> +> Valid for Cluster Type: Aurora DB clusters only +> +> Constraints: +> +> * min: `1` +> * max: `255` +> * pattern: `[A-Za-z][0-9A-Za-z-:._]*` +> + + +`--enable-http-endpoint` | `--no-enable-http-endpoint` (boolean) + +> Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn’t enabled. +> +> When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor. +> +> For more information, see [Using RDS Data API](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the _Amazon Aurora User Guide_ . +> +> Valid for Cluster Type: Aurora DB clusters only + +`--copy-tags-to-snapshot` | `--no-copy-tags-to-snapshot` (boolean) + +> Specifies whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. +> +> Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters + +`--domain` (string) + +> The Active Directory directory ID to create the DB cluster in. +> +> For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster. +> +> For more information, see [Kerberos authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the _Amazon Aurora User Guide_ . +> +> Valid for Cluster Type: Aurora DB clusters only + +`--domain-iam-role-name` (string) + +> The name of the IAM role to use when making API calls to the Directory Service. +> +> Valid for Cluster Type: Aurora DB clusters only + +`--enable-global-write-forwarding` | `--no-enable-global-write-forwarding` (boolean) + +> Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. +> +> You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then. +> +> Valid for Cluster Type: Aurora DB clusters only + +`--network-type` (string) + +> The network type of the DB cluster. +> +> The network type is determined by the `DBSubnetGroup` specified for the DB cluster. 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/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the _Amazon Aurora User Guide._ +> +> Valid for Cluster Type: Aurora DB clusters only +> +> Valid Values: `IPV4 | DUAL` + +`--serverless-v2-scaling-configuration` (structure) + +> Contains the scaling configuration of an Aurora Serverless v2 DB cluster. +> +> For more information, see [Using Amazon Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) in the _Amazon Aurora User Guide_ . +> +> MinCapacity -> (double) +> +>> The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don’t support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5. +> +> MaxCapacity -> (double) +> +>> The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 32, 32.5, 33, and so on. The largest value that you can use is 256 for recent Aurora versions, or 128 for older versions. You can check the attributes of your engine version or platform version to determine the specific maximum capacity supported. +> +> SecondsUntilAutoPause -> (integer) +> +>> Specifies the number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it. +>> +>> Specify a value between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds. + +Shorthand Syntax: + + + MinCapacity=double,MaxCapacity=double,SecondsUntilAutoPause=integer + + +JSON Syntax: + + + { + "MinCapacity": double, + "MaxCapacity": double, + "SecondsUntilAutoPause": integer + } + + @@ -900,48 +955,0 @@ JSON Syntax: -`--serverless-v2-scaling-configuration` (structure) - -> Contains the scaling configuration of an Aurora Serverless v2 DB cluster. -> -> For more information, see [Using Amazon Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) in the _Amazon Aurora User Guide_ . -> -> MinCapacity -> (double)