Exemples d’utilisation de l’AWS CLI avec Amazon RDS

Les exemples de code suivants montrent comment réaliser des actions et mettre en œuvre des scénarios courants en utilisant l’AWS Command Line Interface avec Amazon RDS.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.

Rubriques

Actions

Actions

L’exemple de code suivant montre comment utiliser add-option-to-option-group.

AWS CLI

Pour ajouter une option à un groupe d’options

L’exemple add-option-to-option-group suivant ajoute une option à un groupe d’options spécifié.


aws rds add-option-to-option-group \
    --option-group-name myoptiongroup \
    --options OptionName=OEM,Port=5500,DBSecurityGroupMemberships=default \
    --apply-immediately

Sortie :


{
    "OptionGroup": {
        "OptionGroupName": "myoptiongroup",
        "OptionGroupDescription": "Test Option Group",
        "EngineName": "oracle-ee",
        "MajorEngineVersion": "12.1",
        "Options": [
            {
                "OptionName": "Timezone",
                "OptionDescription": "Change time zone",
                "Persistent": true,
                "Permanent": false,
                "OptionSettings": [
                    {
                        "Name": "TIME_ZONE",
                        "Value": "Australia/Sydney",
                        "DefaultValue": "UTC",
                        "Description": "Specifies the timezone the user wants to change the system time to",
                        "ApplyType": "DYNAMIC",
                        "DataType": "STRING",
                        "AllowedValues": "Africa/Cairo,Africa/Casablanca,Africa/Harare,Africa/Lagos,Africa/Luanda,Africa/Monrovia,Africa/Nairobi,Africa/Tripoli,Africa/Windhoek,America/Araguaina,America/Argentina/Buenos_Aires,America/Asuncion,America/Bogota,America/Caracas,America/Chicago,America/Chihuahua,America/Cuiaba,America/Denver,America/Detroit,America/Fortaleza,America/Godthab,America/Guatemala,America/Halifax,America/Lima,America/Los_Angeles,America/Manaus,America/Matamoros,America/Mexico_City,America/Monterrey,America/Montevideo,America/New_York,America/Phoenix,America/Santiago,America/Sao_Paulo,America/Tijuana,America/Toronto,Asia/Amman,Asia/Ashgabat,Asia/Baghdad,Asia/Baku,Asia/Bangkok,Asia/Beirut,Asia/Calcutta,Asia/Damascus,Asia/Dhaka,Asia/Hong_Kong,Asia/Irkutsk,Asia/Jakarta,Asia/Jerusalem,Asia/Kabul,Asia/Karachi,Asia/Kathmandu,Asia/Kolkata,Asia/Krasnoyarsk,Asia/Magadan,Asia/Manila,Asia/Muscat,Asia/Novosibirsk,Asia/Rangoon,Asia/Riyadh,Asia/Seoul,Asia/Shanghai,Asia/Singapore,Asia/Taipei,Asia/Tehran,Asia/Tokyo,Asia/Ulaanbaatar,Asia/Vladivostok,Asia/Yakutsk,Asia/Yerevan,Atlantic/Azores,Atlantic/Cape_Verde,Australia/Adelaide,Australia/Brisbane,Australia/Darwin,Australia/Eucla,Australia/Hobart,Australia/Lord_Howe,Australia/Perth,Australia/Sydney,Brazil/DeNoronha,Brazil/East,Canada/Newfoundland,Canada/Saskatchewan,Etc/GMT-3,Europe/Amsterdam,Europe/Athens,Europe/Berlin,Europe/Dublin,Europe/Helsinki,Europe/Kaliningrad,Europe/London,Europe/Madrid,Europe/Moscow,Europe/Paris,Europe/Prague,Europe/Rome,Europe/Sarajevo,Pacific/Apia,Pacific/Auckland,Pacific/Chatham,Pacific/Fiji,Pacific/Guam,Pacific/Honolulu,Pacific/Kiritimati,Pacific/Marquesas,Pacific/Samoa,Pacific/Tongatapu,Pacific/Wake,US/Alaska,US/Central,US/East-Indiana,US/Eastern,US/Pacific,UTC",
                        "IsModifiable": true,
                        "IsCollection": false
                    }
                ],
                "DBSecurityGroupMemberships": [],
                "VpcSecurityGroupMemberships": []
            },
            {
                "OptionName": "OEM",
                "OptionDescription": "Oracle 12c EM Express",
                "Persistent": false,
                "Permanent": false,
                "Port": 5500,
                "OptionSettings": [],
                "DBSecurityGroupMemberships": [
                    {
                        "DBSecurityGroupName": "default",
                        "Status": "authorized"
                    }
                ],
                "VpcSecurityGroupMemberships": []
            }
        ],
        "AllowsVpcAndNonVpcInstanceMemberships": false,
        "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:myoptiongroup"
    }
}

Pour plus d’informations, consultez Ajout d’une option à un groupe d’options dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez AddOptionToOptionGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser add-role-to-db-cluster.

AWS CLI

Pour associer un rôle AWS Identity and Access Management (IAM) à un cluster de bases de données

L’exemple add-role-to-db-cluster suivant associe un rôle à un cluster de bases de données.


aws rds add-role-to-db-cluster \
    --db-cluster-identifier mydbcluster \
    --role-arn arn:aws:iam::123456789012:role/RDSLoadFromS3

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Association d’un rôle IAM à un cluster de bases de données Amazon Aurora MySQL dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez AddRoleToDbCluster dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser add-role-to-db-instance.

AWS CLI

Pour associer un rôle AWS Identity and Access Management (IAM) à une instance de base de données

L’exemple add-role-to-db-instance suivant ajoute le rôle à une instance de base de données Oracle nommée test-instance.


aws rds add-role-to-db-instance \
    --db-instance-identifier test-instance \
    --feature-name S3_INTEGRATION \
    --role-arn arn:aws:iam::111122223333:role/rds-s3-integration-role

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Conditions préalables à l’intégration de Amazon RDS Oracle avec Amazon S3 dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez AddRoleToDbInstance dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser add-source-identifier-to-subscription.

AWS CLI

Pour ajouter un identifiant de la source à un abonnement

L’exemple add-source-identifier suivant ajoute un autre identifiant de la source à un abonnement existant.


aws rds add-source-identifier-to-subscription \
    --subscription-name my-instance-events \
    --source-identifier test-instance-repl

Sortie :


{
    "EventSubscription": {
        "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018",
        "CustSubscriptionId": "my-instance-events",
        "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events",
        "Enabled": false,
        "Status": "modifying",
        "EventCategoriesList": [
            "backup",
            "recovery"
        ],
        "CustomerAwsId": "123456789012",
        "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events",
        "SourceType": "db-instance",
        "SourceIdsList": [
            "test-instance",
            "test-instance-repl"
        ]
    }
}

Pour plus de détails sur l’API, consultez AddSourceIdentifierToSubscription dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser add-tags-to-resource.

AWS CLI

Pour ajouter des balises à une ressource

L’exemple add-tags-to-resource suivant ajoute des balises à une base de données RDS.


aws rds add-tags-to-resource \
    --resource-name arn:aws:rds:us-east-1:123456789012:db:database-mysql \
    --tags "[{\"Key\": \"Name\",\"Value\": \"MyDatabase\"},{\"Key\": \"Environment\",\"Value\": \"test\"}]"

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Balisage de ressources Amazon RDS dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez AddTagsToResource dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser apply-pending-maintenance-action.

AWS CLI

Pour appliquer les actions de maintenance en attente

L’exemple apply-pending-maintenance-action suivant applique les actions de maintenance en attente pour un cluster de bases de données.


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

Sortie :


{
    "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"
            }
        ]
    }
}

Pour plus d’informations, consultez Entretien d’une instance de base de données dans le Guide de l’utilisateur Amazon RDS et Entretien d’un cluster de bases de données Amazon Aurora dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez ApplyPendingMaintenanceAction dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser authorize-db-security-group-ingress.

AWS CLI

Pour associer un rôle AWS Identity and Access Management (IAM) à une instance de base de données

L’exemple authorize-db-security-group-ingress suivant configure le groupe de sécurité par défaut avec une règle d’entrée pour la plage d’adresses CIDR IP 192.0.2.0/24.


aws rds authorize-db-security-group-ingress \
    --db-security-group-name default \
    --cidrip 192.0.2.0/24

Sortie :


{
    "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"
    }
}

Pour plus d’informations, consultez Autorisation de l’accès réseau à un groupe de sécurité DB depuis une plage IP dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez AuthorizeDbSecurityGroupIngress dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser backtrack-db-cluster.

AWS CLI

Pour effectuer un retour sur trace sur un cluster de bases de données Aurora

L’exemple backtrack-db-cluster suivant effectue un retour sur trace sur l’exemple de cluster de bases de données spécifié à 10 h, le 19 mars 2018.


aws rds backtrack-db-cluster --db-cluster-identifier sample-cluster --backtrack-to 2018-03-19T10:00:00+00:00

Cette commande génère un bloc JSON qui accuse réception de la modification apportée à la ressource RDS.

Pour plus de détails sur l’API, consultez BacktrackDbCluster dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser cancel-export-task.

AWS CLI

Pour annuler l’exportation d’un instantané vers Amazon S3

L’exemple cancel-export-task suivant annule une tâche en cours d’exportation d’un instantané vers Amazon S3.


aws rds cancel-export-task \
    --export-task-identifier my-s3-export-1

Sortie :


{
    "ExportTaskIdentifier": "my-s3-export-1",
    "SourceArn": "arn:aws:rds:us-east-1:123456789012:snapshot:publisher-final-snapshot",
    "SnapshotTime": "2019-03-24T20:01:09.815Z",
    "S3Bucket": "amzn-s3-demo-bucket",
    "S3Prefix": "",
    "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/export-snap-S3-role",
    "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/abcd0000-7bfd-4594-af38-aabbccddeeff",
    "Status": "CANCELING",
    "PercentProgress": 0,
    "TotalExtractedDataInGB": 0
}

Pour plus d’informations, consultez Annulation d’une tâche d’exportation d’instantané dans le Guide de l’utilisateur Amazon RDS ou Annulation d’une tâche d’exportation d’instantané dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez CancelExportTask dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser copy-db-cluster-parameter-group.

AWS CLI

Pour copier un groupe de paramètres de cluster de bases de données

L’exemple copy-db-cluster-parameter-group suivant effectue une copie d’un groupe de paramètres de cluster de bases de données.


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"

Sortie :


{
    "DBClusterParameterGroup": {
        "DBClusterParameterGroupName": "mydbclusterpgcopy",
        "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpgcopy",
        "DBParameterGroupFamily": "aurora-mysql5.7",
        "Description": "Copy of mydbclusterpg parameter group"
    }
}

Pour plus d’informations, consultez Copie d’un groupe de paramètres de cluster de bases de données dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez CopyDbClusterParameterGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser copy-db-cluster-snapshot.

AWS CLI

Pour copier un instantané de cluster de bases de données

L’exemple copy-db-cluster-snapshot suivant effectue une copie d’un instantané de cluster de bases de données, y compris ses balises.


aws rds copy-db-cluster-snapshot \
    --source-db-cluster-snapshot-identifier arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:myaurora-2019-06-04-09-16
    --target-db-cluster-snapshot-identifier myclustersnapshotcopy \
    --copy-tags

Sortie :


{
    "DBClusterSnapshot": {
        "AvailabilityZones": [
            "us-east-1a",
            "us-east-1b",
            "us-east-1e"
        ],
        "DBClusterSnapshotIdentifier": "myclustersnapshotcopy",
        "DBClusterIdentifier": "myaurora",
        "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:123456789012:cluster-snapshot:myclustersnapshotcopy",
        "IAMDatabaseAuthenticationEnabled": false
    }
}

Pour plus d’informations, consultez Copie d’un instantané dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez CopyDbClusterSnapshot dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser copy-db-parameter-group.

AWS CLI

Pour copier un groupe de paramètres de cluster de bases de données

L’exemple copy-db-parameter-group suivant effectue une copie d’un groupe de paramètres de bases de données.


aws rds copy-db-parameter-group \
    --source-db-parameter-group-identifier mydbpg \
    --target-db-parameter-group-identifier mydbpgcopy \
    --target-db-parameter-group-description "Copy of mydbpg parameter group"

Sortie :


{
    "DBParameterGroup": {
        "DBParameterGroupName": "mydbpgcopy",
        "DBParameterGroupArn": "arn:aws:rds:us-east-1:814387698303:pg:mydbpgcopy",
        "DBParameterGroupFamily": "mysql5.7",
        "Description": "Copy of mydbpg parameter group"
    }
}

Pour plus d’informations, consultez Copie d’un groupe de paramètres de bases de données dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez CopyDbParameterGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser copy-db-snapshot.

AWS CLI

Pour copier un instantané de base de données

L’exemple copy-db-snapshot suivant crée une copie d’un instantané de base de données.


aws rds copy-db-snapshot \
    --source-db-snapshot-identifier rds:database-mysql-2019-06-06-08-38
    --target-db-snapshot-identifier mydbsnapshotcopy

Sortie :


{
    "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"
    }
}

Pour plus d’informations, consultez Copie d’un instantané dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez CopyDbSnapshot dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser copy-option-group.

AWS CLI

Pour copier un groupe d’options

L’exemple copy-option-group suivant effectue une copie d’un groupe d’options.


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"

Sortie :


{
    "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"
    }
}

Pour plus d’informations, consultez Réalisation d’une copie d’un groupe d’options dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez CopyOptionGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-blue-green-deployment.

AWS CLI

Exemple 1 : pour créer un déploiement bleu/vert pour une instance de base de données RDS for MySQL

L’exemple create-blue-green-deployment suivant crée un déploiement bleu/vert pour une instance de base de données MySQL.


aws rds create-blue-green-deployment \
    --blue-green-deployment-name bgd-cli-test-instance \
    --source arn:aws:rds:us-east-1:123456789012:db:my-db-instance \
    --target-engine-version 8.0 \
    --target-db-parameter-group-name mysql-80-group

Sortie :


{
    "BlueGreenDeployment": {
        "BlueGreenDeploymentIdentifier": "bgd-v53303651eexfake",
        "BlueGreenDeploymentName": "bgd-cli-test-instance",
        "Source": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance",
        "SwitchoverDetails": [
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance"
            },
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1"
            },
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2"
            },
            {
                "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3"
            }
        ],
        "Tasks": [
            {
                "Name": "CREATING_READ_REPLICA_OF_SOURCE",
                "Status": "PENDING"
            },
            {
                "Name": "DB_ENGINE_VERSION_UPGRADE",
                "Status": "PENDING"
            },
            {
                "Name": "CONFIGURE_BACKUPS",
                "Status": "PENDING"
            },
            {
                "Name": "CREATING_TOPOLOGY_OF_SOURCE",
                "Status": "PENDING"
            }
        ],
        "Status": "PROVISIONING",
        "CreateTime": "2022-02-25T21:18:51.183000+00:00"
    }
}

Pour plus d’informations, consultez Création d’un déploiement bleu/vert dans le Guide de l’utilisateur Amazon RDS.

Exemple 2 : pour créer un déploiement bleu/vert pour un cluster de bases de données Aurora MySQL

L’exemple create-blue-green-deployment suivant crée un déploiement bleu/vert pour un cluster de bases de données Aurora MySQL.


aws rds create-blue-green-deployment \
    --blue-green-deployment-name my-blue-green-deployment \
    --source arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster \
    --target-engine-version 8.0 \
    --target-db-cluster-parameter-group-name ams-80-binlog-enabled \
    --target-db-parameter-group-name mysql-80-cluster-group

Sortie :


{
      "BlueGreenDeployment": {
        "BlueGreenDeploymentIdentifier": "bgd-wi89nwzglccsfake",
        "BlueGreenDeploymentName": "my-blue-green-deployment",
        "Source": "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",
            "Status": "PROVISIONING"
          },
          {
            "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1",
            "Status": "PROVISIONING"
          },
          {
            "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2",
            "Status": "PROVISIONING"
          },
          {
            "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3",
            "Status": "PROVISIONING"
          },
          {
            "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint",
            "Status": "PROVISIONING"
          },
          {
            "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint",
            "Status": "PROVISIONING"
          }
        ],
        "Tasks": [
          {
            "Name": "CREATING_READ_REPLICA_OF_SOURCE",
            "Status": "PENDING"
          },
          {
            "Name": "DB_ENGINE_VERSION_UPGRADE",
            "Status": "PENDING"
          },
          {
            "Name": "CREATE_DB_INSTANCES_FOR_CLUSTER",
            "Status": "PENDING"
          },
          {
            "Name": "CREATE_CUSTOM_ENDPOINTS",
            "Status": "PENDING"
          }
        ],
        "Status": "PROVISIONING",
        "CreateTime": "2022-02-25T21:12:00.288000+00:00"
      }
}

Pour plus d’informations, consultez Création d’un déploiement bleu/vert dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez CreateBlueGreenDeployment dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-db-cluster-endpoint.

AWS CLI

Pour créer un point de terminaison de cluster de bases de données personnalisé

