Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
# DBInstance
Informations détaillées sur une instance.
## Table des matières
**Note**
Dans la liste suivante, les paramètres requis sont décrits en premier.
** AutoMinorVersionUpgrade **
Ne s'applique pas Ce paramètre ne s'applique pas à Amazon DocumentDB. Amazon DocumentDB n'effectue pas de mises à niveau mineures de version, quelle que soit la valeur définie.
Type : booléen
Obligatoire : non
** AvailabilityZone **
Spécifie le nom de la zone de disponibilité dans laquelle se trouve l'instance.
Type : chaîne
Obligatoire : non
** BackupRetentionPeriod **
Spécifie le nombre de jours pendant lesquels les instantanés automatiques sont conservés.
Type : entier
Obligatoire : non
** CACertificateIdentifier **
Identifiant du certificat CA de cette instance de base de données.
Type : chaîne
Obligatoire : non
** CertificateDetails **
Les détails du certificat de serveur de l'instance de base de données.
Type : objet [CertificateDetails](API_CertificateDetails.md)
Obligatoire : non
** CopyTagsToSnapshot **
Une valeur qui indique si vous voulez copier toutes les balises à partir de l'instance de base de données pour les instantanés de l'instance de base de données. Par défaut, les balises ne sont pas copiées.
Type : booléen
Obligatoire : non
** DBClusterIdentifier **
Contient le nom du cluster dont l'instance est membre si l'instance est membre d'un cluster.
Type : chaîne
Obligatoire : non
** DBInstanceArn **
L'Amazon Resource Name (ARN) de l'instance.
Type : chaîne
Obligatoire : non
** DBInstanceClass **
Contient le nom de la classe de capacité de calcul et de mémoire de l'instance.
Type : chaîne
Obligatoire : non
** DBInstanceIdentifier **
Contient un identifiant de base de données fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une instance.
Type : chaîne
Obligatoire : non
** DBInstanceStatus **
Indique l'état actuel de cette base de données.
Type : chaîne
Obligatoire : non
** DbiResourceId **
L'identifiant Région AWS unique et immuable de l'instance. Cet identifiant se trouve dans les entrées du AWS CloudTrail journal chaque fois que l'on accède à la AWS KMS clé de l'instance.
Type : chaîne
Obligatoire : non
** DBSubnetGroup **
Spécifie des informations sur le groupe de sous-réseaux associé à l'instance, notamment le nom, la description et les sous-réseaux du groupe de sous-réseaux.
Type : objet [DBSubnetGroup](API_DBSubnetGroup.md)
Obligatoire : non
** EnabledCloudwatchLogsExports.member.N **
Liste des types de journaux que cette instance est configurée pour exporter vers CloudWatch Logs.
Type : tableau de chaînes
Obligatoire : non
** Endpoint **
Spécifie le point de terminaison de la connexion.
Type : objet [Endpoint](API_Endpoint.md)
Obligatoire : non
** Engine **
Fournit le nom du moteur de base de données à utiliser pour cette instance.
Type : chaîne
Obligatoire : non
** EngineVersion **
Indique la version du moteur de base de données.
Type : chaîne
Obligatoire : non
** InstanceCreateTime **
Indique la date et l'heure de création de l'instance.
Type : Timestamp
Obligatoire : non
** KmsKeyId **
Si tel `StorageEncrypted` est le cas`true`, l'identifiant de AWS KMS clé de l'instance chiffrée.
Type : chaîne
Obligatoire : non
** LatestRestorableTime **
Spécifie l'heure limite à laquelle une base de données peut être restaurée à l'aide de la fonction de point-in-time restauration.
Type : Timestamp
Obligatoire : non
** PendingModifiedValues **
Spécifie que les modifications apportées à l'instance sont en attente. Cet élément est inclus uniquement lorsque des modifications sont en attente. Des modifications spécifiques sont identifiées par sous-éléments.
Type : objet [PendingModifiedValues](API_PendingModifiedValues.md)
Obligatoire : non
** PerformanceInsightsEnabled **
Définissez `true` si Amazon RDS Performance Insights est activé pour l'instance de base de données, et sinon`false`.
Type : booléen
Obligatoire : non
** PerformanceInsightsKMSKeyId **
Identifiant AWS KMS clé pour le chiffrement des données Performance Insights. L'ID de AWS KMS clé est le Amazon Resource Name (ARN), AWS KMS l'identifiant de AWS KMS clé ou l'alias de clé de AWS KMS chiffrement.
Type : chaîne
Obligatoire : non
** PreferredBackupWindow **
Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété `BackupRetentionPeriod`.
Type : chaîne
Obligatoire : non
** PreferredMaintenanceWindow **
Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.
Type : chaîne
Obligatoire : non
** PromotionTier **
Valeur qui indique l'ordre dans lequel une réplique Amazon DocumentDB est promue vers l'instance principale après une défaillance de l'instance principale existante.
Type : entier
Obligatoire : non
** PubliclyAccessible **
Non pris en charge. Amazon DocumentDB ne prend actuellement pas en charge les points de terminaison publics. La valeur de `PubliclyAccessible` est toujours`false`.
Type : booléen
Obligatoire : non
** StatusInfos.DBInstanceStatusInfo.N **
État d'une réplique lue. Si l'instance n'est pas une réplique lue, ce champ est vide.
Type : tableau d’objets [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md)
Obligatoire : non
** StorageEncrypted **
Spécifie si l'instance est chiffrée ou non.
Type : booléen
Obligatoire : non
** VpcSecurityGroups.VpcSecurityGroupMembership.N **
Fournit une liste des éléments du groupe de sécurité VPC auxquels appartient l'instance.
Type : tableau d’objets [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md)
Obligatoire : non
## consultez aussi
Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+ [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/docdb-2014-10-31/DBInstance)
+ [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/docdb-2014-10-31/DBInstance)
+ [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/docdb-2014-10-31/DBInstance)