diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/apply-pending-maintenance-action.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/apply-pending-maintenance-action.rst new file mode 100644 index 0000000000000000000000000000000000000000..af4beb578f8d238e50fdca61e56b283254426c4f --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/apply-pending-maintenance-action.rst @@ -0,0 +1,26 @@ +**To apply pending maintenance actions** + +The following ``apply-pending-maintenance-action`` example applies the pending maintenance actions for a DB cluster. :: + + aws rds apply-pending-maintenance-action \ + --resource-identifier arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster \ + --apply-action system-update \ + --opt-in-type immediate + +Output:: + + { + "ResourcePendingMaintenanceActions": { + "ResourceIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster", + "PendingMaintenanceActionDetails": [ + { + "Action": "system-update", + "OptInStatus": "immediate", + "CurrentApplyDate": "2021-01-23T01:07:36.100Z", + "Description": "Upgrade to Aurora PostgreSQL 3.3.2" + } + ] + } + } + +For more information, see `Maintaining a DB instance `__ in the *Amazon RDS User Guide* and `Maintaining an Amazon Aurora DB cluster `__ in the *Amazon Aurora User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/authorize-db-security-group-ingress.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/authorize-db-security-group-ingress.rst new file mode 100644 index 0000000000000000000000000000000000000000..81a3f11a709c09fd98dc2a5eb9375a4b145c9db4 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/authorize-db-security-group-ingress.rst @@ -0,0 +1,27 @@ +**To associate an AWS Identity and Access Management (IAM) role with a DB instance** + +The following ``authorize-db-security-group-ingress`` example configures the default security group with an ingress rule for the CIDR IP range 192.0.2.0/24. :: + + aws rds authorize-db-security-group-ingress \ + --db-security-group-name default \ + --cidrip 192.0.2.0/24 + +Output:: + + { + "DBSecurityGroup": { + "OwnerId": "123456789012", + "DBSecurityGroupName": "default", + "DBSecurityGroupDescription": "default", + "EC2SecurityGroups": [], + "IPRanges": [ + { + "Status": "authorizing", + "CIDRIP": "192.0.2.0/24" + } + ], + "DBSecurityGroupArn": "arn:aws:rds:us-east-1:111122223333:secgrp:default" + } + } + +For more information, see `Authorizing Network Access to a DB Security Group from an IP Range `__ in the *Amazon RDS User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/backtrack-db-cluster.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/backtrack-db-cluster.rst new file mode 100644 index 0000000000000000000000000000000000000000..318df0afd0bbfe4b4187d81cfb66859bb21d0df9 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/backtrack-db-cluster.rst @@ -0,0 +1,7 @@ +**To backtrack an Aurora DB cluster** + +The following ``backtrack-db-cluster`` example backtracks the specified DB cluster sample-cluster to March 19, 2018, at 10 a.m. :: + + aws rds backtrack-db-cluster --db-cluster-identifier sample-cluster --backtrack-to 2018-03-19T10:00:00+00:00 + +This command outputs a JSON block that acknowledges the change to the RDS resource. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/copy-db-cluster-parameter-group.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/copy-db-cluster-parameter-group.rst new file mode 100644 index 0000000000000000000000000000000000000000..c54c5cbd3a962c298c67417c142375810fd87d69 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/copy-db-cluster-parameter-group.rst @@ -0,0 +1,21 @@ +**To copy a DB cluster parameter group** + +The following ``copy-db-cluster-parameter-group`` example makes a copy of a DB cluster parameter group. :: + + aws rds copy-db-cluster-parameter-group \ + --source-db-cluster-parameter-group-identifier mydbclusterpg \ + --target-db-cluster-parameter-group-identifier mydbclusterpgcopy \ + --target-db-cluster-parameter-group-description "Copy of mydbclusterpg parameter group" + +Output:: + + { + "DBClusterParameterGroup": { + "DBClusterParameterGroupName": "mydbclusterpgcopy", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpgcopy", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "Copy of mydbclusterpg parameter group" + } + } + +For more information, see `Copying a DB Cluster Parameter Group `__ in the *Amazon Aurora Users Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/copy-db-snapshot.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/copy-db-snapshot.rst new file mode 100644 index 0000000000000000000000000000000000000000..bc48c3b030a211698489fd2f15cdd7ecf7a68817 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/copy-db-snapshot.rst @@ -0,0 +1,42 @@ +**To copy a DB snapshot** + +The following ``copy-db-snapshot`` example creates a copy of a DB snapshot. :: + + aws rds copy-db-snapshot \ + --source-db-snapshot-identifier rds:database-mysql-2019-06-06-08-38 + --target-db-snapshot-identifier mydbsnapshotcopy + +Output:: + + { + "DBSnapshot": { + "VpcId": "vpc-6594f31c", + "Status": "creating", + "Encrypted": true, + "SourceDBSnapshotIdentifier": "arn:aws:rds:us-east-1:123456789012:snapshot:rds:database-mysql-2019-06-06-08-38", + "MasterUsername": "admin", + "Iops": 1000, + "Port": 3306, + "LicenseModel": "general-public-license", + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshotcopy", + "EngineVersion": "5.6.40", + "OptionGroupName": "default:mysql-5-6", + "ProcessorFeatures": [], + "Engine": "mysql", + "StorageType": "io1", + "DbiResourceId": "db-ZI7UJ5BLKMBYFGX7FDENCKADC4", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "SnapshotType": "manual", + "IAMDatabaseAuthenticationEnabled": false, + "SourceRegion": "us-east-1", + "DBInstanceIdentifier": "database-mysql", + "InstanceCreateTime": "2019-04-30T15:45:53.663Z", + "AvailabilityZone": "us-east-1f", + "PercentProgress": 0, + "AllocatedStorage": 100, + "DBSnapshotIdentifier": "mydbsnapshotcopy" + } + } + + +For more information, see `Copying a Snapshot `__ in the *Amazon RDS User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/copy-option-group.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/copy-option-group.rst new file mode 100644 index 0000000000000000000000000000000000000000..f3923a4d6ac1a5ae4e0ae3b0f499e347e6f3d0ee --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/copy-option-group.rst @@ -0,0 +1,24 @@ +**To copy an option group** + +The following ``copy-option-group`` example makes a copy of an option group. :: + + aws rds copy-option-group \ + --source-option-group-identifier myoptiongroup \ + --target-option-group-identifier new-option-group \ + --target-option-group-description "My option group copy" + +Output:: + + { + "OptionGroup": { + "Options": [], + "OptionGroupName": "new-option-group", + "MajorEngineVersion": "11.2", + "OptionGroupDescription": "My option group copy", + "AllowsVpcAndNonVpcInstanceMemberships": true, + "EngineName": "oracle-ee", + "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:new-option-group" + } + } + +For more information, see `Making a Copy of an Option Group `__ in the *Amazon RDS User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-cluster-parameter-group.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-cluster-parameter-group.rst new file mode 100644 index 0000000000000000000000000000000000000000..d140728d64521a893400c14d12fcdc96fefd1993 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-cluster-parameter-group.rst @@ -0,0 +1,21 @@ +**To create a DB cluster parameter group** + +The following ``create-db-cluster-parameter-group`` example creates a DB cluster parameter group. :: + + aws rds create-db-cluster-parameter-group \ + --db-cluster-parameter-group-name mydbclusterparametergroup \ + --db-parameter-group-family aurora5.6 \ + --description "My new cluster parameter group" + +Output:: + + { + "DBClusterParameterGroup": { + "DBClusterParameterGroupName": "mydbclusterparametergroup", + "DBParameterGroupFamily": "aurora5.6", + "Description": "My new cluster parameter group", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup" + } + } + +For more information, see `Creating a DB Cluster Parameter Group `__ in the *Amazon Aurora User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-cluster-snapshot.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-cluster-snapshot.rst new file mode 100644 index 0000000000000000000000000000000000000000..cf61f0771a5383df2ec0b41b8194cf4c93f58595 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-cluster-snapshot.rst @@ -0,0 +1,39 @@ +**To create a DB cluster snapshot** + +The following ``create-db-cluster-snapshot`` example creates a DB cluster snapshot. :: + + aws rds create-db-cluster-snapshot \ + --db-cluster-identifier mydbcluster \ + --db-cluster-snapshot-identifier mydbclustersnapshot + +Output:: + + { + "DBClusterSnapshot": { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "mydbclustersnapshot", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-18T21:21:00.469Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 1, + "Status": "creating", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 0, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot", + "IAMDatabaseAuthenticationEnabled": false + } + } + +For more information, see `Creating a DB Cluster Snapshot `__ in the *Amazon Aurora User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-cluster.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-cluster.rst new file mode 100644 index 0000000000000000000000000000000000000000..02181f03ca8d663a8c514e9bfc6745a33b020ad5 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-cluster.rst @@ -0,0 +1,118 @@ +**Example 1: To create a MySQL 5.7--compatible DB cluster** + +The following ``create-db-cluster`` example creates a MySQL 5.7-compatible DB cluster using the default engine version. Replace the sample password ``secret99`` with a secure password. When you use the console to create a DB cluster, Amazon RDS automatically creates the writer DB instance for your DB cluster. However, when you use the AWS CLI to create a DB cluster, you must explicitly create the writer DB instance for your DB cluster using the ``create-db-instance`` AWS CLI command. :: + + aws rds create-db-cluster \ + --db-cluster-identifier sample-cluster \ + --engine aurora-mysql \ + --engine-version 5.7 \ + --master-username admin \ + --master-user-password secret99 \ + --db-subnet-group-name default \ + --vpc-security-group-ids sg-0b9130572daf3dc16 + +Output:: + + { + "DBCluster": { + "DBSubnetGroup": "default", + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-0b9130572daf3dc16", + "Status": "active" + } + ], + "AllocatedStorage": 1, + "AssociatedRoles": [], + "PreferredBackupWindow": "09:12-09:42", + "ClusterCreateTime": "2023-02-27T23:21:33.048Z", + "DeletionProtection": false, + "IAMDatabaseAuthenticationEnabled": false, + "ReadReplicaIdentifiers": [], + "EngineMode": "provisioned", + "Engine": "aurora-mysql", + "StorageEncrypted": false, + "MultiAZ": false, + "PreferredMaintenanceWindow": "mon:04:31-mon:05:01", + "HttpEndpointEnabled": false, + "BackupRetentionPeriod": 1, + "DbClusterResourceId": "cluster-ANPAJ4AE5446DAEXAMPLE", + "DBClusterIdentifier": "sample-cluster", + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "MasterUsername": "master", + "EngineVersion": "5.7.mysql_aurora.2.11.1", + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster", + "DBClusterMembers": [], + "Port": 3306, + "Status": "creating", + "Endpoint": "sample-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "DBClusterParameterGroup": "default.aurora-mysql5.7", + "HostedZoneId": "Z2R2ITUGPM61AM", + "ReaderEndpoint": "sample-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "CopyTagsToSnapshot": false + } + } + +**Example 2: To create a PostgreSQL--compatible DB cluster** + +The following ``create-db-cluster`` example creates a PostgreSQL-compatible DB cluster using the default engine version. Replace the example password ``secret99`` with a secure password. When you use the console to create a DB cluster, Amazon RDS automatically creates the writer DB instance for your DB cluster. However, when you use the AWS CLI to create a DB cluster, you must explicitly create the writer DB instance for your DB cluster using the ``create-db-instance`` AWS CLI command. :: + + aws rds create-db-cluster \ + --db-cluster-identifier sample-pg-cluster \ + --engine aurora-postgresql \ + --master-username master \ + --master-user-password secret99 \ + --db-subnet-group-name default \ + --vpc-security-group-ids sg-0b9130572daf3dc16 + +Output:: + + { + "DBCluster": { + "Endpoint": "sample-pg-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "HttpEndpointEnabled": false, + "DBClusterMembers": [], + "EngineMode": "provisioned", + "CopyTagsToSnapshot": false, + "HostedZoneId": "Z2R2ITUGPM61AM", + "IAMDatabaseAuthenticationEnabled": false, + "AllocatedStorage": 1, + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-0b9130572daf3dc16", + "Status": "active" + } + ], + "DeletionProtection": false, + "StorageEncrypted": false, + "BackupRetentionPeriod": 1, + "PreferredBackupWindow": "09:56-10:26", + "ClusterCreateTime": "2023-02-27T23:26:08.371Z", + "DBClusterParameterGroup": "default.aurora-postgresql13", + "EngineVersion": "13.7", + "Engine": "aurora-postgresql", + "Status": "creating", + "DBClusterIdentifier": "sample-pg-cluster", + "MultiAZ": false, + "Port": 5432, + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-pg-cluster", + "AssociatedRoles": [], + "DbClusterResourceId": "cluster-ANPAJ4AE5446DAEXAMPLE", + "PreferredMaintenanceWindow": "wed:03:33-wed:04:03", + "ReaderEndpoint": "sample-pg-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "MasterUsername": "master", + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1c" + ], + "ReadReplicaIdentifiers": [], + "DBSubnetGroup": "default" + } + } + +For more information, see `Creating an Amazon Aurora DB cluster `__ in the *Amazon Aurora User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-instance.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-instance.rst new file mode 100644 index 0000000000000000000000000000000000000000..d43b721c3896721e187f70e9adda08ca0ecb5bae --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-instance.rst @@ -0,0 +1,106 @@ +**To create a DB instance** + +The following ``create-db-instance`` example uses the required options to launch a new DB instance. :: + + aws rds create-db-instance \ + --db-instance-identifier test-mysql-instance \ + --db-instance-class db.t3.micro \ + --engine mysql \ + --master-username admin \ + --master-user-password secret99 \ + --allocated-storage 20 + +Output:: + + { + "DBInstance": { + "DBInstanceIdentifier": "test-mysql-instance", + "DBInstanceClass": "db.t3.micro", + "Engine": "mysql", + "DBInstanceStatus": "creating", + "MasterUsername": "admin", + "AllocatedStorage": 20, + "PreferredBackupWindow": "12:55-13:25", + "BackupRetentionPeriod": 1, + "DBSecurityGroups": [], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-12345abc", + "Status": "active" + } + ], + "DBParameterGroups": [ + { + "DBParameterGroupName": "default.mysql5.7", + "ParameterApplyStatus": "in-sync" + } + ], + "DBSubnetGroup": { + "DBSubnetGroupName": "default", + "DBSubnetGroupDescription": "default", + "VpcId": "vpc-2ff2ff2f", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-########", + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-########", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-########", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-########", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + } + ] + }, + "PreferredMaintenanceWindow": "sun:08:07-sun:08:37", + "PendingModifiedValues": { + "MasterUserPassword": "****" + }, + "MultiAZ": false, + "EngineVersion": "5.7.22", + "AutoMinorVersionUpgrade": true, + "ReadReplicaDBInstanceIdentifiers": [], + "LicenseModel": "general-public-license", + "OptionGroupMemberships": [ + { + "OptionGroupName": "default:mysql-5-7", + "Status": "in-sync" + } + ], + "PubliclyAccessible": true, + "StorageType": "gp2", + "DbInstancePort": 0, + "StorageEncrypted": false, + "DbiResourceId": "db-5555EXAMPLE44444444EXAMPLE", + "CACertificateIdentifier": "rds-ca-2019", + "DomainMemberships": [], + "CopyTagsToSnapshot": false, + "MonitoringInterval": 0, + "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:test-mysql-instance", + "IAMDatabaseAuthenticationEnabled": false, + "PerformanceInsightsEnabled": false, + "DeletionProtection": false, + "AssociatedRoles": [] + } + } + +For more information, see `Creating an Amazon RDS DB Instance `__ in the *Amazon RDS User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-proxy-endpoint.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-proxy-endpoint.rst new file mode 100644 index 0000000000000000000000000000000000000000..3af58a32fb5e5dc57554968bc6dde918b1770bd6 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-proxy-endpoint.rst @@ -0,0 +1,34 @@ +**To create a DB proxy endpoint for an RDS database** + +The following ``create-db-proxy-endpoint`` example creates a DB proxy endpoint. :: + + aws rds create-db-proxy-endpoint \ + --db-proxy-name proxyExample \ + --db-proxy-endpoint-name "proxyep1" \ + --vpc-subnet-ids subnetgroup1 subnetgroup2 + +Output:: + + { + "DBProxyEndpoint": { + "DBProxyEndpointName": "proxyep1", + "DBProxyEndpointArn": "arn:aws:rds:us-east-1:123456789012:db-proxy-endpoint:prx-endpoint-0123a01b12345c0ab", + "DBProxyName": "proxyExample", + "Status": "creating", + "VpcId": "vpc-1234567", + "VpcSecurityGroupIds": [ + "sg-1234", + "sg-5678" + ], + "VpcSubnetIds": [ + "subnetgroup1", + "subnetgroup2" + ], + "Endpoint": "proxyep1.endpoint.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com", + "CreatedDate": "2023-04-05T16:09:33.452000+00:00", + "TargetRole": "READ_WRITE", + "IsDefault": false + } + } + +For more information, see `Creating a proxy endpoint `__ in the *Amazon RDS User Guide* and `Creating a proxy endpoint `__ in the *Amazon Aurora User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-proxy.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-proxy.rst new file mode 100644 index 0000000000000000000000000000000000000000..03f470e1d221c3251016acbf2be124e910018f3c --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-proxy.rst @@ -0,0 +1,47 @@ +**To create a DB proxy for an RDS database** + +The following ``create-db-proxy`` example creates a DB proxy. :: + + aws rds create-db-proxy \ + --db-proxy-name proxyExample \ + --engine-family MYSQL \ + --auth Description="proxydescription1",AuthScheme="SECRETS",SecretArn="arn:aws:secretsmanager:us-west-2:123456789123:secret:secretName-1234f",IAMAuth="DISABLED",ClientPasswordAuthType="MYSQL_NATIVE_PASSWORD" \ + --role-arn arn:aws:iam::123456789123:role/ProxyRole \ + --vpc-subnet-ids subnetgroup1 subnetgroup2 + +Output:: + + { + "DBProxy": { + "DBProxyName": "proxyExample", + "DBProxyArn": "arn:aws:rds:us-east-1:123456789012:db-proxy:prx-0123a01b12345c0ab", + "EngineFamily": "MYSQL", + "VpcId": "vpc-1234567", + "VpcSecuritytGroupIds": [ + "sg-1234", + "sg-5678", + "sg-9101" + ], + "VpcSubnetIds": [ + "subnetgroup1", + "subnetgroup2" + ], + "Auth": "[ + { + "Description": "proxydescription1", + "AuthScheme": "SECRETS", + "SecretArn": "arn:aws:secretsmanager:us-west-2:123456789123:secret:proxysecret1-Abcd1e", + "IAMAuth": "DISABLED" + } + ]", + "RoleArn": "arn:aws:iam::12345678912:role/ProxyRole", + "Endpoint": "proxyExample.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com", + "RequireTLS": false, + "IdleClientTimeout": 1800, + "DebuggingLogging": false, + "CreatedDate": "2023-04-05T16:09:33.452000+00:00", + "UpdatedDate": "2023-04-13T01:49:38.568000+00:00" + } + } + +For more information, see `Creating an RDS Proxy `__ in the *Amazon RDS User Guide* and `Creating an RDS Proxy `__ in the *Amazon Aurora User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-snapshot.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-snapshot.rst new file mode 100644 index 0000000000000000000000000000000000000000..45945003230ff9f479497dd54e85d793afca89b0 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-snapshot.rst @@ -0,0 +1,39 @@ +**To create a DB snapshot** + +The following ``create-db-snapshot`` example creates a DB snapshot. :: + + aws rds create-db-snapshot \ + --db-instance-identifier database-mysql \ + --db-snapshot-identifier mydbsnapshot + +Output:: + + { + "DBSnapshot": { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBInstanceIdentifier": "database-mysql", + "Engine": "mysql", + "AllocatedStorage": 100, + "Status": "creating", + "Port": 3306, + "AvailabilityZone": "us-east-1b", + "VpcId": "vpc-6594f31c", + "InstanceCreateTime": "2019-04-30T15:45:53.663Z", + "MasterUsername": "admin", + "EngineVersion": "5.6.40", + "LicenseModel": "general-public-license", + "SnapshotType": "manual", + "Iops": 1000, + "OptionGroupName": "default:mysql-5-6", + "PercentProgress": 0, + "StorageType": "io1", + "Encrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", + "IAMDatabaseAuthenticationEnabled": false, + "ProcessorFeatures": [], + "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE" + } + } + +For more information, see `Creating a DB Snapshot `__ in the *Amazon RDS User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-subnet-group.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-subnet-group.rst new file mode 100644 index 0000000000000000000000000000000000000000..ccf608c61880858dd2db3c413a79acf92c98df8f --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/create-db-subnet-group.rst @@ -0,0 +1,45 @@ +**To create a DB subnet group** + +The following ``create-db-subnet-group`` example creates a DB subnet group called ``mysubnetgroup`` using existing subnets. :: + + aws rds create-db-subnet-group \ + --db-subnet-group-name mysubnetgroup \ + --db-subnet-group-description "test DB subnet group" \ + --subnet-ids '["subnet-0a1dc4e1a6f123456","subnet-070dd7ecb3aaaaaaa","subnet-00f5b198bc0abcdef"]' + +Output:: + + { + "DBSubnetGroup": { + "DBSubnetGroupName": "mysubnetgroup", + "DBSubnetGroupDescription": "test DB subnet group", + "VpcId": "vpc-0f08e7610a1b2c3d4", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-070dd7ecb3aaaaaaa", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-00f5b198bc0abcdef", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-0a1dc4e1a6f123456", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + } + ], + "DBSubnetGroupArn": "arn:aws:rds:us-west-2:0123456789012:subgrp:mysubnetgroup" + } + } + +For more information, see `Creating a DB Instance in a VPC `__ in the *Amazon RDS User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/delete-blue-green-deployment.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/delete-blue-green-deployment.rst new file mode 100644 index 0000000000000000000000000000000000000000..251978a01afcf79447112454bda6a83b1db3dfc9 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/delete-blue-green-deployment.rst @@ -0,0 +1,137 @@ +**Example 1: To delete resources in green environment for an RDS for MySQL DB instance** + +The following ``delete-blue-green-deployment`` example deletes the resources in a green environment for an RDS for MySQL DB instance. :: + + aws rds delete-blue-green-deployment \ + --blue-green-deployment-identifier bgd-v53303651eexfake \ + --delete-target + +Output:: + + { + "BlueGreenDeployment": { + "BlueGreenDeploymentIdentifier": "bgd-v53303651eexfake", + "BlueGreenDeploymentName": "bgd-cli-test-instance", + "Source": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance", + "Target": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-rkfbpe", + "SwitchoverDetails": [ + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-rkfbpe", + "Status": "AVAILABLE" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1-green-j382ha", + "Status": "AVAILABLE" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2-green-ejv4ao", + "Status": "AVAILABLE" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3-green-vlpz3t", + "Status": "AVAILABLE" + } + ], + "Tasks": [ + { + "Name": "CREATING_READ_REPLICA_OF_SOURCE", + "Status": "COMPLETED" + }, + { + "Name": "DB_ENGINE_VERSION_UPGRADE", + "Status": "COMPLETED" + }, + { + "Name": "CONFIGURE_BACKUPS", + "Status": "COMPLETED" + }, + { + "Name": "CREATING_TOPOLOGY_OF_SOURCE", + "Status": "COMPLETED" + } + ], + "Status": "DELETING", + "CreateTime": "2022-02-25T21:18:51.183000+00:00", + "DeleteTime": "2022-02-25T22:25:31.331000+00:00" + } + } + +For more information, see `Deleting a blue/green deployment `__ in the *Amazon RDS User Guide*. + +**Example 2: To delete resources in green environment for an Aurora MySQL DB cluster** + +The following ``delete-blue-green-deployment`` example deletes the resources in a green environment for an Aurora MySQL DB cluster. :: + + aws rds delete-blue-green-deployment \ + --blue-green-deployment-identifier bgd-wi89nwzglccsfake \ + --delete-target + +Output:: + + { + "BlueGreenDeployment": { + "BlueGreenDeploymentIdentifier": "bgd-wi89nwzglccsfake", + "BlueGreenDeploymentName": "my-blue-green-deployment", + "Source": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster", + "Target": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl", + "SwitchoverDetails": [ + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl", + "Status": "AVAILABLE" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1-green-gpmaxf", + "Status": "AVAILABLE" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2-green-j2oajq", + "Status": "AVAILABLE" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3-green-mkxies", + "Status": "AVAILABLE" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint-green-4sqjrq", + "Status": "AVAILABLE" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint-green-gwwzlg", + "Status": "AVAILABLE" + } + ], + "Tasks": [ + { + "Name": "CREATING_READ_REPLICA_OF_SOURCE", + "Status": "COMPLETED" + }, + { + "Name": "DB_ENGINE_VERSION_UPGRADE", + "Status": "COMPLETED" + }, + { + "Name": "CREATE_DB_INSTANCES_FOR_CLUSTER", + "Status": "COMPLETED" + }, + { + "Name": "CREATE_CUSTOM_ENDPOINTS", + "Status": "COMPLETED" + } + ], + "Status": "DELETING", + "CreateTime": "2022-02-25T21:12:00.288000+00:00", + "DeleteTime": "2022-02-25T22:29:11.336000+00:00" + } + } + +For more information, see `Deleting a blue/green deployment `__ in the *Amazon Aurora User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/delete-db-cluster-endpoint.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/delete-db-cluster-endpoint.rst new file mode 100644 index 0000000000000000000000000000000000000000..c538b79e9ec3feda42a0da1d7fb49806a4349e30 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/delete-db-cluster-endpoint.rst @@ -0,0 +1,27 @@ +**To delete a custom DB cluster endpoint** + +The following ``delete-db-cluster-endpoint`` example deletes the specified custom DB cluster endpoint. :: + + aws rds delete-db-cluster-endpoint \ + --db-cluster-endpoint-identifier mycustomendpoint + +Output:: + + { + "DBClusterEndpointIdentifier": "mycustomendpoint", + "DBClusterIdentifier": "mydbcluster", + "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE", + "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "deleting", + "EndpointType": "CUSTOM", + "CustomEndpointType": "READER", + "StaticMembers": [ + "dbinstance1", + "dbinstance2", + "dbinstance3" + ], + "ExcludedMembers": [], + "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint" + } + +For more information, see `Amazon Aurora Connection Management `__ in the *Amazon Aurora User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/delete-db-cluster-snapshot.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/delete-db-cluster-snapshot.rst new file mode 100644 index 0000000000000000000000000000000000000000..e16c3ba1f7b14d0fc58d678c9ef7282af206f548 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/delete-db-cluster-snapshot.rst @@ -0,0 +1,38 @@ +**To delete a DB cluster snapshot** + +The following ``delete-db-cluster-snapshot`` example deletes the specified DB cluster snapshot. :: + + aws rds delete-db-cluster-snapshot \ + --db-cluster-snapshot-identifier mydbclustersnapshot + +Output:: + + { + "DBClusterSnapshot": { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "mydbclustersnapshot", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-18T21:21:00.469Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot", + "IAMDatabaseAuthenticationEnabled": false + } + } + +For more information, see `Deleting a Snapshot `__ in the *Amazon Aurora User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/delete-db-cluster.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/delete-db-cluster.rst new file mode 100644 index 0000000000000000000000000000000000000000..f08191f6db02d356878568338cfe153c59b8be6c --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/delete-db-cluster.rst @@ -0,0 +1,54 @@ +**Example 1: To delete a DB instance in a DB cluster** + +The following ``delete-db-instance`` example deletes the final DB instance in a DB cluster. You can't delete a DB cluster if it contains DB instances that aren't in the **deleting** state. You can't take a final snapshot when deleting a DB instance in a DB cluster. :: + + aws rds delete-db-instance \ + --db-instance-identifier database-3 + +Output:: + + { + "DBInstance": { + "DBInstanceIdentifier": "database-3", + "DBInstanceClass": "db.r4.large", + "Engine": "aurora-postgresql", + "DBInstanceStatus": "deleting", + + ...output omitted... + + } + } + +For more information, see `Deleting a DB Instance in an Aurora DB Cluster `__ in the *Amazon Aurora User Guide*. + +**Example 2: To delete a DB cluster** + +The following ``delete-db-cluster`` example deletes the DB cluster named ``mycluster`` and takes a final snapshot named ``mycluster-final-snapshot``. The status of the DB cluster is **available** while the snapshot is being taken. To follow the progress of the deletion, use the ``describe-db-clusters`` CLI command. :: + + aws rds delete-db-cluster \ + --db-cluster-identifier mycluster \ + --no-skip-final-snapshot \ + --final-db-snapshot-identifier mycluster-final-snapshot + +Output:: + + { + "DBCluster": { + "AllocatedStorage": 20, + "AvailabilityZones": [ + "eu-central-1b", + "eu-central-1c", + "eu-central-1a" + ], + "BackupRetentionPeriod": 7, + "DBClusterIdentifier": "mycluster", + "DBClusterParameterGroup": "default.aurora-postgresql10", + "DBSubnetGroup": "default-vpc-aa11bb22", + "Status": "available", + + ...output omitted... + + } + } + +For more information, see `Aurora Clusters with a Single DB Instance `__ in the *Amazon Aurora User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/delete-db-instance-automated-backup.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/delete-db-instance-automated-backup.rst new file mode 100644 index 0000000000000000000000000000000000000000..b5fafe3666c5115ab28015ed394abc814364bb18 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/delete-db-instance-automated-backup.rst @@ -0,0 +1,36 @@ +**To delete a replicated automated backup from a Region** + +The following ``delete-db-instance-automated-backup`` example deletes the automated backup with the specified Amazon Resource Name (ARN). :: + + aws rds delete-db-instance-automated-backup \ + --db-instance-automated-backups-arn "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" + +Output:: + + { + "DBInstanceAutomatedBackup": { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db", + "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE", + "Region": "us-east-1", + "DBInstanceIdentifier": "new-orcl-db", + "RestoreWindow": {}, + "AllocatedStorage": 20, + "Status": "deleting", + "Port": 1521, + "AvailabilityZone": "us-east-1b", + "VpcId": "vpc-########", + "InstanceCreateTime": "2020-12-04T15:28:31Z", + "MasterUsername": "admin", + "Engine": "oracle-se2", + "EngineVersion": "12.1.0.2.v21", + "LicenseModel": "bring-your-own-license", + "OptionGroupName": "default:oracle-se2-12-1", + "Encrypted": false, + "StorageType": "gp2", + "IAMDatabaseAuthenticationEnabled": false, + "BackupRetentionPeriod": 7, + "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" + } + } + +For more information, see `Deleting replicated backups `__ in the *Amazon RDS User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/delete-db-subnet-group.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/delete-db-subnet-group.rst new file mode 100644 index 0000000000000000000000000000000000000000..be9f348a9101b089ca165a7675f839242deddd3f --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/delete-db-subnet-group.rst @@ -0,0 +1,9 @@ +**To delete a DB subnet group** + +The following ``delete-db-subnet-group`` example deletes the DB subnet group called ``mysubnetgroup``. :: + + aws rds delete-db-subnet-group --db-subnet-group-name mysubnetgroup + +This command produces no output. + +For more information, see `Working with a DB Instance in a VPC `__ in the *Amazon RDS User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/describe-account-attributes.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-account-attributes.rst new file mode 100644 index 0000000000000000000000000000000000000000..cd105cdad38e065fce79178f3957f88d952ccf0d --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-account-attributes.rst @@ -0,0 +1,87 @@ +**To describe account attributes** + +The following ``describe-account-attributes`` example retrieves the attributes for the current AWS account. :: + + aws rds describe-account-attributes + +Output:: + + { + "AccountQuotas": [ + { + "Max": 40, + "Used": 4, + "AccountQuotaName": "DBInstances" + }, + { + "Max": 40, + "Used": 0, + "AccountQuotaName": "ReservedDBInstances" + }, + { + "Max": 100000, + "Used": 40, + "AccountQuotaName": "AllocatedStorage" + }, + { + "Max": 25, + "Used": 0, + "AccountQuotaName": "DBSecurityGroups" + }, + { + "Max": 20, + "Used": 0, + "AccountQuotaName": "AuthorizationsPerDBSecurityGroup" + }, + { + "Max": 50, + "Used": 1, + "AccountQuotaName": "DBParameterGroups" + }, + { + "Max": 100, + "Used": 3, + "AccountQuotaName": "ManualSnapshots" + }, + { + "Max": 20, + "Used": 0, + "AccountQuotaName": "EventSubscriptions" + }, + { + "Max": 50, + "Used": 1, + "AccountQuotaName": "DBSubnetGroups" + }, + { + "Max": 20, + "Used": 1, + "AccountQuotaName": "OptionGroups" + }, + { + "Max": 20, + "Used": 6, + "AccountQuotaName": "SubnetsPerDBSubnetGroup" + }, + { + "Max": 5, + "Used": 0, + "AccountQuotaName": "ReadReplicasPerMaster" + }, + { + "Max": 40, + "Used": 1, + "AccountQuotaName": "DBClusters" + }, + { + "Max": 50, + "Used": 0, + "AccountQuotaName": "DBClusterParameterGroups" + }, + { + "Max": 5, + "Used": 0, + "AccountQuotaName": "DBClusterRoles" + } + ] + } diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/describe-blue-green-deployments.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-blue-green-deployments.rst new file mode 100644 index 0000000000000000000000000000000000000000..3ba673cbe2bedd00dc44c13bf97bbd03cb8ef7f5 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-blue-green-deployments.rst @@ -0,0 +1,333 @@ +**Example 1: To describe a blue/green deployment of an RDS DB instance after creation completes** + +The following ``describe-blue-green-deployment`` example retrieves the details of a blue/green deployment after creation completes. :: + + aws rds describe-blue-green-deployments \ + --blue-green-deployment-identifier bgd-v53303651eexfake + +Output:: + + { + "BlueGreenDeployments": [ + { + "BlueGreenDeploymentIdentifier": "bgd-v53303651eexfake", + "BlueGreenDeploymentName": "bgd-cli-test-instance", + "Source": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance", + "Target": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-rkfbpe", + "SwitchoverDetails": [ + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-rkfbpe", + "Status": "AVAILABLE" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1-green-j382ha", + "Status": "AVAILABLE" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2-green-ejv4ao", + "Status": "AVAILABLE" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3-green-vlpz3t", + "Status": "AVAILABLE" + } + ], + "Tasks": [ + { + "Name": "CREATING_READ_REPLICA_OF_SOURCE", + "Status": "COMPLETED" + }, + { + "Name": "DB_ENGINE_VERSION_UPGRADE", + "Status": "COMPLETED" + }, + { + "Name": "CONFIGURE_BACKUPS", + "Status": "COMPLETED" + }, + { + "Name": "CREATING_TOPOLOGY_OF_SOURCE", + "Status": "COMPLETED" + } + ], + "Status": "AVAILABLE", + "CreateTime": "2022-02-25T21:18:51.183000+00:00" + } + ] + } + +For more information, see `Viewing a blue/green deployment `__ in the *Amazon RDS User Guide*. + +**Example 2: To describe a blue/green deployment for an Aurora MySQL DB cluster** + +The following ``describe-blue-green-deployment`` example retrieves the details of a blue/green deployment. :: + + aws rds describe-blue-green-deployments \ + --blue-green-deployment-identifier bgd-wi89nwzglccsfake + +Output:: + + { + "BlueGreenDeployments": [ + { + "BlueGreenDeploymentIdentifier": "bgd-wi89nwzglccsfake", + "BlueGreenDeploymentName": "my-blue-green-deployment", + "Source": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster", + "Target": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl", + "SwitchoverDetails": [ + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl", + "Status": "AVAILABLE" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1-green-gpmaxf", + "Status": "AVAILABLE" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2-green-j2oajq", + "Status": "AVAILABLE" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3-green-mkxies", + "Status": "AVAILABLE" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint-green-4sqjrq", + "Status": "AVAILABLE" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint-green-gwwzlg", + "Status": "AVAILABLE" + } + ], + "Tasks": [ + { + "Name": "CREATING_READ_REPLICA_OF_SOURCE", + "Status": "COMPLETED" + }, + { + "Name": "DB_ENGINE_VERSION_UPGRADE", + "Status": "COMPLETED" + }, + { + "Name": "CREATE_DB_INSTANCES_FOR_CLUSTER", + "Status": "COMPLETED" + }, + { + "Name": "CREATE_CUSTOM_ENDPOINTS", + "Status": "COMPLETED" + } + ], + "Status": "AVAILABLE", + "CreateTime": "2022-02-25T21:12:00.288000+00:00" + } + ] + } + +For more information, see `Viewing a blue/green deployment `__ in the *Amazon Aurora User Guide*. + + +**Example 3: To describe a blue/green deployment for an Aurora MySQL cluster after switchover** + +The following ``describe-blue-green-deployment`` example retrieves the details about a blue/green deployment after the green environment is promoted to be the production environment. :: + + aws rds describe-blue-green-deployments \ + --blue-green-deployment-identifier bgd-wi89nwzglccsfake + +Output:: + + { + "BlueGreenDeployments": [ + { + "BlueGreenDeploymentIdentifier": "bgd-wi89nwzglccsfake", + "BlueGreenDeploymentName": "my-blue-green-deployment", + "Source": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-old1", + "Target": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster", + "SwitchoverDetails": [ + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-old1", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster", + "Status": "SWITCHOVER_COMPLETED" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1-old1", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1", + "Status": "SWITCHOVER_COMPLETED" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2-old1", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2", + "Status": "SWITCHOVER_COMPLETED" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3-old1", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3", + "Status": "SWITCHOVER_COMPLETED" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint-old1", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint", + "Status": "SWITCHOVER_COMPLETED" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint-old1", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint", + "Status": "SWITCHOVER_COMPLETED" + } + ], + "Tasks": [ + { + "Name": "CREATING_READ_REPLICA_OF_SOURCE", + "Status": "COMPLETED" + }, + { + "Name": "DB_ENGINE_VERSION_UPGRADE", + "Status": "COMPLETED" + }, + { + "Name": "CREATE_DB_INSTANCES_FOR_CLUSTER", + "Status": "COMPLETED" + }, + { + "Name": "CREATE_CUSTOM_ENDPOINTS", + "Status": "COMPLETED" + } + ], + "Status": "SWITCHOVER_COMPLETED", + "CreateTime": "2022-02-25T22:38:49.522000+00:00" + } + ] + } + +For more information, see `Viewing a blue/green deployment `__ in the *Amazon Aurora User Guide*. + +**Example 4: To describe a combined blue/green deployment** + +The following ``describe-blue-green-deployment`` example retrieves the details of a combined blue/green deployment. :: + + aws rds describe-blue-green-deployments + +Output:: + + { + "BlueGreenDeployments": [ + { + "BlueGreenDeploymentIdentifier": "bgd-wi89nwzgfakelccs", + "BlueGreenDeploymentName": "my-blue-green-deployment", + "Source": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster", + "Target": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl", + "SwitchoverDetails": [ + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl", + "Status": "AVAILABLE" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1-green-gpmaxf", + "Status": "AVAILABLE" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2-green-j2oajq", + "Status": "AVAILABLE" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3-green-mkxies", + "Status": "AVAILABLE" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint-green-4sqjrq", + "Status": "AVAILABLE" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint-green-gwwzlg", + "Status": "AVAILABLE" + } + ], + "Tasks": [ + { + "Name": "CREATING_READ_REPLICA_OF_SOURCE", + "Status": "COMPLETED" + }, + { + "Name": "DB_ENGINE_VERSION_UPGRADE", + "Status": "COMPLETED" + }, + { + "Name": "CREATE_DB_INSTANCES_FOR_CLUSTER", + "Status": "COMPLETED" + }, + { + "Name": "CREATE_CUSTOM_ENDPOINTS", + "Status": "COMPLETED" + } + ], + "Status": "AVAILABLE", + "CreateTime": "2022-02-25T21:12:00.288000+00:00" + }, + { + "BlueGreenDeploymentIdentifier": "bgd-v5330365fake1eex", + "BlueGreenDeploymentName": "bgd-cli-test-instance", + "Source": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-old1", + "Target": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance", + "SwitchoverDetails": [ + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-old1", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance", + "Status": "SWITCHOVER_COMPLETED" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1-old1", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1", + "Status": "SWITCHOVER_COMPLETED" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2-old1", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2", + "Status": "SWITCHOVER_COMPLETED" + }, + { + "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3-old1", + "TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3", + "Status": "SWITCHOVER_COMPLETED" + } + ], + "Tasks": [ + { + "Name": "CREATING_READ_REPLICA_OF_SOURCE", + "Status": "COMPLETED" + }, + { + "Name": "DB_ENGINE_VERSION_UPGRADE", + "Status": "COMPLETED" + }, + { + "Name": "CONFIGURE_BACKUPS", + "Status": "COMPLETED" + }, + { + "Name": "CREATING_TOPOLOGY_OF_SOURCE", + "Status": "COMPLETED" + } + ], + "Status": "SWITCHOVER_COMPLETED", + "CreateTime": "2022-02-25T22:33:22.225000+00:00" + } + ] + } + +For more information, see `Viewing a blue/green deployment `__ in the *Amazon RDS User Guide* and `Viewing a blue/green deployment `__ in the *Amazon Aurora User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/describe-certificates.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-certificates.rst new file mode 100644 index 0000000000000000000000000000000000000000..087d5ba64c57ba4a48002a52ce5c4df055e4a647 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-certificates.rst @@ -0,0 +1,52 @@ +**To describe certificates** + +The following ``describe-certificates`` example retrieves the details of the certificate associated with the user's default region. :: + + aws rds describe-certificates + +Output:: + + { + "Certificates": [ + { + "CertificateIdentifier": "rds-ca-ecc384-g1", + "CertificateType": "CA", + "Thumbprint": "2ee3dcc06e50192559b13929e73484354f23387d", + "ValidFrom": "2021-05-24T22:06:59+00:00", + "ValidTill": "2121-05-24T23:06:59+00:00", + "CertificateArn": "arn:aws:rds:us-west-2::cert:rds-ca-ecc384-g1", + "CustomerOverride": false + }, + { + "CertificateIdentifier": "rds-ca-rsa4096-g1", + "CertificateType": "CA", + "Thumbprint": "19da4f2af579a8ae1f6a0fa77aa5befd874b4cab", + "ValidFrom": "2021-05-24T22:03:20+00:00", + "ValidTill": "2121-05-24T23:03:20+00:00", + "CertificateArn": "arn:aws:rds:us-west-2::cert:rds-ca-rsa4096-g1", + "CustomerOverride": false + }, + { + "CertificateIdentifier": "rds-ca-rsa2048-g1", + "CertificateType": "CA", + "Thumbprint": "7c40cb42714b6fdb2b296f9bbd0e8bb364436a76", + "ValidFrom": "2021-05-24T21:59:00+00:00", + "ValidTill": "2061-05-24T22:59:00+00:00", + "CertificateArn": "arn:aws:rds:us-west-2::cert:rds-ca-rsa2048-g1", + "CustomerOverride": true, + "CustomerOverrideValidTill": "2061-05-24T22:59:00+00:00" + }, + { + "CertificateIdentifier": "rds-ca-2019", + "CertificateType": "CA", + "Thumbprint": "d40ddb29e3750dffa671c3140bbf5f478d1c8096", + "ValidFrom": "2019-08-22T17:08:50+00:00", + "ValidTill": "2024-08-22T17:08:50+00:00", + "CertificateArn": "arn:aws:rds:us-west-2::cert:rds-ca-2019", + "CustomerOverride": false + } + ], + "DefaultCertificateForNewLaunches": "rds-ca-rsa2048-g1" + } + +For more information, see `Using SSL/TLS to encrypt a connection to a DB instance `__ in the *Amazon RDS User Guide* and `Using SSL/TLS to encrypt a connection to a DB cluster `__ in the *Amazon Aurora User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-cluster-backtracks.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-cluster-backtracks.rst new file mode 100644 index 0000000000000000000000000000000000000000..3e609ea851f97dd8fd7e7276ec3eb5fbd93bcb68 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-cluster-backtracks.rst @@ -0,0 +1,31 @@ +**To describe backtracks for a DB cluster** + +The following ``describe-db-cluster-backtracks`` example retrieves details about the specified DB cluster. :: + + aws rds describe-db-cluster-backtracks \ + --db-cluster-identifier mydbcluster + +Output:: + + { + "DBClusterBacktracks": [ + { + "DBClusterIdentifier": "mydbcluster", + "BacktrackIdentifier": "2f5f5294-0dd2-44c9-9f50-EXAMPLE", + "BacktrackTo": "2021-02-12T04:59:22Z", + "BacktrackedFrom": "2021-02-12T14:37:31.640Z", + "BacktrackRequestCreationTime": "2021-02-12T14:36:18.819Z", + "Status": "COMPLETED" + }, + { + "DBClusterIdentifier": "mydbcluster", + "BacktrackIdentifier": "3c7a6421-af2a-4ea3-ae95-EXAMPLE", + "BacktrackTo": "2021-02-11T22:53:46Z", + "BacktrackedFrom": "2021-02-12T00:09:27.006Z", + "BacktrackRequestCreationTime": "2021-02-12T00:07:53.487Z", + "Status": "COMPLETED" + } + ] + } + +For more information, see `Backtracking an Aurora DB cluster `__ in the *Amazon Aurora User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-cluster-endpoints.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-cluster-endpoints.rst new file mode 100644 index 0000000000000000000000000000000000000000..9c0635bff316087e3947bb59ee9cac49b4c6d57d --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-cluster-endpoints.rst @@ -0,0 +1,58 @@ +**Example 1: To describe DB cluster endpoints** + +The following ``describe-db-cluster-endpoints`` example retrieves details for your DB cluster endpoints. The most common kinds of Aurora clusters have two endpoints. One endpoint has type ``WRITER``. You can use this endpoint for all SQL statements. The other endpoint has type ``READER``. You can use this endpoint only for SELECT and other read-only SQL statements. :: + + aws rds describe-db-cluster-endpoints + +Output:: + + { + "DBClusterEndpoints": [ + { + "DBClusterIdentifier": "my-database-1", + "Endpoint": "my-database-1.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "creating", + "EndpointType": "WRITER" + }, + { + "DBClusterIdentifier": "my-database-1", + "Endpoint": "my-database-1.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "creating", + "EndpointType": "READER" + }, + { + "DBClusterIdentifier": "mydbcluster", + "Endpoint": "mydbcluster.cluster-cnpexamle.us-east-1.rds.amazonaws.com", + "Status": "available", + "EndpointType": "WRITER" + }, + { + "DBClusterIdentifier": "mydbcluster", + "Endpoint": "mydbcluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "available", + "EndpointType": "READER" + } + ] + } + +**Example 2: To describe DB cluster endpoints of a single DB cluster** + +The following ``describe-db-cluster-endpoints`` example retrieves details for the DB cluster endpoints of a single specified DB cluster. Aurora Serverless clusters have only a single endpoint with a type of ``WRITER``. :: + + aws rds describe-db-cluster-endpoints \ + --db-cluster-identifier serverless-cluster + +Output:: + + { + "DBClusterEndpoints": [ + { + "Status": "available", + "Endpoint": "serverless-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "DBClusterIdentifier": "serverless-cluster", + "EndpointType": "WRITER" + } + ] + } + +For more information, see `Amazon Aurora Connection Management `__ in the *Amazon Aurora User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-cluster-parameter-groups.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-cluster-parameter-groups.rst new file mode 100644 index 0000000000000000000000000000000000000000..449d024e4631478eddbd972fc7325ab748953eda --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-cluster-parameter-groups.rst @@ -0,0 +1,44 @@ +**To describe DB cluster parameter groups** + +The following ``describe-db-cluster-parameter-groups`` example retrieves details for your DB cluster parameter groups. :: + + aws rds describe-db-cluster-parameter-groups + +Output:: + + { + "DBClusterParameterGroups": [ + { + "DBClusterParameterGroupName": "default.aurora-mysql5.7", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "Default cluster parameter group for aurora-mysql5.7", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-mysql5.7" + }, + { + "DBClusterParameterGroupName": "default.aurora-postgresql9.6", + "DBParameterGroupFamily": "aurora-postgresql9.6", + "Description": "Default cluster parameter group for aurora-postgresql9.6", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-postgresql9.6" + }, + { + "DBClusterParameterGroupName": "default.aurora5.6", + "DBParameterGroupFamily": "aurora5.6", + "Description": "Default cluster parameter group for aurora5.6", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora5.6" + }, + { + "DBClusterParameterGroupName": "mydbclusterpg", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "My DB cluster parameter group", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpg" + }, + { + "DBClusterParameterGroupName": "mydbclusterpgcopy", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "Copy of mydbclusterpg parameter group", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpgcopy" + } + ] + } + +For more information, see `Working with DB Parameter Groups and DB Cluster Parameter Groups `__ in the *Amazon Aurora User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-cluster-parameters.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-cluster-parameters.rst new file mode 100644 index 0000000000000000000000000000000000000000..8c62d93e129cf64e54348a9bd3d9d6501fae489f --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-cluster-parameters.rst @@ -0,0 +1,141 @@ +**Example 1: To describe the parameters in a DB cluster parameter group** + +The following ``describe-db-cluster-parameters`` example retrieves details about the parameters in a DB cluster parameter group. :: + + aws rds describe-db-cluster-parameters \ + --db-cluster-parameter-group-name mydbclusterpg + +Output:: + + { + "Parameters": [ + { + "ParameterName": "allow-suspicious-udfs", + "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false, + "ApplyMethod": "pending-reboot", + "SupportedEngineModes": [ + "provisioned" + ] + }, + { + "ParameterName": "aurora_lab_mode", + "ParameterValue": "0", + "Description": "Enables new features in the Aurora engine.", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": true, + "ApplyMethod": "pending-reboot", + "SupportedEngineModes": [ + "provisioned" + ] + }, + ...some output truncated... + ] + } + +**Example 2: To list only the parameter names in a DB cluster parameter group** + +The following ``describe-db-cluster-parameters`` example retrieves only the names of the parameters in a DB cluster parameter group. :: + + aws rds describe-db-cluster-parameters \ + --db-cluster-parameter-group-name default.aurora-mysql5.7 \ + --query 'Parameters[].{ParameterName:ParameterName}' + +Output:: + + [ + { + "ParameterName": "allow-suspicious-udfs" + }, + { + "ParameterName": "aurora_binlog_read_buffer_size" + }, + { + "ParameterName": "aurora_binlog_replication_max_yield_seconds" + }, + { + "ParameterName": "aurora_binlog_use_large_read_buffer" + }, + { + "ParameterName": "aurora_lab_mode" + }, + + ...some output truncated... + } + ] + +**Example 3: To describe only the modifiable parameters in a DB cluster parameter group** + +The following ``describe-db-cluster-parameters`` example retrieves the names of only the parameters that you can modify in a DB cluster parameter group. :: + + aws rds describe-db-cluster-parameters \ + --db-cluster-parameter-group-name default.aurora-mysql5.7 \ + --query 'Parameters[].{ParameterName:ParameterName,IsModifiable:IsModifiable} | [?IsModifiable == `true`]' + +Output:: + + [ + { + "ParameterName": "aurora_binlog_read_buffer_size", + "IsModifiable": true + }, + { + "ParameterName": "aurora_binlog_replication_max_yield_seconds", + "IsModifiable": true + }, + { + "ParameterName": "aurora_binlog_use_large_read_buffer", + "IsModifiable": true + }, + { + "ParameterName": "aurora_lab_mode", + "IsModifiable": true + }, + + ...some output truncated... + } + ] + +**Example 4: To describe only the modifable Boolean parameters in a DB cluster parameter group** + +The following ``describe-db-cluster-parameters`` example retrieves the names of only the parameters that you can modify in a DB cluster parameter group and that have a Boolean data type. :: + + aws rds describe-db-cluster-parameters \ + --db-cluster-parameter-group-name default.aurora-mysql5.7 \ + --query 'Parameters[].{ParameterName:ParameterName,DataType:DataType,IsModifiable:IsModifiable} | [?DataType == `boolean`] | [?IsModifiable == `true`]' + +Output:: + + [ + { + "DataType": "boolean", + "ParameterName": "aurora_binlog_use_large_read_buffer", + "IsModifiable": true + }, + { + "DataType": "boolean", + "ParameterName": "aurora_lab_mode", + "IsModifiable": true + }, + { + "DataType": "boolean", + "ParameterName": "autocommit", + "IsModifiable": true + }, + { + "DataType": "boolean", + "ParameterName": "automatic_sp_privileges", + "IsModifiable": true + }, + ...some output truncated... + } + ] + +For more information, see `Working with DB Parameter Groups and DB Cluster Parameter Groups `__ in the *Amazon Aurora User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-cluster-snapshot-attributes.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-cluster-snapshot-attributes.rst new file mode 100644 index 0000000000000000000000000000000000000000..83a5c532b46fa0bc3d15fe09c389fe43f59c9573 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-cluster-snapshot-attributes.rst @@ -0,0 +1,24 @@ +**To describe the attribute names and values for a DB cluster snapshot** + +The following ``describe-db-cluster-snapshot-attributes`` example retrieves details of the attribute names and values for the specified DB cluster snapshot. :: + + aws rds describe-db-cluster-snapshot-attributes \ + --db-cluster-snapshot-identifier myclustersnapshot + +Output:: + + { + "DBClusterSnapshotAttributesResult": { + "DBClusterSnapshotIdentifier": "myclustersnapshot", + "DBClusterSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [ + "123456789012" + ] + } + ] + } + } + +For more information, see `Sharing a DB Cluster Snapshot `__ in the *Amazon Aurora User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-cluster-snapshots.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-cluster-snapshots.rst new file mode 100644 index 0000000000000000000000000000000000000000..00850b7b4d4b33573f92140995f7f1e227d79808 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-cluster-snapshots.rst @@ -0,0 +1,65 @@ +**To describe a DB cluster snapshot for a DB cluster** + +The following ``describe-db-cluster-snapshots`` example retrieves the details for the DB cluster snapshots for the specified DB cluster. :: + + aws rds describe-db-cluster-snapshots \ + --db-cluster-identifier mydbcluster + +Output:: + + { + "DBClusterSnapshots": [ + { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "myclustersnapshotcopy", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-04T09:16:42.649Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:814387698303:cluster-snapshot:myclustersnapshotcopy", + "IAMDatabaseAuthenticationEnabled": false + }, + { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "rds:mydbcluster-2019-06-20-09-16", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-20T09:16:26.569Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "automated", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:mydbcluster-2019-06-20-09-16", + "IAMDatabaseAuthenticationEnabled": false + } + ] + } + +For more information, see `Creating a DB Cluster Snapshot `__ in the *Amazon Aurora User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-clusters.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-clusters.rst new file mode 100644 index 0000000000000000000000000000000000000000..7a82185c87a9a1ef1d7b3e4f130ef1f9c1cf93dd --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-clusters.rst @@ -0,0 +1,141 @@ +**Example 1: To describe a DB cluster** + +The following ``describe-db-clusters`` example retrieves the details of the specified DB cluster. :: + + aws rds describe-db-clusters \ + --db-cluster-identifier mydbcluster + +Output:: + + { + "DBClusters": [ + { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "BackupRetentionPeriod": 1, + "DatabaseName": "mydbcluster", + "DBClusterIdentifier": "mydbcluster", + "DBClusterParameterGroup": "default.aurora-mysql5.7", + "DBSubnetGroup": "default", + "Status": "available", + "EarliestRestorableTime": "2019-06-19T09:16:28.210Z", + "Endpoint": "mydbcluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "ReaderEndpoint": "mydbcluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "MultiAZ": true, + "Engine": "aurora-mysql", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LatestRestorableTime": "2019-06-20T22:38:14.908Z", + "Port": 3306, + "MasterUsername": "myadmin", + "PreferredBackupWindow": "09:09-09:39", + "PreferredMaintenanceWindow": "sat:04:09-sat:04:39", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [ + { + "DBInstanceIdentifier": "dbinstance3", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "dbinstance1", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "dbinstance2", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "mydbcluster", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "mydbcluster-us-east-1b", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "mydbcluster", + "IsClusterWriter": true, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + } + ], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-0b9130572daf3dc16", + "Status": "active" + } + ], + "HostedZoneId": "Z2R2ITUGPM61AM", + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE", + "DbClusterResourceId": "cluster-AKIAIOSFODNN7EXAMPLE", + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:mydbcluster", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false + } + ] + } + +**Example 2: To list certain attributes of all DB clusters** + +The following ``describe-db-clusters`` example retrieves only the ``DBClusterIdentifier``, ``Endpoint``, and ``ReaderEndpoint`` attributes of all your DB clusters in the current AWS Region. :: + + aws rds describe-db-clusters \ + --query 'DBClusters[].{DBClusterIdentifier:DBClusterIdentifier,Endpoint:Endpoint,ReaderEndpoint:ReaderEndpoint}' + +Output:: + + [ + { + "Endpoint": "cluster-57-2020-05-01-2270.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "ReaderEndpoint": "cluster-57-2020-05-01-2270.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "DBClusterIdentifier": "cluster-57-2020-05-01-2270" + }, + { + "Endpoint": "cluster-57-2020-05-01-4615.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "ReaderEndpoint": "cluster-57-2020-05-01-4615.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "DBClusterIdentifier": "cluster-57-2020-05-01-4615" + }, + { + "Endpoint": "pg2-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "ReaderEndpoint": "pg2-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "DBClusterIdentifier": "pg2-cluster" + }, + ...output omitted... + } + ] + +**Example 3: To list DB clusters with a specific attribute** + +The following ``describe-db-clusters`` example retrieves only the ``DBClusterIdentifier`` and ``Engine`` attributes of your DB clusters that use the ``aurora-postgresql`` DB engine. :: + + aws rds describe-db-clusters \ + --query 'DBClusters[].{DBClusterIdentifier:DBClusterIdentifier,Engine:Engine} | [?Engine == `aurora-postgresql`]' + +Output:: + + [ + { + "Engine": "aurora-postgresql", + "DBClusterIdentifier": "pg2-cluster" + } + ] + +For more information, see `Amazon Aurora DB Clusters `__ in the *Amazon Aurora User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-instances.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-instances.rst new file mode 100644 index 0000000000000000000000000000000000000000..1fe197f8add026585d38d6892cb87572f86118cf --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-instances.rst @@ -0,0 +1,26 @@ +**To describe a DB instance** + +The following ``describe-db-instances`` example retrieves details about the specified DB instance. :: + + aws rds describe-db-instances \ + --db-instance-identifier mydbinstancecf + +Output:: + + { + "DBInstances": [ + { + "DBInstanceIdentifier": "mydbinstancecf", + "DBInstanceClass": "db.t3.small", + "Engine": "mysql", + "DBInstanceStatus": "available", + "MasterUsername": "masterawsuser", + "Endpoint": { + "Address": "mydbinstancecf.abcexample.us-east-1.rds.amazonaws.com", + "Port": 3306, + "HostedZoneId": "Z2R2ITUGPM61AM" + }, + ...some output truncated... + } + ] + } diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-log-files.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-log-files.rst new file mode 100644 index 0000000000000000000000000000000000000000..0e69d5e9933e6c51c031049742f32996b42f9d89 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-log-files.rst @@ -0,0 +1,43 @@ +**To describe the log files for a DB instance** + +The following ``describe-db-log-files`` example retrieves details about the log files for the specified DB instance. :: + + aws rds describe-db-log-files -\ + -db-instance-identifier test-instance + +Output:: + + { + "DescribeDBLogFiles": [ + { + "Size": 0, + "LastWritten": 1533060000000, + "LogFileName": "error/mysql-error-running.log" + }, + { + "Size": 2683, + "LastWritten": 1532994300000, + "LogFileName": "error/mysql-error-running.log.0" + }, + { + "Size": 107, + "LastWritten": 1533057300000, + "LogFileName": "error/mysql-error-running.log.18" + }, + { + "Size": 13105, + "LastWritten": 1532991000000, + "LogFileName": "error/mysql-error-running.log.23" + }, + { + "Size": 0, + "LastWritten": 1533061200000, + "LogFileName": "error/mysql-error.log" + }, + { + "Size": 3519, + "LastWritten": 1532989252000, + "LogFileName": "mysqlUpgrade" + } + ] + } diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-recommendations.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-recommendations.rst new file mode 100644 index 0000000000000000000000000000000000000000..f66da5c00205afd5c475ba8fd32ea1cbfaa58225 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-recommendations.rst @@ -0,0 +1,302 @@ +**Example 1: To list all DB recommendations** + +The following ``describe-db-recommendations`` example lists all DB recommendations in your AWS account. :: + + aws rds describe-db-recommendations + +Output:: + + { + "DBRecommendations": [ + { + "RecommendationId": "12ab3cde-f456-7g8h-9012-i3j45678k9lm", + "TypeId": "config_recommendation::old_minor_version", + "Severity": "informational", + "ResourceArn": "arn:aws:rds:us-west-2:111122223333:db:database-1", + "Status": "active", + "CreatedTime": "2024-02-21T23:14:19.292000+00:00", + "UpdatedTime": "2024-02-21T23:14:19+00:00", + "Detection": "**[resource-name]** is not running the latest minor DB engine version", + "Recommendation": "Upgrade to latest engine version", + "Description": "Your database resources aren't running the latest minor DB engine version. The latest minor version contains the latest security fixes and other improvements.", + "RecommendedActions": [ + { + "ActionId": "12ab34c5de6fg7h89i0jk1lm234n5678", + "Operation": "modifyDbInstance", + "Parameters": [ + { + "Key": "EngineVersion", + "Value": "5.7.44" + }, + { + "Key": "DBInstanceIdentifier", + "Value": "database-1" + } + ], + "ApplyModes": [ + "immediately", + "next-maintenance-window" + ], + "Status": "ready", + "ContextAttributes": [ + { + "Key": "Recommended value", + "Value": "5.7.44" + }, + { + "Key": "Current engine version", + "Value": "5.7.42" + } + ] + } + ], + "Category": "security", + "Source": "RDS", + "TypeDetection": "**[resource-count] resources** are not running the latest minor DB engine version", + "TypeRecommendation": "Upgrade to latest engine version", + "Impact": "Reduced database performance and data security at risk", + "AdditionalInfo": "We recommend that you maintain your database with the latest DB engine minor version as this version includes the latest security and functionality fixes. The DB engine minor version upgrades contain only the changes which are backward-compatible with earlier minor versions of the same major version of the DB engine.", + "Links": [ + { + "Text": "Upgrading an RDS DB instance engine version", + "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html" + }, + { + "Text": "Using Amazon RDS Blue/Green Deployments for database updates for Amazon Aurora", + "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html" + }, + { + "Text": "Using Amazon RDS Blue/Green Deployments for database updates for Amazon RDS", + "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html" + } + ] + } + ] + } + +For more information, see `Viewing and responding to Amazon RDS recommendations `__ in the *Amazon RDS User Guide* and `Viewing and responding to Amazon RDS recommendations `__ in the *Amazon Aurora User Guide*. + +**Example 2: To list high severity DB recommendations** + +The following ``describe-db-recommendations`` example lists high severity DB recommendations in your AWS account. :: + + aws rds describe-db-recommendations \ + --filters Name=severity,Values=high + +Output:: + + { + "DBRecommendations": [ + { + "RecommendationId": "12ab3cde-f456-7g8h-9012-i3j45678k9lm", + "TypeId": "config_recommendation::rds_extended_support", + "Severity": "high", + "ResourceArn": "arn:aws:rds:us-west-2:111122223333:db:database-1", + "Status": "active", + "CreatedTime": "2024-02-21T23:14:19.392000+00:00", + "UpdatedTime": "2024-02-21T23:14:19+00:00", + "Detection": "Your databases will be auto-enrolled to RDS Extended Support on February 29", + "Recommendation": "Upgrade your major version before February 29, 2024 to avoid additional charges", + "Description": "Your PostgreSQL 11 and MySQL 5.7 databases will be automatically enrolled into RDS Extended Support on February 29, 2024. To avoid the increase in charges due to RDS Extended Support, we recommend upgrading your databases to a newer major engine version before February 29, 2024.\nTo learn more about the RDS Extended Support pricing, refer to the pricing page.", + "RecommendedActions": [ + { + "ActionId": "12ab34c5de6fg7h89i0jk1lm234n5678", + "Parameters": [], + "ApplyModes": [ + "manual" + ], + "Status": "ready", + "ContextAttributes": [] + } + ], + "Category": "cost optimization", + "Source": "RDS", + "TypeDetection": "Your database will be auto-enrolled to RDS Extended Support on February 29", + "TypeRecommendation": "Upgrade your major version before February 29, 2024 to avoid additional charges", + "Impact": "Increase in charges due to RDS Extended Support", + "AdditionalInfo": "With Amazon RDS Extended Support, you can continue running your database on a major engine version past the RDS end of standard support date for an additional cost. This paid feature gives you more time to upgrade to a supported major engine version.\nDuring Extended Support, Amazon RDS will supply critical CVE patches and bug fixes.", + "Links": [ + { + "Text": "Amazon RDS Extended Support pricing for RDS for MySQL", + "Url": "https://aws.amazon.com/rds/mysql/pricing/" + }, + { + "Text": "Amazon RDS Extended Support for RDS for MySQL and PostgreSQL databases", + "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html" + }, + { + "Text": "Amazon RDS Extended Support pricing for Amazon Aurora PostgreSQL", + "Url": "https://aws.amazon.com/rds/aurora/pricing/" + }, + { + "Text": "Amazon RDS Extended Support for Aurora PostgreSQL databases", + "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html" + }, + { + "Text": "Amazon RDS Extended Support pricing for RDS for PostgreSQL", + "Url": "https://aws.amazon.com/rds/postgresql/pricing/" + } + ] + } + ] + } + +For more information, see `Viewing and responding to Amazon RDS recommendations `__ in the *Amazon RDS User Guide* and `Viewing and responding to Amazon RDS recommendations `__ in the *Amazon Aurora User Guide*. + +**Example 3: To list DB recommendations for a specified DB instance** + +The following ``describe-db-recommendations`` example lists all DB recommendations for a specified DB instance. :: + + aws rds describe-db-recommendations \ + --filters Name=dbi-resource-id,Values=database-1 + +Output:: + + { + "DBRecommendations": [ + { + "RecommendationId": "12ab3cde-f456-7g8h-9012-i3j45678k9lm", + "TypeId": "config_recommendation::old_minor_version", + "Severity": "informational", + "ResourceArn": "arn:aws:rds:us-west-2:111122223333:db:database-1", + "Status": "active", + "CreatedTime": "2024-02-21T23:14:19.292000+00:00", + "UpdatedTime": "2024-02-21T23:14:19+00:00", + "Detection": "**[resource-name]** is not running the latest minor DB engine version", + "Recommendation": "Upgrade to latest engine version", + "Description": "Your database resources aren't running the latest minor DB engine version. The latest minor version contains the latest security fixes and other improvements.", + "RecommendedActions": [ + { + "ActionId": "12ab34c5de6fg7h89i0jk1lm234n5678", + "Operation": "modifyDbInstance", + "Parameters": [ + { + "Key": "EngineVersion", + "Value": "5.7.44" + }, + { + "Key": "DBInstanceIdentifier", + "Value": "database-1" + } + ], + "ApplyModes": [ + "immediately", + "next-maintenance-window" + ], + "Status": "ready", + "ContextAttributes": [ + { + "Key": "Recommended value", + "Value": "5.7.44" + }, + { + "Key": "Current engine version", + "Value": "5.7.42" + } + ] + } + ], + "Category": "security", + "Source": "RDS", + "TypeDetection": "**[resource-count] resources** are not running the latest minor DB engine version", + "TypeRecommendation": "Upgrade to latest engine version", + "Impact": "Reduced database performance and data security at risk", + "AdditionalInfo": "We recommend that you maintain your database with the latest DB engine minor version as this version includes the latest security and functionality fixes. The DB engine minor version upgrades contain only the changes which are backward-compatible with earlier minor versions of the same major version of the DB engine.", + "Links": [ + { + "Text": "Upgrading an RDS DB instance engine version", + "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html" + }, + { + "Text": "Using Amazon RDS Blue/Green Deployments for database updates for Amazon Aurora", + "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html" + }, + { + "Text": "Using Amazon RDS Blue/Green Deployments for database updates for Amazon RDS", + "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html" + } + ] + } + ] + } + +For more information, see `Viewing and responding to Amazon RDS recommendations `__ in the *Amazon RDS User Guide* and `Viewing and responding to Amazon RDS recommendations `__ in the *Amazon Aurora User Guide*. + +**Example 4: To list all active DB recommendations** + +The following ``describe-db-recommendations`` example lists all active DB recommendations in your AWS account. :: + + aws rds describe-db-recommendations \ + --filters Name=status,Values=active + +Output:: + + { + "DBRecommendations": [ + { + "RecommendationId": "12ab3cde-f456-7g8h-9012-i3j45678k9lm", + "TypeId": "config_recommendation::old_minor_version", + "Severity": "informational", + "ResourceArn": "arn:aws:rds:us-west-2:111122223333:db:database-1", + "Status": "active", + "CreatedTime": "2024-02-21T23:14:19.292000+00:00", + "UpdatedTime": "2024-02-21T23:14:19+00:00", + "Detection": "**[resource-name]** is not running the latest minor DB engine version", + "Recommendation": "Upgrade to latest engine version", + "Description": "Your database resources aren't running the latest minor DB engine version. The latest minor version contains the latest security fixes and other improvements.", + "RecommendedActions": [ + { + "ActionId": "12ab34c5de6fg7h89i0jk1lm234n5678", + "Operation": "modifyDbInstance", + "Parameters": [ + { + "Key": "EngineVersion", + "Value": "5.7.44" + }, + { + "Key": "DBInstanceIdentifier", + "Value": "database-1" + } + ], + "ApplyModes": [ + "immediately", + "next-maintenance-window" + ], + "Status": "ready", + "ContextAttributes": [ + { + "Key": "Recommended value", + "Value": "5.7.44" + }, + { + "Key": "Current engine version", + "Value": "5.7.42" + } + ] + } + ], + "Category": "security", + "Source": "RDS", + "TypeDetection": "**[resource-count] resources** are not running the latest minor DB engine version", + "TypeRecommendation": "Upgrade to latest engine version", + "Impact": "Reduced database performance and data security at risk", + "AdditionalInfo": "We recommend that you maintain your database with the latest DB engine minor version as this version includes the latest security and functionality fixes. The DB engine minor version upgrades contain only the changes which are backward-compatible with earlier minor versions of the same major version of the DB engine.", + "Links": [ + { + "Text": "Upgrading an RDS DB instance engine version", + "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html" + }, + { + "Text": "Using Amazon RDS Blue/Green Deployments for database updates for Amazon Aurora", + "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html" + }, + { + "Text": "Using Amazon RDS Blue/Green Deployments for database updates for Amazon RDS", + "Url": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html" + } + ] + } + ] + } + +For more information, see `Viewing and responding to Amazon RDS recommendations `__ in the *Amazon RDS User Guide* and `Viewing and responding to Amazon RDS recommendations `__ in the *Amazon Aurora User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-security-groups.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-security-groups.rst new file mode 100644 index 0000000000000000000000000000000000000000..c0595e7ba53ccf11d35295a750fb6dc4d184cb08 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-security-groups.rst @@ -0,0 +1,31 @@ +**To list DB security groups** + +The following ``describe-db-security-groups`` example lists DB security groups. :: + + aws rds describe-db-security-groups + +Output:: + + { + "DBSecurityGroups": [ + { + "OwnerId": "123456789012", + "DBSecurityGroupName": "default", + "DBSecurityGroupDescription": "default", + "EC2SecurityGroups": [], + "IPRanges": [], + "DBSecurityGroupArn": "arn:aws:rds:us-west-1:111122223333:secgrp:default" + }, + { + "OwnerId": "123456789012", + "DBSecurityGroupName": "mysecgroup", + "DBSecurityGroupDescription": "My Test Security Group", + "VpcId": "vpc-1234567f", + "EC2SecurityGroups": [], + "IPRanges": [], + "DBSecurityGroupArn": "arn:aws:rds:us-west-1:111122223333:secgrp:mysecgroup" + } + ] + } + +For more information, see `Listing Available DB Security Groups `__ in the *Amazon RDS User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-shard-groups.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-shard-groups.rst new file mode 100644 index 0000000000000000000000000000000000000000..8f6a04abe7c8cb567a18fdc957713dc7b0080a6b --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-db-shard-groups.rst @@ -0,0 +1,34 @@ +**Example 1: To describe DB shard groups** + +The following ``describe-db-shard-groups`` example retrieves the details of your DB shard groups. :: + + aws rds describe-db-shard-groups + +Output:: + + { + "DBShardGroups": [ + { + "DBShardGroupResourceId": "shardgroup-7bb446329da94788b3f957746example", + "DBShardGroupIdentifier": "limitless-test-shard-grp", + "DBClusterIdentifier": "limitless-test-cluster", + "MaxACU": 768.0, + "ComputeRedundancy": 0, + "Status": "available", + "PubliclyAccessible": true, + "Endpoint": "limitless-test-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com" + }, + { + "DBShardGroupResourceId": "shardgroup-a6e3a0226aa243e2ac6c7a1234567890", + "DBShardGroupIdentifier": "my-db-shard-group", + "DBClusterIdentifier": "my-sv2-cluster", + "MaxACU": 768.0, + "ComputeRedundancy": 0, + "Status": "available", + "PubliclyAccessible": false, + "Endpoint": "my-sv2-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com" + } + ] + } + +For more information, see `Amazon Aurora DB Clusters `__ in the *Amazon Aurora User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/describe-event-categories.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-event-categories.rst new file mode 100644 index 0000000000000000000000000000000000000000..f74dbe9677c164074b1ec3230ae7521dc98ab6f5 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-event-categories.rst @@ -0,0 +1,67 @@ +**To describe event categories** + +The following ``describe-event-categories`` example retrieves details about the event categories for all available event sources. :: + + aws rds describe-event-categories + +Output:: + + { + "EventCategoriesMapList": [ + { + "SourceType": "db-instance", + "EventCategories": [ + "deletion", + "read replica", + "failover", + "restoration", + "maintenance", + "low storage", + "configuration change", + "backup", + "creation", + "availability", + "recovery", + "failure", + "backtrack", + "notification" + ] + }, + { + "SourceType": "db-security-group", + "EventCategories": [ + "configuration change", + "failure" + ] + }, + { + "SourceType": "db-parameter-group", + "EventCategories": [ + "configuration change" + ] + }, + { + "SourceType": "db-snapshot", + "EventCategories": [ + "deletion", + "creation", + "restoration", + "notification" + ] + }, + { + "SourceType": "db-cluster", + "EventCategories": [ + "failover", + "failure", + "notification" + ] + }, + { + "SourceType": "db-cluster-snapshot", + "EventCategories": [ + "backup" + ] + } + ] + } diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/describe-events.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-events.rst new file mode 100644 index 0000000000000000000000000000000000000000..f97ffbd52c0815623b95c7fd623ca62c2bec95af --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-events.rst @@ -0,0 +1,34 @@ +**To describe events** + +The following ``describe-events`` example retrieves details for the events that have occurred for the specified DB instance. :: + + aws rds describe-events \ + --source-identifier test-instance \ + --source-type db-instance + +Output:: + + { + "Events": [ + { + "SourceType": "db-instance", + "SourceIdentifier": "test-instance", + "EventCategories": [ + "backup" + ], + "Message": "Backing up DB instance", + "Date": "2018-07-31T23:09:23.983Z", + "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance" + }, + { + "SourceType": "db-instance", + "SourceIdentifier": "test-instance", + "EventCategories": [ + "backup" + ], + "Message": "Finished DB Instance backup", + "Date": "2018-07-31T23:15:13.049Z", + "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance" + } + ] + } diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/describe-export-tasks.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-export-tasks.rst new file mode 100644 index 0000000000000000000000000000000000000000..dd18e0943108c5e75447f0ee1dc19bb27ea59e67 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-export-tasks.rst @@ -0,0 +1,40 @@ +**To describe snapshot export tasks** + +The following ``describe-export-tasks`` example returns information about snapshot exports to Amazon S3. :: + + aws rds describe-export-tasks + +Output:: + + { + "ExportTasks": [ + { + "ExportTaskIdentifier": "test-snapshot-export", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:test-snapshot", + "SnapshotTime": "2020-03-02T18:26:28.163Z", + "TaskStartTime": "2020-03-02T18:57:56.896Z", + "TaskEndTime": "2020-03-02T19:10:31.985Z", + "S3Bucket": "amzn-s3-demo-bucket", + "S3Prefix": "", + "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff", + "Status": "COMPLETE", + "PercentProgress": 100, + "TotalExtractedDataInGB": 0 + }, + { + "ExportTaskIdentifier": "my-s3-export", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test", + "SnapshotTime": "2020-03-27T20:48:42.023Z", + "S3Bucket": "amzn-s3-demo-bucket", + "S3Prefix": "", + "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole", + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff", + "Status": "STARTING", + "PercentProgress": 0, + "TotalExtractedDataInGB": 0 + } + ] + } + +For more information, see `Monitoring Snapshot Exports `__ in the *Amazon RDS User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/describe-global-clusters.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-global-clusters.rst new file mode 100644 index 0000000000000000000000000000000000000000..b9cd425d3f43a030f4879a01c4a7670f8ad83563 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-global-clusters.rst @@ -0,0 +1,25 @@ +**To describe global DB clusters** + +The following ``describe-global-clusters`` example lists Aurora global DB clusters in the current AWS Region. :: + + aws rds describe-global-clusters + +Output:: + + { + "GlobalClusters": [ + { + "GlobalClusterIdentifier": "myglobalcluster", + "GlobalClusterResourceId": "cluster-f5982077e3b5aabb", + "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", + "Status": "available", + "Engine": "aurora-mysql", + "EngineVersion": "5.7.mysql_aurora.2.07.2", + "StorageEncrypted": false, + "DeletionProtection": false, + "GlobalClusterMembers": [] + } + ] + } + +For more information, see `Managing an Aurora global database `__ in the *Amazon Aurora User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/describe-option-group-options.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-option-group-options.rst new file mode 100644 index 0000000000000000000000000000000000000000..4dd2ffb60097154d0d4d2d224ccf704f1e1d2395 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-option-group-options.rst @@ -0,0 +1,61 @@ +**To describe all available options** + +The following ``describe-option-group-options`` example lists two options for an Oracle Database 19c instance. :: + + aws rds describe-option-group-options \ + --engine-name oracle-ee \ + --major-engine-version 19 \ + --max-items 2 + +Output:: + + { + "OptionGroupOptions": [ + { + "Name": "APEX", + "Description": "Oracle Application Express Runtime Environment", + "EngineName": "oracle-ee", + "MajorEngineVersion": "19", + "MinimumRequiredMinorEngineVersion": "0.0.0.ru-2019-07.rur-2019-07.r1", + "PortRequired": false, + "OptionsDependedOn": [], + "OptionsConflictsWith": [], + "Persistent": false, + "Permanent": false, + "RequiresAutoMinorEngineVersionUpgrade": false, + "VpcOnly": false, + "SupportsOptionVersionDowngrade": false, + "OptionGroupOptionSettings": [], + "OptionGroupOptionVersions": [ + { + "Version": "19.1.v1", + "IsDefault": true + }, + { + "Version": "19.2.v1", + "IsDefault": false + } + ] + }, + { + "Name": "APEX-DEV", + "Description": "Oracle Application Express Development Environment", + "EngineName": "oracle-ee", + "MajorEngineVersion": "19", + "MinimumRequiredMinorEngineVersion": "0.0.0.ru-2019-07.rur-2019-07.r1", + "PortRequired": false, + "OptionsDependedOn": [ + "APEX" + ], + "OptionsConflictsWith": [], + "Persistent": false, + "Permanent": false, + "RequiresAutoMinorEngineVersionUpgrade": false, + "VpcOnly": false, + "OptionGroupOptionSettings": [] + } + ], + "NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==" + } + +For more information, see `Listing the Options and Option Settings for an Option Group `__ in the *Amazon RDS User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/describe-orderable-db-instance-options.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-orderable-db-instance-options.rst new file mode 100644 index 0000000000000000000000000000000000000000..3a670dca4ed3a5bb162d8ecb1d79cf05a84f6cb6 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-orderable-db-instance-options.rst @@ -0,0 +1,46 @@ +**To describe orderable DB instance options** + +The following ``describe-orderable-db-instance-options`` example retrieves details about the orderable options for a DB instances running the MySQL DB engine. :: + + aws rds describe-orderable-db-instance-options \ + --engine mysql + +Output:: + + { + "OrderableDBInstanceOptions": [ + { + "MinStorageSize": 5, + "ReadReplicaCapable": true, + "MaxStorageSize": 6144, + "AvailabilityZones": [ + { + "Name": "us-east-1a" + }, + { + "Name": "us-east-1b" + }, + { + "Name": "us-east-1c" + }, + { + "Name": "us-east-1d" + } + ], + "SupportsIops": false, + "AvailableProcessorFeatures": [], + "MultiAZCapable": true, + "DBInstanceClass": "db.m1.large", + "Vpc": true, + "StorageType": "gp2", + "LicenseModel": "general-public-license", + "EngineVersion": "5.5.46", + "SupportsStorageEncryption": false, + "SupportsEnhancedMonitoring": true, + "Engine": "mysql", + "SupportsIAMDatabaseAuthentication": false, + "SupportsPerformanceInsights": false + } + ] + ...some output truncated... + } diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/describe-source-regions.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-source-regions.rst new file mode 100644 index 0000000000000000000000000000000000000000..edcabe7268ab883364f6d364d4a367622c545f62 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-source-regions.rst @@ -0,0 +1,141 @@ +**To describe source Regions** + +The following ``describe-source-regions`` example retrieves details about all source AWS Regions. It also shows that automated backups can be replicated only from US West (Oregon) to the destination AWS Region, US East (N. Virginia). :: + + aws rds describe-source-regions \ + --region us-east-1 + +Output:: + + { + "SourceRegions": [ + { + "RegionName": "af-south-1", + "Endpoint": "https://rds.af-south-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false + }, + { + "RegionName": "ap-east-1", + "Endpoint": "https://rds.ap-east-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false + }, + { + "RegionName": "ap-northeast-1", + "Endpoint": "https://rds.ap-northeast-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "ap-northeast-2", + "Endpoint": "https://rds.ap-northeast-2.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "ap-northeast-3", + "Endpoint": "https://rds.ap-northeast-3.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false + }, + { + "RegionName": "ap-south-1", + "Endpoint": "https://rds.ap-south-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "ap-southeast-1", + "Endpoint": "https://rds.ap-southeast-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "ap-southeast-2", + "Endpoint": "https://rds.ap-southeast-2.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "ap-southeast-3", + "Endpoint": "https://rds.ap-southeast-3.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false + }, + { + "RegionName": "ca-central-1", + "Endpoint": "https://rds.ca-central-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "eu-north-1", + "Endpoint": "https://rds.eu-north-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "eu-south-1", + "Endpoint": "https://rds.eu-south-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false + }, + { + "RegionName": "eu-west-1", + "Endpoint": "https://rds.eu-west-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "eu-west-2", + "Endpoint": "https://rds.eu-west-2.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "eu-west-3", + "Endpoint": "https://rds.eu-west-3.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "me-central-1", + "Endpoint": "https://rds.me-central-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false + }, + { + "RegionName": "me-south-1", + "Endpoint": "https://rds.me-south-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": false + }, + { + "RegionName": "sa-east-1", + "Endpoint": "https://rds.sa-east-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "us-east-2", + "Endpoint": "https://rds.us-east-2.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "us-west-1", + "Endpoint": "https://rds.us-west-1.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + }, + { + "RegionName": "us-west-2", + "Endpoint": "https://rds.us-west-2.amazonaws.com", + "Status": "available", + "SupportsDBInstanceAutomatedBackupsReplication": true + } + ] + } + +For more information, see `Finding information about replicated backups `__ in the *Amazon RDS User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/describe-valid-db-instance-modifications.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-valid-db-instance-modifications.rst new file mode 100644 index 0000000000000000000000000000000000000000..aa4e7cffc50eee510f1d9d30ccdd6440a6c2ff40 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/describe-valid-db-instance-modifications.rst @@ -0,0 +1,95 @@ +**To describe valid modifications for a DB instance** + +The following ``describe-valid-db-instance-modifications`` example retrieves details about the valid modifications for the specified DB instance. :: + + aws rds describe-valid-db-instance-modifications \ + --db-instance-identifier test-instance + +Output:: + + { + "ValidDBInstanceModificationsMessage": { + "ValidProcessorFeatures": [], + "Storage": [ + { + "StorageSize": [ + { + "Step": 1, + "To": 20, + "From": 20 + }, + { + "Step": 1, + "To": 6144, + "From": 22 + } + ], + "ProvisionedIops": [ + { + "Step": 1, + "To": 0, + "From": 0 + } + ], + "IopsToStorageRatio": [ + { + "To": 0.0, + "From": 0.0 + } + ], + "StorageType": "gp2" + }, + { + "StorageSize": [ + { + "Step": 1, + "To": 6144, + "From": 100 + } + ], + "ProvisionedIops": [ + { + "Step": 1, + "To": 40000, + "From": 1000 + } + ], + "IopsToStorageRatio": [ + { + "To": 50.0, + "From": 1.0 + } + ], + "StorageType": "io1" + }, + { + "StorageSize": [ + { + "Step": 1, + "To": 20, + "From": 20 + }, + { + "Step": 1, + "To": 3072, + "From": 22 + } + ], + "ProvisionedIops": [ + { + "Step": 1, + "To": 0, + "From": 0 + } + ], + "IopsToStorageRatio": [ + { + "To": 0.0, + "From": 0.0 + } + ], + "StorageType": "magnetic" + } + ] + } + } diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/generate-db-auth-token.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/generate-db-auth-token.rst new file mode 100644 index 0000000000000000000000000000000000000000..577b921c0203a25cc769779a948b64069a68eece --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/generate-db-auth-token.rst @@ -0,0 +1,15 @@ +**To generate an IAM authentication token** + +The following ``generate-db-auth-token`` example generates IAM authentication token to connect to a database. :: + + aws rds generate-db-auth-token \ + --hostname mydb.123456789012.us-east-1.rds.amazonaws.com \ + --port 3306 \ + --region us-east-1 \ + --username db_user + +Output:: + + mydb.123456789012.us-east-1.rds.amazonaws.com:3306/?Action=connect&DBUser=db_user&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIEXAMPLE%2Fus-east-1%2Frds-db%2Faws4_request&X-Amz-Date=20210123T011543Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=88987EXAMPLE1EXAMPLE2EXAMPLE3EXAMPLE4EXAMPLE5EXAMPLE6 + +For more information, see `Connecting to your DB instance using IAM authentication `__ in the *Amazon RDS User Guide* and `Connecting to your DB cluster using IAM authentication `__ in the *Amazon Aurora User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/list-tags-for-resource.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/list-tags-for-resource.rst new file mode 100644 index 0000000000000000000000000000000000000000..60a8a53c45c3c859273d9251721d7ef38943483a --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/list-tags-for-resource.rst @@ -0,0 +1,23 @@ +**To list tags on an Amazon RDS resource** + +The following ``list-tags-for-resource`` example lists all tags on a DB instance. :: + + aws rds list-tags-for-resource \ + --resource-name arn:aws:rds:us-east-1:123456789012:db:orcl1 + +Output:: + + { + "TagList": [ + { + "Key": "Environment", + "Value": "test" + }, + { + "Key": "Name", + "Value": "MyDatabase" + } + ] + } + +For more information, see `Tagging Amazon RDS Resources `__ in the *Amazon RDS User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/modify-certificates.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-certificates.rst new file mode 100644 index 0000000000000000000000000000000000000000..313494f08db03e49d28b10e3526b3de23d531bd7 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-certificates.rst @@ -0,0 +1,23 @@ +**To temporarily override the system-default SSL/TLS certificate for new DB instances** + +The following ``modify-certificates`` example temporarily overrides the system-default SSL/TLS certificate for new DB instances. :: + + aws rds modify-certificates \ + --certificate-identifier rds-ca-2019 + +Output:: + + { + "Certificate": { + "CertificateIdentifier": "rds-ca-2019", + "CertificateType": "CA", + "Thumbprint": "EXAMPLE123456789012", + "ValidFrom": "2019-09-19T18:16:53Z", + "ValidTill": "2024-08-22T17:08:50Z", + "CertificateArn": "arn:aws:rds:us-east-1::cert:rds-ca-2019", + "CustomerOverride": true, + "CustomerOverrideValidTill": "2024-08-22T17:08:50Z" + } + } + +For more information, see `Rotating your SSL/TLS certificate `__ in the *Amazon RDS User Guide* and `Rotating your SSL/TLS certificate `__ in the *Amazon Aurora User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-cluster-endpoint.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-cluster-endpoint.rst new file mode 100644 index 0000000000000000000000000000000000000000..d408d29a50712a6b984870662052d6d144bfd977 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-cluster-endpoint.rst @@ -0,0 +1,28 @@ +**To modify a custom DB cluster endpoint** + +The following ``modify-db-cluster-endpoint`` example modifies the specified custom DB cluster endpoint. :: + + aws rds modify-db-cluster-endpoint \ + --db-cluster-endpoint-identifier mycustomendpoint \ + --static-members dbinstance1 dbinstance2 dbinstance3 + +Output:: + + { + "DBClusterEndpointIdentifier": "mycustomendpoint", + "DBClusterIdentifier": "mydbcluster", + "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE", + "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "modifying", + "EndpointType": "CUSTOM", + "CustomEndpointType": "READER", + "StaticMembers": [ + "dbinstance1", + "dbinstance2", + "dbinstance3" + ], + "ExcludedMembers": [], + "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint" + } + +For more information, see `Amazon Aurora Connection Management `__ in the *Amazon Aurora User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-cluster-parameter-group.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-cluster-parameter-group.rst new file mode 100644 index 0000000000000000000000000000000000000000..c659452dc2c586460048c7d567bd1fd206203232 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-cluster-parameter-group.rst @@ -0,0 +1,16 @@ +**To modify parameters in a DB cluster parameter group** + +The following ``modify-db-cluster-parameter-group`` example modifies the values of parameters in a DB cluster parameter group. :: + + aws rds modify-db-cluster-parameter-group \ + --db-cluster-parameter-group-name mydbclusterpg \ + --parameters "ParameterName=server_audit_logging,ParameterValue=1,ApplyMethod=immediate" \ + "ParameterName=server_audit_logs_upload,ParameterValue=1,ApplyMethod=immediate" + +Output:: + + { + "DBClusterParameterGroupName": "mydbclusterpg" + } + +For more information, see `Working with DB parameter groups and DB cluster parameter groups `__ in the *Amazon Aurora User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-instance.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-instance.rst new file mode 100644 index 0000000000000000000000000000000000000000..38f903f9138f5a730763afcf8e2337125fca88ca --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-instance.rst @@ -0,0 +1,102 @@ +**Example 1: To modify a DB instance** + +The following ``modify-db-instance`` example associates an option group and a parameter group with a compatible Microsoft SQL Server DB instance. The ``--apply-immediately`` parameter causes the option and parameter groups to be associated immediately, instead of waiting until the next maintenance window. :: + + aws rds modify-db-instance \ + --db-instance-identifier database-2 \ + --option-group-name test-se-2017 \ + --db-parameter-group-name test-sqlserver-se-2017 \ + --apply-immediately + +Output:: + + { + "DBInstance": { + "DBInstanceIdentifier": "database-2", + "DBInstanceClass": "db.r4.large", + "Engine": "sqlserver-se", + "DBInstanceStatus": "available", + + ...output omitted... + + "DBParameterGroups": [ + { + "DBParameterGroupName": "test-sqlserver-se-2017", + "ParameterApplyStatus": "applying" + } + ], + "AvailabilityZone": "us-west-2d", + + ...output omitted... + + "MultiAZ": true, + "EngineVersion": "14.00.3281.6.v1", + "AutoMinorVersionUpgrade": false, + "ReadReplicaDBInstanceIdentifiers": [], + "LicenseModel": "license-included", + "OptionGroupMemberships": [ + { + "OptionGroupName": "test-se-2017", + "Status": "pending-apply" + } + ], + "CharacterSetName": "SQL_Latin1_General_CP1_CI_AS", + "SecondaryAvailabilityZone": "us-west-2c", + "PubliclyAccessible": true, + "StorageType": "gp2", + + ...output omitted... + + "DeletionProtection": false, + "AssociatedRoles": [], + "MaxAllocatedStorage": 1000 + } + } + +For more information, see `Modifying an Amazon RDS DB Instance `__ in the *Amazon RDS User Guide*. + +**Example 2: To associate VPC security group with a DB instance** + +The following ``modify-db-instance`` example associates a specific VPC security group and removes DB security groups from a DB instance:: + + aws rds modify-db-instance \ + --db-instance-identifier dbName \ + --vpc-security-group-ids sg-ID + +Output:: + + { + "DBInstance": { + "DBInstanceIdentifier": "dbName", + "DBInstanceClass": "db.t3.micro", + "Engine": "mysql", + "DBInstanceStatus": "available", + "MasterUsername": "admin", + "Endpoint": { + "Address": "dbName.abcdefghijk.us-west-2.rds.amazonaws.com", + "Port": 3306, + "HostedZoneId": "ABCDEFGHIJK1234" + }, + "AllocatedStorage": 20, + "InstanceCreateTime": "2024-02-15T00:37:58.793000+00:00", + "PreferredBackupWindow": "11:57-12:27", + "BackupRetentionPeriod": 7, + "DBSecurityGroups": [], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-ID", + "Status": "active" + } + ], + ... output omitted ... + "MultiAZ": false, + "EngineVersion": "8.0.35", + "AutoMinorVersionUpgrade": true, + "ReadReplicaDBInstanceIdentifiers": [], + "LicenseModel": "general-public-license", + + ... output ommited ... + } + } + +For more information, see `Controlling access with security groups `__ in the *Amazon RDS User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-parameter-group.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-parameter-group.rst new file mode 100644 index 0000000000000000000000000000000000000000..7f86a1ca929f6e784e9b20dca61ea4cc55eaef21 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-parameter-group.rst @@ -0,0 +1,16 @@ +**To modify a DB parameter group** + +The following ``modify-db-parameter-group`` example changes the value of the ``clr enabled`` parameter in a DB parameter group. The ``--apply-immediately`` parameter causes the DB parameter group to be modified immediately, instead of waiting until the next maintenance window. :: + + aws rds modify-db-parameter-group \ + --db-parameter-group-name test-sqlserver-se-2017 \ + --parameters "ParameterName='clr enabled',ParameterValue=1,ApplyMethod=immediate" + + +Output:: + + { + "DBParameterGroupName": "test-sqlserver-se-2017" + } + +For more information, see `Modifying Parameters in a DB Parameter Group `__ in the *Amazon RDS User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-proxy-endpoint.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-proxy-endpoint.rst new file mode 100644 index 0000000000000000000000000000000000000000..9ffd97dd1fe4c8d32f7adfc3f223cf6af77e15ec --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-proxy-endpoint.rst @@ -0,0 +1,33 @@ +**To modify a DB proxy endpoint for an RDS database** + +The following ``modify-db-proxy-endpoint`` example modifies a DB proxy endpoint ``proxyEndpoint`` to set the read-timeout to 65 seconds. :: + + aws rds modify-db-proxy-endpoint \ + --db-proxy-endpoint-name proxyEndpoint \ + --cli-read-timeout 65 + +Output:: + + { + "DBProxyEndpoint": + { + "DBProxyEndpointName": "proxyEndpoint", + "DBProxyEndpointArn": "arn:aws:rds:us-east-1:123456789012:db-proxy-endpoint:prx-endpoint-0123a01b12345c0ab", + "DBProxyName": "proxyExample", + "Status": "available", + "VpcId": "vpc-1234567", + "VpcSecurityGroupIds": [ + "sg-1234" + ], + "VpcSubnetIds": [ + "subnetgroup1", + "subnetgroup2" + ], + "Endpoint": "proxyEndpoint.endpoint.proxyExample-ab0cd1efghij.us-east-1.rds.amazonaws.com", + "CreatedDate": "2023-04-05T16:09:33.452000+00:00", + "TargetRole": "READ_WRITE", + "IsDefault": "false" + } + } + +For more information, see `Modifying a proxy endpoint `__ in the *Amazon RDS User Guide* and `Modifying a proxy endpoint `__ in the *Amazon Aurora User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-proxy-target-group.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-proxy-target-group.rst new file mode 100644 index 0000000000000000000000000000000000000000..5b80bea4b2d50a653ba8d5f1010f2310e32a620f --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-proxy-target-group.rst @@ -0,0 +1,34 @@ +**To modify a DB proxy endpoints** + +The following ``modify-db-proxy-target-group`` example modifies a DB proxy target group to set the maximum connections to 80 percent and maximum idle connections to 10 percent. :: + + aws rds modify-db-proxy-target-group \ + --target-group-name default \ + --db-proxy-name proxyExample \ + --connection-pool-config MaxConnectionsPercent=80,MaxIdleConnectionsPercent=10 + + +Output:: + + { + "DBProxyTargetGroup": + { + "DBProxyName": "proxyExample", + "TargetGroupName": "default", + "TargetGroupArn": "arn:aws:rds:us-east-1:123456789012:target-group:prx-tg-0123a01b12345c0ab", + "IsDefault": true, + "Status": "available", + "ConnectionPoolConfig": { + "MaxConnectionsPercent": 80, + "MaxIdleConnectionsPercent": 10, + "ConnectionBorrowTimeout": 120, + "SessionPinningFilters": [] + }, + "CreatedDate": "2023-05-02T18:41:19.495000+00:00", + "UpdatedDate": "2023-05-02T18:41:21.762000+00:00" + } + } + +For more information, see `Modifying an RDS Proxy `__ in the *Amazon RDS User Guide* and `Modifying an RDS Proxy `__ in the *Amazon Aurora User Guide*. + + diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-proxy.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-proxy.rst new file mode 100644 index 0000000000000000000000000000000000000000..aefbd0cd7a8b8ba1c1001657047e7a31db45b943 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-proxy.rst @@ -0,0 +1,44 @@ +**To modify a DB proxy for an RDS database** + +The following ``modify-db-proxy`` example modifies a DB proxy named ``proxyExample`` to require SSL for its connections. :: + + aws rds modify-db-proxy \ + --db-proxy-name proxyExample \ + --require-tls + +Output:: + + { + "DBProxy": + { + "DBProxyName": "proxyExample", + "DBProxyArn": "arn:aws:rds:us-east-1:123456789012:db-proxy:prx-0123a01b12345c0ab", + "Status": "modifying" + "EngineFamily": "PostgreSQL", + "VpcId": "sg-1234567", + "VpcSecurityGroupIds": [ + "sg-1234" + ], + "VpcSubnetIds": [ + "subnetgroup1", + "subnetgroup2" + ], + "Auth": "[ + { + "Description": "proxydescription1", + "AuthScheme": "SECRETS", + "SecretArn": "arn:aws:secretsmanager:us-west-2:123456789123:secret:proxysecret1-Abcd1e", + "IAMAuth": "DISABLED" + } + ]", + "RoleArn": "arn:aws:iam::12345678912:role/ProxyPostgreSQLRole", + "Endpoint": "proxyExample.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com", + "RequireTLS": true, + "IdleClientTimeout": 1800, + "DebuggingLogging": false, + "CreatedDate": "2023-04-05T16:09:33.452000+00:00", + "UpdatedDate": "2023-04-13T01:49:38.568000+00:00" + } + } + +For more information, see `Modify an RDS Proxy `__ in the *Amazon RDS User Guide* and `Creating an RDS Proxy `__ in the *Amazon Aurora User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-shard-group.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-shard-group.rst new file mode 100644 index 0000000000000000000000000000000000000000..cb45a8b38cb8eed33a6bd8d1b2aaada7bbd770fb --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-shard-group.rst @@ -0,0 +1,61 @@ +**Example 1: To modify a DB shard group** + +The following ``modify-db-shard-group`` example changes the maximum capacity of a DB shard group. :: + + aws rds modify-db-shard-group \ + --db-shard-group-identifier my-db-shard-group \ + --max-acu 1000 + +Output:: + + { + "DBShardGroups": [ + { + "DBShardGroupResourceId": "shardgroup-a6e3a0226aa243e2ac6c7a1234567890", + "DBShardGroupIdentifier": "my-db-shard-group", + "DBClusterIdentifier": "my-sv2-cluster", + "MaxACU": 768.0, + "ComputeRedundancy": 0, + "Status": "available", + "PubliclyAccessible": false, + "Endpoint": "my-sv2-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com" + } + ] + } + +For more information, see `Amazon Aurora DB Clusters `__ in the *Amazon Aurora User Guide*. + +**Example 2: To describe your DB shard groups** + +The following ``describe-db-shard-groups`` example retrieves the details of your DB shard groups after you run the ``modify-db-shard-group`` command. The maximum capacity of the DB shard group ``my-db-shard-group`` is now 1000 Aurora capacity units (ACUs). :: + + aws rds describe-db-shard-groups + +Output:: + + { + "DBShardGroups": [ + { + "DBShardGroupResourceId": "shardgroup-7bb446329da94788b3f957746example", + "DBShardGroupIdentifier": "limitless-test-shard-grp", + "DBClusterIdentifier": "limitless-test-cluster", + "MaxACU": 768.0, + "ComputeRedundancy": 0, + "Status": "available", + "PubliclyAccessible": true, + "Endpoint": "limitless-test-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com" + }, + { + "DBShardGroupResourceId": "shardgroup-a6e3a0226aa243e2ac6c7a1234567890", + "DBShardGroupIdentifier": "my-db-shard-group", + "DBClusterIdentifier": "my-sv2-cluster", + "MaxACU": 1000.0, + "ComputeRedundancy": 0, + "Status": "available", + "PubliclyAccessible": false, + "Endpoint": "my-sv2-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com" + } + ] + } + +For more information, see `Amazon Aurora DB Clusters `__ in the *Amazon Aurora User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-snapshot-attributes.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-snapshot-attributes.rst new file mode 100644 index 0000000000000000000000000000000000000000..ca32a805d9774737d3fe504f987e106e181ebebb --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-snapshot-attributes.rst @@ -0,0 +1,27 @@ +**To modify a DB snapshot attribute** + +The following ``modify-db-snapshot-attribute`` example permits two AWS account identifiers, ``111122223333`` and ``444455556666``, to restore the DB snapshot named ``mydbsnapshot``. :: + + aws rds modify-db-snapshot-attribute \ + --db-snapshot-identifier mydbsnapshot \ + --attribute-name restore \ + --values-to-add '["111122223333","444455556666"]' + +Output:: + + { + "DBSnapshotAttributesResult": { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [ + "111122223333", + "444455556666" + ] + } + ] + } + } + +For more information, see `Sharing a Snapshot `__ in the *Amazon RDS User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-snapshot.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-snapshot.rst new file mode 100644 index 0000000000000000000000000000000000000000..5bc7d1e18d7fc3f31129eac7f8b76709088b9246 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-snapshot.rst @@ -0,0 +1,38 @@ +**To modify a DB snapshot** + +The following ``modify-db-snapshot`` example upgrades a PostgeSQL 10.6 snapshot named ``db5-snapshot-upg-test`` to PostgreSQL 11.7. The new DB engine version is shown after the snapshot has finished upgrading and its status is **available**. :: + + aws rds modify-db-snapshot \ + --db-snapshot-identifier db5-snapshot-upg-test \ + --engine-version 11.7 + +Output:: + + { + "DBSnapshot": { + "DBSnapshotIdentifier": "db5-snapshot-upg-test", + "DBInstanceIdentifier": "database-5", + "SnapshotCreateTime": "2020-03-27T20:49:17.092Z", + "Engine": "postgres", + "AllocatedStorage": 20, + "Status": "upgrading", + "Port": 5432, + "AvailabilityZone": "us-west-2a", + "VpcId": "vpc-2ff27557", + "InstanceCreateTime": "2020-03-27T19:59:04.735Z", + "MasterUsername": "postgres", + "EngineVersion": "10.6", + "LicenseModel": "postgresql-license", + "SnapshotType": "manual", + "OptionGroupName": "default:postgres-11", + "PercentProgress": 100, + "StorageType": "gp2", + "Encrypted": false, + "DBSnapshotArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-upg-test", + "IAMDatabaseAuthenticationEnabled": false, + "ProcessorFeatures": [], + "DbiResourceId": "db-GJMF75LM42IL6BTFRE4UZJ5YM4" + } + } + +For more information, see `Upgrading a PostgreSQL DB Snapshot `__ in the *Amazon RDS User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-subnet-group.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-subnet-group.rst new file mode 100644 index 0000000000000000000000000000000000000000..0c75aa4c7dd7c838d6c29d7fbb9e50d25ad46f2a --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-db-subnet-group.rst @@ -0,0 +1,51 @@ +**To modify a DB subnet group** + +The following ``modify-db-subnet-group`` example adds a subnet with the ID ``subnet-08e41f9e230222222`` to the DB subnet group named ``mysubnetgroup``. To keep the existing subnets in the subnet group, include their IDs as values in the ``--subnet-ids`` option. Make sure to have subnets with at least two different Availability Zones in the DB subnet group. :: + + aws rds modify-db-subnet-group \ + --db-subnet-group-name mysubnetgroup \ + --subnet-ids '["subnet-0a1dc4e1a6f123456","subnet-070dd7ecb3aaaaaaa","subnet-00f5b198bc0abcdef","subnet-08e41f9e230222222"]' + +Output:: + + { + "DBSubnetGroup": { + "DBSubnetGroupName": "mysubnetgroup", + "DBSubnetGroupDescription": "test DB subnet group", + "VpcId": "vpc-0f08e7610a1b2c3d4", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-08e41f9e230222222", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-070dd7ecb3aaaaaaa", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-00f5b198bc0abcdef", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-0a1dc4e1a6f123456", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + } + ], + "DBSubnetGroupArn": "arn:aws:rds:us-west-2:534026745191:subgrp:mysubnetgroup" + } + } + +For more information, see `Step 3: Create a DB Subnet Group `__ in the *Amazon RDS User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/modify-event-subscription.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-event-subscription.rst new file mode 100644 index 0000000000000000000000000000000000000000..a27fb1322b5d4ba94de36da236b1489296586eb2 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/modify-event-subscription.rst @@ -0,0 +1,26 @@ +**To modify an event subscription** + +The following ``modify-event-subscription`` example disables the specified event subscription, so that it no longer publishes notifications to the specified Amazon Simple Notification Service topic. :: + + aws rds modify-event-subscription \ + --subscription-name my-instance-events \ + --no-enabled + +Output:: + + { + "EventSubscription": { + "EventCategoriesList": [ + "backup", + "recovery" + ], + "CustomerAwsId": "123456789012", + "SourceType": "db-instance", + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "CustSubscriptionId": "my-instance-events", + "Status": "modifying", + "Enabled": false + } + } diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/promote-read-replica-db-cluster.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/promote-read-replica-db-cluster.rst new file mode 100644 index 0000000000000000000000000000000000000000..ac48b11fcb8ef4ffcbf5cc51dfdddde7be633966 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/promote-read-replica-db-cluster.rst @@ -0,0 +1,25 @@ +**To promote a DB cluster read replica** + +The following ``promote-read-replica-db-cluster`` example promotes the specified read replica to become a standalone DB cluster. :: + + aws rds promote-read-replica-db-cluster \ + --db-cluster-identifier mydbcluster-1 + +Output:: + + { + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1c" + ], + "BackupRetentionPeriod": 1, + "DatabaseName": "", + "DBClusterIdentifier": "mydbcluster-1", + ...some output truncated... + } + } + +For more information, see `Promoting a read replica to be a DB cluster `__ in the *Amazon Aurora User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/promote-read-replica.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/promote-read-replica.rst new file mode 100644 index 0000000000000000000000000000000000000000..f81e4b1825c5f9fb4dbbafd79b90e34ab90863cb --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/promote-read-replica.rst @@ -0,0 +1,18 @@ +**To promote a read replica** + +The following ``promote-read-replica`` example promotes the specified read replica to become a standalone DB instance. :: + + aws rds promote-read-replica \ + --db-instance-identifier test-instance-repl + +Output:: + + { + "DBInstance": { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance-repl", + "StorageType": "standard", + "ReadReplicaSourceDBInstanceIdentifier": "test-instance", + "DBInstanceStatus": "modifying", + ...some output truncated... + } + } diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/purchase-reserved-db-instance.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/purchase-reserved-db-instance.rst new file mode 100644 index 0000000000000000000000000000000000000000..37dd044b3ea5b0627beaa904de125dd359679802 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/purchase-reserved-db-instance.rst @@ -0,0 +1,7 @@ +**To purchase a reserved DB instance offering** + +The following ``purchase-reserved-db-instances-offering`` example purchases a reserved DB instance offering. The ``reserved-db-instances-offering-id`` must be a valid offering ID, as returned by the ``describe-reserved-db-instances-offering`` command. + + aws rds purchase-reserved-db-instances-offering \ + --reserved-db-instances-offering-id 438012d3-4a52-4cc7-b2e3-8dff72e0e706 + diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/purchase-reserved-db-instances-offerings.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/purchase-reserved-db-instances-offerings.rst new file mode 100644 index 0000000000000000000000000000000000000000..02e84fd1727a38add9a96bcf584bde64da54d595 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/purchase-reserved-db-instances-offerings.rst @@ -0,0 +1,71 @@ +**Example 1: To find a reserved DB instance to purchase** + +The following ``describe-reserved-db-instances-offerings`` example lists the available reserved MySQL DB instances with the db.t2.micro instance class and a duration of one year. The offering ID is required for purchasing a reserved DB instance. :: + + aws rds describe-reserved-db-instances-offerings \ + --product-description mysql \ + --db-instance-class db.t2.micro \ + --duration 1 + +Output:: + + { + "ReservedDBInstancesOfferings": [ + { + "ReservedDBInstancesOfferingId": "8ba30be1-b9ec-447f-8f23-6114e3f4c7b4", + "DBInstanceClass": "db.t2.micro", + "Duration": 31536000, + "FixedPrice": 51.0, + "UsagePrice": 0.0, + "CurrencyCode": "USD", + "ProductDescription": "mysql", + "OfferingType": "Partial Upfront", + "MultiAZ": false, + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.006, + "RecurringChargeFrequency": "Hourly" + } + ] + }, + ... some output truncated ... + ] + } + +For more information, see `Reserved DB Instances for Amazon RDS `__ in the *Amazon RDS User Guide*. + +**Example 2: To purchase a reserved DB instance** + +The following ``purchase-reserved-db-instances-offering`` example shows how to buy the reserved DB instance offering from the previous example. + + aws rds purchase-reserved-db-instances-offering \ + --reserved-db-instances-offering-id 8ba30be1-b9ec-447f-8f23-6114e3f4c7b4 + +Output:: + + { + "ReservedDBInstance": { + "ReservedDBInstanceId": "ri-2020-06-29-16-54-57-670", + "ReservedDBInstancesOfferingId": "8ba30be1-b9ec-447f-8f23-6114e3f4c7b4", + "DBInstanceClass": "db.t2.micro", + "StartTime": "2020-06-29T16:54:57.670Z", + "Duration": 31536000, + "FixedPrice": 51.0, + "UsagePrice": 0.0, + "CurrencyCode": "USD", + "DBInstanceCount": 1, + "ProductDescription": "mysql", + "OfferingType": "Partial Upfront", + "MultiAZ": false, + "State": "payment-pending", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.006, + "RecurringChargeFrequency": "Hourly" + } + ], + "ReservedDBInstanceArn": "arn:aws:rds:us-west-2:123456789012:ri:ri-2020-06-29-16-54-57-670" + } + } + +For more information, see `Reserved DB Instances for Amazon RDS `__ in the *Amazon RDS User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/reboot-db-instance.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/reboot-db-instance.rst new file mode 100644 index 0000000000000000000000000000000000000000..47c76e40761eda57fc620dd6b0e6ef489f42ef03 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/reboot-db-instance.rst @@ -0,0 +1,28 @@ +**To reboot a DB instance** + +The following ``reboot-db-instance`` example starts a reboot of the specified DB instance. :: + + aws rds reboot-db-instance \ + --db-instance-identifier test-mysql-instance + +Output:: + + { + "DBInstance": { + "DBInstanceIdentifier": "test-mysql-instance", + "DBInstanceClass": "db.t3.micro", + "Engine": "mysql", + "DBInstanceStatus": "rebooting", + "MasterUsername": "admin", + "Endpoint": { + "Address": "test-mysql-instance.############.us-west-2.rds.amazonaws.com", + "Port": 3306, + "HostedZoneId": "Z1PVIF0EXAMPLE" + }, + + ... output omitted... + + } + } + +For more information, see `Rebooting a DB Instance `__ in the *Amazon RDS User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/reboot-db-shard-group.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/reboot-db-shard-group.rst new file mode 100644 index 0000000000000000000000000000000000000000..5fa635d08f4c6b186a7f3d20f42e5bdffb1ee495 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/reboot-db-shard-group.rst @@ -0,0 +1,60 @@ +**Example 1: To reboot a DB shard group** + +The following ``reboot-db-shard-group`` example reboots a DB shard group. :: + + aws rds reboot-db-shard-group \ + --db-shard-group-identifier my-db-shard-group + +Output:: + + { + "DBShardGroups": [ + { + "DBShardGroupResourceId": "shardgroup-a6e3a0226aa243e2ac6c7a1234567890", + "DBShardGroupIdentifier": "my-db-shard-group", + "DBClusterIdentifier": "my-sv2-cluster", + "MaxACU": 1000.0, + "ComputeRedundancy": 0, + "Status": "available", + "PubliclyAccessible": false, + "Endpoint": "my-sv2-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com" + } + ] + } + +For more information, see `Rebooting an Amazon Aurora DB cluster or Amazon Aurora DB instance `__ in the *Amazon Aurora User Guide*. + +**Example 2: To describe your DB shard groups** + +The following ``describe-db-shard-groups`` example retrieves the details of your DB shard groups after you run the ``reboot-db-shard-group`` command. The DB shard group ``my-db-shard-group`` is now rebooting. :: + + aws rds describe-db-shard-groups + +Output:: + + { + "DBShardGroups": [ + { + "DBShardGroupResourceId": "shardgroup-7bb446329da94788b3f957746example", + "DBShardGroupIdentifier": "limitless-test-shard-grp", + "DBClusterIdentifier": "limitless-test-cluster", + "MaxACU": 768.0, + "ComputeRedundancy": 0, + "Status": "available", + "PubliclyAccessible": true, + "Endpoint": "limitless-test-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com" + }, + { + "DBShardGroupResourceId": "shardgroup-a6e3a0226aa243e2ac6c7a1234567890", + "DBShardGroupIdentifier": "my-db-shard-group", + "DBClusterIdentifier": "my-sv2-cluster", + "MaxACU": 1000.0, + "ComputeRedundancy": 0, + "Status": "rebooting", + "PubliclyAccessible": false, + "Endpoint": "my-sv2-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com" + } + ] + } + +For more information, see `Rebooting an Amazon Aurora DB cluster or Amazon Aurora DB instance `__ in the *Amazon Aurora User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/register-db-proxy-targets.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/register-db-proxy-targets.rst new file mode 100644 index 0000000000000000000000000000000000000000..6883ba28bd2beb1f0fb50fd956d69f226300bae0 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/register-db-proxy-targets.rst @@ -0,0 +1,33 @@ +**To register a DB proxy with a database** + +The following ``register-db-proxy-targets`` example creates the association between a database and a proxy. :: + + aws rds register-db-proxy-targets \ + --db-proxy-name proxyExample \ + --db-cluster-identifiers database-5 + +Output:: + + { + "DBProxyTargets": [ + { + "RdsResourceId": "database-5", + "Port": 3306, + "Type": "TRACKED_CLUSTER", + "TargetHealth": { + "State": "REGISTERING" + } + }, + { + "Endpoint": "database-5instance-1.ab0cd1efghij.us-east-1.rds.amazonaws.com", + "RdsResourceId": "database-5", + "Port": 3306, + "Type": "RDS_INSTANCE", + "TargetHealth": { + "State": "REGISTERING" + } + } + ] + } + +For more information, see `Creating an RDS proxy `__ in the *Amazon RDS User Guide* and `Creating an RDS proxy `__ in the *Amazon Aurora User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/remove-from-global-cluster.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/remove-from-global-cluster.rst new file mode 100644 index 0000000000000000000000000000000000000000..1ef0dfb4a5a31bf8cfa9230a5cc4654599c3cc6c --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/remove-from-global-cluster.rst @@ -0,0 +1,40 @@ +**To detach an Aurora secondary cluster from an Aurora global database cluster** + +The following ``remove-from-global-cluster`` example detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster changes from being read-only to a standalone cluster with read-write capability. :: + + aws rds remove-from-global-cluster \ + --region us-west-2 \ + --global-cluster-identifier myglobalcluster \ + --db-cluster-identifier arn:aws:rds:us-west-2:123456789012:cluster:DB-1 + +Output:: + + { + "GlobalCluster": { + "GlobalClusterIdentifier": "myglobalcluster", + "GlobalClusterResourceId": "cluster-abc123def456gh", + "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster", + "Status": "available", + "Engine": "aurora-postgresql", + "EngineVersion": "10.11", + "StorageEncrypted": true, + "DeletionProtection": false, + "GlobalClusterMembers": [ + { + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:js-global-cluster", + "Readers": [ + "arn:aws:rds:us-west-2:123456789012:cluster:DB-1" + ], + "IsWriter": true + }, + { + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:DB-1", + "Readers": [], + "IsWriter": false, + "GlobalWriteForwardingStatus": "disabled" + } + ] + } + } + +For more information, see `Removing a cluster from an Amazon Aurora global database `__ in the *Amazon Aurora User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/remove-role-from-db-cluster.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/remove-role-from-db-cluster.rst new file mode 100644 index 0000000000000000000000000000000000000000..5c8112cb5eb1eaf490ded5736d9aca436c2ce1fd --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/remove-role-from-db-cluster.rst @@ -0,0 +1,11 @@ +**To disassociate an AWS Identity and Access Management (IAM) role from a DB cluster** + +The following ``remove-role-from-db-cluster`` example removes a role from a DB cluster. :: + + aws rds remove-role-from-db-cluster \ + --db-cluster-identifier mydbcluster \ + --role-arn arn:aws:iam::123456789012:role/RDSLoadFromS3 + +This command produces no output. + +For more information, see `Associating an IAM role with an Amazon Aurora MySQL DB cluster `__ in the *Amazon Aurora User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/remove-source-identifier-from-subscription.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/remove-source-identifier-from-subscription.rst new file mode 100644 index 0000000000000000000000000000000000000000..b809d695f13fae373369132bd950baeba1ce175f --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/remove-source-identifier-from-subscription.rst @@ -0,0 +1,29 @@ +**To remove a source identifier from a subscription** + +The following ``remove-source-identifier`` example removes the specified source identifier from an existing subscription. :: + + aws rds remove-source-identifier-from-subscription \ + --subscription-name my-instance-events \ + --source-identifier test-instance-repl + +Output:: + + { + "EventSubscription": { + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "EventCategoriesList": [ + "backup", + "recovery" + ], + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "Status": "modifying", + "CustSubscriptionId": "my-instance-events", + "CustomerAwsId": "123456789012", + "SourceIdsList": [ + "test-instance" + ], + "SourceType": "db-instance", + "Enabled": false + } + } diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/reset-db-cluster-parameter-group.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/reset-db-cluster-parameter-group.rst new file mode 100644 index 0000000000000000000000000000000000000000..099af55818a45c312811b7c9de5e25118bddd047 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/reset-db-cluster-parameter-group.rst @@ -0,0 +1,32 @@ +**Example 1: To reset all parameters to their default values** + +The following ``reset-db-cluster-parameter-group`` example resets all parameter values in a customer-created DB cluster parameter group to their default values. :: + + aws rds reset-db-cluster-parameter-group \ + --db-cluster-parameter-group-name mydbclpg \ + --reset-all-parameters + +Output:: + + { + "DBClusterParameterGroupName": "mydbclpg" + } + +For more information, see `Working with DB parameter groups and DB cluster parameter groups `__ in the *Amazon Aurora User Guide*. + +**Example 2: To reset specific parameters to their default values** + +The following ``reset-db-cluster-parameter-group`` example resets the parameter values for specific parameters to their default values in a customer-created DB cluster parameter group. :: + + aws rds reset-db-cluster-parameter-group \ + --db-cluster-parameter-group-name mydbclpgy \ + --parameters "ParameterName=max_connections,ApplyMethod=immediate" \ + "ParameterName=max_allowed_packet,ApplyMethod=immediate" + +Output:: + + { + "DBClusterParameterGroupName": "mydbclpg" + } + +For more information, see `Working with DB parameter groups and DB cluster parameter groups `__ in the *Amazon Aurora User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/restore-db-cluster-from-snapshot.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/restore-db-cluster-from-snapshot.rst new file mode 100644 index 0000000000000000000000000000000000000000..01a3a194ef082cf1fc1c7c6d60b7dc894a87cfb0 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/restore-db-cluster-from-snapshot.rst @@ -0,0 +1,61 @@ +**To restore a DB cluster from a snapshot** + +The following ``restore-db-cluster-from-snapshot`` restores an Aurora PostgreSQL DB cluster compatible with PostgreSQL version 10.7 from a DB cluster snapshot named ``test-instance-snapshot``. :: + + aws rds restore-db-cluster-from-snapshot \ + --db-cluster-identifier newdbcluster \ + --snapshot-identifier test-instance-snapshot \ + --engine aurora-postgresql \ + --engine-version 10.7 + +Output:: + + { + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "us-west-2c", + "us-west-2a", + "us-west-2b" + ], + "BackupRetentionPeriod": 7, + "DatabaseName": "", + "DBClusterIdentifier": "newdbcluster", + "DBClusterParameterGroup": "default.aurora-postgresql10", + "DBSubnetGroup": "default", + "Status": "creating", + "Endpoint": "newdbcluster.cluster-############.us-west-2.rds.amazonaws.com", + "ReaderEndpoint": "newdbcluster.cluster-ro-############.us-west-2.rds.amazonaws.com", + "MultiAZ": false, + "Engine": "aurora-postgresql", + "EngineVersion": "10.7", + "Port": 5432, + "MasterUsername": "postgres", + "PreferredBackupWindow": "09:33-10:03", + "PreferredMaintenanceWindow": "sun:12:22-sun:12:52", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-########", + "Status": "active" + } + ], + "HostedZoneId": "Z1PVIF0EXAMPLE", + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6", + "DbClusterResourceId": "cluster-5DSB5IFQDDUVAWOUWM1EXAMPLE", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:newdbcluster", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "ClusterCreateTime": "2020-06-05T15:06:58.634Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false, + "CopyTagsToSnapshot": false, + "CrossAccountClone": false, + "DomainMemberships": [] + } + } + +For more information, see `Restoring from a DB Cluster Snapshot `__ in the *Amazon Aurora User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/restore-db-cluster-to-point-in-time.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/restore-db-cluster-to-point-in-time.rst new file mode 100644 index 0000000000000000000000000000000000000000..9f4cff9452c58a7152089490d7e471e2f7ab4a69 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/restore-db-cluster-to-point-in-time.rst @@ -0,0 +1,63 @@ +**To restore a DB cluster to a specified time** + +The following ``restore-db-cluster-to-point-in-time`` example restores the DB cluster named ``database-4`` to the latest possible time. Using ``copy-on-write`` as the restore type restores the new DB cluster as a clone of the source DB cluster. :: + + aws rds restore-db-cluster-to-point-in-time \ + --source-db-cluster-identifier database-4 \ + --db-cluster-identifier sample-cluster-clone \ + --restore-type copy-on-write \ + --use-latest-restorable-time + + + +Output:: + + { + "DBCluster": { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "us-west-2c", + "us-west-2a", + "us-west-2b" + ], + "BackupRetentionPeriod": 7, + "DatabaseName": "", + "DBClusterIdentifier": "sample-cluster-clone", + "DBClusterParameterGroup": "default.aurora-postgresql10", + "DBSubnetGroup": "default", + "Status": "creating", + "Endpoint": "sample-cluster-clone.cluster-############.us-west-2.rds.amazonaws.com", + "ReaderEndpoint": "sample-cluster-clone.cluster-ro-############.us-west-2.rds.amazonaws.com", + "MultiAZ": false, + "Engine": "aurora-postgresql", + "EngineVersion": "10.7", + "Port": 5432, + "MasterUsername": "postgres", + "PreferredBackupWindow": "09:33-10:03", + "PreferredMaintenanceWindow": "sun:12:22-sun:12:52", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-########", + "Status": "active" + } + ], + "HostedZoneId": "Z1PVIF0EXAMPLE", + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/287364e4-33e3-4755-a3b0-a1b2c3d4e5f6", + "DbClusterResourceId": "cluster-BIZ77GDSA2XBSTNPFW1EXAMPLE", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-clone", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "CloneGroupId": "8d19331a-099a-45a4-b4aa-11aa22bb33cc44dd", + "ClusterCreateTime": "2020-03-10T19:57:38.967Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false, + "CopyTagsToSnapshot": false, + "CrossAccountClone": false + } + } + +For more information, see `Restoring a DB Cluster to a Specified Time `__ in the *Amazon Aurora User Guide*. diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/restore-db-instance-from-s3.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/restore-db-instance-from-s3.rst new file mode 100644 index 0000000000000000000000000000000000000000..287a9024ccde7b28855a2b87f2fbdbfdb3e0df48 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/restore-db-instance-from-s3.rst @@ -0,0 +1,10 @@ +**To restore a DB instance from a backup in Amazon S3** + +The following ``restore-db-instance-from-s3`` example creates a new DB instance named ``restored-test-instance`` from an existing backup in the ``my-backups`` S3 bucket. :: + + aws rds restore-db-instance-from-s3 \ + --db-instance-identifier restored-test-instance \ + --allocated-storage 250 --db-instance-class db.m4.large --engine mysql \ + --master-username master --master-user-password secret99 \ + --s3-bucket-name my-backups --s3-ingestion-role-arn arn:aws:iam::123456789012:role/my-role \ + --source-engine mysql --source-engine-version 5.6.27 diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/start-activity-stream.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/start-activity-stream.rst new file mode 100644 index 0000000000000000000000000000000000000000..4e6c95978071a65eca8ece3428ca5fdd43cef653 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/start-activity-stream.rst @@ -0,0 +1,22 @@ +**To start a database activity stream** + +The following ``start-activity-stream`` example starts an asynchronous activity stream to monitor an Aurora cluster named my-pg-cluster. :: + + aws rds start-activity-stream \ + --region us-east-1 \ + --mode async \ + --kms-key-id arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1 \ + --resource-arn arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster \ + --apply-immediately + +Output:: + + { + "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1", + "KinesisStreamName": "aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S", + "Status": "starting", + "Mode": "async", + "ApplyImmediately": true + } + +For more information, see `Starting a database activity stream `__ in the *Amazon Aurora User Guide*. \ No newline at end of file diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/start-db-instance.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/start-db-instance.rst new file mode 100644 index 0000000000000000000000000000000000000000..8ce7d6ddc8ff6a50a65088c66f5ef4647ae2d3fe --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/start-db-instance.rst @@ -0,0 +1,15 @@ +**To start a DB instance** + +The following ``start-db-instance`` example starts the specified DB instance. :: + + aws rds start-db-instance \ + --db-instance-identifier test-instance + +Output:: + + { + "DBInstance": { + "DBInstanceStatus": "starting", + ...some output truncated... + } + } diff --git a/data/lib/python3.10/site-packages/awscli/examples/rds/stop-db-instance.rst b/data/lib/python3.10/site-packages/awscli/examples/rds/stop-db-instance.rst new file mode 100644 index 0000000000000000000000000000000000000000..779a6331eaa20a1b64adeafe5d3258094549b7c7 --- /dev/null +++ b/data/lib/python3.10/site-packages/awscli/examples/rds/stop-db-instance.rst @@ -0,0 +1,15 @@ +**To stop a DB instance** + +The following ``stop-db-instance`` example stops the specified DB instance. :: + + aws rds stop-db-instance \ + --db-instance-identifier test-instance + +Output:: + + { + "DBInstance": { + "DBInstanceStatus": "stopping", + ...some output truncated... + } + } diff --git a/data/lib/python3.10/site-packages/botocore/data/connectcases/2022-10-03/service-2.json.gz b/data/lib/python3.10/site-packages/botocore/data/connectcases/2022-10-03/service-2.json.gz new file mode 100644 index 0000000000000000000000000000000000000000..9cf9be9ce2864c302b5d6921c797cce4fcfaacfa --- /dev/null +++ b/data/lib/python3.10/site-packages/botocore/data/connectcases/2022-10-03/service-2.json.gz @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:f82568d6ad2489bf203966116d2e4dabfaf5fe58a72501aa58471af2f00545e1 +size 15377 diff --git a/data/lib/python3.10/site-packages/botocore/data/iotthingsgraph/2018-09-06/service-2.json.gz b/data/lib/python3.10/site-packages/botocore/data/iotthingsgraph/2018-09-06/service-2.json.gz new file mode 100644 index 0000000000000000000000000000000000000000..f449def9d8d29a1b16c2d8c584eb30e85fc4d801 --- /dev/null +++ b/data/lib/python3.10/site-packages/botocore/data/iotthingsgraph/2018-09-06/service-2.json.gz @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ece0fabbea84c6cc4a01b7aa475c42e1e4e6844d2b390e8a0a417f1d17b387fe +size 10349 diff --git a/data/lib/python3.10/site-packages/botocore/data/license-manager-user-subscriptions/2018-05-10/service-2.json.gz b/data/lib/python3.10/site-packages/botocore/data/license-manager-user-subscriptions/2018-05-10/service-2.json.gz new file mode 100644 index 0000000000000000000000000000000000000000..8290d9bdb0661e293f8f74030869cde155c27d8c --- /dev/null +++ b/data/lib/python3.10/site-packages/botocore/data/license-manager-user-subscriptions/2018-05-10/service-2.json.gz @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7f3d6acca7a81ea4711f893455ea6d70c0ff3ae12d1203fe1b3a91f1b8a65033 +size 6480 diff --git a/data/lib/python3.10/site-packages/botocore/data/pca-connector-scep/2018-05-10/service-2.json.gz b/data/lib/python3.10/site-packages/botocore/data/pca-connector-scep/2018-05-10/service-2.json.gz new file mode 100644 index 0000000000000000000000000000000000000000..29d68c4db99aedcb3fd626be5b39f31bee9fc479 --- /dev/null +++ b/data/lib/python3.10/site-packages/botocore/data/pca-connector-scep/2018-05-10/service-2.json.gz @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:45322872817125d295901fa2cf0ea0abf7d781e2e7f5bc3d478c25fb7e23a53a +size 5804 diff --git a/data/lib/python3.10/site-packages/botocore/data/personalize-runtime/2018-05-22/endpoint-rule-set-1.json.gz b/data/lib/python3.10/site-packages/botocore/data/personalize-runtime/2018-05-22/endpoint-rule-set-1.json.gz new file mode 100644 index 0000000000000000000000000000000000000000..a033a12afd53cbb74e3e34a81bf860a8805c5a84 --- /dev/null +++ b/data/lib/python3.10/site-packages/botocore/data/personalize-runtime/2018-05-22/endpoint-rule-set-1.json.gz @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:0897cd8dcd139f40cfca5e73aefb6ea4af38a4494647a4e03fb2ca52990c54ad +size 1160 diff --git a/data/lib/python3.10/site-packages/botocore/data/route53profiles/2018-05-10/endpoint-rule-set-1.json.gz b/data/lib/python3.10/site-packages/botocore/data/route53profiles/2018-05-10/endpoint-rule-set-1.json.gz new file mode 100644 index 0000000000000000000000000000000000000000..0a9899e4bba5eb96438e291165ef83ab4c116f57 --- /dev/null +++ b/data/lib/python3.10/site-packages/botocore/data/route53profiles/2018-05-10/endpoint-rule-set-1.json.gz @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:554e8fa21f509c84d03e057e3db5f5dc458726bf6a10f88fd5a87c0c78ef6f69 +size 1308