L’exemple create-db-cluster-endpoint suivant crée un point de terminaison de cluster de bases de données personnalisé et l’associe au cluster de bases de données Aurora spécifié.


aws rds create-db-cluster-endpoint \
    --db-cluster-endpoint-identifier mycustomendpoint \
    --endpoint-type reader \
    --db-cluster-identifier mydbcluster \
    --static-members dbinstance1 dbinstance2

Sortie :


{
    "DBClusterEndpointIdentifier": "mycustomendpoint",
    "DBClusterIdentifier": "mydbcluster",
    "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE",
    "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com",
    "Status": "creating",
    "EndpointType": "CUSTOM",
    "CustomEndpointType": "READER",
    "StaticMembers": [
        "dbinstance1",
        "dbinstance2"
    ],
    "ExcludedMembers": [],
    "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint"
}

Pour plus d’informations, consultez Gestion des connexions Amazon Aurora dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez CreateDbClusterEndpoint dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-db-cluster-parameter-group.

AWS CLI

Pour créer un groupe de paramètres de cluster de bases de données

L’exemple create-db-cluster-parameter-group suivant crée un groupe de paramètres de cluster de bases de données.


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"

Sortie :


{
    "DBClusterParameterGroup": {
        "DBClusterParameterGroupName": "mydbclusterparametergroup",
        "DBParameterGroupFamily": "aurora5.6",
        "Description": "My new cluster parameter group",
        "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup"
    }
}

Pour plus d’informations, consultez Création d’un groupe de paramètres de cluster de bases de données dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez CreateDbClusterParameterGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-db-cluster-snapshot.

AWS CLI

Pour créer un instantané de cluster de bases de données

L’exemple create-db-cluster-snapshot suivant crée un instantané de cluster de bases de données.


aws rds create-db-cluster-snapshot \
    --db-cluster-identifier mydbcluster \
    --db-cluster-snapshot-identifier mydbclustersnapshot

Sortie :


{
    "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
    }
}

Pour plus d’informations, consultez Création d’un instantané de cluster de bases de données dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez CreateDbClusterSnapshot dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-db-cluster.

AWS CLI

Exemple 1 : pour créer un cluster de bases de données compatible avec MySQL 5.7

L’exemple create-db-cluster suivant crée un cluster de bases de données compatible avec MySQL 5.7 en utilisant la version du moteur par défaut. Remplacez ensuite l’exemple de mot de passe secret99 par un mot de passe sécurisé. Si vous utilisez la console pour créer un cluster de bases de données, Amazon RDS crée automatiquement l’instance de base de données d’enregistreur pour votre cluster de bases de données. Toutefois, lorsque vous utilisez l’AWS CLI pour créer un cluster de bases de données, vous devez créer explicitement l’instance de base de données d’enregistreur pour votre cluster de bases de données à l’aide de la commande d’AWS CLI create-db-instance.


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

Sortie :


{
    "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
    }
}

Exemple 2 : pour créer un cluster de bases de données compatible avec PostgreSQL

L’exemple create-db-cluster suivant crée un cluster de bases de données compatible avec PostgreSQL en utilisant la version du moteur par défaut. Remplacez ensuite l’exemple de mot de passe secret99 par un mot de passe sécurisé. Si vous utilisez la console pour créer un cluster de bases de données, Amazon RDS crée automatiquement l’instance de base de données d’enregistreur pour votre cluster de bases de données. Toutefois, lorsque vous utilisez l’AWS CLI pour créer un cluster de bases de données, vous devez créer explicitement l’instance de base de données d’enregistreur pour votre cluster de bases de données à l’aide de la commande d’AWS CLI create-db-instance.


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

Sortie :


{
    "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"
    }
}

Pour plus d’informations, consultez Création d’un cluster de bases de données Amazon Aurora dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez CreateDbCluster dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-db-instance-read-replica.

AWS CLI

Pour créer un réplica en lecture d’une instance de base de données

Cet exemple crée un réplica en lecture d’une instance de base de données existante nommée test-instance. Le réplica en lecture est nommé test-instance-repl.


aws rds create-db-instance-read-replica \
    --db-instance-identifier test-instance-repl \
    --source-db-instance-identifier test-instance

Sortie :


{
    "DBInstance": {
        "IAMDatabaseAuthenticationEnabled": false,
        "MonitoringInterval": 0,
        "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance-repl",
        "ReadReplicaSourceDBInstanceIdentifier": "test-instance",
        "DBInstanceIdentifier": "test-instance-repl",
        ...some output truncated...
    }
}

Pour plus de détails sur l’API, consultez CreateDbInstanceReadReplica dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-db-instance.

AWS CLI

Pour créer une instance de base de données

L’exemple create-db-instance suivant utilise les options requises pour lancer une nouvelle instance de base de données.


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

Sortie :


{
    "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": []
    }
}

Pour plus d’informations, consultez Création d’une instance de base de données Amazon RDS dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez CreateDBInstance dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-db-parameter-group.

AWS CLI

Pour créer un groupe de paramètres de base de données

L’exemple create-db-parameter-group suivant crée un groupe de paramètres de base de données.


aws rds create-db-parameter-group \
    --db-parameter-group-name mydbparametergroup \
    --db-parameter-group-family MySQL5.6 \
    --description "My new parameter group"

Sortie :


{
    "DBParameterGroup": {
        "DBParameterGroupName": "mydbparametergroup",
        "DBParameterGroupFamily": "mysql5.6",
        "Description": "My new parameter group",
        "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:mydbparametergroup"
    }
}

Pour plus d’informations, consultez Création d’un groupe de paramètres de bases de données dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez CreateDBParameterGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-db-proxy-endpoint.

AWS CLI

Pour créer un point de terminaison proxy de base de données pour une base de données RDS

L’exemple create-db-proxy-endpoint suivant crée un point de terminaison proxy de base de données personnalisé.


aws rds create-db-proxy-endpoint \
    --db-proxy-name proxyExample \
    --db-proxy-endpoint-name "proxyep1" \
    --vpc-subnet-ids subnetgroup1 subnetgroup2

Sortie :


{
"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
    }
}

Pour plus d’informations, consultez Création d’un point de terminaison proxy dans le Guide de l’utilisateur Amazon RDS et Création d’un point de terminaison proxy dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez CreateDbProxyEndpoint dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-db-proxy.

AWS CLI

Pour créer un proxy de base de données pour une base de données RDS

L’exemple create-db-proxy suivant crée un proxy de base de données.


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

Sortie :


{
"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"
    }
}

Pour plus d’informations, consultez Création d’un RDS proxy dans le Guide de l’utilisateur Amazon RDS et Création d’un RDS proxy dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez CreateDbProxy dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-db-security-group.

AWS CLI

Pour créer un groupe de sécurité de base de données Amazon RDS

La commande create-db-security-group suivante crée un nouveau groupe de sécurité de base de données Amazon RDS :


aws rds create-db-security-group --db-security-group-name mysecgroup --db-security-group-description "My Test Security Group"

Dans l’exemple, le nouveau groupe de sécurité de base de données est nommé mysecgroup et possède une description.

Sortie :


{
    "DBSecurityGroup": {
        "OwnerId": "123456789012",
        "DBSecurityGroupName": "mysecgroup",
        "DBSecurityGroupDescription": "My Test Security Group",
        "VpcId": "vpc-a1b2c3d4",
        "EC2SecurityGroups": [],
        "IPRanges": [],
        "DBSecurityGroupArn": "arn:aws:rds:us-west-2:123456789012:secgrp:mysecgroup"
    }
}

Pour plus de détails sur l’API, consultez CreateDbSecurityGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-db-shard-group.

AWS CLI

Exemple 1 : pour créer un cluster de bases de données principal Aurora PostgreSQL

L’exemple create-db-cluster suivant crée un cluster de bases de données principal SQL Aurora PostgreSQL compatible avec Aurora sans serveur v2 et Aurora Limitless Database.


aws rds create-db-cluster \
    --db-cluster-identifier my-sv2-cluster \
    --engine aurora-postgresql \
    --engine-version 15.2-limitless \
    --storage-type aurora-iopt1 \
    --serverless-v2-scaling-configuration MinCapacity=2,MaxCapacity=16 \
    --enable-limitless-database \
    --master-username myuser \
    --master-user-password mypassword \
    --enable-cloudwatch-logs-exports postgresql

Sortie :


{
    "DBCluster": {
        "AllocatedStorage": 1,
        "AvailabilityZones": [
            "us-east-2b",
            "us-east-2c",
            "us-east-2a"
        ],
        "BackupRetentionPeriod": 1,
        "DBClusterIdentifier": "my-sv2-cluster",
        "DBClusterParameterGroup": "default.aurora-postgresql15",
        "DBSubnetGroup": "default",
        "Status": "creating",
        "Endpoint": "my-sv2-cluster.cluster-cekycexample.us-east-2.rds.amazonaws.com",
        "ReaderEndpoint": "my-sv2-cluster.cluster-ro-cekycexample.us-east-2.rds.amazonaws.com",
        "MultiAZ": false,
        "Engine": "aurora-postgresql",
        "EngineVersion": "15.2-limitless",
        "Port": 5432,
        "MasterUsername": "myuser",
        "PreferredBackupWindow": "06:05-06:35",
        "PreferredMaintenanceWindow": "mon:08:25-mon:08:55",
        "ReadReplicaIdentifiers": [],
        "DBClusterMembers": [],
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-########",
                "Status": "active"
            }
        ],
        "HostedZoneId": "Z2XHWR1EXAMPLE",
        "StorageEncrypted": false,
        "DbClusterResourceId": "cluster-XYEDT6ML6FHIXH4Q2J1EXAMPLE",
        "DBClusterArn": "arn:aws:rds:us-east-2:123456789012:cluster:my-sv2-cluster",
        "AssociatedRoles": [],
        "IAMDatabaseAuthenticationEnabled": false,
        "ClusterCreateTime": "2024-02-19T16:24:07.771000+00:00",
        "EnabledCloudwatchLogsExports": [
            "postgresql"
        ],
        "EngineMode": "provisioned",
        "DeletionProtection": false,
        "HttpEndpointEnabled": false,
        "CopyTagsToSnapshot": false,
        "CrossAccountClone": false,
        "DomainMemberships": [],
        "TagList": [],
        "StorageType": "aurora-iopt1",
        "AutoMinorVersionUpgrade": true,
        "ServerlessV2ScalingConfiguration": {
            "MinCapacity": 2.0,
            "MaxCapacity": 16.0
        },
        "NetworkType": "IPV4",
        "IOOptimizedNextAllowedModificationTime": "2024-03-21T16:24:07.781000+00:00",
        "LimitlessDatabase": {
            "Status": "not-in-use",
            "MinRequiredACU": 96.0
        }
    }
}

Exemple 2 : pour créer l’instance de base de données principale (enregistreur)

L’exemple create-db-instance suivant crée une instance de base de données principale (enregistreur) Aurora sans serveur v2. Si vous utilisez la console pour créer un cluster de bases de données, Amazon RDS crée automatiquement l’instance de base de données d’enregistreur pour votre cluster de bases de données. Toutefois, lorsque vous utilisez l’AWS CLI pour créer un cluster de bases de données, vous devez créer explicitement l’instance de base de données d’enregistreur pour votre cluster de bases de données à l’aide de la commande d’AWS CLI create-db-instance.


aws rds create-db-instance \
    --db-instance-identifier my-sv2-instance \
    --db-cluster-identifier my-sv2-cluster \
    --engine aurora-postgresql \
    --db-instance-class db.serverless

Sortie :


{
    "DBInstance": {
        "DBInstanceIdentifier": "my-sv2-instance",
        "DBInstanceClass": "db.serverless",
        "Engine": "aurora-postgresql",
        "DBInstanceStatus": "creating",
        "MasterUsername": "myuser",
        "AllocatedStorage": 1,
        "PreferredBackupWindow": "06:05-06:35",
        "BackupRetentionPeriod": 1,
        "DBSecurityGroups": [],
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-########",
                "Status": "active"
            }
        ],
        "DBParameterGroups": [
            {
                "DBParameterGroupName": "default.aurora-postgresql15",
                "ParameterApplyStatus": "in-sync"
            }
        ],
        "DBSubnetGroup": {
            "DBSubnetGroupName": "default",
            "DBSubnetGroupDescription": "default",
            "VpcId": "vpc-########",
            "SubnetGroupStatus": "Complete",
            "Subnets": [
                {
                    "SubnetIdentifier": "subnet-########",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-2c"
                    },
                    "SubnetOutpost": {},
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-########",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-2a"
                    },
                    "SubnetOutpost": {},
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-########",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-2b"
                    },
                    "SubnetOutpost": {},
                    "SubnetStatus": "Active"
                }
            ]
        },
        "PreferredMaintenanceWindow": "fri:09:01-fri:09:31",
        "PendingModifiedValues": {
            "PendingCloudwatchLogsExports": {
                "LogTypesToEnable": [
                    "postgresql"
                ]
            }
        },
        "MultiAZ": false,
        "EngineVersion": "15.2-limitless",
        "AutoMinorVersionUpgrade": true,
        "ReadReplicaDBInstanceIdentifiers": [],
        "LicenseModel": "postgresql-license",
        "OptionGroupMemberships": [
            {
                "OptionGroupName": "default:aurora-postgresql-15",
                "Status": "in-sync"
            }
        ],
        "PubliclyAccessible": false,
        "StorageType": "aurora-iopt1",
        "DbInstancePort": 0,
        "DBClusterIdentifier": "my-sv2-cluster",
        "StorageEncrypted": false,
        "DbiResourceId": "db-BIQTE3B3K3RM7M74SK5EXAMPLE",
        "CACertificateIdentifier": "rds-ca-rsa2048-g1",
        "DomainMemberships": [],
        "CopyTagsToSnapshot": false,
        "MonitoringInterval": 0,
        "PromotionTier": 1,
        "DBInstanceArn": "arn:aws:rds:us-east-2:123456789012:db:my-sv2-instance",
        "IAMDatabaseAuthenticationEnabled": false,
        "PerformanceInsightsEnabled": false,
        "DeletionProtection": false,
        "AssociatedRoles": [],
        "TagList": [],
        "CustomerOwnedIpEnabled": false,
        "BackupTarget": "region",
        "NetworkType": "IPV4",
        "StorageThroughput": 0,
        "CertificateDetails": {
            "CAIdentifier": "rds-ca-rsa2048-g1"
        },
        "DedicatedLogVolume": false
    }
}

Exemple 3 : pour créer le groupe de partitions de base de données

L’exemple create-db-shard-group suivant crée un groupe de partitions de base de données dans le cluster de bases de données principal Aurora PostgreSQL.


aws rds create-db-shard-group \
    --db-shard-group-identifier my-db-shard-group \
    --db-cluster-identifier my-sv2-cluster \
    --max-acu 768

Sortie :


{
    "DBShardGroupResourceId": "shardgroup-a6e3a0226aa243e2ac6c7a1234567890",
    "DBShardGroupIdentifier": "my-db-shard-group",
    "DBClusterIdentifier": "my-sv2-cluster",
    "MaxACU": 768.0,
    "ComputeRedundancy": 0,
    "Status": "creating",
    "PubliclyAccessible": false,
    "Endpoint": "my-sv2-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com"
}

Pour plus d’informations, consultez Utilisation d’Amazon Aurora sans serveur v2 dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez CreateDbShardGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-db-snapshot.

AWS CLI

Pour créer un instantané de base de données

L’exemple create-db-snapshot suivant crée un instantané de base de données.


aws rds create-db-snapshot \
    --db-instance-identifier database-mysql \
    --db-snapshot-identifier mydbsnapshot

Sortie :


{
    "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"
    }
}

Pour plus d’informations, consultez Création d’un instantané de base de données dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez CreateDBSnapshot dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-db-subnet-group.

AWS CLI

Pour créer un groupe de sous-réseaux de base de données

L’exemple create-db-subnet-group suivant crée un groupe de sous-réseaux de base de données appelé mysubnetgroup à l’aide de sous-réseaux existants.


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"]'

Sortie :


{
    "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"
    }
}

Pour plus d’informations, consultez Création d’une instance de base de données dans un VPC dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez CreateDbSubnetGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-event-subscription.

AWS CLI

Pour créer un abonnement au événements

L’exemple create-event-subscription suivant crée un abonnement pour les événements de sauvegarde et de restauration d’instances de base de données dans le compte AWS actuel. Les notifications sont envoyées à une rubrique Amazon Simple Notification Service spécifiée par --sns-topic-arn.


aws rds create-event-subscription \
    --subscription-name my-instance-events \
    --source-type db-instance \
    --event-categories '["backup","recovery"]' \
    --sns-topic-arn arn:aws:sns:us-east-1:123456789012:interesting-events

Sortie :


{
    "EventSubscription": {
        "Status": "creating",
        "CustSubscriptionId": "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",
        "CustomerAwsId": "123456789012",
        "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events",
        "SourceType": "db-instance",
        "Enabled": true
    }
}

Pour plus de détails sur l’API, consultez CreateEventSubscription dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-global-cluster.

AWS CLI

Pour créer un cluster de bases de données global

L’exemple create-global-cluster suivant crée un nouveau cluster de bases de données global compatible avec Aurora MySQL.


