API d'instances Neptune - Amazon Neptune

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.

API d'instances Neptune

Structures :

Actions :

DBInstance (structure)

Contient les détails d'une instance de base de données Amazon Neptune.

Ce type de données est utilisé comme élément de réponse dans l'action DescribeDBInstances (action).

Champs

  • AutoMinorVersionUpgrade – Booléen.

    Indique que des correctifs de versions mineures sont appliquées automatiquement.

  • AvailabilityZone – Chaîne UTF-8.

    Spécifie le nom de la zone de disponibilité dans laquelle l'instance DB se trouve.

  • BackupRetentionPeriod – Nombre (entier).

    Spécifie le nombre de jours de conservation des instantanés de bases de données automatiques.

  • CACertificateIdentifier – Chaîne UTF-8.

    Identifiant du certificat CA de cette instance de base de données.

  • CopyTagsToSnapshot – Booléen.

    Indique si des balises sont copiées de l'instance de base de données vers des instantanés de l'instance de base de données.

  • DBClusterIdentifier – Chaîne UTF-8.

    Si l'instance de base de données est membre d'un cluster de bases de données, elle contient le nom du cluster de bases de données dont elle est membre.

  • DBInstanceArn – Chaîne UTF-8.

    ARN (Amazon Resource Name) de l'instance de base de données.

  • DBInstanceClass – Chaîne UTF-8.

    Contient le nom de la classe de capacité de calcul et de mémoire de l'instance de base de données.

  • DBInstanceIdentifier – Chaîne UTF-8.

    Contient un identifiant de base de données fourni par l'utilisateur. Ce dernier est la clé unique qui identifie une instance de base de données.

  • DbInstancePort – Nombre (entier).

    Spécifie le port sur lequel l'instance de base de données écoute. Si l'instance de base de données fait partie d'un cluster de bases de données, le port peut être différent du port de cluster de bases de données.

  • DBInstanceStatus – Chaîne UTF-8.

    Indique l'état actuel de cette base de données.

  • DbiResourceId – Chaîne UTF-8.

    Identifiant immuable et propre à la région Amazon pour l'instance de base de données. Cet identifiant se trouve dans Amazon CloudTrail entrées de journal à chaque accès à la clé Amazon KMS de l'instance de base de données.

  • DBName – Chaîne UTF-8.

    Nom de la base de données.

  • DBParameterGroups— — — Tableau d'élémentsDBParameterGroupStatusDBParameterGroup Objets.

    Fournit la liste des groupes de paramètres de base de données appliqués à cette instance de base de données.

  • DBSecurityGroups— — — Tableau d'élémentsDBSecurityGroupMembershipDBSecurityGroup Objets.

    Fournit la liste des éléments du Security Group DB contenant uniquement des sous-éléments DBSecurityGroup.Name et DBSecurityGroup.Status.

  • DBSubnetGroup – Un objet DBSubnetGroup.

    Spécifie des informations sur le groupe de sous-réseaux associé à l'instance de base de données, dont le nom, la description et les sous-réseaux du groupe de sous-réseaux.

  • DeletionProtection – Booléen.

    Indique si la protection contre la suppression a été activée pour l'instance de base de données. L’instance ne peut pas être supprimée tant que la protection contre la suppression est activée. Consultez Suppression d'une instance de base de données.

  • DomainMemberships – Un tableau d'objets DomainMembership DomainMembership .

    Non pris en charge

  • EnabledCloudwatchLogsExports – Tableau de chaînes UTF-8.

    Liste des types de journaux vers lesquels cette instance de base de données est configurée et qui sont exportés vers CloudWatchBûches.

  • Endpoint – Un objet Point de terminaison.

    Spécifie le point de terminaison de la connexion.

  • Engine – Chaîne UTF-8.

    Fournit le nom du moteur de base de données à utiliser pour cette instance de base de données.

  • EngineVersion – Chaîne UTF-8.

    Indique la version du moteur de base de données.

  • EnhancedMonitoringResourceArn – Chaîne UTF-8.

    Amazon Resource Name (ARN) de Amazon CloudWatch Journal le flux de journal qui reçoit les données de métriques de surveillance améliorée pour l'instance de base de données.

  • IAMDatabaseAuthenticationEnabled – Booléen.

    Valeur true si l'authentification d'Amazon Identity and Access Management (IAM) est activée, et false dans le cas contraire.

  • InstanceCreateTime – Horodatage.

    Indique la date et l'heure de création de l'instance de base de données.

  • Iops – Nombre (entier).

    Spécifie la valeur des IOPS provisionnés (opérations d'E/S par seconde).

  • KmsKeyId – Chaîne UTF-8.

    Non pris pris pris pris Le chiffrement des instances de base de données est géré par le cluster de bases de données.

  • LatestRestorableTime – Horodatage.

    Spécifie la dernière heure à laquelle une base de données peut être restaurée avec point-in-timeRestauration.

  • LicenseModel – Chaîne UTF-8.

    Informations sur le modèle de licence de cette instance de base de données.

  • MonitoringInterval – Nombre (entier).

    Intervalle, en secondes, entre les points lorsque des métriques de surveillance améliorée sont collectées pour l'instance de base de données.

  • MonitoringRoleArn – Chaîne UTF-8.

    ARN pour le rôle IAM qui autorise Neptune à envoyer des métriques de surveillance améliorée à Amazon CloudWatch Bûches.

  • MultiAZ – Booléen.

    Indique si l'instance de base de données est un déploiement multi-AZ.

  • PendingModifiedValues – Un objet PendingModifiedValues.

    Spécifie que les modifications apportées à l'instance de base de données 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.

  • PreferredBackupWindow – Chaîne UTF-8.

    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.

  • PreferredMaintenanceWindow – Chaîne UTF-8.

    Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.

  • PromotionTier – Nombre (entier).

    Valeur qui spécifie l'ordre dans lequel un réplica en lecture est promu en instance principale après un échec de l'instance principale existante.

  • PubliclyAccessible – Booléen.

    Cet indicateur ne doit plus être utilisé.

  • ReadReplicaDBClusterIdentifiers— Tableau d'éléments ReadReplicaDBClusterIdentifier— Chaîne UTF-8.

    Contient un ou plusieurs identifiants des clusters de base de données qui sont des réplicas en lecture de cette instance de base de données.

  • ReadReplicaDBInstanceIdentifiers— Tableau d'éléments ReadReplicaDBInstanceIdentifier— Chaîne UTF-8.

    Contient un ou plusieurs identifiants des réplicas en lecture associés à cette instance de base de données.

  • ReadReplicaSourceDBInstanceIdentifier – Chaîne UTF-8.

    Contient l'identifiant de l'instance de base de données source si cette dernière est un réplica en lecture.

  • SecondaryAvailabilityZone – Chaîne UTF-8.

    Si cette valeur est présente, spécifie le nom de la zone de disponibilité secondaire d'une instance de base de données avec prise en charge multi-AZ.

  • StatusInfos— Tableau d'élémentsDBInstanceStatusInfoDBInstanceStatusInfo Objets.

    Statut d'un réplica en lecture. Si l'instance n'est pas un réplica en lecture, ce champ est vide.

  • StorageEncrypted – Booléen.

    Non pris pris pris pris Le chiffrement des instances de base de données est géré par le cluster de bases de données.

  • StorageType – Chaîne UTF-8.

    Spécifie le type de stockage associé à l'instance de base de données.

  • TdeCredentialArn – Chaîne UTF-8.

    ARN du magasin de clés associé à l'instance pour le chiffrement TDE.

  • Timezone – Chaîne UTF-8.

    Non pris en charge.

  • VpcSecurityGroups – Un tableau d'objets VpcSecurityGroupMembership VpcSecurityGroupMembership .

    Fournit une liste des éléments du groupe de sécurité VPC auxquels appartient l'instance de base de données.

DBInstance est utilisé comme élément de réponse pour :

DBInstanceStatusInfo (structure)

Fournit une liste des informations sur le statut d'une instance de base de données.

Champs

  • Message – Chaîne UTF-8.

    Détails de l'erreur en cas d'erreur de l'instance. Si l'instance n'est pas dans un état d'erreur, cette valeur est vide.

  • Normal – Booléen.

    Valeur booléenne true si l'instance fonctionne normalement, et false si l'instance est dans un état d'erreur.

  • Status – Chaîne UTF-8.

    Statut de l'instance de base de données. Pour un StatusType du réplica en lecture, les valeurs peuvent indiquer une réplication, une erreur, un arrêt ou une résiliation.

  • StatusType – Chaîne UTF-8.

    Cette valeur est actuellement « read replication ».

Base de données commandableInstanceOption (structure)

Contient une liste des options disponibles pour une instance de base de données.

Ce type de données est utilisé comme élément de réponse dans l'action DescribeOrderableDBInstanceOptions (action).

Champs

  • AvailabilityZones – Un tableau d'objets AvailabilityZone AvailabilityZone .

    Une liste des zones de disponibilité pour une instance de base de données.

  • DBInstanceClass – Chaîne UTF-8.

    Classe d'instance de base de données d'une instance de base de données.

  • Engine – Chaîne UTF-8.

    Type de moteur d'une instance de base de données.

  • EngineVersion – Chaîne UTF-8.

    Version du moteur d'une instance de base de données.

  • LicenseModel – Chaîne UTF-8.

    Modèle de licence d'une instance de base de données.

  • MaxIopsPerDbInstance – Nombre (entier).

    Nombre total maximum des IOPS provisionnés pour une instance de base de données.

  • MaxIopsPerGib – Nombre (double).

    Nombre total maximum des IOPS provisionnés par Gio pour une instance de base de données.

  • MaxStorageSize – Nombre (entier).

    Taille de stockage maximum d'une instance de base de données.

  • MinIopsPerDbInstance – Nombre (entier).

    Nombre total minimum des IOPS provisionnés pour une instance de base de données.

  • MinIopsPerGib – Nombre (double).

    Nombre total minimum des IOPS provisionnés par Gio pour une instance de base de données.

  • MinStorageSize – Nombre (entier).

    Taille de stockage minimum d'une instance de base de données.

  • MultiAZCapable – Booléen.

    Indique si une instance de base de données peut gérer le mode Multi-AZ.

  • ReadReplicaCapable – Booléen.

    Indique si une instance de base de données peut disposer d'un réplica en lecture.

  • StorageType – Chaîne UTF-8.

    Indique le type de stockage pour une instance de base de données.

  • SupportsEnhancedMonitoring – Booléen.

    Indique si une instance de base de données prend en charge la surveillance améliorée à des intervalles de 1 à 60 secondes.

  • SupportsGlobalDatabases – Booléen.

    Valeur qui indique si vous pouvez utiliser les bases de données globales Neptune avec une combinaison spécifique d'autres attributs de moteur de base de données.

  • SupportsIAMDatabaseAuthentication – Booléen.

    Indique si une instance de base de données prend en charge l'authentification de base de données IAM.

  • SupportsIops – Booléen.

    Indique si une instance de base de données prend en charge les IOPS provisionnés.

  • SupportsStorageEncryption – Booléen.

    Indique si une instance de base de données prend en charge le stockage chiffré.

  • Vpc – Booléen.

    Indique si une instance de base de données se trouve dans un VPC.

Base de données valideInstanceModificationsMessage (structure)

Informations sur les modifications valides que vous pouvez apporter à votre instance de base de données. Contient le résultat d'un appel réussi à l'action DescribeValidDBInstanceModifications (action). Vous pouvez utiliser ces informations lorsque vous appelez ModifyDBInstance (action).

Champs

  • Storage— — — Tableau d'éléments ValidStorageOptions— une structure.

    Options de stockage valides pour votre instance de base de données.

ValidDBInstanceModificationsMessage est utilisé comme élément de réponse pour :

CreateDBInstance (action)

        Le nom de ligne de ligne de commande Amazon pour cette API est :create-db-instance, et le nom Python est :create_db_instance.

Crée une nouvelle instance de base de données.

Demande

  • AutoMinorVersionUpgrade(dans l'objet :--auto-minor-version-upgrade, ou en Python :auto_minor_version_upgrade) – Booléen.

    Indique que des mises à niveau de moteur mineures sont appliquées automatiquement à l'instance de base de données pendant la fenêtre de maintenance.

    Par défaut : true

  • AvailabilityZone(dans la CLI :--availability-zone, ou en Python :availability_zone) – Chaîne UTF-8.

    Zone de disponibilité EC2 dans laquelle l'instance de base de données est créée.

    Par défaut: Une zone de disponibilité aléatoire choisie par le système dans la région Amazon du point de terminaison.

    Exemple : us-east-1d

    Constraint : Le AvailabilityZone paramètre ne peut être spécifié si le paramètre MultiAZ est défini surtrue. La zone de disponibilité spécifiée doit être dans la même région Amazon que le point de terminaison actuel.

  • BackupRetentionPeriod(dans l'objet :--backup-retention-period, ou en Python :backup_retention_period) – Nombre (entier).

    Nombre de jours de conservation des sauvegardes automatiques.

    Ne s'applique pas. La période de rétention des sauvegardes automatisées est gérée par le cluster de bases de données. Pour plus d'informations, consultez CreateDBCluster (action).

    Par défaut: 1

    Contraintes :

    • Doit être compris entre 0 et 35

    • Ne peut pas être défini sur 0 si l'instance de base de données est une source des réplicas en lecture

  • CopyTagsToSnapshot(dans l'objet :--copy-tags-to-snapshot, ou en Python :copy_tags_to_snapshot) – Booléen.

    Valeur true pour copier toutes les balises de l'instance de base de données vers les instantanés de l'instance de base de données, et false dans le cas contraire. La valeur par défaut est false.

  • DBClusterIdentifier(dans l'objet :--db-cluster-identifier, ou en Python :db_cluster_identifier) – Chaîne UTF-8.

    Identifiant du cluster de bases de données auquel appartient l'instance.

    Pour plus d'informations sur la création d'un cluster de base de données , consultez CreateDBCluster (action).

    Type : Chaîne

  • DBInstanceClass(dans la CLI :--db-instance-class, ou en Python :db_instance_class) –Obligatoire : Une chaîne UTF-8.

    Capacité de calcul et de mémoire de l'instance de base de données, par exemple db.m4.large. Toutes les classes d'instance de base de données ne sont pas disponibles dans toutes les régions Amazon.

  • DBInstanceIdentifier(interface de ligne de commande :--db-instance-identifier, ou en Python :db_instance_identifier) –Obligatoire : Une chaîne UTF-8.

    Identifiant de l'instance de base de données. Ce paramètre est stocké sous la forme d'une chaîne en lettres minuscules.

    Contraintes :

    • Doit contenir entre 1 et 63 lettres, chiffres ou traits d'union.

    • Le premier caractère doit être une lettre.

    • Ne peut pas se terminer par un trait d'union ni contenir deux traits d'union consécutifs.

    Exemple : mydbinstance

  • DBName(dans la CLI :--db-name, ou en Python :db_name) – Chaîne UTF-8.

    Non pris en charge.

  • DBParameterGroupName(interface de ligne de commande :--db-parameter-group-name, ou en Python :db_parameter_group_name) – Chaîne UTF-8.

    Nom du groupe de paramètres de base de données à associer à cette instance de base de données. Si cet argument est omis, la base de données par défautParameterGroup pour le moteur spécifié est utilisé.

    Contraintes :

    • Doit comporter entre 1 et 255 lettres, chiffres ou traits d'union.

    • Le premier caractère doit être une lettre

    • Ne peut pas se terminer par un trait d'union ni contenir deux traits d'union consécutifs

  • DBSecurityGroups(dans la CLI :--db-security-groups, ou en Python :db_security_groups) — Tableau d'éléments.SecurityGroupName— Chaîne UTF-8.

    Liste des Security Groups DB à associer à cette instance de base de données.

    Par défaut: Le groupe de sécurité DB par défaut pour le moteur de base de données.

  • DBSubnetGroupName(interface de ligne de commande :--db-subnet-group-name, ou en Python :db_subnet_group_name) – Chaîne UTF-8.

    Groupe de sous-réseaux de base de données à associer à cette instance de base de données.

    S'il n'existe aucun groupe de sous-réseaux de base de données, il s'agit d'une instance de base de données non VPC.

  • DeletionProtection(dans la CLI :--deletion-protection, ou en Python :deletion_protection) – Booléen.

    Une valeur qui indique si la protection contre la suppression a été activée pour l'instance de base de données. La base de données ne peut pas être supprimé lorsque la protection contre la suppression est activée. Par défaut, la protection contre la suppression est désactivée. Consultez Suppression d'une instance de base de données.

    Les instances de base de données dans un cluster de base de données peuvent être supprimées même lorsque la protection contre la suppression est activée dans le cluster de base de données parent.

  • Domain(interface de ligne de commande :--domain, ou en Python :domain) – Chaîne UTF-8.

    Spécifiez le domaine Active Directory dans lequel créer l'instance.

  • DomainIAMRoleName(dans la CLI :--domain-iam-role-name, ou en Python :domain_iam_role_name) – Chaîne UTF-8.

    Spécifiez le nom du rôle IAM à utiliser pour effectuer des appels d'API à Directory Service.

  • EnableCloudwatchLogsExports(dans la CLI :--enable-cloudwatch-logs-exports, ou en Python :enable_cloudwatch_logs_exports) – Tableau de chaînes UTF-8.

    Liste des types de journaux qui doivent être activés pour l'exportation vers CloudWatchBûches.

  • EnableIAMDatabaseAuthentication(dans la CLI :--enable-iam-database-authentication, ou en Python :enable_iam_database_authentication) – Booléen.

    Non pris en charge par Neptune (ignoré).

  • Engine(interface de ligne de commande :--engine, ou en Python :engine) –Obligatoire : Une chaîne UTF-8.

    Nom du moteur de base de données à utiliser pour cette instance.

    Valeurs valides : neptune

  • EngineVersion(interface de ligne de commande :--engine-version, ou en Python :engine_version) – Chaîne UTF-8.

    Numéro de version du moteur de base de données à utiliser. Actuellement, la définition de ce paramètre n'a aucun effet.

  • Iops(dans la CLI :--iops, ou en Python :iops) – Nombre (entier).

    Quantité d'IOPS provisionnés (opérations d'E/S par seconde) à allouer initialement pour l'instance de base de données.

  • KmsKeyId(dans la CLI :--kms-key-id, ou en Python :kms_key_id) – Chaîne UTF-8.

    Identifiant de clé Amazon KMS pour une instance de base de données chiffrée.

    L'identifiant de clé KMS est l'Amazon Resource Name (ARN) de la clé de chiffrement KMS. Si vous créez une instance de base de données avec le compte Amazon qui possède la clé de chiffrement KMS utilisée pour chiffrer la nouvelle instance de base de données, vous pouvez utiliser l'alias de clé KMS plutôt que l'ARN de la clé de chiffrement KM.

    Ne s'applique pas. L'identifiant de clé KMS est géré par le cluster de bases de données. Pour plus d'informations, consultez CreateDBCluster (action).

    Si le paramètre StorageEncrypted est true, et que vous ne spécifiez pas de valeur pour le paramètre KmsKeyId, Amazon Neptune utilisera votre clé de chiffrement par défaut. Amazon KMS crée la clé de chiffrement par défaut pour votre compte Amazon. Votre compte Amazon a une clé de chiffrement par défaut différente pour chaque région Amazon.

  • LicenseModel(interface de ligne de commande :--license-model, ou en Python :license_model) – Chaîne UTF-8.

    Informations sur le modèle de licence de cette instance de base de données.

    Valeurs valides : license-included | bring-your-own-license | general-public-license

  • MonitoringInterval(dans la CLI :--monitoring-interval, ou en Python :monitoring_interval) – Nombre (entier).

    Intervalle, en secondes, entre les points lorsque des métriques de surveillance améliorée sont collectées pour l'instance de base de données. Pour désactiver la collecte des métriques de surveillance améliorée, spécifiez 0. La valeur par défaut est 0.

    Si MonitoringRoleArn est spécifié, vous devez également définir MonitoringInterval sur une valeur différente de 0.

    Valeurs valides : 0, 1, 5, 10, 15, 30, 60

  • MonitoringRoleArn(dans la CLI :--monitoring-role-arn, ou en Python :monitoring_role_arn) – Chaîne UTF-8.

    ARN pour le rôle IAM qui autorise Neptune à envoyer des métriques de surveillance améliorée à Amazon CloudWatch Bûches. Par exemple, arn:aws:iam:123456789012:role/emaccess.

    Si MonitoringInterval est défini sur une valeur différente de 0, vous devez fournir une valeur MonitoringRoleArn.

  • MultiAZ(interface de ligne de commande :--multi-az, ou en Python :multi_az) – Booléen.

    Indique si l'instance de base de données est un déploiement multi-AZ. Tableau d'éléments. AvailabilityZone si le paramètre MultiAZ est défini sur true.

  • Port(interface de ligne de commande :--port, ou en Python :port) – Nombre (entier).

    Numéro de port au niveau duquel la base de données accepte les connexions.

    Ne s'applique pas. Le port est géré par le cluster de bases de données. Pour plus d'informations, consultez CreateDBCluster (action).

    Par défaut: 8182

    Type : Entier

  • PreferredBackupWindow(interface de ligne de commande :--preferred-backup-window, ou en Python :preferred_backup_window) – Chaîne UTF-8.

    L'intervalle de temps quotidien au cours duquel les sauvegardes automatiques sont créées.

    Ne s'applique pas. L'intervalle de temps quotidien pour la création des sauvegardes automatisées est géré par le cluster de bases de données. Pour plus d'informations, consultez CreateDBCluster (action).

  • PreferredMaintenanceWindow(interface de ligne de commande :--preferred-maintenance-window, ou en Python :preferred_maintenance_window) – Chaîne UTF-8.

    Intervalle de temps hebdomadaire, au format UTC (temps universel), pendant lequel a lieu la maintenance du système.

    Format : ddd:hh24:mi-ddd:hh24:mi

    Par défaut, une fenêtre de 30 minutes est sélectionnée au hasard dans un bloc horaire pour chaque région Amazon, durant un jour de la semaine aléatoire.

    Jours de Validité : Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    Contraintes : Fenêtre minimale de 30 minutes.

  • PromotionTier(interface de ligne de commande :--promotion-tier, ou en Python :promotion_tier) – Nombre (entier).

    Valeur qui spécifie l'ordre dans lequel un réplica en lecture est promu en instance principale après un échec de l'instance principale existante.

    Par défaut: 1

    Valeurs valides : 0 - 15

  • PubliclyAccessible(interface de ligne de commande :--publicly-accessible, ou en Python :publicly_accessible) – Booléen.

    Cet indicateur ne doit plus être utilisé.

  • StorageEncrypted(dans la CLI :--storage-encrypted, ou en Python :storage_encrypted) – Booléen.

    Indique si l'instance de base de données est chiffrée.

    Ne s'applique pas. Le chiffrement des instances de base de données est géré par le cluster de bases de données. Pour plus d'informations, consultez CreateDBCluster (action).

    Par défaut : faux

  • StorageType(dans la CLI :--storage-type, ou en Python :storage_type) – Chaîne UTF-8.

    Spécifie le type de stockage à associer à l'instance de base de données.

    Ne s'applique pas. Le stockage est géré par le cluster de bases de données.

  • Tags(dans la CLI :--tags, ou en Python :tags) — — — Tableau d'élémentsTagMarquez des objets.

    Balises à attribuer à la nouvelle instance.

  • TdeCredentialArn(dans la CLI :--tde-credential-arn, ou en Python :tde_credential_arn) – Chaîne UTF-8.

    ARN du magasin de clés auquel associer l'instance pour le chiffrement TDE.

  • TdeCredentialPassword(interface de ligne de commande :--tde-credential-password, ou en Python :tde_credential_password) – Chaîne UTF-8.

    Mot de passe de l'ARN donnée du magasin de clés pour accéder à l'appareil.

  • Timezone(dans la CLI :--timezone, ou en Python :timezone) – Chaîne UTF-8.

    Fuseau horaire de l'instance de base de données.

  • VpcSecurityGroupIds(interface de ligne de commande :--vpc-security-group-ids, ou en Python :vpc_security_group_ids) — — — Tableau d'éléments VpcSecurityGroupId— Chaîne UTF-8.

    Liste des groupes de sécurité VPC EC2 à associer à cette instance de base de données.

    Ne s'applique pas. La liste associée des groupes de sécurité VPC EC2 est gérée par le cluster de bases de données. Pour plus d'informations, consultez CreateDBCluster (action).

    Par défaut: Le groupe de sécurité VPC EC2 par défaut pour le VPC du groupe de sous-réseaux de base de données.

Réponse

Contient les détails d'une instance de base de données Amazon Neptune.

Ce type de données est utilisé comme élément de réponse dans l'action DescribeDBInstances (action).

  • AutoMinorVersionUpgrade(interface de ligne de commande :--auto-minor-version-upgrade, ou en Python :auto_minor_version_upgrade) – Booléen.

    Indique que des correctifs de versions mineures sont appliquées automatiquement.

  • AvailabilityZone(interface de ligne de commande :--availability-zone, ou en Python :availability_zone) – Chaîne UTF-8.

    Spécifie le nom de la zone de disponibilité dans laquelle l'instance DB se trouve.

  • BackupRetentionPeriod(dans la CLI :--backup-retention-period, ou en Python :backup_retention_period) – Nombre (entier).

    Spécifie le nombre de jours de conservation des instantanés de bases de données automatiques.

  • CACertificateIdentifier(interface de ligne de commande :--ca-certificate-identifier, ou en Python :ca_certificate_identifier) – Chaîne UTF-8.

    Identifiant du certificat CA de cette instance de base de données.

  • CopyTagsToSnapshot(interface de ligne de commande :--copy-tags-to-snapshot, ou en Python :copy_tags_to_snapshot) – Booléen.

    Indique si des balises sont copiées de l'instance de base de données vers des instantanés de l'instance de base de données.

  • DBClusterIdentifier(interface de ligne de commande :--db-cluster-identifier, ou en Python :db_cluster_identifier) – Chaîne UTF-8.

    Si l'instance de base de données est membre d'un cluster de bases de données, elle contient le nom du cluster de bases de données dont elle est membre.

  • DBInstanceArn(dans la CLI :--db-instance-arn, ou en Python :db_instance_arn) – Chaîne UTF-8.

    ARN (Amazon Resource Name) de l'instance de base de données.

  • DBInstanceClass(interface de ligne de commande :--db-instance-class, ou en Python :db_instance_class) – Chaîne UTF-8.

    Contient le nom de la classe de capacité de calcul et de mémoire de l'instance de base de données.

  • DBInstanceIdentifier(interface de ligne de commande :--db-instance-identifier, ou en Python :db_instance_identifier) – Chaîne UTF-8.

    Contient un identifiant de base de données fourni par l'utilisateur. Ce dernier est la clé unique qui identifie une instance de base de données.

  • DbInstancePort(interface de ligne de commande :--db-instance-port, ou en Python :db_instance_port) – Nombre (entier).

    Spécifie le port sur lequel l'instance de base de données écoute. Si l'instance de base de données fait partie d'un cluster de bases de données, le port peut être différent du port de cluster de bases de données.

  • DBInstanceStatus(dans la CLI :--db-instance-status, ou en Python :db_instance_status) – Chaîne UTF-8.

    Indique l'état actuel de cette base de données.

  • DbiResourceId(interface de ligne de commande :--dbi-resource-id, ou en Python :dbi_resource_id) – Chaîne UTF-8.

    Identifiant immuable et propre à la région Amazon pour l'instance de base de données. Cet identifiant se trouve dans Amazon CloudTrail entrées de journal à chaque accès à la clé Amazon KMS de l'instance de base de données.

  • DBName(interface de ligne de commande :--db-name, ou en Python :db_name) – Chaîne UTF-8.

    Nom de la base de données.

  • DBParameterGroups(interface de ligne de commande :--db-parameter-groups, ou en Python :db_parameter_groups) — — — Tableau d'élémentsDBParameterGroupStatusDBParameterGroup Objets.

    Fournit la liste des groupes de paramètres de base de données appliqués à cette instance de base de données.

  • DBSecurityGroups(interface de ligne de commande :--db-security-groups, ou en Python :db_security_groups) — — — Tableau d'élémentsDBSecurityGroupMembershipDBSecurityGroup Objets.

    Fournit la liste des éléments du Security Group DB contenant uniquement des sous-éléments DBSecurityGroup.Name et DBSecurityGroup.Status.

  • DBSubnetGroup(interface de ligne de commande :--db-subnet-group, ou en Python :db_subnet_group) — UNDBSubnetGroupl'objet.

    Spécifie des informations sur le groupe de sous-réseaux associé à l'instance de base de données, dont le nom, la description et les sous-réseaux du groupe de sous-réseaux.

  • DeletionProtection(interface de ligne de commande :--deletion-protection, ou en Python :deletion_protection) – Booléen.

    Indique si la protection contre la suppression a été activée pour l'instance de base de données. L’instance ne peut pas être supprimée tant que la protection contre la suppression est activée. Consultez Suppression d'une instance de base de données.

  • DomainMemberships(interface de ligne de commande :--domain-memberships, ou en Python :domain_memberships) — — — Tableau d'élémentsDomainMembership DomainMembership Objets.

    Non pris en charge

  • EnabledCloudwatchLogsExports(interface de ligne de commande :--enabled-cloudwatch-logs-exports, ou en Python :enabled_cloudwatch_logs_exports) – Tableau de chaînes UTF-8.

    Liste des types de journaux vers lesquels cette instance de base de données est configurée et qui sont exportés vers CloudWatchBûches.

  • Endpoint(dans la CLI :--endpoint, ou en Python :endpoint) — UnPoint de terminaisonl'objet.

    Spécifie le point de terminaison de la connexion.

  • Engine(dans la CLI :--engine, ou en Python :engine) – Chaîne UTF-8.

    Fournit le nom du moteur de base de données à utiliser pour cette instance de base de données.

  • EngineVersion(interface de ligne de commande :--engine-version, ou en Python :engine_version) – Chaîne UTF-8.

    Indique la version du moteur de base de données.

  • EnhancedMonitoringResourceArn(interface de ligne de commande :--enhanced-monitoring-resource-arn, ou en Python :enhanced_monitoring_resource_arn) – Chaîne UTF-8.

    Amazon Resource Name (ARN) de Amazon CloudWatch Journal le flux de journal qui reçoit les données de métriques de surveillance améliorée pour l'instance de base de données.

  • IAMDatabaseAuthenticationEnabled(dans la CLI :--iam-database-authentication-enabled, ou en Python :iam_database_authentication_enabled) – Booléen.

    Valeur true si l'authentification d'Amazon Identity and Access Management (IAM) est activée, et false dans le cas contraire.

  • InstanceCreateTime(dans la CLI :--instance-create-time, ou en Python :instance_create_time) – Horodatage.

    Indique la date et l'heure de création de l'instance de base de données.

  • Iops(interface de ligne de commande :--iops, ou en Python :iops) – Nombre (entier).

    Spécifie la valeur des IOPS provisionnés (opérations d'E/S par seconde).

  • KmsKeyId(interface de ligne de commande :--kms-key-id, ou en Python :kms_key_id) – Chaîne UTF-8.

    Non pris pris pris pris Le chiffrement des instances de base de données est géré par le cluster de bases de données.

  • LatestRestorableTime(dans la CLI :--latest-restorable-time, ou en Python :latest_restorable_time) – Horodatage.

    Spécifie la dernière heure à laquelle une base de données peut être restaurée avec point-in-timeRestauration.

  • LicenseModel(interface de ligne de commande :--license-model, ou en Python :license_model) – Chaîne UTF-8.

    Informations sur le modèle de licence de cette instance de base de données.

  • MonitoringInterval(interface de ligne de commande :--monitoring-interval, ou en Python :monitoring_interval) – Nombre (entier).

    Intervalle, en secondes, entre les points lorsque des métriques de surveillance améliorée sont collectées pour l'instance de base de données.

  • MonitoringRoleArn(interface de ligne de commande :--monitoring-role-arn, ou en Python :monitoring_role_arn) – Chaîne UTF-8.

    ARN pour le rôle IAM qui autorise Neptune à envoyer des métriques de surveillance améliorée à Amazon CloudWatch Bûches.

  • MultiAZ(interface de ligne de commande :--multi-az, ou en Python :multi_az) – Booléen.

    Indique si l'instance de base de données est un déploiement multi-AZ.

  • PendingModifiedValues(interface de ligne de commande :--pending-modified-values, ou en Python :pending_modified_values) — UNPendingModifiedValuesl'objet.

    Spécifie que les modifications apportées à l'instance de base de données 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.

  • PreferredBackupWindow(interface de ligne de commande :--preferred-backup-window, ou en Python :preferred_backup_window) – Chaîne UTF-8.

    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.

  • PreferredMaintenanceWindow(interface de ligne de commande :--preferred-maintenance-window, ou en Python :preferred_maintenance_window) – Chaîne UTF-8.

    Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.

  • PromotionTier(dans la CLI :--promotion-tier, ou en Python :promotion_tier) – Nombre (entier).

    Valeur qui spécifie l'ordre dans lequel un réplica en lecture est promu en instance principale après un échec de l'instance principale existante.

  • PubliclyAccessible(dans la CLI :--publicly-accessible, ou en Python :publicly_accessible) – Booléen.

    Cet indicateur ne doit plus être utilisé.

  • ReadReplicaDBClusterIdentifiers(interface de ligne de commande :--read-replica-db-cluster-identifiers, ou en Python :read_replica_db_cluster_identifiers) — — — Tableau d'éléments ReadReplicaDBClusterIdentifier— Chaîne UTF-8.

    Contient un ou plusieurs identifiants des clusters de base de données qui sont des réplicas en lecture de cette instance de base de données.

  • ReadReplicaDBInstanceIdentifiers(interface de ligne de commande :--read-replica-db-instance-identifiers, ou en Python :read_replica_db_instance_identifiers) — — — Tableau d'éléments ReadReplicaDBInstanceIdentifier— Chaîne UTF-8.

    Contient un ou plusieurs identifiants des réplicas en lecture associés à cette instance de base de données.

  • ReadReplicaSourceDBInstanceIdentifier(dans la CLI :--read-replica-source-db-instance-identifier, ou en Python :read_replica_source_db_instance_identifier) – Chaîne UTF-8.

    Contient l'identifiant de l'instance de base de données source si cette dernière est un réplica en lecture.

  • SecondaryAvailabilityZone(interface de ligne de commande :--secondary-availability-zone, ou en Python :secondary_availability_zone) – Chaîne UTF-8.

    Si cette valeur est présente, spécifie le nom de la zone de disponibilité secondaire d'une instance de base de données avec prise en charge multi-AZ.

  • StatusInfos(interface de ligne de commande :--status-infos, ou en Python :status_infos) — — — Tableau d'élémentsDBInstanceStatusInfoDBInstanceStatusInfo Objets.

    Statut d'un réplica en lecture. Si l'instance n'est pas un réplica en lecture, ce champ est vide.

  • StorageEncrypted(interface de ligne de commande :--storage-encrypted, ou en Python :storage_encrypted) – Booléen.

    Non pris pris pris pris Le chiffrement des instances de base de données est géré par le cluster de bases de données.

  • StorageType(dans la CLI :--storage-type, ou en Python :storage_type) – Chaîne UTF-8.

    Spécifie le type de stockage associé à l'instance de base de données.

  • TdeCredentialArn(dans la CLI :--tde-credential-arn, ou en Python :tde_credential_arn) – Chaîne UTF-8.

    ARN du magasin de clés associé à l'instance pour le chiffrement TDE.

  • Timezone(interface de ligne de commande :--timezone, ou en Python :timezone) – Chaîne UTF-8.

    Non pris en charge.

  • VpcSecurityGroups(interface de ligne de commande :--vpc-security-groups, ou en Python :vpc_security_groups) — — — Tableau d'élémentsVpcSecurityGroupMembership VpcSecurityGroupMembership Objets.

    Fournit une liste des éléments du groupe de sécurité VPC auxquels appartient l'instance de base de données.

DeleteDBInstance (action)

        Le nom de ligne de ligne de commande Amazon pour cette API est :delete-db-instance, et le nom Python est :delete_db_instance.

L'action DeleteDBInstance supprime une instance de base de données précédemment allouée. Lorsque vous supprimez une instance de base de données, toutes les sauvegardes automatiques de cette dernière sont supprimées et ne peuvent pas être récupérées. Les instantanés de base de données manuels de l'instance de base de données devant être supprimés par l'action DeleteDBInstance ne sont pas supprimés.

Si vous demandez un instantané de bases de données final, le statut de l'instance de base de données Amazon Neptune est deleting jusqu'à la création de l'instantané de base de données. L'action d'API DescribeDBInstance est utilisée pour surveiller le statut de cette opération. L'action ne peut pas être annulée une fois exécutée.

Notez que lorsqu'une instance de base de données est dans un état d'échec et possède un statut failed, incompatible-restore ou incompatible-network, vous pouvez uniquement la supprimer lorsque le paramètre SkipFinalSnapshot est défini sur true.

Vous ne pouvez pas supprimer une instance de base de données si elle est la seule instance du cluster de base de données ou si la protection contre la suppression est activée.

Demande

  • DBInstanceIdentifier(dans la CLI :--db-instance-identifier, ou en Python :db_instance_identifier) –Obligatoire : Une chaîne UTF-8.

    Identifiant d'instance DB de l'instance de base de données à supprimer. Ce paramètre n'est pas sensible à la casse.

    Contraintes :

    • Doit correspondre au nom d'une instance de bases de données existante.

  • FinalDBSnapshotIdentifier(interface de ligne de commande :--final-db-snapshot-identifier, ou en Python :final_db_snapshot_identifier) – Chaîne UTF-8.

    la objetSnapshotIdentifier du nouvel instantané de base de données créé lorsque SkipFinalSnapshota la valeurfalse.

    Note

    Spécifier ce paramètre et également définir la valeur SkipFinalShapshot paramètre à true génère une erreur.

    Contraintes :

    • Doit comporter entre 1 et 255 lettres ou chiffres.

    • Le premier caractère doit être une lettre

    • Ne peut pas se terminer par un trait d'union ni contenir deux traits d'union consécutifs

    • Ne peut pas être spécifié lors de la suppression d'un réplica en lecture.

  • SkipFinalSnapshot(dans la CLI :--skip-final-snapshot, ou en Python :skip_final_snapshot) – Booléen.

    Détermine si un instantané de bases de données final est créé avant la suppression de l'instance de base de données. Si true est spécifié, aucun instantané de bases de données n'est créé. Si false est spécifié, un instantané de base de données est créé avant que l'instance de base de données soit supprimée.

    Notez que lorsqu'une instance de base de données est dans un état d'échec et possède un statut « failed », « incompatible-restore » ou « incompatible-network », vous pouvez uniquement la supprimer lorsque le champ SkipFinalSnapshot paramètre est défini sur « Vrai ».

    Spécifiez true lors de la suppression d'un réplica en lecture.

    Note

    Le FinalDBSnapshotIdentifier doit être spécifié si SkipFinalSnapshotestfalse.

    Par défaut : false

Réponse

Contient les détails d'une instance de base de données Amazon Neptune.

Ce type de données est utilisé comme élément de réponse dans l'action DescribeDBInstances (action).

  • AutoMinorVersionUpgrade(interface de ligne de commande :--auto-minor-version-upgrade, ou en Python :auto_minor_version_upgrade) – Booléen.

    Indique que des correctifs de versions mineures sont appliquées automatiquement.

  • AvailabilityZone(interface de ligne de commande :--availability-zone, ou en Python :availability_zone) – Chaîne UTF-8.

    Spécifie le nom de la zone de disponibilité dans laquelle l'instance DB se trouve.

  • BackupRetentionPeriod(interface de ligne de commande :--backup-retention-period, ou en Python :backup_retention_period) – Nombre (entier).

    Spécifie le nombre de jours de conservation des instantanés de bases de données automatiques.

  • CACertificateIdentifier(interface de ligne de commande :--ca-certificate-identifier, ou en Python :ca_certificate_identifier) – Chaîne UTF-8.

    Identifiant du certificat CA de cette instance de base de données.

  • CopyTagsToSnapshot(interface de ligne de commande :--copy-tags-to-snapshot, ou en Python :copy_tags_to_snapshot) – Booléen.

    Indique si des balises sont copiées de l'instance de base de données vers des instantanés de l'instance de base de données.

  • DBClusterIdentifier(dans la CLI :--db-cluster-identifier, ou en Python :db_cluster_identifier) – Chaîne UTF-8.

    Si l'instance de base de données est membre d'un cluster de bases de données, elle contient le nom du cluster de bases de données dont elle est membre.

  • DBInstanceArn(interface de ligne de commande :--db-instance-arn, ou en Python :db_instance_arn) – Chaîne UTF-8.

    ARN (Amazon Resource Name) de l'instance de base de données.

  • DBInstanceClass(interface de ligne de commande :--db-instance-class, ou en Python :db_instance_class) – Chaîne UTF-8.

    Contient le nom de la classe de capacité de calcul et de mémoire de l'instance de base de données.

  • DBInstanceIdentifier(interface de ligne de commande :--db-instance-identifier, ou en Python :db_instance_identifier) – Chaîne UTF-8.

    Contient un identifiant de base de données fourni par l'utilisateur. Ce dernier est la clé unique qui identifie une instance de base de données.

  • DbInstancePort(dans la CLI :--db-instance-port, ou en Python :db_instance_port) – Nombre (entier).

    Spécifie le port sur lequel l'instance de base de données écoute. Si l'instance de base de données fait partie d'un cluster de bases de données, le port peut être différent du port de cluster de bases de données.

  • DBInstanceStatus(interface de ligne de commande :--db-instance-status, ou en Python :db_instance_status) – Chaîne UTF-8.

    Indique l'état actuel de cette base de données.

  • DbiResourceId(interface de ligne de commande :--dbi-resource-id, ou en Python :dbi_resource_id) – Chaîne UTF-8.

    Identifiant immuable et propre à la région Amazon pour l'instance de base de données. Cet identifiant se trouve dans Amazon CloudTrail entrées de journal à chaque accès à la clé Amazon KMS de l'instance de base de données.

  • DBName(interface de ligne de commande :--db-name, ou en Python :db_name) – Chaîne UTF-8.

    Nom de la base de données.

  • DBParameterGroups(interface de ligne de commande :--db-parameter-groups, ou en Python :db_parameter_groups) — Tableau d'élémentsDBParameterGroupStatusDBParameterGroup Objets.

    Fournit la liste des groupes de paramètres de base de données appliqués à cette instance de base de données.

  • DBSecurityGroups(interface de ligne de commande :--db-security-groups, ou en Python :db_security_groups) — Tableau d'élémentsDBSecurityGroupMembershipDBSecurityGroup Objets.

    Fournit la liste des éléments du Security Group DB contenant uniquement des sous-éléments DBSecurityGroup.Name et DBSecurityGroup.Status.

  • DBSubnetGroup(dans la CLI :--db-subnet-group, ou en Python :db_subnet_group) — UNDBSubnetGroupl'objet.

    Spécifie des informations sur le groupe de sous-réseaux associé à l'instance de base de données, dont le nom, la description et les sous-réseaux du groupe de sous-réseaux.

  • DeletionProtection(interface de ligne de commande :--deletion-protection, ou en Python :deletion_protection) – Booléen.

    Indique si la protection contre la suppression a été activée pour l'instance de base de données. L’instance ne peut pas être supprimée tant que la protection contre la suppression est activée. Consultez Suppression d'une instance de base de données.

  • DomainMemberships(interface de ligne de commande :--domain-memberships, ou en Python :domain_memberships) — Tableau d'élémentsDomainMembership DomainMembership Objets.

    Non pris en charge

  • EnabledCloudwatchLogsExports(interface de ligne de commande :--enabled-cloudwatch-logs-exports, ou en Python :enabled_cloudwatch_logs_exports) – Tableau de chaînes UTF-8.

    Liste des types de journaux vers lesquels cette instance de base de données est configurée et qui sont exportés vers CloudWatchBûches.

  • Endpoint(dans la CLI :--endpoint, ou en Python :endpoint) — UnPoint de terminaisonl'objet.

    Spécifie le point de terminaison de la connexion.

  • Engine(interface de ligne de commande :--engine, ou en Python :engine) – Chaîne UTF-8.

    Fournit le nom du moteur de base de données à utiliser pour cette instance de base de données.

  • EngineVersion(dans la CLI :--engine-version, ou en Python :engine_version) – Chaîne UTF-8.

    Indique la version du moteur de base de données.

  • EnhancedMonitoringResourceArn(dans la CLI :--enhanced-monitoring-resource-arn, ou en Python :enhanced_monitoring_resource_arn) – Chaîne UTF-8.

    Amazon Resource Name (ARN) de Amazon CloudWatch Journal le flux de journal qui reçoit les données de métriques de surveillance améliorée pour l'instance de base de données.

  • IAMDatabaseAuthenticationEnabled(interface de ligne de commande :--iam-database-authentication-enabled, ou en Python :iam_database_authentication_enabled) – Booléen.

    Valeur true si l'authentification d'Amazon Identity and Access Management (IAM) est activée, et false dans le cas contraire.

  • InstanceCreateTime(dans la CLI :--instance-create-time, ou en Python :instance_create_time) – Horodatage.

    Indique la date et l'heure de création de l'instance de base de données.

  • Iops(dans la CLI :--iops, ou en Python :iops) – Nombre (entier).

    Spécifie la valeur des IOPS provisionnés (opérations d'E/S par seconde).

  • KmsKeyId(interface de ligne de commande :--kms-key-id, ou en Python :kms_key_id) – Chaîne UTF-8.

    Non pris pris pris pris Le chiffrement des instances de base de données est géré par le cluster de bases de données.

  • LatestRestorableTime(interface de ligne de commande :--latest-restorable-time, ou en Python :latest_restorable_time) – Horodatage.

    Spécifie la dernière heure à laquelle une base de données peut être restaurée avec point-in-timeRestauration.

  • LicenseModel(interface de ligne de commande :--license-model, ou en Python :license_model) – Chaîne UTF-8.

    Informations sur le modèle de licence de cette instance de base de données.

  • MonitoringInterval(interface de ligne de commande :--monitoring-interval, ou en Python :monitoring_interval) – Nombre (entier).

    Intervalle, en secondes, entre les points lorsque des métriques de surveillance améliorée sont collectées pour l'instance de base de données.

  • MonitoringRoleArn(interface de ligne de commande :--monitoring-role-arn, ou en Python :monitoring_role_arn) – Chaîne UTF-8.

    ARN pour le rôle IAM qui autorise Neptune à envoyer des métriques de surveillance améliorée à Amazon CloudWatch Bûches.

  • MultiAZ(interface de ligne de commande :--multi-az, ou en Python :multi_az) – Booléen.

    Indique si l'instance de base de données est un déploiement multi-AZ.

  • PendingModifiedValues(interface de ligne de commande :--pending-modified-values, ou en Python :pending_modified_values) — UNPendingModifiedValuesl'objet.

    Spécifie que les modifications apportées à l'instance de base de données 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.

  • PreferredBackupWindow(interface de ligne de commande :--preferred-backup-window, ou en Python :preferred_backup_window) – Chaîne UTF-8.

    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.

  • PreferredMaintenanceWindow(interface de ligne de commande :--preferred-maintenance-window, ou en Python :preferred_maintenance_window) – Chaîne UTF-8.

    Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.

  • PromotionTier(interface de ligne de commande :--promotion-tier, ou en Python :promotion_tier) – Nombre (entier).

    Valeur qui spécifie l'ordre dans lequel un réplica en lecture est promu en instance principale après un échec de l'instance principale existante.

  • PubliclyAccessible(dans la CLI :--publicly-accessible, ou en Python :publicly_accessible) – Booléen.

    Cet indicateur ne doit plus être utilisé.

  • ReadReplicaDBClusterIdentifiers(dans la CLI :--read-replica-db-cluster-identifiers, ou en Python :read_replica_db_cluster_identifiers) — Tableau d'éléments ReadReplicaDBClusterIdentifier— Chaîne UTF-8.

    Contient un ou plusieurs identifiants des clusters de base de données qui sont des réplicas en lecture de cette instance de base de données.

  • ReadReplicaDBInstanceIdentifiers(interface de ligne de commande :--read-replica-db-instance-identifiers, ou en Python :read_replica_db_instance_identifiers) — Tableau d'éléments ReadReplicaDBInstanceIdentifier— Chaîne UTF-8.

    Contient un ou plusieurs identifiants des réplicas en lecture associés à cette instance de base de données.

  • ReadReplicaSourceDBInstanceIdentifier(interface de ligne de commande :--read-replica-source-db-instance-identifier, ou en Python :read_replica_source_db_instance_identifier) – Chaîne UTF-8.

    Contient l'identifiant de l'instance de base de données source si cette dernière est un réplica en lecture.

  • SecondaryAvailabilityZone(dans la CLI :--secondary-availability-zone, ou en Python :secondary_availability_zone) – Chaîne UTF-8.

    Si cette valeur est présente, spécifie le nom de la zone de disponibilité secondaire d'une instance de base de données avec prise en charge multi-AZ.

  • StatusInfos(dans la CLI :--status-infos, ou en Python :status_infos) — Tableau d'élémentsDBInstanceStatusInfoDBInstanceStatusInfo Objets.

    Statut d'un réplica en lecture. Si l'instance n'est pas un réplica en lecture, ce champ est vide.

  • StorageEncrypted(interface de ligne de commande :--storage-encrypted, ou en Python :storage_encrypted) – Booléen.

    Non pris pris pris pris Le chiffrement des instances de base de données est géré par le cluster de bases de données.

  • StorageType(dans la CLI :--storage-type, ou en Python :storage_type) – Chaîne UTF-8.

    Spécifie le type de stockage associé à l'instance de base de données.

  • TdeCredentialArn(dans la CLI :--tde-credential-arn, ou en Python :tde_credential_arn) – Chaîne UTF-8.

    ARN du magasin de clés associé à l'instance pour le chiffrement TDE.

  • Timezone(interface de ligne de commande :--timezone, ou en Python :timezone) – Chaîne UTF-8.

    Non pris en charge.

  • VpcSecurityGroups(interface de ligne de commande :--vpc-security-groups, ou en Python :vpc_security_groups) — Tableau d'élémentsVpcSecurityGroupMembership VpcSecurityGroupMembership Objets.

    Fournit une liste des éléments du groupe de sécurité VPC auxquels appartient l'instance de base de données.

ModifyDBInstance (action)

        Le nom de ligne de ligne de commande Amazon pour cette API est :modify-db-instance, et le nom Python est :modify_db_instance.

Modifie les paramètres d'une instance de base de données. Vous pouvez modifier un ou plusieurs paramètres de configuration de base de données en spécifiant ces paramètres et les nouvelles valeurs dans la demande. Pour en savoir plus sur les modifications à apporter à votre instance de base de données, appelez DescribeValidDBInstanceModifications (action) avant d'appeler ModifyDBInstance (action).

Demande

  • AllowMajorVersionUpgrade(interface de ligne de commande :--allow-major-version-upgrade, ou en Python :allow_major_version_upgrade) – Booléen.

    Indique que des mises à niveau de version majeure sont autorisées. La modification de ce paramètre n'entraîne pas d'interruption et est appliquée de manière asynchrone dès que possible.

  • ApplyImmediately(interface de ligne de commande :--apply-immediately, ou en Python :apply_immediately) – Booléen.

    Spécifie si les modifications dans cette demande et toutes les modifications en attente sont appliquées de manière asynchrone dès que possible, quel que soit le paramètre PreferredMaintenanceWindow pour l'instance de base de données.

    Si ce paramètre est défini sur false, les modifications apportées à l'instance de base de données sont appliquées pendant la fenêtre de maintenance suivante. Certaines modifications de paramètre peut entraîner une interruption et sont appliquées sur le prochain appel à RebootDBInstance (action), ou le prochain redémarrage d'échec.

    Par défaut : false

  • AutoMinorVersionUpgrade(interface de ligne de commande :--auto-minor-version-upgrade, ou en Python :auto_minor_version_upgrade) – Booléen.

    Indique que des mises à niveau de version mineure sont appliquées automatiquement à l'instance de base de données pendant la fenêtre de maintenance. La modification de ce paramètre n'entraîne pas d'interruption, sauf dans le cas suivant, et est appliquée de manière asynchrone dès que possible. Une interruption se produit si ce paramètre est défini sur true pendant la fenêtre de maintenance, si une version mineure plus récente est disponible et si Neptune active les correctifs automatiques pour cette version de moteur.

  • BackupRetentionPeriod(dans la CLI :--backup-retention-period, ou en Python :backup_retention_period) – Nombre (entier).

    Ne s'applique pas. La période de rétention des sauvegardes automatisées est gérée par le cluster de bases de données. Pour plus d'informations, consultez ModifyDBCluster (action).

    Par défaut: utilise le paramètre existant

  • CACertificateIdentifier(dans la CLI :--ca-certificate-identifier, ou en Python :ca_certificate_identifier) – Chaîne UTF-8.

    Indique le certificat qui doit être associé à l'instance.

  • CloudwatchLogsExportConfiguration(dans la CLI :--cloudwatch-logs-export-configuration, ou en Python :cloudwatch_logs_export_configuration) — UNCloudwatchLogsExportConfigurationl'objet.

    Paramètre de configuration des types de journaux à activer pour l'exportation vers CloudWatch Journaux pour une instance ou un cluster de bases de données spécifique.

  • CopyTagsToSnapshot(interface de ligne de commande :--copy-tags-to-snapshot, ou en Python :copy_tags_to_snapshot) – Booléen.

    Valeur true pour copier toutes les balises de l'instance de base de données vers les instantanés de l'instance de base de données, et false dans le cas contraire. La valeur par défaut est false.

  • DBInstanceClass(interface de ligne de commande :--db-instance-class, ou en Python :db_instance_class) – Chaîne UTF-8.

    Nouvelle capacité de calcul et de mémoire de l'instance de base de données, par exemple db.m4.large. Toutes les classes d'instance de base de données ne sont pas disponibles dans toutes les régions Amazon.

    La modification de la classe d'instance de base de données entraîne une interruption. La modification est appliquée pendant la fenêtre de maintenance suivante, sauf si ApplyImmediately a été spécifié true pour cette demande.

    Par défaut: Une chaîne existant en charge

  • DBInstanceIdentifier(interface de ligne de commande :--db-instance-identifier, ou en Python :db_instance_identifier) –Obligatoire : Une chaîne UTF-8.

    Identifiant de l'instance de base de données. Cette valeur est stockée sous la forme d'une chaîne en minuscules.

    Contraintes :

    • Doit correspondre à l'identifiant d'une DBInstance existante.

  • DBParameterGroupName(dans la CLI :--db-parameter-group-name, ou en Python :db_parameter_group_name) – Chaîne UTF-8.

    Nom du groupe de paramètres de base de données à appliquer à l'instance de base de données. La modification de ce paramètre n'entraîne pas d'interruption. Le nom du groupe de paramètres lui-même est immédiatement changé, mais les modifications réelles des paramètres ne prennent effet qu'après le redémarrage de l'instance, sans basculement. L'instance de base de données NE sera PAS automatiquement redémarrée et les modifications du paramètre NE seront PAS appliquées pendant la fenêtre de maintenance suivante.

    Par défaut: utilise le paramètre existant

    Contraintes : Le groupe de paramètres de base de données doit faire partie de la même famille de groupe de paramètres de base de données que cette instance de base

  • DBPortNumber(interface de ligne de commande :--db-port-number, ou en Python :db_port_number) – Nombre (entier).

    Numéro de port au niveau duquel la base de données accepte les connexions.

    La valeur du paramètre DBPortNumber ne doit correspondre à aucune des valeurs de port spécifiées pour les options du groupe d'options de l'instance de base de données.

    Votre base de données redémarre lorsque vous modifiez la valeur DBPortNumber quelle que soit la valeur du paramètre ApplyImmediately.

    Par défaut : 8182

  • DBSecurityGroups(dans la CLI :--db-security-groups, ou en Python :db_security_groups) — Tableau d'éléments.SecurityGroupName— Chaîne UTF-8.

    Liste des Security Groups DB à autoriser sur cette instance de base de données. La modification de ce paramètre n'entraîne pas d'interruption et est appliquée de manière asynchrone dès que possible.

    Contraintes :

    • Si cette valeur est fournie, doit correspondre à une baseSecurityGroups.

  • DBSubnetGroupName(interface de ligne de commande :--db-subnet-group-name, ou en Python :db_subnet_group_name) – Chaîne UTF-8.

    Nouveau groupe de sous-réseaux de l'instance de base de données. Vous pouvez utiliser ce paramètre pour transférer votre instance de base de données vers un autre VPC.

    La modification du groupe de sous-réseaux entraîne une interruption. La modification est appliquée pendant la fenêtre de maintenance suivante, sauf si vous spécifiez true pour le paramètre ApplyImmediately.

    Contraintes : Si cette valeur est fournie, doit correspondre au nom d'une base de données existanteSubnetGroup.

    Exemple : mySubnetGroup

  • DeletionProtection(interface de ligne de commande :--deletion-protection, ou en Python :deletion_protection) – Booléen.

    Une valeur qui indique si la protection contre la suppression a été activée pour l'instance de base de données. La base de données ne peut pas être supprimé lorsque la protection contre la suppression est activée. Par défaut, la protection contre la suppression est désactivée. Consultez Suppression d'une instance de base de données.

  • Domain(interface de ligne de commande :--domain, ou en Python :domain) – Chaîne UTF-8.

    Non pris en charge.

  • DomainIAMRoleName(interface de ligne de commande :--domain-iam-role-name, ou en Python :domain_iam_role_name) – Chaîne UTF-8.

    Non pris en charge

  • EnableIAMDatabaseAuthentication(interface de ligne de commande :--enable-iam-database-authentication, ou en Python :enable_iam_database_authentication) – Booléen.

    Valeur true pour activer le mappage des comptes Amazon Identity and Access Management (IAM) aux comptes de base de données ; sinon, valeur false.

    Vous pouvez activer l'authentification de base de données IAM pour les moteurs de base de données suivants

    Ne s'applique pas. La correspondance des comptes Amazon IAM vers des comptes de base de données est gérée par le cluster de base de données Pour plus d'informations, consultez ModifyDBCluster (action).

    Par défaut: false

  • EngineVersion(dans la CLI :--engine-version, ou en Python :engine_version) – Chaîne UTF-8.

    Numéro de version du moteur de base de données vers lequel effectuer la mise à niveau. Actuellement, la définition de ce paramètre n'a aucun effet. Pour mettre à niveau votre moteur de base de données vers la version la plus récente, utilisez l'API ApplyPendingMaintenanceAction (action).

  • Iops(dans la CLI :--iops, ou en Python :iops) – Nombre (entier).

    Nouvelle valeur d'IOPS provisionnés (opérations d'E/S par seconde) pour l'instance.

    La modification de ce paramètre n'entraîne pas d'interruption et la modification est appliquée pendant la fenêtre de maintenance suivante, sauf si le paramètre ApplyImmediately est défini sur true pour cette demande.

    Par défaut: utilise le paramètre existant

  • MonitoringInterval(interface de ligne de commande :--monitoring-interval, ou en Python :monitoring_interval) – Nombre (entier).

    Intervalle, en secondes, entre les points lorsque des métriques de surveillance améliorée sont collectées pour l'instance de base de données. Pour désactiver la collecte des métriques de surveillance améliorée, spécifiez 0. La valeur par défaut est 0.

    Si MonitoringRoleArn est spécifié, vous devez également définir MonitoringInterval sur une valeur différente de 0.

    Valeurs valides : 0, 1, 5, 10, 15, 30, 60

  • MonitoringRoleArn(dans la CLI :--monitoring-role-arn, ou en Python :monitoring_role_arn) – Chaîne UTF-8.

    ARN pour le rôle IAM qui autorise Neptune à envoyer des métriques de surveillance améliorée à Amazon CloudWatch Bûches. Par exemple, arn:aws:iam:123456789012:role/emaccess.

    Si MonitoringInterval est défini sur une valeur différente de 0, vous devez fournir une valeur MonitoringRoleArn.

  • MultiAZ(interface de ligne de commande :--multi-az, ou en Python :multi_az) – Booléen.

    Indique si l'instance de base de données est un déploiement multi-AZ. La modification de ce paramètre n'entraîne pas d'interruption et la modification est appliquée pendant la fenêtre de maintenance suivante, sauf si le paramètre ApplyImmediately est défini sur true pour cette demande.

  • NewDBInstanceIdentifier(interface de ligne de commande :--new-db-instance-identifier, ou en Python :new_db_instance_identifier) – Chaîne UTF-8.

    Nouvel identifiant d'instance DB pour l'instance de base de données lors du renommage d'une instance de base de données. Lorsque vous modifiez l'identifiant d'instance DB, un redémarrage d'instance se produit immédiatement si vous définissez Apply Immediately sur true, ou se produira pendant la fenêtre de maintenance suivants si vous définissez Apply Immediately sur false. Cette valeur est stockée sous la forme d'une chaîne en minuscules.

    Contraintes :

    • Doit contenir entre 1 et 63 lettres, chiffres ou traits d'union.

    • Le premier caractère doit être une lettre.

    • Ne peut pas se terminer par un trait d'union ni contenir deux traits d'union consécutifs.

    Exemple : mydbinstance

  • PreferredBackupWindow(interface de ligne de commande :--preferred-backup-window, ou en Python :preferred_backup_window) – Chaîne UTF-8.

    Intervalle de temps quotidien au cours duquel les sauvegardes automatiques sont créées si des sauvegardes automatiques sont activées.

    Ne s'applique pas. L'intervalle de temps quotidien pour la création des sauvegardes automatisées est géré par le cluster de bases de données. Pour plus d'informations, consultez ModifyDBCluster (action).

    Contraintes :

    • Doit être au format hh24:mi-hh24:mi

    • Doit être dans le fuseau UTC (temps universel)

    • Ne doit pas être en conflit avec la fenêtre de maintenance préférée

    • Doit être de 30 minutes minimum.

  • PreferredMaintenanceWindow(interface de ligne de commande :--preferred-maintenance-window, ou en Python :preferred_maintenance_window) – Chaîne UTF-8.

    Intervalle de temps hebdomadaire (au format UTC) pendant lequel se produit la maintenance du système qui peut entraîner une interruption. La modification de ce paramètre n'entraîne pas une interruption, sauf dans le cas suivant, et est appliquée de manière asynchrone dès que possible. Si des actions en attente entraînent un redémarrage et si la fenêtre de maintenance est modifiée pour inclure l'heure actuelle, la modification de ce paramètre entraînera un redémarrage de l'instance de base de données. Si vous définissez la fenêtre sur l'heure actuelle, vous devez prévoir 30 minutes minimum entre l'heure actuelle et la fin de la fenêtre afin que les modifications en attente soient appliquées.

    Par défaut: utilise le paramètre existant

    Format : ddd:hh24:mi-ddd:hh24:mi

    Jours de Validité : Mon | Tue | Wed | Thu | Fri | Sat | Sun

    Contraintes : Doit être de 30 minutes minimum.

  • PromotionTier(interface de ligne de commande :--promotion-tier, ou en Python :promotion_tier) – Nombre (entier).

    Valeur qui spécifie l'ordre dans lequel un réplica en lecture est promu en instance principale après un échec de l'instance principale existante.

    Par défaut: 1

    Valeurs valides : 0 - 15

  • PubliclyAccessible(interface de ligne de commande :--publicly-accessible, ou en Python :publicly_accessible) – Booléen.

    Cet indicateur ne doit plus être utilisé.

  • StorageType(dans la CLI :--storage-type, ou en Python :storage_type) – Chaîne UTF-8.

    Non pris en charge.

  • TdeCredentialArn(interface de ligne de commande :--tde-credential-arn, ou en Python :tde_credential_arn) – Chaîne UTF-8.

    ARN du magasin de clés auquel associer l'instance pour le chiffrement TDE.

  • TdeCredentialPassword(interface de ligne de commande :--tde-credential-password, ou en Python :tde_credential_password) – Chaîne UTF-8.

    Mot de passe de l'ARN donnée du magasin de clés pour accéder à l'appareil.

  • VpcSecurityGroupIds(interface de ligne de commande :--vpc-security-group-ids, ou en Python :vpc_security_group_ids) — Tableau d'éléments VpcSecurityGroupId— Chaîne UTF-8.

    Liste des groupes de sécurité VPC EC2 à autoriser sur cette instance de base de données. Cette modification est appliquée de manière asynchrone dès que possible.

    Ne s'applique pas. La liste associée des groupes de sécurité VPC EC2 est gérée par le cluster de bases de données. Pour plus d'informations, consultez ModifyDBCluster (action).

    Contraintes :

    • Si cette valeur est fournie, doit correspondre à un VpcSecurityGroupIds.

Réponse

Contient les détails d'une instance de base de données Amazon Neptune.

Ce type de données est utilisé comme élément de réponse dans l'action DescribeDBInstances (action).

  • AutoMinorVersionUpgrade(dans la CLI :--auto-minor-version-upgrade, ou en Python :auto_minor_version_upgrade) – Booléen.

    Indique que des correctifs de versions mineures sont appliquées automatiquement.

  • AvailabilityZone(interface de ligne de commande :--availability-zone, ou en Python :availability_zone) – Chaîne UTF-8.

    Spécifie le nom de la zone de disponibilité dans laquelle l'instance DB se trouve.

  • BackupRetentionPeriod(dans la CLI :--backup-retention-period, ou en Python :backup_retention_period) – Nombre (entier).

    Spécifie le nombre de jours de conservation des instantanés de bases de données automatiques.

  • CACertificateIdentifier(dans la CLI :--ca-certificate-identifier, ou en Python :ca_certificate_identifier) – Chaîne UTF-8.

    Identifiant du certificat CA de cette instance de base de données.

  • CopyTagsToSnapshot(interface de ligne de commande :--copy-tags-to-snapshot, ou en Python :copy_tags_to_snapshot) – Booléen.

    Indique si des balises sont copiées de l'instance de base de données vers des instantanés de l'instance de base de données.

  • DBClusterIdentifier(dans la CLI :--db-cluster-identifier, ou en Python :db_cluster_identifier) – Chaîne UTF-8.

    Si l'instance de base de données est membre d'un cluster de bases de données, elle contient le nom du cluster de bases de données dont elle est membre.

  • DBInstanceArn(dans la CLI :--db-instance-arn, ou en Python :db_instance_arn) – Chaîne UTF-8.

    ARN (Amazon Resource Name) de l'instance de base de données.

  • DBInstanceClass(interface de ligne de commande :--db-instance-class, ou en Python :db_instance_class) – Chaîne UTF-8.

    Contient le nom de la classe de capacité de calcul et de mémoire de l'instance de base de données.

  • DBInstanceIdentifier(interface de ligne de commande :--db-instance-identifier, ou en Python :db_instance_identifier) – Chaîne UTF-8.

    Contient un identifiant de base de données fourni par l'utilisateur. Ce dernier est la clé unique qui identifie une instance de base de données.

  • DbInstancePort(interface de ligne de commande :--db-instance-port, ou en Python :db_instance_port) – Nombre (entier).

    Spécifie le port sur lequel l'instance de base de données écoute. Si l'instance de base de données fait partie d'un cluster de bases de données, le port peut être différent du port de cluster de bases de données.

  • DBInstanceStatus(interface de ligne de commande :--db-instance-status, ou en Python :db_instance_status) – Chaîne UTF-8.

    Indique l'état actuel de cette base de données.

  • DbiResourceId(dans la CLI :--dbi-resource-id, ou en Python :dbi_resource_id) – Chaîne UTF-8.

    Identifiant immuable et propre à la région Amazon pour l'instance de base de données. Cet identifiant se trouve dans Amazon CloudTrail entrées de journal à chaque accès à la clé Amazon KMS de l'instance de base de données.

  • DBName(dans la CLI :--db-name, ou en Python :db_name) – Chaîne UTF-8.

    Nom de la base de données.

  • DBParameterGroups(interface de ligne de commande :--db-parameter-groups, ou en Python :db_parameter_groups) — Tableau d'élémentsDBParameterGroupStatusDBParameterGroup Objets.

    Fournit la liste des groupes de paramètres de base de données appliqués à cette instance de base de données.

  • DBSecurityGroups(interface de ligne de commande :--db-security-groups, ou en Python :db_security_groups) — Tableau d'élémentsDBSecurityGroupMembershipDBSecurityGroup Objets.

    Fournit la liste des éléments du Security Group DB contenant uniquement des sous-éléments DBSecurityGroup.Name et DBSecurityGroup.Status.

  • DBSubnetGroup(dans la CLI :--db-subnet-group, ou en Python :db_subnet_group) — UNDBSubnetGroupl'objet.

    Spécifie des informations sur le groupe de sous-réseaux associé à l'instance de base de données, dont le nom, la description et les sous-réseaux du groupe de sous-réseaux.

  • DeletionProtection(interface de ligne de commande :--deletion-protection, ou en Python :deletion_protection) – Booléen.

    Indique si la protection contre la suppression a été activée pour l'instance de base de données. L’instance ne peut pas être supprimée tant que la protection contre la suppression est activée. Consultez Suppression d'une instance de base de données.

  • DomainMemberships(interface de ligne de commande :--domain-memberships, ou en Python :domain_memberships) — Tableau d'élémentsDomainMembership DomainMembership Objets.

    Non pris en charge

  • EnabledCloudwatchLogsExports(interface de ligne de commande :--enabled-cloudwatch-logs-exports, ou en Python :enabled_cloudwatch_logs_exports) – Tableau de chaînes UTF-8.

    Liste des types de journaux vers lesquels cette instance de base de données est configurée et qui sont exportés vers CloudWatchBûches.

  • Endpoint(interface de ligne de commande :--endpoint, ou en Python :endpoint) — UnPoint de terminaisonl'objet.

    Spécifie le point de terminaison de la connexion.

  • Engine(interface de ligne de commande :--engine, ou en Python :engine) – Chaîne UTF-8.

    Fournit le nom du moteur de base de données à utiliser pour cette instance de base de données.

  • EngineVersion(interface de ligne de commande :--engine-version, ou en Python :engine_version) – Chaîne UTF-8.

    Indique la version du moteur de base de données.

  • EnhancedMonitoringResourceArn(interface de ligne de commande :--enhanced-monitoring-resource-arn, ou en Python :enhanced_monitoring_resource_arn) – Chaîne UTF-8.

    Amazon Resource Name (ARN) de Amazon CloudWatch Journal le flux de journal qui reçoit les données de métriques de surveillance améliorée pour l'instance de base de données.

  • IAMDatabaseAuthenticationEnabled(dans la CLI :--iam-database-authentication-enabled, ou en Python :iam_database_authentication_enabled) – Booléen.

    Valeur true si l'authentification d'Amazon Identity and Access Management (IAM) est activée, et false dans le cas contraire.

  • InstanceCreateTime(dans la CLI :--instance-create-time, ou en Python :instance_create_time) – Horodatage.

    Indique la date et l'heure de création de l'instance de base de données.

  • Iops(dans la CLI :--iops, ou en Python :iops) – Nombre (entier).

    Spécifie la valeur des IOPS provisionnés (opérations d'E/S par seconde).

  • KmsKeyId(dans la CLI :--kms-key-id, ou en Python :kms_key_id) – Chaîne UTF-8.

    Non pris pris pris pris Le chiffrement des instances de base de données est géré par le cluster de bases de données.

  • LatestRestorableTime(interface de ligne de commande :--latest-restorable-time, ou en Python :latest_restorable_time) – Horodatage.

    Spécifie la dernière heure à laquelle une base de données peut être restaurée avec point-in-timeRestauration.

  • LicenseModel(interface de ligne de commande :--license-model, ou en Python :license_model) – Chaîne UTF-8.

    Informations sur le modèle de licence de cette instance de base de données.

  • MonitoringInterval(interface de ligne de commande :--monitoring-interval, ou en Python :monitoring_interval) – Nombre (entier).

    Intervalle, en secondes, entre les points lorsque des métriques de surveillance améliorée sont collectées pour l'instance de base de données.

  • MonitoringRoleArn(dans la CLI :--monitoring-role-arn, ou en Python :monitoring_role_arn) – Chaîne UTF-8.

    ARN pour le rôle IAM qui autorise Neptune à envoyer des métriques de surveillance améliorée à Amazon CloudWatch Bûches.

  • MultiAZ(interface de ligne de commande :--multi-az, ou en Python :multi_az) – Booléen.

    Indique si l'instance de base de données est un déploiement multi-AZ.

  • PendingModifiedValues(interface de ligne de commande :--pending-modified-values, ou en Python :pending_modified_values) — UNPendingModifiedValuesl'objet.

    Spécifie que les modifications apportées à l'instance de base de données 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.

  • PreferredBackupWindow(L'interface de ligne de commande :--preferred-backup-window, ou en Python :preferred_backup_window) – Chaîne UTF-8.

    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.

  • PreferredMaintenanceWindow(L'interface de ligne de commande :--preferred-maintenance-window, ou en Python :preferred_maintenance_window) – Chaîne UTF-8.

    Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.

  • PromotionTier(interface de ligne de commande :--promotion-tier, ou en Python :promotion_tier) – Nombre (entier).

    Valeur qui spécifie l'ordre dans lequel un réplica en lecture est promu en instance principale après un échec de l'instance principale existante.

  • PubliclyAccessible(interface de ligne de commande :--publicly-accessible, ou en Python :publicly_accessible) – Booléen.

    Cet indicateur ne doit plus être utilisé.

  • ReadReplicaDBClusterIdentifiers(interface de ligne de commande :--read-replica-db-cluster-identifiers, ou en Python :read_replica_db_cluster_identifiers) — Tableau d'éléments ReadReplicaDBClusterIdentifier— Chaîne UTF-8.

    Contient un ou plusieurs identifiants des clusters de base de données qui sont des réplicas en lecture de cette instance de base de données.

  • ReadReplicaDBInstanceIdentifiers(L'interface de ligne de commande :--read-replica-db-instance-identifiers, ou en Python :read_replica_db_instance_identifiers) — Tableau d'éléments ReadReplicaDBInstanceIdentifier— Chaîne UTF-8.

    Contient un ou plusieurs identifiants des réplicas en lecture associés à cette instance de base de données.

  • ReadReplicaSourceDBInstanceIdentifier(L'interface de ligne de commande :--read-replica-source-db-instance-identifier, ou en Python :read_replica_source_db_instance_identifier) – Chaîne UTF-8.

    Contient l'identifiant de l'instance de base de données source si cette dernière est un réplica en lecture.

  • SecondaryAvailabilityZone(L'interface de ligne de commande :--secondary-availability-zone, ou en Python :secondary_availability_zone) – Chaîne UTF-8.

    Si cette valeur est présente, spécifie le nom de la zone de disponibilité secondaire d'une instance de base de données avec prise en charge multi-AZ.

  • StatusInfos(dans la CLI :--status-infos, ou en Python :status_infos) — Tableau d'élémentsDBInstanceStatusInfoDBInstanceStatusInfo Objets.

    Statut d'un réplica en lecture. Si l'instance n'est pas un réplica en lecture, ce champ est vide.

  • StorageEncrypted(dans la CLI :--storage-encrypted, ou en Python :storage_encrypted) – Booléen.

    Non pris pris pris pris Le chiffrement des instances de base de données est géré par le cluster de bases de données.

  • StorageType(L'interface de ligne de commande :--storage-type, ou en Python :storage_type) – Chaîne UTF-8.

    Spécifie le type de stockage associé à l'instance de base de données.

  • TdeCredentialArn(dans la CLI :--tde-credential-arn, ou en Python :tde_credential_arn) – Chaîne UTF-8.

    ARN du magasin de clés associé à l'instance pour le chiffrement TDE.

  • Timezone(dans la CLI :--timezone, ou en Python :timezone) – Chaîne UTF-8.

    Non pris en charge.

  • VpcSecurityGroups(L'interface de ligne de commande :--vpc-security-groups, ou en Python :vpc_security_groups) — Tableau d'élémentsVpcSecurityGroupMembership VpcSecurityGroupMembership Objets.

    Fournit une liste des éléments du groupe de sécurité VPC auxquels appartient l'instance de base de données.

RebootDBInstance (action)

        Le nom de ligne de ligne de commande Amazon pour cette API est :reboot-db-instance, et le nom Python est :reboot_db_instance.

Vous pouvez avoir besoin de redémarrer votre instance de bases de données, en général pour des raisons de maintenance. Par exemple, si vous effectuez certaines modifications, ou si vous changez un groupe de paramètres de base de données associé à l'instance de bases de données, vous devez redémarrer l'instance pour que les modifications prennent effet.

Le redémarrage d'une instance de base de données entraîne celui du service du moteur de base de données. Le redémarrage d'une instance de bases de données entraîne une interruption momentanée, au cours de laquelle le statut de l'instance de bases de données est défini sur redémarrage.

Demande

  • DBInstanceIdentifier(dans la CLI :--db-instance-identifier, ou en Python :db_instance_identifier) –Obligatoire : Une chaîne UTF-8.

    Identifiant de l'instance de base de données. Ce paramètre est stocké sous la forme d'une chaîne en lettres minuscules.

    Contraintes :

    • Doit correspondre à l'identifiant d'une DBInstance existante.

  • ForceFailover(L'interface de ligne de commande :--force-failover, ou en Python :force_failover) – Booléen.

    Lorsque la valeur est true, le redémarrage se déroule via un basculement MultiAZ.

    Constraint : Tableau d'élémentstruesi l'instance n'est pas configurée pour MultiAZ.

Réponse

Contient les détails d'une instance de base de données Amazon Neptune.

Ce type de données est utilisé comme élément de réponse dans l'action DescribeDBInstances (action).

  • AutoMinorVersionUpgrade(L'interface de ligne de commande :--auto-minor-version-upgrade, ou en Python :auto_minor_version_upgrade) – Booléen.

    Indique que des correctifs de versions mineures sont appliquées automatiquement.

  • AvailabilityZone(dans la CLI :--availability-zone, ou en Python :availability_zone) – Chaîne UTF-8.

    Spécifie le nom de la zone de disponibilité dans laquelle l'instance DB se trouve.

  • BackupRetentionPeriod(L'interface de ligne de commande :--backup-retention-period, ou en Python :backup_retention_period) – Nombre (entier).

    Spécifie le nombre de jours de conservation des instantanés de bases de données automatiques.

  • CACertificateIdentifier(L'interface de ligne de commande :--ca-certificate-identifier, ou en Python :ca_certificate_identifier) – Chaîne UTF-8.

    Identifiant du certificat CA de cette instance de base de données.

  • CopyTagsToSnapshot(L'interface de ligne de commande :--copy-tags-to-snapshot, ou en Python :copy_tags_to_snapshot) – Booléen.

    Indique si des balises sont copiées de l'instance de base de données vers des instantanés de l'instance de base de données.

  • DBClusterIdentifier(dans la CLI :--db-cluster-identifier, ou en Python :db_cluster_identifier) – Chaîne UTF-8.

    Si l'instance de base de données est membre d'un cluster de bases de données, elle contient le nom du cluster de bases de données dont elle est membre.

  • DBInstanceArn(L'interface de ligne de commande :--db-instance-arn, ou en Python :db_instance_arn) – Chaîne UTF-8.

    ARN (Amazon Resource Name) de l'instance de base de données.

  • DBInstanceClass(L'interface de ligne de commande :--db-instance-class, ou en Python :db_instance_class) – Chaîne UTF-8.

    Contient le nom de la classe de capacité de calcul et de mémoire de l'instance de base de données.

  • DBInstanceIdentifier(L'interface de ligne de commande :--db-instance-identifier, ou en Python :db_instance_identifier) – Chaîne UTF-8.

    Contient un identifiant de base de données fourni par l'utilisateur. Ce dernier est la clé unique qui identifie une instance de base de données.

  • DbInstancePort(L'interface de ligne de commande :--db-instance-port, ou en Python :db_instance_port) – Nombre (entier).

    Spécifie le port sur lequel l'instance de base de données écoute. Si l'instance de base de données fait partie d'un cluster de bases de données, le port peut être différent du port de cluster de bases de données.

  • DBInstanceStatus(dans la CLI :--db-instance-status, ou en Python :db_instance_status) – Chaîne UTF-8.

    Indique l'état actuel de cette base de données.

  • DbiResourceId(dans la CLI :--dbi-resource-id, ou en Python :dbi_resource_id) – Chaîne UTF-8.

    Identifiant immuable et propre à la région Amazon pour l'instance de base de données. Cet identifiant se trouve dans Amazon CloudTrail entrées de journal à chaque accès à la clé Amazon KMS de l'instance de base de données.

  • DBName(dans la CLI :--db-name, ou en Python :db_name) – Chaîne UTF-8.

    Nom de la base de données.

  • DBParameterGroups(dans la CLI :--db-parameter-groups, ou en Python :db_parameter_groups) — Tableau d'élémentsDBParameterGroupStatusDBParameterGroup Objets.

    Fournit la liste des groupes de paramètres de base de données appliqués à cette instance de base de données.

  • DBSecurityGroups(L'interface de ligne de commande :--db-security-groups, ou en Python :db_security_groups) — Tableau d'élémentsDBSecurityGroupMembershipDBSecurityGroup Objets.

    Fournit la liste des éléments du Security Group DB contenant uniquement des sous-éléments DBSecurityGroup.Name et DBSecurityGroup.Status.

  • DBSubnetGroup(L'interface de ligne de commande :--db-subnet-group, ou en Python :db_subnet_group) — UNDBSubnetGroupl'objet.

    Spécifie des informations sur le groupe de sous-réseaux associé à l'instance de base de données, dont le nom, la description et les sous-réseaux du groupe de sous-réseaux.

  • DeletionProtection(L'interface de ligne de commande :--deletion-protection, ou en Python :deletion_protection) – Booléen.

    Indique si la protection contre la suppression a été activée pour l'instance de base de données. L’instance ne peut pas être supprimée tant que la protection contre la suppression est activée. Consultez Suppression d'une instance de base de données.

  • DomainMemberships(L'interface de ligne de commande :--domain-memberships, ou en Python :domain_memberships) — Tableau d'élémentsDomainMembership DomainMembership Objets.

    Non pris en charge

  • EnabledCloudwatchLogsExports(L'interface de ligne de commande :--enabled-cloudwatch-logs-exports, ou en Python :enabled_cloudwatch_logs_exports) – Tableau de chaînes UTF-8.

    Liste des types de journaux vers lesquels cette instance de base de données est configurée et qui sont exportés vers CloudWatchBûches.

  • Endpoint(dans la CLI :--endpoint, ou en Python :endpoint) — UnPoint de terminaisonl'objet.

    Spécifie le point de terminaison de la connexion.

  • Engine(L'interface de ligne de commande :--engine, ou en Python :engine) – Chaîne UTF-8.

    Fournit le nom du moteur de base de données à utiliser pour cette instance de base de données.

  • EngineVersion(dans la CLI :--engine-version, ou en Python :engine_version) – Chaîne UTF-8.

    Indique la version du moteur de base de données.

  • EnhancedMonitoringResourceArn(L'interface de ligne de commande :--enhanced-monitoring-resource-arn, ou en Python :enhanced_monitoring_resource_arn) – Chaîne UTF-8.

    Amazon Resource Name (ARN) de Amazon CloudWatch Journal le flux de journal qui reçoit les données de métriques de surveillance améliorée pour l'instance de base de données.

  • IAMDatabaseAuthenticationEnabled(L'interface de ligne de commande :--iam-database-authentication-enabled, ou en Python :iam_database_authentication_enabled) – Booléen.

    Valeur true si l'authentification d'Amazon Identity and Access Management (IAM) est activée, et false dans le cas contraire.

  • InstanceCreateTime(dans la CLI :--instance-create-time, ou en Python :instance_create_time) – Horodatage.

    Indique la date et l'heure de création de l'instance de base de données.

  • Iops(L'interface de ligne de commande :--iops, ou en Python :iops) – Nombre (entier).

    Spécifie la valeur des IOPS provisionnés (opérations d'E/S par seconde).

  • KmsKeyId(L'interface de ligne de commande :--kms-key-id, ou en Python :kms_key_id) – Chaîne UTF-8.

    Non pris pris pris pris Le chiffrement des instances de base de données est géré par le cluster de bases de données.

  • LatestRestorableTime(dans la CLI :--latest-restorable-time, ou en Python :latest_restorable_time) – Horodatage.

    Spécifie la dernière heure à laquelle une base de données peut être restaurée avec point-in-timeRestauration.

  • LicenseModel(dans la CLI :--license-model, ou en Python :license_model) – Chaîne UTF-8.

    Informations sur le modèle de licence de cette instance de base de données.

  • MonitoringInterval(L'interface de ligne de commande :--monitoring-interval, ou en Python :monitoring_interval) – Nombre (entier).

    Intervalle, en secondes, entre les points lorsque des métriques de surveillance améliorée sont collectées pour l'instance de base de données.

  • MonitoringRoleArn(L'interface de ligne de commande :--monitoring-role-arn, ou en Python :monitoring_role_arn) – Chaîne UTF-8.

    ARN pour le rôle IAM qui autorise Neptune à envoyer des métriques de surveillance améliorée à Amazon CloudWatch Bûches.

  • MultiAZ(L'interface de ligne de commande :--multi-az, ou en Python :multi_az) – Booléen.

    Indique si l'instance de base de données est un déploiement multi-AZ.

  • PendingModifiedValues(dans la CLI :--pending-modified-values, ou en Python :pending_modified_values) — UNPendingModifiedValuesl'objet.

    Spécifie que les modifications apportées à l'instance de base de données 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.

  • PreferredBackupWindow(dans la CLI :--preferred-backup-window, ou en Python :preferred_backup_window) – Chaîne UTF-8.

    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.

  • PreferredMaintenanceWindow(dans la CLI :--preferred-maintenance-window, ou en Python :preferred_maintenance_window) – Chaîne UTF-8.

    Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.

  • PromotionTier(L'interface de ligne de commande :--promotion-tier, ou en Python :promotion_tier) – Nombre (entier).

    Valeur qui spécifie l'ordre dans lequel un réplica en lecture est promu en instance principale après un échec de l'instance principale existante.

  • PubliclyAccessible(dans la CLI :--publicly-accessible, ou en Python :publicly_accessible) – Booléen.

    Cet indicateur ne doit plus être utilisé.

  • ReadReplicaDBClusterIdentifiers(dans la CLI :--read-replica-db-cluster-identifiers, ou en Python :read_replica_db_cluster_identifiers) — Tableau d'éléments ReadReplicaDBClusterIdentifier— Chaîne UTF-8.

    Contient un ou plusieurs identifiants des clusters de base de données qui sont des réplicas en lecture de cette instance de base de données.

  • ReadReplicaDBInstanceIdentifiers(dans la CLI :--read-replica-db-instance-identifiers, ou en Python :read_replica_db_instance_identifiers) — Tableau d'éléments ReadReplicaDBInstanceIdentifier— Chaîne UTF-8.

    Contient un ou plusieurs identifiants des réplicas en lecture associés à cette instance de base de données.

  • ReadReplicaSourceDBInstanceIdentifier(dans la CLI :--read-replica-source-db-instance-identifier, ou en Python :read_replica_source_db_instance_identifier) – Chaîne UTF-8.

    Contient l'identifiant de l'instance de base de données source si cette dernière est un réplica en lecture.

  • SecondaryAvailabilityZone(L'interface de ligne de commande :--secondary-availability-zone, ou en Python :secondary_availability_zone) – Chaîne UTF-8.

    Si cette valeur est présente, spécifie le nom de la zone de disponibilité secondaire d'une instance de base de données avec prise en charge multi-AZ.

  • StatusInfos(L'interface de ligne de commande :--status-infos, ou en Python :status_infos) — Tableau d'élémentsDBInstanceStatusInfoDBInstanceStatusInfo Objets.

    Statut d'un réplica en lecture. Si l'instance n'est pas un réplica en lecture, ce champ est vide.

  • StorageEncrypted(L'interface de ligne de commande :--storage-encrypted, ou en Python :storage_encrypted) – Booléen.

    Non pris pris pris pris Le chiffrement des instances de base de données est géré par le cluster de bases de données.

  • StorageType(dans la CLI :--storage-type, ou en Python :storage_type) – Chaîne UTF-8.

    Spécifie le type de stockage associé à l'instance de base de données.

  • TdeCredentialArn(L'interface de ligne de commande :--tde-credential-arn, ou en Python :tde_credential_arn) – Chaîne UTF-8.

    ARN du magasin de clés associé à l'instance pour le chiffrement TDE.

  • Timezone(L'interface de ligne de commande :--timezone, ou en Python :timezone) – Chaîne UTF-8.

    Non pris en charge.

  • VpcSecurityGroups(L'interface de ligne de commande :--vpc-security-groups, ou en Python :vpc_security_groups) — Tableau d'élémentsVpcSecurityGroupMembership VpcSecurityGroupMembership Objets.

    Fournit une liste des éléments du groupe de sécurité VPC auxquels appartient l'instance de base de données.

DescribeDBInstances (action)

        Le nom de ligne de ligne de commande Amazon pour cette API est :describe-db-instances, et le nom Python est :describe_db_instances.

Renvoie des informations sur les instances provisionnées et prend en charge la pagination.

Note

Cette opération peut également renvoyer des informations pour les instances Amazon RDS et les instances Amazon DocDB.

Demande

  • DBInstanceIdentifier(L'interface de ligne de commande :--db-instance-identifier, ou en Python :db_instance_identifier) – Chaîne UTF-8.

    Identifiant d'instance fourni par l'utilisateur. Si ce paramètre est spécifié, seules les informations de l'instance de base de données spécifique sont renvoyées. Ce paramètre n'est pas sensible à la casse.

    Contraintes :

    • Si cette valeur est fournie, doit correspondre à l'identifiant d'une DBInstance existante.

  • Filters(L'interface de ligne de commande :--filters, ou en Python :filters) — Tableau d'élémentsFiltreFiltrez les objets

    Filtre qui spécifie une ou plusieurs instances de bases de données à décrire.

    Filtres pris en charge :

    • db-cluster-id – Accepte les identifiants de cluster de base de données et les Amazon Resource Names (ARN) de cluster de base de données. La liste de résultats inclut uniquement des informations sur les instances de base de données associées aux clusters de bases de données identifiés par ces ARN.

    • engine - Accepte un nom de moteur (tel que neptune) et restreint la liste de résultats aux instances de base de données créées par ce moteur.

    Par exemple, pour appeler cette API à partir de l'interface de ligne de commande Amazon et filtrer afin que seules les instances de base de données Neptune soient renvoyées, vous pouvez utiliser la commande suivante :

    aws neptune describe-db-instances \ --filters Name=engine,Values=neptune
  • Marker(L'interface de ligne de commande :--marker, ou en Python :marker) – Chaîne UTF-8.

    Jeton de pagination facultatif fourni par une demande DescribeDBInstances précédente. Si ce paramètre est spécifié, la réponse inclut uniquement des enregistrements supérieurs au marqueur, jusqu'à la valeur spécifiée par MaxRecords.

  • MaxRecords(L'interface de ligne de commande :--max-records, ou en Python :max_records) – Nombre (entier).

    Nombre maximal d'enregistrements à inclure dans la réponse. Si le nombre d'enregistrements existants est supérieur à la valeur MaxRecords spécifiée, un jeton de pagination appelé marqueur est inclus dans la réponse pour permettre la récupération des résultats restants.

    Par défaut: 100

    Contraintes : Minimum 20, maximum 100.

Réponse

  • DBInstances(L'interface de ligne de commande :--db-instances, ou en Python :db_instances) — Tableau d'élémentsDBInstanceUn objet DbInstance.

    Une liste des instances DBInstance (structure).

  • Marker(L'interface de ligne de commande :--marker, ou en Python :marker) – Chaîne UTF-8.

    Jeton de pagination facultatif fourni par une demande précédente. Si ce paramètre est spécifié, la réponse inclut uniquement des enregistrements supérieurs au marqueur, jusqu'à la valeur spécifiée par MaxRecords.

DescribeOrderableDBInstanceOptions (action)

        Le nom de ligne de ligne de commande Amazon pour cette API est :describe-orderable-db-instance-options, et le nom Python est :describe_orderable_db_instance_options.

Renvoie une liste des options d'instance de base de données à commander pour le moteur spécifié.

Demande

  • DBInstanceClass(dans la CLI :--db-instance-class, ou en Python :db_instance_class) – Chaîne UTF-8.

    Valeur de filtre de la classe d'instance de base de données. Spécifiez ce paramètre pour afficher uniquement les offres disponibles correspondant à la classe d'instance de base de données.

  • Engine(L'interface de ligne de commande :--engine, ou en Python :engine) –Obligatoire : Une chaîne UTF-8.

    Nom du moteur pour lequel récupérer les options d'instance de base de données.

  • EngineVersion(dans la CLI :--engine-version, ou en Python :engine_version) – Chaîne UTF-8.

    Valeur de filtre de la version de moteur. Spécifiez ce paramètre pour afficher uniquement les offres disponibles correspondant à la version de moteur spécifiée.

  • Filters(dans la CLI :--filters, ou en Python :filters) — Tableau d'élémentsFiltreFiltrez les objets

    Ce paramètre n'est actuellement pas pris en charge.

  • LicenseModel(dans la CLI :--license-model, ou en Python :license_model) – Chaîne UTF-8.

    Valeur de filtre du modèle de licence. Spécifiez ce paramètre pour afficher uniquement les offres disponibles correspondant au modèle de licence spécifié.

  • Marker(L'interface de ligne de commande :--marker, ou en Python :marker) – Chaîne UTF-8.

    Jeton de pagination facultatif fourni par un précédent DescribeOrderableDBInstanceOptionsde la demande. Si ce paramètre est spécifié, la réponse inclut uniquement des enregistrements supérieurs au marqueur, jusqu'à la valeur spécifiée par MaxRecords.

  • MaxRecords(L'interface de ligne de commande :--max-records, ou en Python :max_records) – Nombre (entier).

    Nombre maximal d'enregistrements à inclure dans la réponse. Si le nombre d'enregistrements existants est supérieur à la valeur MaxRecords spécifiée, un jeton de pagination appelé marqueur est inclus dans la réponse pour permettre la récupération des résultats restants.

    Par défaut: 100

    Contraintes : Minimum 20, maximum 100.

  • Vpc(dans la CLI :--vpc, ou en Python :vpc) – Booléen.

    Valeur de filtre VPC. Spécifiez ce paramètre pour afficher uniquement les offres VPC ou non VPC disponibles.

Réponse

  • Marker(L'interface de ligne de commande :--marker, ou en Python :marker) – Chaîne UTF-8.

    Jeton de pagination facultatif fourni par une base de données OrderableDB précédenteInstanceOptionsde la demande. Si ce paramètre est spécifié, la réponse inclut uniquement des enregistrements supérieurs au marqueur, jusqu'à la valeur spécifiée par MaxRecords.

  • OrderableDBInstanceOptions(L'interface de ligne de commande :--orderable-db-instance-options, ou en Python :orderable_db_instance_options) — Tableau d'élémentsBase de données commandableInstanceOptionBase de données commandableInstanceOption Objets.

    Structure Base de données commandableInstanceOption (structure) contenant des informations sur les options à commander pour l'instance de base de données.

DescribeValidDBInstanceModifications (action)

        Le nom de ligne de ligne de commande Amazon pour cette API est :describe-valid-db-instance-modifications, et le nom Python est :describe_valid_db_instance_modifications.

Vous pouvez appeler DescribeValidDBInstanceModifications (action) pour connaître les modifications à apporter à votre instance de base de données. Vous pouvez utiliser ces informations lorsque vous appelez ModifyDBInstance (action).

Demande

  • DBInstanceIdentifier(L'interface de ligne de commande :--db-instance-identifier, ou en Python :db_instance_identifier) –Obligatoire : Une chaîne UTF-8.

    Identifiant client ou ARN de votre instance de base de données.

Réponse

Informations sur les modifications valides que vous pouvez apporter à votre instance de base de données. Contient le résultat d'un appel réussi à l'action DescribeValidDBInstanceModifications (action). Vous pouvez utiliser ces informations lorsque vous appelez ModifyDBInstance (action).

  • Storage(dans la CLI :--storage, ou en Python :storage) — Tableau d'éléments ValidStorageOptions— une structure.

    Options de stockage valides pour votre instance de base de données.