aws rds create-global-cluster \
    --global-cluster-identifier myglobalcluster \
    --engine aurora-mysql

Sortie :


{
    "GlobalCluster": {
        "GlobalClusterIdentifier": "myglobalcluster",
        "GlobalClusterResourceId": "cluster-f0e523bfe07aabb",
        "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": []
    }
}

Pour plus d’informations, consultez Création d’une base de données Aurora globale dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez CreateGlobalCluster dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-option-group.

AWS CLI

Pour créer un groupe d’options Amazon RDS

La commande create-option-group suivante crée un nouveau groupe d’options Amazon RDS pour Oracle Enterprise Edition version 11.2`, is named ``MyOptionGroup et inclut une description.


aws rds create-option-group \
    --option-group-name MyOptionGroup \
    --engine-name oracle-ee \
    --major-engine-version 11.2 \
    --option-group-description "Oracle Database Manager Database Control"

Sortie :


{
    "OptionGroup": {
        "OptionGroupName": "myoptiongroup",
        "OptionGroupDescription": "Oracle Database Manager Database Control",
        "EngineName": "oracle-ee",
        "MajorEngineVersion": "11.2",
        "Options": [],
        "AllowsVpcAndNonVpcInstanceMemberships": true,
        "OptionGroupArn": "arn:aws:rds:us-west-2:123456789012:og:myoptiongroup"
    }
}

Pour plus de détails sur l’API, consultez CreateOptionGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-blue-green-deployment.

AWS CLI

Exemple 1 : pour supprimer des ressources dans un environnement vert pour une instance de base de données RDS for MySQL

L’exemple delete-blue-green-deployment suivant supprime les ressources dans un environnement vert pour une instance de base de données RDS for MySQL.


aws rds delete-blue-green-deployment \
    --blue-green-deployment-identifier bgd-v53303651eexfake \
    --delete-target

Sortie :


{
    "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"
    }
}

Pour plus d’informations, consultez Suppression d’un déploiement bleu/vert dans le Guide de l’utilisateur Amazon RDS.

Exemple 2 : pour supprimer des ressources dans un environnement vert pour un cluster de bases de données Aurora MySQL

L’exemple delete-blue-green-deployment suivant supprime les ressources dans un environnement vert pour un cluster de bases de données Aurora MySQL.


aws rds delete-blue-green-deployment \
    --blue-green-deployment-identifier bgd-wi89nwzglccsfake \
    --delete-target

Sortie :


{
    "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"
    }
}

Pour plus d’informations, consultez Suppression d’un déploiement bleu/vert dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez DeleteBlueGreenDeployment dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-db-cluster-endpoint.

AWS CLI

Pour supprimer un point de terminaison de cluster de bases de données personnalisé

L’exemple delete-db-cluster-endpoint suivant supprime le point de terminaison de cluster de bases de données personnalisé spécifié.


aws rds delete-db-cluster-endpoint \
    --db-cluster-endpoint-identifier mycustomendpoint

Sortie :


{
    "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"
}

Pour plus d’informations, consultez Gestion des connexions Amazon Aurora dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez DeleteDbClusterEndpoint dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-db-cluster-parameter-group.

AWS CLI

Pour supprimer un groupe de paramètres de cluster de bases de données

L’exemple delete-db-cluster-parameter-group suivant supprime le groupe de paramètres de cluster de bases de données spécifié.


aws rds delete-db-cluster-parameter-group \
    --db-cluster-parameter-group-name mydbclusterparametergroup

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Utilisation de groupes de paramètres de base de données et de groupes de paramètres de cluster de bases de données dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez DeleteDbClusterParameterGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-db-cluster-snapshot.

AWS CLI

Pour supprimer un instantané de cluster de bases de données

L’exemple delete-db-cluster-snapshot suivant supprime l’instantané de cluster de bases de données spécifié.


aws rds delete-db-cluster-snapshot \
    --db-cluster-snapshot-identifier mydbclustersnapshot

Sortie :


{
    "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
    }
}

Pour plus d’informations, consultez Suppression d’un instantané dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez DeleteDbClusterSnapshot dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-db-cluster.

AWS CLI

Exemple 1 : pour supprimer une instance de base de données dans un cluster de bases de données

L’exemple delete-db-instance suivant supprime l’instance de base de données finale dans un cluster de bases de données. Vous ne pouvez pas supprimer un cluster de bases de données s’il contient des instances de base de données dont l’état n’est pas suppression en cours. Vous ne pouvez pas prendre un instantané final lors de la suppression d’une instance de base de données dans un cluster de bases de données.


aws rds delete-db-instance \
    --db-instance-identifier database-3

Sortie :


{
    "DBInstance": {
        "DBInstanceIdentifier": "database-3",
        "DBInstanceClass": "db.r4.large",
        "Engine": "aurora-postgresql",
        "DBInstanceStatus": "deleting",

    ...output omitted...

    }
}

Pour plus d’informations, consultez Deleting a DB Instance in an Aurora DB Cluster dans le Guide de l’utilisateur Amazon Aurora.

Exemple 2 : pour supprimer un cluster de bases de données

L’exemple delete-db-cluster suivant supprime le cluster de bases de données appelé mycluster et prend un instantané final nommé mycluster-final-snapshot. Le statut du cluster de bases de données est disponible pendant la prise de l’instantané. Pour suivre la progression de la suppression, utilisez la commande de l’interface de ligne de commande describe-db-clusters.


aws rds delete-db-cluster \
    --db-cluster-identifier mycluster \
    --no-skip-final-snapshot \
    --final-db-snapshot-identifier mycluster-final-snapshot

Sortie :


{
    "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...

    }
}

Pour plus d’informations, consultez Aurora Clusters with a Single DB Instance dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez DeleteDbCluster dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-db-instance-automated-backup.

AWS CLI

Pour supprimer une sauvegarde automatique répliquée d’une région

L’exemple delete-db-instance-automated-backup suivant supprime la sauvegarde automatique avec l’Amazon Resource Name (ARN) spécifié.


aws rds delete-db-instance-automated-backup \
    --db-instance-automated-backups-arn "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example"

Sortie :


{
    "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"
    }
}

Pour plus d’informations, consultez Suppression des sauvegardes répliquées dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez DeleteDbInstanceAutomatedBackup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-db-instance.

AWS CLI

Pour supprimer une instance de base de données

L’exemple delete-db-instance suivant supprime l’instance de base de données spécifiée après la création d’un instantané de base de données final nommé test-instance-final-snap.


aws rds delete-db-instance \
    --db-instance-identifier test-instance \
    --final-db-snapshot-identifier test-instance-final-snap

Sortie :


{
    "DBInstance": {
        "DBInstanceIdentifier": "test-instance",
        "DBInstanceStatus": "deleting",
        ...some output truncated...
    }
}

Pour plus de détails sur l’API, consultez DeleteDBInstance dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-db-parameter-group.

AWS CLI

Pour supprimer un groupe de paramètres de base de données

L’exemple command suivant supprime un groupe de paramètres de base de données.


aws rds delete-db-parameter-group \
    --db-parameter-group-name mydbparametergroup

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Utilisation de groupes de paramètres de base de données dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez DeleteDBParameterGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-db-proxy-endpoint.

AWS CLI

Pour supprimer un point de terminaison proxy de base de données pour une base de données RDS

L’exemple delete-db-proxy-endpoint suivant supprime un point de terminaison proxy de base de données pour la base de données cible.


aws rds delete-db-proxy-endpoint \
    --db-proxy-endpoint-name proxyEP1

Sortie :


{
"DBProxyEndpoint":
    {
        "DBProxyEndpointName": "proxyEP1",
        "DBProxyEndpointArn": "arn:aws:rds:us-east-1:123456789012:db-proxy-endpoint:prx-endpoint-0123a01b12345c0ab",
        "DBProxyName": "proxyExample",
        "Status": "deleting",
        "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-13T01:49:38.568000+00:00",
        "TargetRole": "READ_ONLY",
        "IsDefault": false
    }
}

Pour plus d’informations, consultez Suppression d’un point de terminaison proxy dans le Guide de l’utilisateur Amazon RDS et Suppression d’un point de terminaison proxy dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez DeleteDbProxyEndpoint dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-db-proxy.

AWS CLI

Pour supprimer un proxy de base de données pour une base de données RDS

L’exemple delete-db-proxy suivant supprime un proxy de base de données.


aws rds delete-db-proxy \
    --db-proxy-name proxyExample

Sortie :


{
        "DBProxy":
        {
            "DBProxyName": "proxyExample",
            "DBProxyArn": "arn:aws:rds:us-east-1:123456789012:db-proxy:prx-0123a01b12345c0ab",
            "Status": "deleting",
            "EngineFamily": "PostgreSQL",
            "VpcId": "vpc-1234567",
            "VpcSecurityGroupIds": [
                "sg-1234",
                "sg-5678"
            ],
            "VpcSubnetIds": [
                "subnetgroup1",
                "subnetgroup2"
            ],
            "Auth": "[
                {
                "Description": "proxydescription`"
                "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": false,
            "IdleClientTimeout": 1800,
            "DebuggingLogging": false,
        "CreatedDate": "2023-04-05T16:09:33.452000+00:00",
        "UpdatedDate": "2023-04-13T01:49:38.568000+00:00"
    }
}

Pour plus d’informations, consultez Suppression d’un RDS proxy dans le Guide de l’utilisateur Amazon RDS et Suppression d’un RDS proxy dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez DeleteDbProxy dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-db-security-group.

AWS CLI

Pour supprimer un groupe de sécurité de base de données

L’exemple delete-db-security-group suivant supprime un groupe de sécurité de base de données nommé mysecuritygroup.


aws rds delete-db-security-group \
    --db-security-group-name mysecuritygroup

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Utilisation de groupes de sécurité DB (plateforme EC2-Classic) dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez DeleteDbSecurityGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-db-shard-group.

AWS CLI

Exemple 1 : pour supprimer un groupe de partitions de base de données sans succès

L’exemple delete-db-shard-group suivant montre l’erreur qui se produit lorsque vous essayez de supprimer un groupe de partitions de base de données avant de supprimer l’ensemble de vos bases de données et de vos schémas.


aws rds delete-db-shard-group \
    --db-shard-group-identifier limitless-test-shard-grp

Sortie :


An error occurred (InvalidDBShardGroupState) when calling the DeleteDBShardGroup operation: Unable to delete the DB shard group limitless-test-db-shard-group.
Delete all of your Limitless Database databases and schemas, then try again.

Exemple 2 : pour supprimer un groupe de partitions de base de données avec succès

L’exemple delete-db-shard-group suivant supprime un groupe de partitions de base de données une fois que vous avez supprimé toutes vos bases de données et tous vos schémas, y compris le schéma public.


aws rds delete-db-shard-group \
    --db-shard-group-identifier limitless-test-shard-grp

Sortie :


{
    "DBShardGroupResourceId": "shardgroup-7bb446329da94788b3f957746example",
    "DBShardGroupIdentifier": "limitless-test-shard-grp",
    "DBClusterIdentifier": "limitless-test-cluster",
    "MaxACU": 768.0,
    "ComputeRedundancy": 0,
    "Status": "deleting",
    "PubliclyAccessible": true,
    "Endpoint": "limitless-test-cluster.limitless-cekycexample.us-east-2.rds.amazonaws.com"
}

Pour plus d’informations, consultez Suppression de clusters de bases de données Aurora et d’instances de base de données dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez DeleteDbShardGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-db-snapshot.

AWS CLI

Pour supprimer un instantané de base de données

L’exemple delete-db-snapshot suivant supprime l’instantané de base de données spécifié.


aws rds delete-db-snapshot \
    --db-snapshot-identifier mydbsnapshot

Sortie :


{
    "DBSnapshot": {
        "DBSnapshotIdentifier": "mydbsnapshot",
        "DBInstanceIdentifier": "database-mysql",
        "SnapshotCreateTime": "2019-06-18T22:08:40.702Z",
        "Engine": "mysql",
        "AllocatedStorage": 100,
        "Status": "deleted",
        "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": 100,
        "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"
    }
}

Pour plus d’informations, consultez Suppression d’un instantané dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez DeleteDbSnapshot dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-db-subnet-group.

AWS CLI

Pour supprimer un groupe de sous-réseaux de base de données

L’exemple delete-db-subnet-group suivant supprime le groupe de sous-réseaux de base de données nommé mysubnetgroup.


aws rds delete-db-subnet-group --db-subnet-group-name mysubnetgroup

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Utilisation d’une instance de base de données dans un VPC dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez DeleteDbSubnetGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-event-subscription.

AWS CLI

Pour supprimer un abonnement à un événement

L’exemple delete-event-subscription suivant supprime l’abonnement à un événement spécifié.


aws rds delete-event-subscription --subscription-name my-instance-events

Sortie :


{
    "EventSubscription": {
        "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events",
        "CustomerAwsId": "123456789012",
        "Enabled": false,
        "SourceIdsList": [
            "test-instance"
        ],
        "SourceType": "db-instance",
        "EventCategoriesList": [
            "backup",
            "recovery"
        ],
        "SubscriptionCreationTime": "2018-07-31 23:22:01.893",
        "CustSubscriptionId": "my-instance-events",
        "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events",
        "Status": "deleting"
    }
}

Pour plus de détails sur l’API, consultez DeleteEventSubscription dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-global-cluster.

AWS CLI

Pour supprimer un cluster de bases de données global

L’exemple delete-global-cluster suivant supprime un cluster de bases de données global compatible avec Aurora MySQL. La sortie indique le cluster que vous supprimez, mais les commandes describe-global-clusters suivantes ne répertorient pas ce cluster de bases de données.


aws rds delete-global-cluster \
    --global-cluster-identifier myglobalcluster

Sortie :


{
    "GlobalCluster": {
        "GlobalClusterIdentifier": "myglobalcluster",
        "GlobalClusterResourceId": "cluster-f0e523bfe07aabb",
        "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": []
    }
}

Pour plus d’informations, consultez Suppression d’une base de données Aurora globale dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez DeleteGlobalCluster dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-option-group.

AWS CLI

Pour supprimer un groupe d’options

L’exemple delete-option-group suivant supprime le groupe d’options spécifié.


aws rds delete-option-group \
    --option-group-name myoptiongroup

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Suppression d’un groupe d’options dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez DeleteOptionGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser deregister-db-proxy-targets.

AWS CLI

Pour annuler l’enregistrement d’une cible de proxy de base de données du groupe cible de bases de données

L’exemple deregister-db-proxy-targets suivant supprime l’association entre le proxy proxyExample et sa cible.


aws rds deregister-db-proxy-targets \
    --db-proxy-name proxyExample \
    --db-instance-identifiers database-1

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Suppression d’un RDS proxy dans le Guide de l’utilisateur Amazon RDS et Suppression d’un RDS proxy dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez DeregisterDbProxyTargets dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-account-attributes.

AWS CLI

Pour décrire les attributs d’un compte

L’exemple describe-account-attributes suivant récupère les attributs pour le compte AWS actuel.


aws rds describe-account-attributes

Sortie :


{
    "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"
        }
    ]
}

Pour plus de détails sur l’API, consultez DescribeAccountAttributes dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-blue-green-deployments.

AWS CLI

Exemple 1 : pour décrire un déploiement bleu/vert d’une instance de base de données RDS une fois la création terminée

L’exemple describe-blue-green-deployment suivant récupère les détails d’un déploiement bleu/vert une fois la création terminée.


aws rds describe-blue-green-deployments \
    --blue-green-deployment-identifier bgd-v53303651eexfake

Sortie :


{
    "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"
        }
    ]
}

Pour plus d’informations, consultez Affichage d’un déploiement bleu/vert dans le Guide de l’utilisateur Amazon RDS.

Exemple 2 : pour décrire un déploiement bleu/vert pour un cluster de bases de données Aurora MySQL

L’exemple describe-blue-green-deployment suivant récupère les détails sur un déploiement bleu/vert.


aws rds describe-blue-green-deployments \
    --blue-green-deployment-identifier bgd-wi89nwzglccsfake

Sortie :


{
    "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"
        }
    ]
}

Pour plus d’informations, consultez Affichage d’un déploiement bleu/vert dans le Guide de l’utilisateur Amazon Aurora.

Exemple 3 : pour décrire un déploiement bleu/vert pour un cluster de bases de données Aurora MySQL après une bascule

L’exemple describe-blue-green-deployment suivant récupère les détails sur un déploiement bleu/vert une fois que l’environnement vert a été promu environnement de production.


aws rds describe-blue-green-deployments \
    --blue-green-deployment-identifier bgd-wi89nwzglccsfake

Sortie :


{
    "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"
        }
    ]
}

Pour plus d’informations, consultez Affichage d’un déploiement bleu/vert dans le Guide de l’utilisateur Amazon Aurora.

Exemple 4 : pour décrire un déploiement bleu/vert combiné

L’exemple describe-blue-green-deployment suivant récupère les détails sur un déploiement bleu/vert combiné.


aws rds describe-blue-green-deployments

Sortie :


{
    "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"
        }
    ]
}

Pour plus d’informations, consultez Affichage d’un déploiement bleu/vert dans le Guide de l’utilisateur Amazon RDS et Affichage d’un déploiement bleu/vert dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez DescribeBlueGreenDeployments dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-certificates.

AWS CLI

Pour décrire les certificats

L’exemple describe-certificates suivant récupère les détails sur le certificat associé à la région par défaut de l’utilisateur.


aws rds describe-certificates

Sortie :


{
    "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"
}

Pour plus d’informations, consultez Utilisation de SSL/TLS pour chiffrer une connexion à une instance de base de données dans le Guide de l’utilisateur Amazon RDS et Utilisation de SSL/TLS pour chiffrer une connexion à un cluster de bases de données dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez DescribeCertificates dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-db-cluster-backtracks.

AWS CLI

Pour décrire les retours sur trace pour un cluster de bases de données

L’exemple describe-db-cluster-backtracks suivant récupère les détails sur le cluster de bases de données spécifié.


aws rds describe-db-cluster-backtracks \
    --db-cluster-identifier mydbcluster

Sortie :


{
    "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"
        }
    ]
}

Pour plus d’informations, consultez Retour sur trace d’un cluster de bases de données Aurora dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez DescribeDbClusterBacktracks dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-db-cluster-endpoints.

AWS CLI

Exemple 1 : pour décrire les points de terminaison d’un cluster de bases de données

L’exemple describe-db-cluster-endpoints suivant récupère les détails sur les points de terminaison du cluster de bases de données. Les types de clusters Aurora les plus courants possèdent deux points de terminaison. Un point de terminaison est de type WRITER. Vous pouvez utiliser ce point de terminaison pour toutes les instructions SQL. L’autre point de terminaison est de type READER. Vous ne pouvez utiliser ce point de terminaison que pour SELECT et les autres instructions SQL en lecture seule.


aws rds describe-db-cluster-endpoints

Sortie :


{
    "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"
        }
    ]
}

Exemple 2 : pour décrire les points de terminaison d’un cluster de bases de données unique

L’exemple describe-db-cluster-endpoints suivant récupère les détails sur les points de terminaison d’un cluster de bases de données unique spécifié. Les clusters Aurora sans serveur ne possèdent qu’un seul point de terminaison de type WRITER.


aws rds describe-db-cluster-endpoints \
    --db-cluster-identifier serverless-cluster

Sortie :


{
    "DBClusterEndpoints": [
        {
            "Status": "available",
            "Endpoint": "serverless-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com",
            "DBClusterIdentifier": "serverless-cluster",
            "EndpointType": "WRITER"
        }
    ]
}

Pour plus d’informations, consultez Gestion des connexions Amazon Aurora dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez DescribeDbClusterEndpoints dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-db-cluster-parameter-groups.

AWS CLI

Pour décrire les groupes de paramètres de cluster de bases de données

L’exemple describe-db-cluster-parameter-groups suivant récupère les détails sur vos groupes de paramètres de cluster de bases de données.


aws rds describe-db-cluster-parameter-groups

Sortie :


{
    "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"
        }
    ]
}

Pour plus de détails sur l’API, consultez DescribeDbClusterParameterGroups dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-db-cluster-parameters.

AWS CLI

Exemple 1 : pour décrire les paramètres d’un groupe de paramètres de cluster de bases de données

L’exemple describe-db-cluster-parameters suivant récupère les détails sur les paramètres d’un groupe de paramètres de cluster de bases de données.


aws rds describe-db-cluster-parameters \
    --db-cluster-parameter-group-name mydbclusterpg

Sortie :


{
    "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...
    ]
}

Exemple 2 : pour décrire les noms de paramètres d’un groupe de paramètres de cluster de bases de données

L’exemple describe-db-cluster-parameters suivant récupère uniquement les noms des paramètres d’un groupe de paramètres de cluster de bases de données.


aws rds describe-db-cluster-parameters \
    --db-cluster-parameter-group-name default.aurora-mysql5.7 \
    --query 'Parameters[].{ParameterName:ParameterName}'

Sortie :


[
    {
        "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...
    }
]

Exemple 3 : pour décrire uniquement les paramètres modifiables d’un groupe de paramètres de cluster de bases de données

L’exemple describe-db-cluster-parameters suivant récupère les noms d’uniquement les paramètres que vous pouvez modifier dans un groupe de paramètres de cluster de bases de données.


aws rds describe-db-cluster-parameters \
    --db-cluster-parameter-group-name default.aurora-mysql5.7 \
    --query 'Parameters[].{ParameterName:ParameterName,IsModifiable:IsModifiable} | [?IsModifiable == `true`]'

Sortie :


[
    {
        "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...
    }
]

Exemple 4 : pour décrire uniquement les paramètres booléens modifiables dans un groupe de paramètres de cluster de bases de données

L’exemple describe-db-cluster-parameters suivant récupère les noms d’uniquement les paramètres que vous pouvez modifier dans un groupe de paramètres de cluster de bases de données et qui ont un type de données booléen.


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`]'

Sortie :


[
    {
        "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...
    }
]

Pour plus de détails sur l’API, consultez DescribeDbClusterParameters dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-db-cluster-snapshot-attributes.

AWS CLI

Pour décrire les noms et les valeurs des attributs d’un instantané de cluster de bases de données

L’exemple describe-db-cluster-snapshot-attributes suivant récupère les détails sur les noms et les valeurs des attributs de l’instantané de cluster de bases de données spécifié.


aws rds describe-db-cluster-snapshot-attributes \
    --db-cluster-snapshot-identifier myclustersnapshot

Sortie :


{
    "DBClusterSnapshotAttributesResult": {
        "DBClusterSnapshotIdentifier": "myclustersnapshot",
        "DBClusterSnapshotAttributes": [
            {
                "AttributeName": "restore",
                "AttributeValues": [
                    "123456789012"
                ]
            }
        ]
    }
}

Pour plus d’informations, consultez Partage d’un instantané de cluster de bases de données dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez DescribeDbClusterSnapshotAttributes dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-db-cluster-snapshots.

AWS CLI

Pour décrire un instantané d’un cluster de bases de données

L’exemple describe-db-cluster-snapshots suivant récupère les détails sur les instantanés du cluster de bases de données spécifié.


aws rds describe-db-cluster-snapshots \
    --db-cluster-identifier mydbcluster

Sortie :


{
    "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
        }
    ]
}

Pour plus d’informations, consultez Création d’un instantané de cluster de bases de données dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez DescribeDbClusterSnapshots dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-db-clusters.

AWS CLI

Exemple 1 : pour décrire un cluster de bases de données

L’exemple describe-db-clusters suivant récupère les détails sur le cluster de bases de données spécifié.


aws rds describe-db-clusters \
    --db-cluster-identifier mydbcluster

Sortie :


{
    "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
        }
    ]
}

Exemple 2 : pour répertorier certains attributs de tous les clusters de bases de données

L’exemple describe-db-clusters suivant récupère uniquement les attributs DBClusterIdentifier, Endpoint et ReaderEndpoint de tous les clusters de bases de données dans la région AWS actuelle.


aws rds describe-db-clusters \
    --query 'DBClusters[].{DBClusterIdentifier:DBClusterIdentifier,Endpoint:Endpoint,ReaderEndpoint:ReaderEndpoint}'

Sortie :


[
    {
        "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...
    }
]

Exemple 3 : pour répertorier les clusters de bases de données avec un attribut spécifique

L’exemple describe-db-clusters suivant récupère uniquement les attributs DBClusterIdentifier et Engine de tous les clusters de bases de données qui utilisent le moteur de base de données aurora-postgresql.


aws rds describe-db-clusters \
    --query 'DBClusters[].{DBClusterIdentifier:DBClusterIdentifier,Engine:Engine} | [?Engine == `aurora-postgresql`]'

Sortie :


[
    {
        "Engine": "aurora-postgresql",
        "DBClusterIdentifier": "pg2-cluster"
    }
]

Pour plus d’informations, consultez Clusters de bases de données Amazon Aurora dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez DescribeDbClusters dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-db-engine-versions.

AWS CLI

Pour décrire les versions du moteur de base de données MySQL

L’exemple describe-db-engine-versions suivant affiche les détails sur chacune des versions du moteur de base de données spécifié.


aws rds describe-db-engine-versions \
    --engine mysql

Sortie :


{
    "DBEngineVersions": [
        {
            "Engine": "mysql",
            "EngineVersion": "5.5.46",
            "DBParameterGroupFamily": "mysql5.5",
            "DBEngineDescription": "MySQL Community Edition",
            "DBEngineVersionDescription": "MySQL 5.5.46",
            "ValidUpgradeTarget": [
                {
                    "Engine": "mysql",
                    "EngineVersion": "5.5.53",
                    "Description": "MySQL 5.5.53",
                    "AutoUpgrade": false,
                    "IsMajorVersionUpgrade": false
                },
                {
                    "Engine": "mysql",
                    "EngineVersion": "5.5.54",
                    "Description": "MySQL 5.5.54",
                    "AutoUpgrade": false,
                    "IsMajorVersionUpgrade": false
                },
                {
                    "Engine": "mysql",
                    "EngineVersion": "5.5.57",
                    "Description": "MySQL 5.5.57",
                    "AutoUpgrade": false,
                    "IsMajorVersionUpgrade": false
                },
                ...some output truncated...
            ]
        }

Pour plus d’informations, consultez Qu’est-ce qu’Amazon Relational Database Service (Amazon RDS) ? dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez DescribeDBEngineVersions dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-db-instance-automated-backups.

AWS CLI

Pour décrire les sauvegardes automatiques d’une instance de base de données

L’exemple describe-db-instance-automated-backups suivant affiche les détails sur les sauvegardes automatiques pour l’instance de base de données spécifiée. Les détails incluent les sauvegardes automatisées répliquées dans d’autres régions AWS.


aws rds describe-db-instance-automated-backups \
    --db-instance-identifier new-orcl-db

Sortie :


{
    "DBInstanceAutomatedBackups": [
        {
            "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db",
            "DbiResourceId": "db-JKIB2GFQ5RV7REPLZA4EXAMPLE",
            "Region": "us-east-1",
            "DBInstanceIdentifier": "new-orcl-db",
            "RestoreWindow": {
                "EarliestTime": "2020-12-07T21:05:20.939Z",
                "LatestTime": "2020-12-07T21:05:20.939Z"
            },
            "AllocatedStorage": 20,
            "Status": "replicating",
            "Port": 1521,
            "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": 14,
            "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example"
        }
    ]
}

Pour plus d’informations, consultez Recherche d’informations sur les sauvegardes répliquées dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez DescribeDbInstanceAutomatedBackups dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-db-instances.

AWS CLI

Pour décrire une instance de base de données

L’exemple describe-db-instances suivant récupère les détails sur l’instance de base de données spécifiée.


aws rds describe-db-instances \
    --db-instance-identifier mydbinstancecf

Sortie :


{
    "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...
        }
    ]
}

Pour plus de détails sur l’API, consultez DescribeDBInstances dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-db-log-files.

AWS CLI

Pour décrire les fichiers journaux d’une instance de base de données

L’exemple describe-db-log-files suivant récupère les détails sur les fichiers journaux de l’instance de base de données spécifiée.


aws rds describe-db-log-files -\
    -db-instance-identifier test-instance

Sortie :


{
    "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"
        }
    ]
}

Pour plus de détails sur l’API, consultez DescribeDbLogFiles dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-db-parameter-groups.

AWS CLI

Pour décrire votre groupe de paramètres de bases de données

L’exemple describe-db-parameter-groups suivant récupère les détails sur vos groupes de paramètres de base de données.


aws rds describe-db-parameter-groups

Sortie :


{
    "DBParameterGroups": [
        {
            "DBParameterGroupName": "default.aurora-mysql5.7",
            "DBParameterGroupFamily": "aurora-mysql5.7",
            "Description": "Default parameter group for aurora-mysql5.7",
            "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora-mysql5.7"
        },
        {
            "DBParameterGroupName": "default.aurora-postgresql9.6",
            "DBParameterGroupFamily": "aurora-postgresql9.6",
            "Description": "Default parameter group for aurora-postgresql9.6",
            "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora-postgresql9.6"
        },
        {
            "DBParameterGroupName": "default.aurora5.6",
            "DBParameterGroupFamily": "aurora5.6",
            "Description": "Default parameter group for aurora5.6",
            "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora5.6"
        },
        {
            "DBParameterGroupName": "default.mariadb10.1",
            "DBParameterGroupFamily": "mariadb10.1",
            "Description": "Default parameter group for mariadb10.1",
            "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.mariadb10.1"
        },
        ...some output truncated...
    ]
}

Pour plus d’informations, consultez Utilisation de groupes de paramètres de base de données dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez DescribeDBParameterGroups dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-db-parameters.

AWS CLI

Pour décrire les paramètres d’un groupe de paramètres de bases de données

L’exemple describe-db-parameters suivant récupère les détails sur le groupe de paramètres de base de données spécifié.


aws rds describe-db-parameters \
    --db-parameter-group-name mydbpg

Sortie :


{
    "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"
        },
        {
            "ParameterName": "auto_generate_certs",
            "Description": "Controls whether the server autogenerates SSL key and certificate files in the data directory, if they do not already exist.",
            "Source": "engine-default",
            "ApplyType": "static",
            "DataType": "boolean",
            "AllowedValues": "0,1",
            "IsModifiable": false,
            "ApplyMethod": "pending-reboot"
        },
        ...some output truncated...
    ]
}

Pour plus d’informations, consultez Utilisation de groupes de paramètres de base de données dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez DescribeDBParameters dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-db-proxies.

AWS CLI

Pour décrire un proxy de base de données pour une base de données RDS

L’exemple describe-db-proxies suivant renvoie les informations sur les proxy de base de données.


aws rds describe-db-proxies

Sortie :


{
    "DBProxies": [
        {
            "DBProxyName": "proxyExample1",
            "DBProxyArn": "arn:aws:rds:us-east-1:123456789012:db-proxy:prx-0123a01b12345c0ab",
            "Status": "available",
            "EngineFamily": "PostgreSQL",
            "VpcId": "vpc-1234567",
            "VpcSecurityGroupIds": [
                "sg-1234"
            ],
            "VpcSubnetIds": [
                "subnetgroup1",
                "subnetgroup2"
            ],
            "Auth": "[
                {
                    "Description": "proxydescription1"
                    "AuthScheme": "SECRETS",
                    "SecretArn": "arn:aws:secretsmanager:us-west-2:123456789123:secret:secretName-1234f",
                    "IAMAuth": "DISABLED"
                }
            ]",
            "RoleArn": "arn:aws:iam::12345678912??:role/ProxyPostgreSQLRole",
            "Endpoint": "proxyExample1.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"
        },
        {
            "DBProxyName": "proxyExample2",
            "DBProxyArn": "arn:aws:rds:us-east-1:123456789012:db-proxy:prx-1234a12b23456c1ab",
            "Status": "available",
            "EngineFamily": "PostgreSQL",
            "VpcId": "sg-1234567",
            "VpcSecurityGroupIds": [
                "sg-1234"
            ],
            "VpcSubnetIds": [
                "subnetgroup1",
                "subnetgroup2"
            ],
            "Auth": "[
                {
                    "Description": "proxydescription2"
                    "AuthScheme": "SECRETS",
                    "SecretArn": "aarn:aws:secretsmanager:us-west-2:123456789123:secret:secretName-1234f",
                    "IAMAuth": "DISABLED"
                }
            ]",
            "RoleArn": "arn:aws:iam::12345678912:role/ProxyPostgreSQLRole",
            "Endpoint": "proxyExample2.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com",
            "RequireTLS": false,
            "IdleClientTimeout": 1800,
            "DebuggingLogging": false,
            "CreatedDate": "2022-01-05T16:19:33.452000+00:00",
            "UpdatedDate": "2023-04-13T01:49:38.568000+00:00"
        }
    ]
}

Pour plus d’informations, consultez Affichage d’un RDS proxy dans le Guide de l’utilisateur Amazon RDS et Affichage d’un RDS proxy dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez DescribeDbProxies dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-db-proxy-endpoints.

AWS CLI

Pour décrire les points de terminaison d’un proxy de base de données

L’exemple describe-db-proxy-endpoints suivant renvoie les informations sur les points de terminaison de proxy de base de données.


aws rds describe-db-proxy-endpoints

Sortie :


{
    "DBProxyEndpoints": [
        {
            "DBProxyEndpointName": "proxyEndpoint1",
            "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": "proxyEndpoint1.endpoint.proxy-ab0cd1efghij.us-east-1.rds.amazonaws.com",
            "CreatedDate": "2023-04-05T16:09:33.452000+00:00",
            "TargetRole": "READ_WRITE",
            "IsDefault": false
        },
        {
            "DBProxyEndpointName": "proxyEndpoint2",
            "DBProxyEndpointArn": "arn:aws:rds:us-east-1:123456789012:db-proxy-endpoint:prx-endpoint-4567a01b12345c0ab",
            "DBProxyName": "proxyExample2",
            "Status": "available",
            "VpcId": "vpc1234567",
            "VpcSecurityGroupIds": [
                "sg-5678"
            ],
            "VpcSubnetIds": [
                "subnetgroup1",
                "subnetgroup2"
            ],
            "Endpoint": "proxyEndpoint2.endpoint.proxy-cd1ef2klmnop.us-east-1.rds.amazonaws.com",
            "CreatedDate": "2023-04-05T16:09:33.452000+00:00",
            "TargetRole": "READ_WRITE",
            "IsDefault": false
        }
    ]
}

Pour plus d’informations, consultez Viewing a proxy endpoint dans le Guide de l’utilisateur Amazon RDS et Création d’un point de terminaison proxy dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez DescribeDbProxyEndpoints dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-db-proxy-target-groups.

AWS CLI

Pour décrire les points de terminaison d’un proxy de base de données

L’exemple describe-db-proxy-target-groups suivant renvoie les informations sur les groupes de cibles de proxy de base de données.


aws rds describe-db-proxy-target-groups \
    --db-proxy-name proxyExample

Sortie :


{
"TargetGroups":
    {
        "DBProxyName": "proxyExample",
        "TargetGroupName": "default",
        "TargetGroupArn": "arn:aws:rds:us-east-1:123456789012:target-group:prx-tg-0123a01b12345c0ab",
        "IsDefault": true,
        "Status": "available",
        "ConnectionPoolConfig": {
            "MaxConnectionsPercent": 100,
            "MaxIdleConnectionsPercent": 50,
            "ConnectionBorrowTimeout": 120,
            "SessionPinningFilters": []
        },
        "CreatedDate": "2023-05-02T18:41:19.495000+00:00",
        "UpdatedDate": "2023-05-02T18:41:21.762000+00:00"
    }
}

Pour plus d’informations, consultez Affichage d’un RDS proxy dans le Guide de l’utilisateur Amazon RDS et Affichage d’un RDS proxy dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez DescribeDbProxyTargetGroups dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-db-proxy-targets.

AWS CLI

Pour décrire les cibles de proxy de base de données

L’exemple describe-db-proxy-targets suivant renvoie les informations sur les cibles de proxy de base de données.


aws rds describe-db-proxy-targets \
    --db-proxy-name proxyExample

Sortie :


{
    "Targets": [
        {
            "Endpoint": "database1.ab0cd1efghij.us-east-1.rds.amazonaws.com",
            "TrackedClusterId": "database1",
            "RdsResourceId": "database1-instance-1",
            "Port": 3306,
            "Type": "RDS_INSTANCE",
            "Role": "READ_WRITE",
            "TargetHealth": {
                "State": "UNAVAILABLE",
                "Reason": "PENDING_PROXY_CAPACITY",
                "Description": "DBProxy Target is waiting for proxy to scale to desired capacity"
            }
        }
    ]
}

Pour plus d’informations, consultez Affichage d’un RDS proxy dans le Guide de l’utilisateur Amazon RDS et Affichage d’un RDS proxy dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez DescribeDbProxyTargets dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-db-recommendations.

AWS CLI

Exemple 1 : pour répertorier toutes les recommandations de base de données

L’exemple describe-db-recommendations suivant répertorie toutes les recommandations de base de données de votre compte AWS.


aws rds describe-db-recommendations

Sortie :


{
    "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"
                }
            ]
        }
    ]
}

Pour plus d’informations, consultez Viewing and responding to Amazon RDS recommendations dans le Guide de l’utilisateur Amazon RDS et Viewing and responding to Amazon RDS recommendations dans le Guide de l’utilisateur Amazon Aurora.

Exemple 2 : pour répertorier toutes les recommandations de base de données de gravité élevée

L’exemple describe-db-recommendations suivant répertorie toutes les recommandations de base de données de gravité élevée de votre compte AWS.


aws rds describe-db-recommendations \
    --filters Name=severity,Values=high

Sortie :


{
    "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/"
                }
            ]
        }
    ]
}

Exemple 3 : pour répertorier les recommandations de base de données pour une instance de base de données spécifiée

L’exemple describe-db-recommendations suivant répertorie toutes les recommandations de base de données pour une instance de base de données spécifiée.


aws rds describe-db-recommendations \
    --filters Name=dbi-resource-id,Values=database-1

Sortie :


{
    "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"
                }
            ]
        }
    ]
}

Exemple 4 : pour répertorier toutes les recommandations de base de données actives

L’exemple describe-db-recommendations suivant répertorie toutes les recommandations de base de données actives de votre compte AWS.


aws rds describe-db-recommendations \
    --filters Name=status,Values=active

Sortie :


{
    "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"
                }
            ]
        }
    ]
}

Pour plus de détails sur l’API, consultez DescribeDbRecommendations dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-db-security-groups.

AWS CLI

Pour répertorier les groupes de sécurité de base de données

L’exemple describe-db-security-groups suivant répertorie les groupes de sécurité de base de données.


aws rds describe-db-security-groups

Sortie :


{
    "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"
        }
    ]
}

Pour plus d’informations, consultez Liste des groupes de sécurité de base de données disponibles dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez DescribeDbSecurityGroups dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-db-shard-groups.

AWS CLI

Exemple 1 : pour décrire les groupes de partitions de base de données

L’exemple describe-db-shard-groups suivant récupère les détails sur vos groupes de partitions de base de données.


aws rds describe-db-shard-groups

Sortie :


{
    "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"
        }
    ]
}

Pour plus d’informations, consultez Clusters de bases de données Amazon Aurora dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez DescribeDbShardGroups dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-db-snapshot-attributes.

AWS CLI

Pour décrire les noms et les valeurs des attributs d’un instantané de base de données

L’exemple describe-db-snapshot-attributes suivant décrit des noms et les valeurs d’attributs pour un instantané de base de données.


aws rds describe-db-snapshot-attributes \
    --db-snapshot-identifier mydbsnapshot

Sortie :


{
    "DBSnapshotAttributesResult": {
        "DBSnapshotIdentifier": "mydbsnapshot",
        "DBSnapshotAttributes": [
            {
                "AttributeName": "restore",
                "AttributeValues": [
                    "123456789012",
                    "210987654321"
                ]
            }
        ]
    }
}

Pour plus d’informations, consultez Sharing a DB Snapshot dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez DescribeDbSnapshotAttributes dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-db-snapshots.

AWS CLI

Exemple 1 : pour décrire un instantané de base de données pour une instance de base de données

L’exemple describe-db-snapshots suivant récupère les détails sur instantané de base de données pour une instance de base de données.


aws rds describe-db-snapshots \
    --db-snapshot-identifier mydbsnapshot

Sortie :


{
    "DBSnapshots": [
        {
            "DBSnapshotIdentifier": "mydbsnapshot",
            "DBInstanceIdentifier": "mysqldb",
            "SnapshotCreateTime": "2018-02-08T22:28:08.598Z",
            "Engine": "mysql",
            "AllocatedStorage": 20,
            "Status": "available",
            "Port": 3306,
            "AvailabilityZone": "us-east-1f",
            "VpcId": "vpc-6594f31c",
            "InstanceCreateTime": "2018-02-08T22:24:55.973Z",
            "MasterUsername": "mysqladmin",
            "EngineVersion": "5.6.37",
            "LicenseModel": "general-public-license",
            "SnapshotType": "manual",
            "OptionGroupName": "default:mysql-5-6",
            "PercentProgress": 100,
            "StorageType": "gp2",
            "Encrypted": false,
            "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot",
            "IAMDatabaseAuthenticationEnabled": false,
            "ProcessorFeatures": [],
            "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE"
        }
    ]
}

Pour plus d’informations, consultez Création d’un instantané de base de données dans le Guide de l’utilisateur Amazon RDS.

Exemple 2 : pour trouver le nombre d’instantanés manuels pris

L’exemple describe-db-snapshots suivant utilise l’opérateur length dans l’option --query pour renvoyer le nombre d’instantanés manuels qui ont été pris dans une région AWS donnée.


aws rds describe-db-snapshots \
    --snapshot-type manual \
    --query "length(*[].{DBSnapshots:SnapshotType})" \
    --region eu-central-1

Sortie :

Pour plus d’informations, consultez Création d’un instantané de base de données dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez DescribeDBSnapshots dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-db-subnet-groups.

AWS CLI

Pour décrire un groupe de sous-réseaux de base de données

L’exemple describe-db-subnet-groups extrait les détails sur le groupe de sous-réseaux de base de données spécifié.


aws rds describe-db-subnet-groups

Sortie :


{
    "DBSubnetGroups": [
        {
            "DBSubnetGroupName": "mydbsubnetgroup",
            "DBSubnetGroupDescription": "My DB Subnet Group",
            "VpcId": "vpc-971c12ee",
            "SubnetGroupStatus": "Complete",
            "Subnets": [
                {
                    "SubnetIdentifier": "subnet-d8c8e7f4",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1a"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-718fdc7d",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1f"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-cbc8e7e7",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1a"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-0ccde220",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1a"
                    },
                    "SubnetStatus": "Active"
                }
            ],
            "DBSubnetGroupArn": "arn:aws:rds:us-east-1:123456789012:subgrp:mydbsubnetgroup"
        }
    ]
}

Pour plus d’informations, consultez Amazon Virtual Private Cloud VPCs and Amazon RDS dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez DescribeDbSubnetGroups dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-engine-default-cluster-parameters.

AWS CLI

Pour décrire les informations sur le moteur par défaut et sur les paramètres système du moteur de base de données Aurora

L’exemple describe-engine-default-cluster-parameters suivant récupère les détails sur le moteur par défaut et les informations sur les paramètres système pour les clusters de bases de données Aurora compatibles avec MySQL 5.7.


aws rds describe-engine-default-cluster-parameters \
    --db-parameter-group-family aurora-mysql5.7

Sortie :


{
    "EngineDefaults": {
        "Parameters": [
            {
                "ParameterName": "aurora_load_from_s3_role",
                "Description": "IAM role ARN used to load data from AWS S3",
                "Source": "engine-default",
                "ApplyType": "dynamic",
                "DataType": "string",
                "IsModifiable": true,
                "SupportedEngineModes": [
                    "provisioned"
                ]
            },
            ...some output truncated...
        ]
    }
}

Pour plus de détails sur l’API, consultez DescribeEngineDefaultClusterParameters dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-engine-default-parameters.

AWS CLI

Pour décrire les informations sur le moteur par défaut et sur les paramètres système du moteur de base de données

L’exemple describe-engine-default-parameters suivant récupère les détails sur le moteur par défaut et les informations sur les paramètres système pour les instances de base de données MySQL 5.7.


aws rds describe-engine-default-parameters \
    --db-parameter-group-family mysql5.7

Sortie :


{
    "EngineDefaults": {
        "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
            },
            ...some output truncated...
        ]
    }
}

Pour plus d’informations, consultez Utilisation de groupes de paramètres de base de données dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez DescribeEngineDefaultParameters dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-event-categories.

AWS CLI

Pour décrire les catégories d’événements

L’exemple describe-event-categories suivant récupère les détails sur les catégories d’événements pour toutes les sources d’événements disponibles.


aws rds describe-event-categories

Sortie :


{
    "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"
            ]
        }
    ]
}

Pour plus de détails sur l’API, consultez DescribeEventCategories dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-event-subscriptions.

AWS CLI

Pour décrire les abonnements aux événements

Cet exemple décrit tous les abonnements aux événements Amazon RDS pour le compte AWS actuel.


aws rds describe-event-subscriptions

Sortie :


{
    "EventSubscriptionsList": [
        {
            "EventCategoriesList": [
                "backup",
                "recovery"
            ],
            "Enabled": true,
            "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events",
            "Status": "creating",
            "SourceType": "db-instance",
            "CustomerAwsId": "123456789012",
            "SubscriptionCreationTime": "2018-07-31 23:22:01.893",
            "CustSubscriptionId": "my-instance-events",
            "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events"
        },
        ...some output truncated...
    ]
}

Pour plus de détails sur l’API, consultez DescribeEventSubscriptions dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-events.

AWS CLI

Pour décrire les événements

L’exemple describe-events suivant récupère les détails sur les événements qui se sont produits pour l’instance de base de données spécifiée.


aws rds describe-events \
    --source-identifier test-instance \
    --source-type db-instance

Sortie :


{
    "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"
        }
    ]
}

Pour plus de détails sur l’API, consultez DescribeEvents dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-export-tasks.

AWS CLI

Pour décrire les tâches d’exportation d’instantanés

L’exemple describe-export-tasks suivant renvoie les informations sur les exportations d’instantanés vers Amazon S3.


aws rds describe-export-tasks

Sortie :


{
    "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
        }
    ]
}

Pour plus d’informations, consultez Surveillance des exportations d’instantanés dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez DescribeExportTasks dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-global-clusters.

AWS CLI

Pour décrire les clusters de bases de données globaux

L’exemple describe-global-clusters suivant crée une liste des clusters de base de données globaux Aurora dans la région AWS actuelle.


aws rds describe-global-clusters

Sortie :


{
    "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": []
        }
    ]
}

Pour plus d’informations, consultez Gestion d’une base de données Aurora globale dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez DescribeGlobalClusters dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-option-group-options.

AWS CLI

Pour décrire toutes les options disponibles

L’exemple describe-option-group-options suivant répertorie deux options pour une instance Oracle Database 19c.


aws rds describe-option-group-options \
    --engine-name oracle-ee \
    --major-engine-version 19 \
    --max-items 2

Sortie :


{
    "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=="
}

Pour plus d’informations, consultez Liste des options et des paramètres d’options pour un groupe d’options dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez DescribeOptionGroupOptions dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-option-groups.

AWS CLI

Pour décrire les groupes d’options disponibles

L’exemple describe-option-groups suivant répertorie les groupes d’options pour une instance Oracle Database 19c.


aws rds describe-option-groups \
    --engine-name oracle-ee \
    --major-engine-version 19

Sortie :


{
    "OptionGroupsList": [
        {
            "OptionGroupName": "default:oracle-ee-19",
            "OptionGroupDescription": "Default option group for oracle-ee 19",
            "EngineName": "oracle-ee",
            "MajorEngineVersion": "19",
            "Options": [],
            "AllowsVpcAndNonVpcInstanceMemberships": true,
            "OptionGroupArn": "arn:aws:rds:us-west-1:111122223333:og:default:oracle-ee-19"
        }
    ]
}

Pour plus d’informations, consultez Liste des options et des paramètres d’options pour un groupe d’options dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez DescribeOptionGroups dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-orderable-db-instance-options.

AWS CLI

Pour décrire les options d’instance de base de données pouvant être commandées

L’exemple describe-orderable-db-instance-options suivant récupère les détails sur les options pouvant être commandées pour une instance de base de données exécutant le moteur de base de données MySQL.


aws rds describe-orderable-db-instance-options \
    --engine mysql

Sortie :


{
    "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...
}

Pour plus de détails sur l’API, consultez DescribeOrderableDBInstanceOptions dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-pending-maintenance-actions.

AWS CLI

Pour créer une liste des ressources dont au moins une action d’entretien est en attente

L’exemple describe-pending-maintenance-actions suivant crée une liste des actions d’entretien en attente pour une instance de base de données.


aws rds describe-pending-maintenance-actions

Sortie :


{
    "PendingMaintenanceActions": [
        {
            "ResourceIdentifier": "arn:aws:rds:us-west-2:123456789012:cluster:global-db1-cl1",
            "PendingMaintenanceActionDetails": [
                {
                    "Action": "system-update",
                    "Description": "Upgrade to Aurora PostgreSQL 2.4.2"
                }
            ]
        }
    ]
}

Pour plus d’informations, consultez Entretien d’une instance de base de données dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez DescribePendingMaintenanceActions dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-reserved-db-instances-offerings.

AWS CLI

Pour décrire les offres d’instances de base de données réservées

L’exemple describe-reserved-db-instances-offerings suivant récupère les détails sur les options d’instance de base de données réservées pour oracle.


aws rds describe-reserved-db-instances-offerings \
    --product-description oracle

Sortie :


{
    "ReservedDBInstancesOfferings": [
        {
            "CurrencyCode": "USD",
            "UsagePrice": 0.0,
            "ProductDescription": "oracle-se2(li)",
            "ReservedDBInstancesOfferingId": "005bdee3-9ef4-4182-aa0c-58ef7cb6c2f8",
            "MultiAZ": true,
            "DBInstanceClass": "db.m4.xlarge",
            "OfferingType": "Partial Upfront",
            "RecurringCharges": [
                {
                    "RecurringChargeAmount": 0.594,
                    "RecurringChargeFrequency": "Hourly"
                }
            ],
            "FixedPrice": 4089.0,
            "Duration": 31536000
        },
    ...some output truncated...
}

Pour plus de détails sur l’API, consultez DescribeReservedDbInstancesOfferings dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-reserved-db-instances.

AWS CLI

Pour décrire les instances de base de données réservées

L’exemple describe-reserved-db-instances suivant récupère les détails sur toutes les instances de base de données réservées dans le compte AWS actuel.


aws rds describe-reserved-db-instances

Sortie :


{
    "ReservedDBInstances": [
        {
            "ReservedDBInstanceId": "myreservedinstance",
            "ReservedDBInstancesOfferingId": "12ab34cd-59af-4b2c-a660-1abcdef23456",
            "DBInstanceClass": "db.t3.micro",
            "StartTime": "2020-06-01T13:44:21.436Z",
            "Duration": 31536000,
            "FixedPrice": 0.0,
            "UsagePrice": 0.0,
            "CurrencyCode": "USD",
            "DBInstanceCount": 1,
            "ProductDescription": "sqlserver-ex(li)",
            "OfferingType": "No Upfront",
            "MultiAZ": false,
            "State": "payment-pending",
            "RecurringCharges": [
                {
                    "RecurringChargeAmount": 0.014,
                    "RecurringChargeFrequency": "Hourly"
                }
            ],
            "ReservedDBInstanceArn": "arn:aws:rds:us-west-2:123456789012:ri:myreservedinstance",
            "LeaseId": "a1b2c3d4-6b69-4a59-be89-5e11aa446666"
        }
    ]
}

Pour plus d’informations, consultez Reserved DB Instances for Amazon RDS dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez DescribeReservedDbInstances dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-source-regions.

AWS CLI

Pour décrire les régions source

L’exemple describe-source-regions suivant récupère les détails sur toutes les régions AWS source. Cela indique également que les sauvegardes automatiques ne peuvent être répliquées que de la région USA Ouest (Oregon) vers la région AWS de destination, USA Est (Virginie du Nord).


aws rds describe-source-regions \
    --region us-east-1

Sortie :


{
    "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
        }
    ]
}

Pour plus d’informations, consultez Recherche d’informations sur les sauvegardes répliquées dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez DescribeSourceRegions dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-valid-db-instance-modifications.

AWS CLI

Pour décrire les modifications valides pour une instance de base de données

L’exemple describe-valid-db-instance-modifications suivant récupère les détails sur les modifications valides pour l’instance de base de données spécifiée.


aws rds describe-valid-db-instance-modifications \
    --db-instance-identifier test-instance

Sortie :


{
    "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"
            }
        ]
    }
}

Pour plus de détails sur l’API, consultez DescribeValidDbInstanceModifications dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser download-db-log-file-portion.

AWS CLI

Exemple 1 : pour télécharger la dernière partie d’un fichier journal de base de données

L’exemple download-db-log-file-portion suivant télécharge uniquement la dernière partie de votre fichier journal et l’enregistre dans un fichier local nommé tail.txt.


aws rds download-db-log-file-portion \
    --db-instance-identifier test-instance \
    --log-file-name log.txt \
    --output text > tail.txt

Le fichier enregistré peut contenir des lignes vides. Elles apparaissent à la fin de chaque partie du fichier journal lors du téléchargement.

Exemple 2 : pour télécharger l’intégralité d’un fichier journal de base de données

L’exemple download-db-log-file-portion suivant télécharge l’intégralité du fichier journal à l’aide du paramètre --starting-token 0 et enregistre la sortie dans un fichier local nommé full.txt.


aws rds download-db-log-file-portion \
    --db-instance-identifier test-instance \
    --log-file-name log.txt \
    --starting-token 0 \
    --output text > full.txt

Le fichier enregistré peut contenir des lignes vides. Elles apparaissent à la fin de chaque partie du fichier journal lors du téléchargement.

Pour plus de détails sur l’API, consultez DownloadDbLogFilePortion dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser generate-auth-token.

AWS CLI

Pour générer un jeton d’authentification

L’exemple generate-db-auth-token suivant génère un jeton d’authentification à utiliser avec l’authentification de base de données IAM.


aws rds generate-db-auth-token \
    --hostname aurmysql-test.cdgmuqiadpid.us-west-2.rds.amazonaws.com \
    --port 3306 \
    --region us-east-1 \
    --username jane_doe

Sortie :


aurmysql-test.cdgmuqiadpid.us-west-2.rds.amazonaws.com:3306/?Action=connect&DBUser=jane_doe&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIESZCNJ3OEXAMPLE%2F20180731%2Fus-east-1%2Frds-db%2Faws4_request&X-Amz-Date=20180731T235209Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=5a8753ebEXAMPLEa2c724e5667797EXAMPLE9d6ec6e3f427191fa41aeEXAMPLE

Pour plus de détails sur l’API, consultez GenerateAuthToken dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser generate-db-auth-token.

AWS CLI

Pour générer un jeton d’authentification IAM

L’exemple generate-db-auth-token suivant génère un jeton d’authentification IAM pour se connecter à une base de données.


aws rds generate-db-auth-token \
    --hostname mydb.123456789012.us-east-1.rds.amazonaws.com \
    --port 3306 \
    --region us-east-1 \
    --username db_user

Sortie :


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

Pour plus d’informations, consultez Connecting to your DB instance using IAM authentication dans le Guide de l’utilisateur Amazon RDS et Connecting to your DB cluster using IAM authentication dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez GenerateDbAuthToken dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-tags-for-resource.

AWS CLI

Pour répertorier les balises sur une ressource Amazon RDS

L’exemple list-tags-for-resource suivant répertorie toutes les balises d’une instance de base de données.


aws rds list-tags-for-resource \
    --resource-name arn:aws:rds:us-east-1:123456789012:db:orcl1

Sortie :


{
    "TagList": [
        {
            "Key": "Environment",
            "Value": "test"
        },
        {
            "Key": "Name",
            "Value": "MyDatabase"
        }
    ]
}

Pour plus d’informations, consultez Balisage de ressources Amazon RDS dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez ListTagsForResource dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-certificates.

AWS CLI

Pour remplacer temporairement le certificat SSL/TLS par défaut du système pour les nouvelles instances de base de données

L’exemple modify-certificates suivant remplace temporairement le certificat SSL/TLS par défaut du système pour les nouvelles instances de base de données.


aws rds modify-certificates \
    --certificate-identifier rds-ca-2019

Sortie :


{
    "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"
    }
}

Pour plus d’informations, consultez Rotation de votre certificat SSL/TLS dans le Guide de l’utilisateur Amazon RDS et Rotation de votre certificat SSL/TLS dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez ModifyCertificates dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-current-db-cluster-capacity.

AWS CLI

Pour mettre à l’échelle la capacité d’un cluster de bases de données Aurora sans serveur

L’exemple modify-current-db-cluster-capacity suivant met à l’échelle la capacité d’un cluster de bases de données Aurora sans serveur à 8.


aws rds modify-current-db-cluster-capacity \
    --db-cluster-identifier mydbcluster \
    --capacity 8

Sortie :


{
    "DBClusterIdentifier": "mydbcluster",
    "PendingCapacity": 8,
    "CurrentCapacity": 1,
    "SecondsBeforeTimeout": 300,
    "TimeoutAction": "ForceApplyCapacityChange"
}

Pour plus d’informations, consultez Mise à l’échelle manuelle de la capacité d’un cluster de bases de données Aurora sans serveur v1 dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez ModifyCurrentDbClusterCapacity dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-db-cluster-endpoint.

AWS CLI

Pour modifier un point de terminaison de cluster de bases de données personnalisé

L’exemple modify-db-cluster-endpoint suivant modifie le point de terminaison de cluster de bases de données spécifié.


aws rds modify-db-cluster-endpoint \
    --db-cluster-endpoint-identifier mycustomendpoint \
    --static-members dbinstance1 dbinstance2 dbinstance3

Sortie :


{
    "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"
}

Pour plus d’informations, consultez Gestion des connexions Amazon Aurora dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez ModifyDbClusterEndpoint dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-db-cluster-parameter-group.

AWS CLI

Pour modifier les paramètres d’un groupe de paramètres de cluster de bases de données

L’exemple modify-db-cluster-parameter-group suivant modifie les valeurs des paramètres d’un groupe de paramètres de cluster de bases de données.


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"

Sortie :


{
    "DBClusterParameterGroupName": "mydbclusterpg"
}

Pour plus de détails sur l’API, consultez ModifyDbClusterParameterGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-db-cluster-snapshot-attribute.

AWS CLI

Pour modifier un attribut d’instantané de cluster de bases de données

L’exemple modify-db-cluster-snapshot-attribute suivant apporte des modifications à l’attribut d’instantané de cluster de bases de données spécifié.


aws rds modify-db-cluster-snapshot-attribute \
    --db-cluster-snapshot-identifier myclustersnapshot \
    --attribute-name restore \
    --values-to-add 123456789012

Sortie :


{
    "DBClusterSnapshotAttributesResult": {
        "DBClusterSnapshotIdentifier": "myclustersnapshot",
        "DBClusterSnapshotAttributes": [
            {
                "AttributeName": "restore",
                "AttributeValues": [
                    "123456789012"
                ]
            }
        ]
    }
}

Pour plus d’informations, consultez Restauration à partir d’un instantané de cluster de bases de données dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez ModifyDbClusterSnapshotAttribute dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-db-cluster.

AWS CLI

Exemple 1 : pour modifier un cluster de bases de données

L’exemple modify-db-cluster suivant modifie le mot de passe de l’utilisateur principal pour le cluster de bases de données nommé cluster-2 et définit la période de rétention des sauvegardes à 14 jours. Le paramètre --apply-immediately entraîne la modification immédiate du groupes de paramètres de base de données, au lieu d’attendre la prochaine fenêtre de maintenance.


aws rds modify-db-cluster \
    --db-cluster-identifier cluster-2 \
    --backup-retention-period 14 \
    --master-user-password newpassword99 \
    --apply-immediately

Sortie :


{
    "DBCluster": {
        "AllocatedStorage": 1,
        "AvailabilityZones": [
            "eu-central-1b",
            "eu-central-1c",
            "eu-central-1a"
        ],
        "BackupRetentionPeriod": 14,
        "DatabaseName": "",
        "DBClusterIdentifier": "cluster-2",
        "DBClusterParameterGroup": "default.aurora5.6",
        "DBSubnetGroup": "default-vpc-2305ca49",
        "Status": "available",
        "EarliestRestorableTime": "2020-06-03T02:07:29.637Z",
        "Endpoint": "cluster-2.cluster-############.eu-central-1.rds.amazonaws.com",
        "ReaderEndpoint": "cluster-2.cluster-ro-############.eu-central-1.rds.amazonaws.com",
        "MultiAZ": false,
        "Engine": "aurora",
        "EngineVersion": "5.6.10a",
        "LatestRestorableTime": "2020-06-04T15:11:25.748Z",
        "Port": 3306,
        "MasterUsername": "admin",
        "PreferredBackupWindow": "01:55-02:25",
        "PreferredMaintenanceWindow": "thu:21:14-thu:21:44",
        "ReadReplicaIdentifiers": [],
        "DBClusterMembers": [
            {
                "DBInstanceIdentifier": "cluster-2-instance-1",
                "IsClusterWriter": true,
                "DBClusterParameterGroupStatus": "in-sync",
                "PromotionTier": 1
            }
        ],
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-20a5c047",
                "Status": "active"
            }
        ],
        "HostedZoneId": "Z1RLNU0EXAMPLE",
        "StorageEncrypted": true,
        "KmsKeyId": "arn:aws:kms:eu-central-1:123456789012:key/d1bd7c8f-5cdb-49ca-8a62-a1b2c3d4e5f6",
        "DbClusterResourceId": "cluster-AGJ7XI77XVIS6FUXHU1EXAMPLE",
        "DBClusterArn": "arn:aws:rds:eu-central-1:123456789012:cluster:cluster-2",
        "AssociatedRoles": [],
        "IAMDatabaseAuthenticationEnabled": false,
        "ClusterCreateTime": "2020-04-03T14:44:02.764Z",
        "EngineMode": "provisioned",
        "DeletionProtection": false,
        "HttpEndpointEnabled": false,
        "CopyTagsToSnapshot": true,
        "CrossAccountClone": false,
        "DomainMemberships": []
    }
}

Pour plus d’informations, consultez Modification d’un cluster de bases de données Amazon Aurora dans le Guide de l’utilisateur Amazon Aurora.

Exemple 2 : pour associer un groupe de sécurité VPC à un cluster de bases de données

L’exemple modify-db-instance suivant associe un groupe de sécurité VPC spécifique et supprime des groupes de sécurité de base de données d’un cluster de bases de données.


aws rds modify-db-cluster \
    --db-cluster-identifier dbName \
    --vpc-security-group-ids sg-ID

Sortie :


{
    "DBCluster": {
        "AllocatedStorage": 1,
        "AvailabilityZones": [
            "us-west-2c",
            "us-west-2b",
            "us-west-2a"
        ],
        "BackupRetentionPeriod": 1,
        "DBClusterIdentifier": "dbName",
        "DBClusterParameterGroup": "default.aurora-mysql8.0",
        "DBSubnetGroup": "default",
        "Status": "available",
        "EarliestRestorableTime": "2024-02-15T01:12:13.966000+00:00",
        "Endpoint": "dbName.cluster-abcdefghji.us-west-2.rds.amazonaws.com",
        "ReaderEndpoint": "dbName.cluster-ro-abcdefghji.us-west-2.rds.amazonaws.com",
        "MultiAZ": false,
        "Engine": "aurora-mysql",
        "EngineVersion": "8.0.mysql_aurora.3.04.1",
        "LatestRestorableTime": "2024-02-15T02:25:33.696000+00:00",
        "Port": 3306,
        "MasterUsername": "admin",
        "PreferredBackupWindow": "10:59-11:29",
        "PreferredMaintenanceWindow": "thu:08:54-thu:09:24",
        "ReadReplicaIdentifiers": [],
        "DBClusterMembers": [
            {
                "DBInstanceIdentifier": "dbName-instance-1",
                "IsClusterWriter": true,
                "DBClusterParameterGroupStatus": "in-sync",
                "PromotionTier": 1
            }
        ],
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-ID",
                "Status": "active"
            }
        ],
        ...output omitted...
    }
}

Pour plus d’informations, consultez Contrôle d’accès par groupe de sécurité dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez ModifyDbCluster dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-db-instance.

AWS CLI

Exemple 1 : pour modifier une instance de base de données

L’exemple modify-db-instance suivant associe un groupe d’options et un groupe de paramètres à une instance de base de données Microsoft SQL Server compatible. Le paramètre --apply-immediately entraîne l’association immédiate des groupes d’options et de paramètres au lieu d’attendre la prochaine fenêtre de maintenance.


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

Sortie :


{
    "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
    }
}

Pour plus d’informations, consultez Modification d’une instance de base de données Amazon RDS dans le Guide de l’utilisateur Amazon RDS.

Exemple 2 : pour associer un groupe de sécurité VPC à une instance de base de données

L’exemple modify-db-instance suivant associe un groupe de sécurité VPC spécifique et supprime des groupes de sécurité de base de données d’une instance de base de données :


aws rds modify-db-instance \
    --db-instance-identifier dbName \
    --vpc-security-group-ids sg-ID

Sortie :


{
"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 ...
    }
}

Pour plus d’informations, consultez Contrôle d’accès par groupe de sécurité dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez ModifyDBInstance dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-db-parameter-group.

AWS CLI

Pour modifier un groupe de paramètres de base de données

L’exemple modify-db-parameter-group suivant modifie la valeur du paramètre clr enabled dans un groupe de paramètres de base de données. Le paramètre --apply-immediately entraîne la modification immédiate du groupe de paramètres de base de données, au lieu d’attendre la prochaine fenêtre de maintenance.


aws rds modify-db-parameter-group \
    --db-parameter-group-name test-sqlserver-se-2017 \
    --parameters "ParameterName='clr enabled',ParameterValue=1,ApplyMethod=immediate"

Sortie :


{
    "DBParameterGroupName": "test-sqlserver-se-2017"
}

Pour plus d’informations, consultez Modification de paramètres dans un groupe de paramètres de base de données dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez ModifyDBParameterGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-db-proxy-endpoint.

AWS CLI

Pour modifier un point de terminaison proxy de base de données pour une base de données RDS

L’exemple modify-db-proxy-endpoint suivant modifie un point de terminaison proxy de base de données proxyEndpoint pour définir le délai d’expiration de lecture à 65 secondes.


aws rds modify-db-proxy-endpoint \
    --db-proxy-endpoint-name proxyEndpoint \
    --cli-read-timeout 65

Sortie :


{
"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"
    }
}

Pour plus d’informations, consultez Modification d’un point de terminaison proxy dans le Guide de l’utilisateur Amazon RDS et Modification d’un point de terminaison proxy dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez ModifyDbProxyEndpoint dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-db-proxy-target-group.

AWS CLI

Pour modifier les points de terminaison d’un proxy de base de données

L’exemple modify-db-proxy-target-group suivant modifie un groupe cible de proxy de base de données pour définir le nombre maximum de connexions à 80 % et le nombre maximum de connexions inactives à 10 %.


aws rds modify-db-proxy-target-group \
    --target-group-name default \
    --db-proxy-name proxyExample \
    --connection-pool-config MaxConnectionsPercent=80,MaxIdleConnectionsPercent=10

Sortie :


{
"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"
    }
}

Pour plus d’informations, consultez Modification d’un RDS proxy dans le Guide de l’utilisateur Amazon RDS et Modification d’un RDS proxy dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez ModifyDbProxyTargetGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-db-proxy.

AWS CLI

Pour modifier un proxy de base de données pour une base de données RDS

L’exemple modify-db-proxy suivant modifie un proxy de base de données nommé proxyExample pour exiger le protocole SSL pour ses connexions.


aws rds modify-db-proxy \
    --db-proxy-name proxyExample \
    --require-tls

Sortie :


{
"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"
    }
}

Pour plus d’informations, consultez Modify an RDS Proxy dans le Guide de l’utilisateur Amazon RDS et Création d’un RDS Proxy dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez ModifyDbProxy dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-db-shard-group.

AWS CLI

Exemple 1 : pour modifier un groupe de partitions de base de données

L’exemple modify-db-shard-group suivant modifie la capacité maximale d’un groupe de partitions de base de données.


aws rds modify-db-shard-group \
    --db-shard-group-identifier my-db-shard-group \
    --max-acu 1000

Sortie :


{
    "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"
        }
    ]
}

Pour plus d’informations, consultez Clusters de bases de données Amazon Aurora dans le Guide de l’utilisateur Amazon Aurora.

Exemple 2 : pour décrire les groupes de partitions de base de données

L’exemple describe-db-shard-groups suivant récupère les détails sur vos groupes de partitions de base de données une fois que vous avez exécuté la commande modify-db-shard-group. La capacité maximale du groupe de partitions de base de données my-db-shard-group est désormais de 1 000 unités de capacité Aurora (ACU).


aws rds describe-db-shard-groups

Sortie :


{
    "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"
        }
    ]
}

Pour plus d’informations, consultez Clusters de bases de données Amazon Aurora dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez ModifyDbShardGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-db-snapshot-attribute.

AWS CLI

Exemple 1 : pour permettre à deux comptes AWS de restaurer un instantané de base de données

L’exemple modify-db-snapshot-attribute suivant autorise deux comptes AWS avec les identifiants 111122223333 et 444455556666 à restaurer l’instantané de base de données nommé mydbsnapshot.


aws rds modify-db-snapshot-attribute \
    --db-snapshot-identifier mydbsnapshot \
    --attribute-name restore \
    --values-to-add {"111122223333","444455556666"}

Sortie :


{
    "DBSnapshotAttributesResult": {
        "DBSnapshotIdentifier": "mydbsnapshot",
        "DBSnapshotAttributes": [
            {
                "AttributeName": "restore",
                "AttributeValues": [
                    "111122223333",
                    "444455556666"
                ]
            }
        ]
    }
}

Pour plus d’informations, consultez Partage d’un instantané dans le Guide de l’utilisateur Amazon RDS.

Exemple 2 : pour empêcher un compte AWS de restaurer un instantané de base de données

L’exemple modify-db-snapshot-attribute suivant supprime l’autorisation d’un compte AWS particulier à restaurer l’instantané de base de données nommé mydbsnapshot. Lorsque vous spécifiez un seul compte, l’identifiant du compte ne peut pas être entouré de guillemets ou d’accolades.


aws rds modify-db-snapshot-attribute \
    --db-snapshot-identifier mydbsnapshot \
    --attribute-name restore \
    --values-to-remove 444455556666

Sortie :


{
    "DBSnapshotAttributesResult": {
        "DBSnapshotIdentifier": "mydbsnapshot",
        "DBSnapshotAttributes": [
            {
                "AttributeName": "restore",
                "AttributeValues": [
                    "111122223333"
                ]
            }
        ]
    }
}

Pour plus d’informations, consultez Partage d’un instantané dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez ModifyDbSnapshotAttribute dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-db-snapshot-attributes.

AWS CLI

Pour modifier un attribut d’instantané de base de données

L’exemple modify-db-snapshot-attribute suivant autorise deux identifiants de compte AWS, 111122223333 et 444455556666, à restaurer l’instantané de base de données nommé mydbsnapshot.


aws rds modify-db-snapshot-attribute \
    --db-snapshot-identifier mydbsnapshot \
    --attribute-name restore \
    --values-to-add '["111122223333","444455556666"]'

Sortie :


{
    "DBSnapshotAttributesResult": {
        "DBSnapshotIdentifier": "mydbsnapshot",
        "DBSnapshotAttributes": [
            {
                "AttributeName": "restore",
                "AttributeValues": [
                    "111122223333",
                    "444455556666"
                ]
            }
        ]
    }
}

Pour plus d’informations, consultez Partage d’un instantané dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez ModifyDbSnapshotAttributes dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-db-snapshot.

AWS CLI

Pour modifier un instantané de base de données

L’exemple modify-db-snapshot suivant met à niveau un instantané PostgreSQL 10.6 nommé db5-snapshot-upg-test vers PostgreSQL 11.7. La nouvelle version du moteur de base de données est affichée une fois que la mise à niveau de l’instantané est terminée et que son statut est disponible.


aws rds modify-db-snapshot \
    --db-snapshot-identifier db5-snapshot-upg-test \
    --engine-version 11.7

Sortie :


{
    "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"
    }
}

Pour plus d’informations, consultez Mise à niveau d’un instantané de base de données PostgreSQL dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez ModifyDbSnapshot dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-db-subnet-group.

AWS CLI

Pour modifier un groupe de sous-réseaux de base de données

L’exemple modify-db-subnet-group suivant ajoute un sous-réseau avec l’ID subnet-08e41f9e230222222 au groupe de sous-réseaux de base de données nommé mysubnetgroup. Pour conserver les sous-réseaux existants dans le groupe de sous-réseaux, incluez leurs ID sous forme de valeurs dans l’option --subnet-ids. Assurez-vous de disposer de sous-réseaux avec au moins deux zones de disponibilité distinctes dans le groupe de sous-réseaux de base de données.


aws rds modify-db-subnet-group \
    --db-subnet-group-name mysubnetgroup \
    --subnet-ids '["subnet-0a1dc4e1a6f123456","subnet-070dd7ecb3aaaaaaa","subnet-00f5b198bc0abcdef","subnet-08e41f9e230222222"]'

Sortie :


{
    "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"
    }
}

Pour plus d’informations, consultez Étape 3 : Créer un groupe de sous-réseaux de base de données dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez ModifyDbSubnetGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-event-subscription.

AWS CLI

Pour modifier un abonnement à un événement

L’exemple modify-event-subscription suivant désactive l’abonnement à un événement spécifié, de sorte qu’il ne publie plus de notifications sur la rubrique Amazon Simple Notification Service spécifiée.


aws rds modify-event-subscription \
    --subscription-name my-instance-events \
    --no-enabled

Sortie :


{
    "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
    }
}

Pour plus de détails sur l’API, consultez ModifyEventSubscription dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser modify-global-cluster.

AWS CLI

Pour modifier un cluster de bases de données global

L’exemple modify-global-cluster suivant active la protection contre la suppression d’un cluster de bases de données global compatible avec Aurora MySQL.


aws rds modify-global-cluster \
    --global-cluster-identifier myglobalcluster \
    --deletion-protection

Sortie :


{
    "GlobalCluster": {
        "GlobalClusterIdentifier": "myglobalcluster",
        "GlobalClusterResourceId": "cluster-f0e523bfe07aabb",
        "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster",
        "Status": "available",
        "Engine": "aurora-mysql",
        "EngineVersion": "5.7.mysql_aurora.2.07.2",
        "StorageEncrypted": false,
        "DeletionProtection": true,
        "GlobalClusterMembers": []
    }
}

Pour plus d’informations, consultez Gestion d’une base de données Aurora globale dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez ModifyGlobalCluster dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser promote-read-replica-db-cluster.

AWS CLI

Pour promouvoir un réplica en lecture de cluster de bases de données

L’exemple promote-read-replica-db-cluster suivant promeut le réplica en lecture spécifié pour en faire un cluster de bases de données autonome.


aws rds promote-read-replica-db-cluster \
    --db-cluster-identifier mydbcluster-1

Sortie :


{
    "DBCluster": {
        "AllocatedStorage": 1,
        "AvailabilityZones": [
            "us-east-1a",
            "us-east-1b",
            "us-east-1c"
        ],
        "BackupRetentionPeriod": 1,
        "DatabaseName": "",
        "DBClusterIdentifier": "mydbcluster-1",
        ...some output truncated...
    }
}

Pour plus d’informations, consultez Promotion d’un réplica en lecture en cluster de bases de données dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez PromoteReadReplicaDbCluster dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser promote-read-replica.

AWS CLI

Pour promouvoir un réplica en lecture

L’exemple promote-read-replica suivant promeut le réplica en lecture spécifié pour en faire une instance de base de données autonome.


aws rds promote-read-replica \
    --db-instance-identifier test-instance-repl

Sortie :


{
    "DBInstance": {
        "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance-repl",
        "StorageType": "standard",
        "ReadReplicaSourceDBInstanceIdentifier": "test-instance",
        "DBInstanceStatus": "modifying",
        ...some output truncated...
    }
}

Pour plus de détails sur l’API, consultez PromoteReadReplica dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser purchase-reserved-db-instance.

AWS CLI

Pour acheter une offre d’instance de base de données réservée

L’exemple purchase-reserved-db-instances-offering suivant achète une offre d’instance de base de données réservée. reserved-db-instances-offering-id doit être un ID d’offre valide, tel que renvoyé par la commande describe-reserved-db-instances-offering.

aws rds purchase-reserved-db-instances-offering --reserved-db-instances-offering-id 438012d3-4a52-4cc7-b2e3-8dff72e0e706

Pour plus de détails sur l’API, consultez PurchaseReservedDbInstance dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser purchase-reserved-db-instances-offerings.

AWS CLI

Exemple 1 : pour rechercher une instance de base de données réservée à acheter

L’exemple describe-reserved-db-instances-offerings suivant crée une liste des instances de base de données MySQL réservées disponibles avec la classe d’instance db.t2.micro et d’une durée d’un an. L’ID d’offre est requis pour acheter une instance de base de données réservée.


aws rds describe-reserved-db-instances-offerings \
    --product-description mysql \
    --db-instance-class db.t2.micro \
    --duration 1

Sortie :


{
    "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 ...
    ]
}

Pour plus d’informations, consultez Reserved DB Instances for Amazon RDS dans le Guide de l’utilisateur Amazon RDS.

Exemple 2 : pour acheter une instance de base de données réservée

L’exemple purchase-reserved-db-instances-offering suivant montre comment acheter l’offre d’instance de base de données réservée de l’exemple précédent.

aws rds purchase-reserved-db-instances-offering --reserved-db-instances-offering-id 8ba30be1-b9ec-447f-8f23-6114e3f4c7b4

Sortie :


{
    "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"
    }
}

Pour plus d’informations, consultez Reserved DB Instances for Amazon RDS dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez PurchaseReservedDbInstancesOfferings dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser reboot-db-instance.

AWS CLI

Pour redémarrer une instance de base de données

L’exemple reboot-db-instance suivant lance un redémarrage de l’instance de base de données spécifiée.


aws rds reboot-db-instance \
    --db-instance-identifier test-mysql-instance

Sortie :


{
    "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...

    }
}

Pour plus d’informations, consultez Redémarrage d’une instance de base de données dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez RebootDBInstance dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser reboot-db-shard-group.

AWS CLI

Exemple 1 : pour redémarrer un groupe de partitions de base de données

L’exemple reboot-db-shard-group suivant redémarre un groupe de partitions de base de données.


aws rds reboot-db-shard-group \
    --db-shard-group-identifier my-db-shard-group

Sortie :


{
    "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"
        }
    ]
}

Pour plus d’informations, consultez Redémarrage d’un cluster de bases de données Amazon Aurora ou d’une instance de base de données Amazon Aurora dans le Guide de l’utilisateur Amazon Aurora.

Exemple 2 : pour décrire les groupes de partitions de base de données

L’exemple describe-db-shard-groups suivant récupère les détails sur vos groupes de partitions de base de données une fois que vous avez exécuté la commande reboot-db-shard-group. Le groupe de partitions de base de données my-db-shard-group est en train de redémarrer.


aws rds describe-db-shard-groups

Sortie :


{
    "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"
        }
    ]
}

Pour plus de détails sur l’API, consultez RebootDbShardGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser register-db-proxy-targets.

AWS CLI

Pour enregistrer un proxy de base de données auprès d’une base de données

L’exemple register-db-proxy-targets suivant crée l’association entre une base de données et un proxy.


aws rds register-db-proxy-targets \
    --db-proxy-name proxyExample \
    --db-cluster-identifiers database-5

Sortie :


{
    "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"
            }
        }
    ]
}

Pour plus d’informations, consultez Création d’un RDS proxy dans le Guide de l’utilisateur Amazon RDS et Création d’un RDS proxy dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez RegisterDbProxyTargets dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser remove-from-global-cluster.

AWS CLI

Pour détacher un cluster Aurora secondaire d’un cluster de bases de données Aurora global

L’exemple remove-from-global-cluster suivant détache un cluster Aurora secondaire d’un cluster de bases de données Aurora global. Le cluster passe d’un cluster en lecture seule à un cluster autonome doté d’une capacité de lecture-écriture.


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

Sortie :


{
    "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"
            }
        ]
    }
}

Pour plus d’informations, consultez Dissociation d’un cluster d’une base de données Amazon Aurora Global Database dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez RemoveFromGlobalCluster dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser remove-option-from-option-group.

AWS CLI

Pour supprimer une option d’un groupe d’options

L’exemple remove-option-from-option-group suivant supprime l’option OEM de myoptiongroup.


aws rds remove-option-from-option-group \
    --option-group-name myoptiongroup \
    --options OEM \
    --apply-immediately

Sortie :


{
    "OptionGroup": {
        "OptionGroupName": "myoptiongroup",
        "OptionGroupDescription": "Test",
        "EngineName": "oracle-ee",
        "MajorEngineVersion": "19",
        "Options": [],
        "AllowsVpcAndNonVpcInstanceMemberships": true,
        "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:myoptiongroup"
    }
}

Pour plus d’informations, consultez Suppression d’une option d’un groupe d’options dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez RemoveOptionFromOptionGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser remove-role-from-db-cluster.

AWS CLI

Pour dissocier un rôle AWS Identity and Access Management (IAM) d’un cluster de bases de données

L’exemple remove-role-from-db-cluster suivant supprime un rôle d’un cluster de bases de données.


aws rds remove-role-from-db-cluster \
    --db-cluster-identifier mydbcluster \
    --role-arn arn:aws:iam::123456789012:role/RDSLoadFromS3

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Association d’un rôle IAM à un cluster de bases de données Amazon Aurora MySQL dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez RemoveRoleFromDbCluster dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser remove-role-from-db-instance.

AWS CLI

Pour dissocier un rôle AWS Identity and Access Management (IAM) d’une instance de base de données

L’exemple remove-role-from-db-instance suivant supprime le rôle nommé rds-s3-integration-role d’une instance de base de données Oracle nommée test-instance.


aws rds remove-role-from-db-instance \
    --db-instance-identifier test-instance \
    --feature-name S3_INTEGRATION \
    --role-arn arn:aws:iam::111122223333:role/rds-s3-integration-role

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Désactivation de l’intégration RDS SQL Server avec S3 dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez RemoveRoleFromDbInstance dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser remove-source-identifier-from-subscription.

AWS CLI

Pour supprimer un identifiant source d’un abonnement

L’exemple remove-source-identifier suivant supprime l’identifiant source spécifié d’un abonnement existant.


aws rds remove-source-identifier-from-subscription \
    --subscription-name my-instance-events \
    --source-identifier test-instance-repl

Sortie :


{
    "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
    }
}

Pour plus de détails sur l’API, consultez RemoveSourceIdentifierFromSubscription dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser remove-tags-from-resource.

AWS CLI

Pour supprimer des balises d'une ressource

L’exemple remove-tags-from-resource suivant supprime des balises d’une ressource.


aws rds remove-tags-from-resource \
    --resource-name arn:aws:rds:us-east-1:123456789012:db:mydbinstance \
    --tag-keys Name Environment

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez Balisage de ressources Amazon RDS dans le Guide de l’utilisateur Amazon RDS et Balisage de ressources Amazon RDS dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez RemoveTagsFromResource dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser reset-db-cluster-parameter-group.

AWS CLI

Exemple 1 : pour réinitialiser tous les paramètres à leurs valeurs par défaut

L’exemple reset-db-cluster-parameter-group suivant réinitialise toutes les valeurs par défaut des paramètres d’un groupe de paramètres de cluster de bases de données créé par le client.


aws rds reset-db-cluster-parameter-group \
    --db-cluster-parameter-group-name mydbclpg \
    --reset-all-parameters

Sortie :


{
    "DBClusterParameterGroupName": "mydbclpg"
}

Exemple 2 : pour réinitialiser des paramètres spécifiques à leurs valeurs par défaut

L’exemple reset-db-cluster-parameter-group suivant réinitialise les valeurs par défaut des paramètres spécifiques dans un groupe de paramètres de cluster de bases de données créé par le client.


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"

Sortie :


{
    "DBClusterParameterGroupName": "mydbclpg"
}

Pour plus de détails sur l’API, consultez ResetDbClusterParameterGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser reset-db-parameter-group.

AWS CLI

Exemple 1 : pour réinitialiser tous les paramètres à leurs valeurs par défaut

L’exemple reset-db-parameter-group suivant réinitialise toutes les valeurs par défaut des paramètres d’un groupe de paramètres de base de données créé par le client.


aws rds reset-db-parameter-group \
    --db-parameter-group-name mypg \
    --reset-all-parameters

Sortie :


{
    "DBParameterGroupName": "mypg"
}

Pour plus d’informations, consultez Utilisation de groupes de paramètres de base de données dans le Guide de l’utilisateur Amazon RDS et Utilisation de groupes de paramètres de base de données et de groupes de paramètres de cluster de bases de données dans le Guide de l’utilisateur Amazon Aurora.

Exemple 2 : pour réinitialiser des paramètres spécifiques à leurs valeurs par défaut

L’exemple reset-db-parameter-group suivant réinitialise les valeurs par défaut des paramètres spécifiques dans un groupe de paramètres de cluster de bases de données créé par le client.


aws rds reset-db-parameter-group \
    --db-parameter-group-name mypg \
    --parameters "ParameterName=max_connections,ApplyMethod=immediate" \
                 "ParameterName=max_allowed_packet,ApplyMethod=immediate"

Sortie :


{
    "DBParameterGroupName": "mypg"
}

Pour plus de détails sur l’API, consultez ResetDbParameterGroup dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser restore-db-cluster-from-s3.

AWS CLI

Pour restaurer un cluster de bases de données Amazon Aurora à partir d’Amazon S3

L’exemple restore-db-cluster-from-s3 suivant restaure un cluster de bases de données compatible avec Amazon Aurora MySQL version 5.7 à partir d’un fichier de sauvegarde de base de données MySQL 5.7 dans Amazon S3.


aws rds restore-db-cluster-from-s3 \
    --db-cluster-identifier cluster-s3-restore \
    --engine aurora-mysql \
    --master-username admin \
    --master-user-password mypassword \
    --s3-bucket-name amzn-s3-demo-bucket \
    --s3-prefix test-backup \
    --s3-ingestion-role-arn arn:aws:iam::123456789012:role/service-role/TestBackup \
    --source-engine mysql \
    --source-engine-version 5.7.28

Sortie :


{
    "DBCluster": {
        "AllocatedStorage": 1,
        "AvailabilityZones": [
            "us-west-2c",
            "us-west-2a",
            "us-west-2b"
        ],
        "BackupRetentionPeriod": 1,
        "DBClusterIdentifier": "cluster-s3-restore",
        "DBClusterParameterGroup": "default.aurora-mysql5.7",
        "DBSubnetGroup": "default",
        "Status": "creating",
        "Endpoint": "cluster-s3-restore.cluster-co3xyzabc123.us-west-2.rds.amazonaws.com",
        "ReaderEndpoint": "cluster-s3-restore.cluster-ro-co3xyzabc123.us-west-2.rds.amazonaws.com",
        "MultiAZ": false,
        "Engine": "aurora-mysql",
        "EngineVersion": "5.7.12",
        "Port": 3306,
        "MasterUsername": "admin",
        "PreferredBackupWindow": "11:15-11:45",
        "PreferredMaintenanceWindow": "thu:12:19-thu:12:49",
        "ReadReplicaIdentifiers": [],
        "DBClusterMembers": [],
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-########",
                "Status": "active"
            }
        ],
        "HostedZoneId": "Z1PVIF0EXAMPLE",
        "StorageEncrypted": false,
        "DbClusterResourceId": "cluster-SU5THYQQHOWCXZZDGXREXAMPLE",
        "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:cluster-s3-restore",
        "AssociatedRoles": [],
        "IAMDatabaseAuthenticationEnabled": false,
        "ClusterCreateTime": "2020-07-27T14:22:08.095Z",
        "EngineMode": "provisioned",
        "DeletionProtection": false,
        "HttpEndpointEnabled": false,
        "CopyTagsToSnapshot": false,
        "CrossAccountClone": false,
        "DomainMemberships": []
    }
}

Pour plus d’informations, consultez Migration des données à partir de MySQL à l’aide d’un compartiment Amazon S3 dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez RestoreDbClusterFromS3 dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser restore-db-cluster-from-snapshot.

AWS CLI

Pour restaurer un cluster de bases de données à partir d’un instantané

L’exemple restore-db-cluster-from-snapshot suivant restaure un cluster de bases de données Aurora PostgreSQL compatible avec PostgreSQL version 10.7 à partir d’un instantané de cluster de bases de données nommé 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

Sortie :


{
    "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": []
    }
}

Pour plus d’informations, consultez Restauration à partir d’un instantané de cluster de bases de données dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez RestoreDbClusterFromSnapshot dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser restore-db-cluster-to-point-in-time.

AWS CLI

Pour restaurer un cluster de bases de données à un moment spécifié

L’exemple restore-db-cluster-to-point-in-time suivant restaure un cluster de bases de données nommé database-4 à la date la plus récente possible. L’utilisation de copy-on-write comme type de restauration restaure le nouveau cluster de bases de données sous la forme d’un clone du cluster de bases de données source.


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

Sortie :


{
    "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
    }
}

Pour plus d’informations, consultez Restauration d’un cluster de bases de données à une date définie dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez RestoreDbClusterToPointInTime dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser restore-db-instance-from-db-snapshot.

AWS CLI

Pour restaurer une instance de base de données à partir d'un instantané de base de données

L’exemple restore-db-instance-from-db-snapshot crée une nouvelle instance de base de données nommée db7-new-instance avec la classe d’instance de base de données db.t3.small à partir de l’instantané de base de données spécifié. L’instance de base de données source à partir de laquelle l’instantané a été pris utilise une classe d’instance de base de données obsolète, vous ne pouvez donc pas la mettre à niveau.


aws rds restore-db-instance-from-db-snapshot \
    --db-instance-identifier db7-new-instance \
    --db-snapshot-identifier db7-test-snapshot \
    --db-instance-class db.t3.small

Sortie :


{
    "DBInstance": {
        "DBInstanceIdentifier": "db7-new-instance",
        "DBInstanceClass": "db.t3.small",
        "Engine": "mysql",
        "DBInstanceStatus": "creating",

        ...output omitted...

        "PreferredMaintenanceWindow": "mon:07:37-mon:08:07",
        "PendingModifiedValues": {},
        "MultiAZ": false,
        "EngineVersion": "5.7.22",
        "AutoMinorVersionUpgrade": true,
        "ReadReplicaDBInstanceIdentifiers": [],
        "LicenseModel": "general-public-license",

        ...output omitted...

        "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:db7-new-instance",
        "IAMDatabaseAuthenticationEnabled": false,
        "PerformanceInsightsEnabled": false,
        "DeletionProtection": false,
        "AssociatedRoles": []
    }
}

Pour plus d’informations, consultez Restauration à partir d’un instantané de base de données dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez RestoreDbInstanceFromDbSnapshot dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser restore-db-instance-from-s3.

AWS CLI

Pour restaurer une instance de base de données à partir d’une sauvegarde dans Amazon S3

L’exemple restore-db-instance-from-s3 suivant crée une nouvelle instance de base de données nommée restored-test-instance à partir d’une sauvegarde existante dans le compartiment S3 my-backups.


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

Pour plus de détails sur l’API, consultez RestoreDbInstanceFromS3 dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser restore-db-instance-to-point-in-time.

AWS CLI

Exemple 1 : pour restaurer une instance de base de données à une date donnée

L’exemple restore-db-instance-to-point-in-time suivant restaure test-instance vers une nouvelle instance de base de données nommée restored-test-instance à la date spécifiée.


aws rds restore-db-instance-to-point-in-time \
    --source-db-instance-identifier test-instance \
    --target-db-instance restored-test-instance \
    --restore-time 2018-07-30T23:45:00.000Z

Sortie :


{
    "DBInstance": {
        "AllocatedStorage": 20,
        "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:restored-test-instance",
        "DBInstanceStatus": "creating",
        "DBInstanceIdentifier": "restored-test-instance",
        ...some output omitted...
    }
}

Pour plus d’informations, consultez Restauration d’une instance de base de données à une date spécifiée dans le Guide de l’utilisateur Amazon RDS.

Exemple 2 : pour restaurer une instance de base de données à une heure spécifiée à partir d’une sauvegarde répliquée

L’exemple restore-db-instance-to-point-in-time suivant restaure une instance de base de données Oracle à l’heure spécifiée à partir d’une sauvegarde automatique répliquée.


aws rds restore-db-instance-to-point-in-time \
    --source-db-instance-automated-backups-arn "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" \
    --target-db-instance-identifier myorclinstance-from-replicated-backup \
    --restore-time 2020-12-08T18:45:00.000Z

Sortie :


{
    "DBInstance": {
        "DBInstanceIdentifier": "myorclinstance-from-replicated-backup",
        "DBInstanceClass": "db.t3.micro",
        "Engine": "oracle-se2",
        "DBInstanceStatus": "creating",
        "MasterUsername": "admin",
        "DBName": "ORCL",
        "AllocatedStorage": 20,
        "PreferredBackupWindow": "07:45-08:15",
        "BackupRetentionPeriod": 14,
        ... some output omitted ...
        "DbiResourceId": "db-KGLXG75BGVIWKQT7NQ4EXAMPLE",
        "CACertificateIdentifier": "rds-ca-2019",
        "DomainMemberships": [],
        "CopyTagsToSnapshot": false,
        "MonitoringInterval": 0,
        "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:myorclinstance-from-replicated-backup",
        "IAMDatabaseAuthenticationEnabled": false,
        "PerformanceInsightsEnabled": false,
        "DeletionProtection": false,
        "AssociatedRoles": [],
        "TagList": []
    }
}

Pour plus d’informations, consultez Restauration à une heure spécifiée à partir d’une sauvegarde répliquée dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez RestoreDbInstanceToPointInTime dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser start-activity-stream.

AWS CLI

Pour démarrer un flux d'activité de base de données

L’exemple start-activity-stream suivant démarre un flux d’activité asynchrone pour surveiller un cluster Aurora nommé 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

Sortie :


{
    "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
}

Pour plus d’informations, consultez Démarrage d’un flux d’activité de base de données dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez StartActivityStream dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser start-db-cluster.

AWS CLI

Pour démarrer un cluster de bases de données

L’exemple start-db-cluster suivant démarre un cluster de bases de données et ses instances de base de données.


aws rds start-db-cluster \
    --db-cluster-identifier mydbcluster

Sortie :


{
    "DBCluster": {
        "AllocatedStorage": 1,
        "AvailabilityZones": [
            "us-east-1a",
            "us-east-1e",
            "us-east-1b"
        ],
        "BackupRetentionPeriod": 1,
        "DatabaseName": "mydb",
        "DBClusterIdentifier": "mydbcluster",
        ...some output truncated...
    }
}

Pour plus d’informations, consultez Arrêt et démarrage d’un cluster de bases de données Amazon Aurora dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez StartDbCluster dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser start-db-instance-automated-backups-replication.

AWS CLI

Pour activer les sauvegardes automatiques entre régions

L’exemple start-db-instance-automated-backups-replication suivant réplique les sauvegardes automatiques d’une instance de base de données de la région USA Est (Virginie du Nord) vers la région USA Ouest (Oregon). La période de rétention des sauvegardes est de 14 jours.


aws rds start-db-instance-automated-backups-replication \
    --region us-west-2 \
    --source-db-instance-arn "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db" \
    --backup-retention-period 14

Sortie :


{
    "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": "pending",
        "Port": 1521,
        "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": 14,
        "DBInstanceAutomatedBackupsArn": "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example"
    }
}

Pour plus d’informations, consultez Activation des sauvegardes automatiques entre régions dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez StartDbInstanceAutomatedBackupsReplication dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser start-db-instance.

AWS CLI

Pour démarrer une instance de base de données

L’exemple start-db-instance suivant démarre l’instance de base de données spécifiée.


aws rds start-db-instance \
    --db-instance-identifier test-instance

Sortie :


{
    "DBInstance": {
        "DBInstanceStatus": "starting",
        ...some output truncated...
    }
}

Pour plus de détails sur l’API, consultez StartDbInstance dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser start-export-task.

AWS CLI

Pour exporter un instantané vers Amazon S3

L’exemple start-export-task suivant exporte un instantané de base de données nommé db5-snapshot-test vers le compartiment Amazon S3 nommé amzn-s3-demo-bucket.


aws rds start-export-task \
    --export-task-identifier my-s3-export \
    --source-arn arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test \
    --s3-bucket-name amzn-s3-demo-bucket \
    --iam-role-arn arn:aws:iam::123456789012:role/service-role/ExportRole \
    --kms-key-id arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff

Sortie :


{
    "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",
    "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
}

Pour plus d’informations, consultez Exportation d’un instantané vers un compartiment Amazon S3 dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez StartExportTask dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser stop-activity-stream.

AWS CLI

Pour arrêter un flux d’activité de base de données

L’exemple stop-activity-stream suivant arrête un flux d’activité dans un cluster Aurora nommé my-pg-cluster.


aws rds stop-activity-stream \
    --region us-east-1 \
    --resource-arn arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster \
    --apply-immediately

Sortie :


{
    "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1",
    "KinesisStreamName": "aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S",
    "Status": "stopping"
}

Pour plus d’informations, consultez Arrêt d’un flux d’activité dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez StopActivityStream dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser stop-db-cluster.

AWS CLI

Pour arrêter un cluster de bases de données

L’exemple stop-db-cluster suivant arrête un cluster de bases de données et ses instances de base de données.


aws rds stop-db-cluster \
    --db-cluster-identifier mydbcluster

Sortie :


{
    "DBCluster": {
        "AllocatedStorage": 1,
        "AvailabilityZones": [
            "us-east-1a",
            "us-east-1e",
            "us-east-1b"
        ],
        "BackupRetentionPeriod": 1,
        "DatabaseName": "mydb",
        "DBClusterIdentifier": "mydbcluster",
        ...some output truncated...
    }
}

Pour plus d’informations, consultez Arrêt et démarrage d’un cluster de bases de données Amazon Aurora dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez StopDbCluster dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser stop-db-instance-automated-backups-replication.

AWS CLI

Pour arrêter la réplication des sauvegardes automatisées

L’exemple stop-db-instance-automated-backups-replication suivant met fin à la réplication des sauvegardes automatiques dans la région USA Ouest (Oregon). Les sauvegardes répliquées sont retenues conformément à la période de rétention des sauvegardes définie.


aws rds stop-db-instance-automated-backups-replication \
    --region us-west-2 \
    --source-db-instance-arn "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db"

Sortie :


{
    "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": {
            "EarliestTime": "2020-12-04T23:13:21.030Z",
            "LatestTime": "2020-12-07T19:59:57Z"
        },
        "AllocatedStorage": 20,
        "Status": "replicating",
        "Port": 1521,
        "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"
    }
}

Pour plus d’informations, consultez Arrêt de la réplication des sauvegardes automatiques dans le Guide de l’utilisateur Amazon RDS.

Pour plus de détails sur l’API, consultez StopDbInstanceAutomatedBackupsReplication dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser stop-db-instance.

AWS CLI

Pour arrêter une instance de bases de données

L’exemple stop-db-instance suivant arrête l’instance de base de données spécifiée.


aws rds stop-db-instance \
    --db-instance-identifier test-instance

Sortie :


{
    "DBInstance": {
        "DBInstanceStatus": "stopping",
        ...some output truncated...
    }
}

Pour plus de détails sur l’API, consultez StopDbInstance dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser switchover-blue-green-deployment.

AWS CLI

Exemple 1 : pour basculer un déploiement bleu/vert pour une instance de base de données RDS

L’exemple switchover-blue-green-deployment suivant promeut l’environnement vert spécifié en tant que nouvel environnement de production.


aws rds switchover-blue-green-deployment \
    --blue-green-deployment-identifier bgd-wi89nwzglccsfake \
    --switchover-timeout 300

Sortie :


{
    "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-blhi1e",
        "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-blhi1e",
                "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-k5fv7u",
                "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-ggsh8m",
                "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-o2vwm0",
                "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": "SWITCHOVER_IN_PROGRESS",
        "CreateTime": "2022-02-25T22:33:22.225000+00:00"
    }
}

Pour plus d’informations, consultez Basculement d’un déploiement bleu/vert dans le Guide de l’utilisateur Amazon RDS.

Exemple 2 : pour promouvoir un déploiement bleu/vert pour un cluster de bases de données Aurora MySQL

L’exemple switchover-blue-green-deployment suivant promeut l’environnement vert spécifié en tant que nouvel environnement de production.


aws rds switchover-blue-green-deployment \
    --blue-green-deployment-identifier bgd-wi89nwzglccsfake \
    --switchover-timeout 300

Sortie :


{
    "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-3ud8z6",
        "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-3ud8z6",
                "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-bvxc73",
                "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-7wc4ie",
                "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-p4xxkz",
                "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-np1ikl",
                "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-miszlf",
                "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": "SWITCHOVER_IN_PROGRESS",
        "CreateTime": "2022-02-25T22:38:49.522000+00:00"
    }
}

Pour plus d’informations, consultez Basculement d’un déploiement bleu/vert dans le Guide de l’utilisateur Amazon Aurora.

Pour plus de détails sur l’API, consultez SwitchoverBlueGreenDeployment dans la Référence des commandes de l’AWS CLI.

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

QLDB

Amazon RDS Data Service