API d'instances Neptune

Actions :

• CreateDBInstance (action)

• DeleteDBInstance (action)

• ModifyDBInstance (action)

• RebootDBInstance (action)

• DescribeDBInstances (action)

• DescribeOrderableDBInstanceOptions (action)

• DescribeValidDBInstanceModifications (action)

Structures :

• DBInstance (structure)

• DBInstanceStatusInfo (structure)

• OrderableDBInstanceOption (structure)

• PendingModifiedValues (structure)

• ValidStorageOptions (structure)

• ValidDBInstanceModificationsMessage (structure)

CreateDBInstance (action)

        Le nom AWS CLI de cette API est : create-db-instance.

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

Demande

• AutoMinorVersionUpgrade (dans la CLI : --auto-minor-version-upgrade) : élément BooleanOptional de type : boolean (valeur booléenne : true ou false).

  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) : chaîne de type : string (chaîne encodée en UTF-8).

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

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

  Exemple : us-east-1d

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

• BackupRetentionPeriod (dans la CLI : --backup-retention-period) : élément IntegerOptional de type : integer (entier signé de 32 bits).

  Nombre de jours de conservation des sauvegardes automatiques.

  Non applicable. La période de rétention des sauvegardes automatisées est gérée par le cluster de bases de données. Pour de plus amples informations, veuillez consulter 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 la CLI : --copy-tags-to-snapshot) : élément BooleanOptional de type : boolean (valeur booléenne : true ou false).

  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 la CLI : --db-cluster-identifier) : obligatoire : chaîne de type : string (chaîne encodée en 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) : obligatoire : chaîne de type : string (chaîne encodée en 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'instances de base de données ne sont pas disponibles dans toutes les régions Amazon.

• DBInstanceIdentifier (dans la CLI : --db-instance-identifier) : obligatoire : chaîne de type : string (chaîne encodée en 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) : chaîne de type : string (chaîne encodée en UTF-8).

  Non pris en charge.

• DBParameterGroupName (dans la CLI : --db-parameter-group-name) : chaîne de type : string (chaîne encodée en 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 valeur de DBParameterGroup par défaut pour le moteur spécifié est utilisée.

  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) : chaîne de type : string (chaîne encodée en UTF-8).

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

  Par défaut : le Security Group DB par défaut pour le moteur de base de données.

• DBSubnetGroupName (dans la CLI : --db-subnet-group-name) : chaîne de type : string (chaîne encodée en 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) : élément BooleanOptional de type : boolean (valeur booléenne : true ou false).

  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ée 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 (dans la CLI : --domain) : chaîne de type : string (chaîne encodée en UTF-8).

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

• DomainIAMRoleName (dans la CLI : --domain-iam-role-name) : chaîne de type : string (chaîne encodée en 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) : chaîne de type : string (chaîne encodée en UTF-8).

  Liste des types de journaux qui doivent être activés pour l'exportation vers CloudWatch Logs.

• EnableIAMDatabaseAuthentication (dans la CLI : --enable-iam-database-authentication) : élément BooleanOptional de type : boolean (valeur booléenne : true ou false).

  Non prise en charge par Neptune (ignorée).

• Engine (dans la CLI : --engine) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

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

  Valeurs valides : neptune

• EngineVersion (dans la CLI : --engine-version) : chaîne de type : string (chaîne encodée en 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) : élément IntegerOptional de type : integer (entier signé de 32 bits).

  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) : chaîne de type : string (chaîne encodée en 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 détient 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 KMS.

  Non applicable. L'identifiant de clé KMS est géré par le cluster de bases de données. Pour de plus amples informations, veuillez consulter 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 (dans la CLI : --license-model) : chaîne de type : string (chaîne encodée en 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) : élément IntegerOptional de type : integer (entier signé de 32 bits).

  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) : chaîne de type : string (chaîne encodée en UTF-8).

  ARN pour le rôle IAM qui autorise Neptune à envoyer des métriques de surveillance améliorée à Amazon CloudWatch Logs. 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 (dans la CLI : --multi-az) : élément BooleanOptional de type : boolean (valeur booléenne : true ou false).

  Indique si l’instance de base de données est un déploiement multi-AZ. Vous ne pouvez pas définir le paramètre AvailabilityZone si le paramètre MultiAZ est défini sur true.

• Port (dans la CLI : --port) : élément IntegerOptional de type : integer (entier signé de 32 bits).

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

  Non applicable. Le port est géré par le cluster de bases de données. Pour de plus amples informations, veuillez consulter CreateDBCluster (action).

  Par défaut : 8182

  Type : entier

• PreferredBackupWindow (dans la CLI : --preferred-backup-window) : chaîne de type : string (chaîne encodée en UTF-8).

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

  Non applicable. 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 de plus amples informations, veuillez consulter CreateDBCluster (action).

• PreferredMaintenanceWindow (dans la CLI : --preferred-maintenance-window) : chaîne de type : string (chaîne encodée en 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 de manière aléatoire dans un bloc de 8 heures pour chaque région Amazon, se produisant un jour choisi au hasard dans la semaine.

  Jours valides : Mon, Tue, Wed, Thu, Fri, Sat, Sun.

  Contraintes : fenêtre minimale de 30 minutes.

• PromotionTier (dans la CLI : --promotion-tier) : élément IntegerOptional de type : integer (entier signé de 32 bits).

  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 (dans la CLI : --publicly-accessible) : élément BooleanOptional de type : boolean (valeur booléenne : true ou false).

  Cet indicateur ne doit plus être utilisé.

• StorageEncrypted (dans la CLI : --storage-encrypted) : élément BooleanOptional de type : boolean (valeur booléenne : true ou false).

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

  Non applicable. Le chiffrement des instances de base de données est géré par le cluster de bases de données. Pour de plus amples informations, veuillez consulter CreateDBCluster (action).

  Valeur par défaut : false

• StorageType (dans la CLI : --storage-type) : chaîne de type : string (chaîne encodée en UTF-8).

  Non applicable. Dans Neptune, le type de stockage est géré au niveau du cluster de bases de données.

• Tags (dans la CLI : --tags) : tableau d’objets Tag.

  Balises à attribuer à la nouvelle instance.

• TdeCredentialArn (dans la CLI : --tde-credential-arn) : chaîne de type : string (chaîne encodée en UTF-8).

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

• TdeCredentialPassword (dans la CLI : --tde-credential-password) : SensitiveString, de type : string (chaîne encodée en 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) : chaîne de type : string (chaîne encodée en UTF-8).

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

• VpcSecurityGroupIds (dans la CLI : --vpc-security-group-ids) : chaîne de type : string (chaîne encodée en UTF-8).

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

  Non applicable. La liste associée des groupes de sécurité VPC EC2 est gérée par le cluster de bases de données. Pour de plus amples informations, veuillez consulter 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 : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• AvailabilityZone : chaîne de type : string (chaîne encodée en UTF-8).

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

• BackupRetentionPeriod : entier de type : integer (entier signé de 32 bits).

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

• CACertificateIdentifier : chaîne de type : string (chaîne encodée en UTF-8).

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

• CopyTagsToSnapshot : valeur booléenne de type : boolean (valeur booléenne : true ou false).

  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 de type : string (chaîne encodée en 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 de type : string (chaîne encodée en UTF-8).

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

• DBInstanceClass : chaîne de type : string (chaîne encodée en 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 de type : string (chaîne encodée en 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 : entier de type : integer (entier signé de 32 bits).

  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 de type : string (chaîne encodée en UTF-8).

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

• DbiResourceId : chaîne de type : string (chaîne encodée en UTF-8).

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

• DBName : chaîne de type : string (chaîne encodée en UTF-8).

  Nom de la base de données.

• DBParameterGroups : tableau d’objets DBParameterGroupStatus.

  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’objets DBSecurityGroupMembership.

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

• DBSubnetGroup : 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 : valeur booléenne facultative de type : boolean (valeur booléenne : true ou false).

  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 : tableau d’objets DomainMembership.

  Non pris en charge

• EnabledCloudwatchLogsExports : chaîne de type : string (chaîne encodée en UTF-8).

  Liste des types de journaux pour lesquels cette instance de base de données est configurée et qui sont exportés vers CloudWatch Logs.

• Endpoint : objet Point de terminaison.

  Spécifie le point de terminaison de la connexion.

• Engine : chaîne de type : string (chaîne encodée en UTF-8).

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

• EngineVersion : chaîne de type : string (chaîne encodée en UTF-8).

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

• EnhancedMonitoringResourceArn : chaîne de type : string (chaîne encodée en UTF-8).

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

• IAMDatabaseAuthenticationEnabled : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• InstanceCreateTime : horodatage de type : timestamp (point dans le temps, généralement défini comme un décalage par rapport à minuit le 1er janvier 1970).

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

• Iops : entier facultatif de type : integer (entier signé de 32 bits).

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

• KmsKeyId : chaîne de type : string (chaîne encodée en UTF-8).

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

• LatestRestorableTime : horodatage de type : timestamp (point dans le temps, généralement défini comme un décalage par rapport à minuit le 1er janvier 1970).

  Spécifie la dernière heure à laquelle une base de données peut être restaurée avec une restauration à un moment donné.

• LicenseModel : chaîne de type : string (chaîne encodée en UTF-8).

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

• MonitoringInterval : entier facultatif de type : integer (entier signé de 32 bits).

  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 de type : string (chaîne encodée en UTF-8).

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

• MultiAZ : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• PendingModifiedValues : 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 de type : string (chaîne encodée en 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 de type : string (chaîne encodée en 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 : entier facultatif de type : integer (entier signé de 32 bits).

  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 : valeur booléenne de type : boolean (valeur booléenne : true ou false).

  Cet indicateur ne doit plus être utilisé.

• ReadReplicaDBClusterIdentifiers : chaîne de type : string (chaîne encodée en UTF-8).

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

• ReadReplicaDBInstanceIdentifiers : chaîne de type : string (chaîne encodée en UTF-8).

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

• ReadReplicaSourceDBInstanceIdentifier : chaîne de type : string (chaîne encodée en 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 de type : string (chaîne encodée en 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’objets DBInstanceStatusInfo.

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

• StorageEncrypted : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• StorageType : chaîne de type : string (chaîne encodée en UTF-8).

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

• TdeCredentialArn : chaîne de type : string (chaîne encodée en UTF-8).

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

• Timezone : chaîne de type : string (chaîne encodée en UTF-8).

  Non pris en charge.

• VpcSecurityGroups : tableau d’objets VpcSecurityGroupMembership.

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

Erreurs

• DBInstanceAlreadyExistsFault

• InsufficientDBInstanceCapacityFault

• DBParameterGroupNotFoundFault

• DBSecurityGroupNotFoundFault

• InstanceQuotaExceededFault

• StorageQuotaExceededFault

• DBSubnetGroupNotFoundFault

• DBSubnetGroupDoesNotCoverEnoughAZs

• InvalidDBClusterStateFault

• InvalidSubnet

• InvalidVPCNetworkStateFault

• ProvisionedIopsNotAvailableInAZFault

• OptionGroupNotFoundFault

• DBClusterNotFoundFault

• StorageTypeNotSupportedFault

• AuthorizationNotFoundFault

• KMSKeyNotAccessibleFault

• DomainNotFoundFault

DeleteDBInstance (action)

        Le nom AWS CLI de cette API 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) : obligatoire : chaîne de type : string (chaîne encodée en 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 (dans la CLI : --final-db-snapshot-identifier) : chaîne de type : string (chaîne encodée en UTF-8).

  DBSnapshotIdentifier du nouvel instantané de base de données créé lorsque SkipFinalSnapshot est défini sur false.

  Note

  Le fait de spécifier ce paramètre et également de définir le paramètre SkipFinalShapshot sur 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) : valeur booléenne de type : boolean (valeur booléenne : true ou false).

  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 paramètre SkipFinalSnapshot est défini sur « true ».

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

  Note

  Le paramètre FinalDBSnapshotIdentifier doit être spécifié si SkipFinalSnapshot est défini sur false.

  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 : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• AvailabilityZone : chaîne de type : string (chaîne encodée en UTF-8).

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

• BackupRetentionPeriod : entier de type : integer (entier signé de 32 bits).

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

• CACertificateIdentifier : chaîne de type : string (chaîne encodée en UTF-8).

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

• CopyTagsToSnapshot : valeur booléenne de type : boolean (valeur booléenne : true ou false).

  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 de type : string (chaîne encodée en 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 de type : string (chaîne encodée en UTF-8).

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

• DBInstanceClass : chaîne de type : string (chaîne encodée en 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 de type : string (chaîne encodée en 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 : entier de type : integer (entier signé de 32 bits).

  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 de type : string (chaîne encodée en UTF-8).

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

• DbiResourceId : chaîne de type : string (chaîne encodée en UTF-8).

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

• DBName : chaîne de type : string (chaîne encodée en UTF-8).

  Nom de la base de données.

• DBParameterGroups : tableau d’objets DBParameterGroupStatus.

  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’objets DBSecurityGroupMembership.

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

• DBSubnetGroup : 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 : valeur booléenne facultative de type : boolean (valeur booléenne : true ou false).

  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 : tableau d’objets DomainMembership.

  Non pris en charge

• EnabledCloudwatchLogsExports : chaîne de type : string (chaîne encodée en UTF-8).

  Liste des types de journaux pour lesquels cette instance de base de données est configurée et qui sont exportés vers CloudWatch Logs.

• Endpoint : objet Point de terminaison.

  Spécifie le point de terminaison de la connexion.

• Engine : chaîne de type : string (chaîne encodée en UTF-8).

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

• EngineVersion : chaîne de type : string (chaîne encodée en UTF-8).

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

• EnhancedMonitoringResourceArn : chaîne de type : string (chaîne encodée en UTF-8).

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

• IAMDatabaseAuthenticationEnabled : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• InstanceCreateTime : horodatage de type : timestamp (point dans le temps, généralement défini comme un décalage par rapport à minuit le 1er janvier 1970).

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

• Iops : entier facultatif de type : integer (entier signé de 32 bits).

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

• KmsKeyId : chaîne de type : string (chaîne encodée en UTF-8).

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

• LatestRestorableTime : horodatage de type : timestamp (point dans le temps, généralement défini comme un décalage par rapport à minuit le 1er janvier 1970).

  Spécifie la dernière heure à laquelle une base de données peut être restaurée avec une restauration à un moment donné.

• LicenseModel : chaîne de type : string (chaîne encodée en UTF-8).

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

• MonitoringInterval : entier facultatif de type : integer (entier signé de 32 bits).

  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 de type : string (chaîne encodée en UTF-8).

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

• MultiAZ : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• PendingModifiedValues : 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 de type : string (chaîne encodée en 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 de type : string (chaîne encodée en 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 : entier facultatif de type : integer (entier signé de 32 bits).

  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 : valeur booléenne de type : boolean (valeur booléenne : true ou false).

  Cet indicateur ne doit plus être utilisé.

• ReadReplicaDBClusterIdentifiers : chaîne de type : string (chaîne encodée en UTF-8).

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

• ReadReplicaDBInstanceIdentifiers : chaîne de type : string (chaîne encodée en UTF-8).

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

• ReadReplicaSourceDBInstanceIdentifier : chaîne de type : string (chaîne encodée en 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 de type : string (chaîne encodée en 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’objets DBInstanceStatusInfo.

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

• StorageEncrypted : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• StorageType : chaîne de type : string (chaîne encodée en UTF-8).

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

• TdeCredentialArn : chaîne de type : string (chaîne encodée en UTF-8).

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

• Timezone : chaîne de type : string (chaîne encodée en UTF-8).

  Non pris en charge.

• VpcSecurityGroups : tableau d’objets VpcSecurityGroupMembership.

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

Erreurs

• DBInstanceNotFoundFault

• InvalidDBInstanceStateFault

• DBSnapshotAlreadyExistsFault

• SnapshotQuotaExceededFault

• InvalidDBClusterStateFault

ModifyDBInstance (action)

        Le nom AWS CLI de cette API 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 (dans la CLI : --allow-major-version-upgrade) : valeur booléenne de type : boolean (valeur booléenne : true ou false).

  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 (dans la CLI : --apply-immediately) : valeur booléenne de type : boolean (valeur booléenne : true ou false).

  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 (dans la CLI : --auto-minor-version-upgrade) : élément BooleanOptional de type : boolean (valeur booléenne : true ou false).

  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) : élément IntegerOptional de type : integer (entier signé de 32 bits).

  Non applicable. La période de rétention des sauvegardes automatisées est gérée par le cluster de bases de données. Pour de plus amples informations, veuillez consulter ModifyDBCluster (action).

  Par défaut : utilise le paramètre existant

• CACertificateIdentifier (dans la CLI : --ca-certificate-identifier) : chaîne de type : string (chaîne encodée en UTF-8).

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

• CloudwatchLogsExportConfiguration (dans la CLI : --cloudwatch-logs-export-configuration) : objet CloudwatchLogsExportConfiguration.

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

• CopyTagsToSnapshot (dans la CLI : --copy-tags-to-snapshot) : élément BooleanOptional de type : boolean (valeur booléenne : true ou false).

  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 (dans la CLI : --db-instance-class) : chaîne de type : string (chaîne encodée en 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'instances 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 : utilise le paramètre existant

• DBInstanceIdentifier (dans la CLI : --db-instance-identifier) : obligatoire : chaîne de type : string (chaîne encodée en 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) : chaîne de type : string (chaîne encodée en 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 être dans la même famille de groupe de paramètres de base de données que cette instance de base de données.

• DBPortNumber (dans la CLI : --db-port-number) : élément IntegerOptional de type : integer (entier signé de 32 bits).

  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) : chaîne de type : string (chaîne encodée en 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 à un nom de DBSecurityGroups existant.

• DBSubnetGroupName (dans la CLI : --db-subnet-group-name) : chaîne de type : string (chaîne encodée en 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 à un nom de DBSubnetGroup existant.

  Exemple : mySubnetGroup

• DeletionProtection (dans la CLI : --deletion-protection) : élément BooleanOptional de type : boolean (valeur booléenne : true ou false).

  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ée 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 (dans la CLI : --domain) : chaîne de type : string (chaîne encodée en UTF-8).

  Non pris en charge.

• DomainIAMRoleName (dans la CLI : --domain-iam-role-name) : chaîne de type : string (chaîne encodée en UTF-8).

  Non pris en charge

• EnableIAMDatabaseAuthentication (dans la CLI : --enable-iam-database-authentication) : élément BooleanOptional de type : boolean (valeur booléenne : true ou false).

  Valeur true pour activer le mappage des comptes Amazon Identity and Access Management (IAM) avec les 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

  Non applicable. Le mappage des comptes Amazon IAM avec des comptes de base de données est géré par le cluster de bases de données. Pour de plus amples informations, veuillez consulter ModifyDBCluster (action).

  Par défaut : false

• EngineVersion (dans la CLI : --engine-version) : chaîne de type : string (chaîne encodée en 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) : élément IntegerOptional de type : integer (entier signé de 32 bits).

  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 (dans la CLI : --monitoring-interval) : élément IntegerOptional de type : integer (entier signé de 32 bits).

  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) : chaîne de type : string (chaîne encodée en UTF-8).

  ARN pour le rôle IAM qui autorise Neptune à envoyer des métriques de surveillance améliorée à Amazon CloudWatch Logs. 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 (dans la CLI : --multi-az) : élément BooleanOptional de type : boolean (valeur booléenne : true ou false).

  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 (dans la CLI : --new-db-instance-identifier) : chaîne de type : string (chaîne encodée en 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 (dans la CLI : --preferred-backup-window) : chaîne de type : string (chaîne encodée en UTF-8).

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

  Non applicable. 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 de plus amples informations, veuillez consulter 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 (dans la CLI : --preferred-maintenance-window) : chaîne de type : string (chaîne encodée en 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 valides : Mon | Tue | Wed | Thu | Fri | Sat | Sun

  Contraintes : doit être de 30 minutes minimum.

• PromotionTier (dans la CLI : --promotion-tier) : élément IntegerOptional de type : integer (entier signé de 32 bits).

  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 (dans la CLI : --publicly-accessible) : élément BooleanOptional de type : boolean (valeur booléenne : true ou false).

  Cet indicateur ne doit plus être utilisé.

• StorageType (dans la CLI : --storage-type) : chaîne de type : string (chaîne encodée en UTF-8).

  Non applicable. Dans Neptune, le type de stockage est géré au niveau du cluster de bases de données.

• TdeCredentialArn (dans la CLI : --tde-credential-arn) : chaîne de type : string (chaîne encodée en UTF-8).

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

• TdeCredentialPassword (dans la CLI : --tde-credential-password) : SensitiveString, de type : string (chaîne encodée en UTF-8).

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

• VpcSecurityGroupIds (dans la CLI : --vpc-security-group-ids) : chaîne de type : string (chaîne encodée en 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.

  Non applicable. La liste associée des groupes de sécurité VPC EC2 est gérée par le cluster de bases de données. Pour de plus amples informations, veuillez consulter ModifyDBCluster (action).

  Contraintes :

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

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 : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• AvailabilityZone : chaîne de type : string (chaîne encodée en UTF-8).

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

• BackupRetentionPeriod : entier de type : integer (entier signé de 32 bits).

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

• CACertificateIdentifier : chaîne de type : string (chaîne encodée en UTF-8).

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

• CopyTagsToSnapshot : valeur booléenne de type : boolean (valeur booléenne : true ou false).

  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 de type : string (chaîne encodée en 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 de type : string (chaîne encodée en UTF-8).

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

• DBInstanceClass : chaîne de type : string (chaîne encodée en 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 de type : string (chaîne encodée en 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 : entier de type : integer (entier signé de 32 bits).

  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 de type : string (chaîne encodée en UTF-8).

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

• DbiResourceId : chaîne de type : string (chaîne encodée en UTF-8).

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

• DBName : chaîne de type : string (chaîne encodée en UTF-8).

  Nom de la base de données.

• DBParameterGroups : tableau d’objets DBParameterGroupStatus.

  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’objets DBSecurityGroupMembership.

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

• DBSubnetGroup : 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 : valeur booléenne facultative de type : boolean (valeur booléenne : true ou false).

  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 : tableau d’objets DomainMembership.

  Non pris en charge

• EnabledCloudwatchLogsExports : chaîne de type : string (chaîne encodée en UTF-8).

  Liste des types de journaux pour lesquels cette instance de base de données est configurée et qui sont exportés vers CloudWatch Logs.

• Endpoint : objet Point de terminaison.

  Spécifie le point de terminaison de la connexion.

• Engine : chaîne de type : string (chaîne encodée en UTF-8).

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

• EngineVersion : chaîne de type : string (chaîne encodée en UTF-8).

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

• EnhancedMonitoringResourceArn : chaîne de type : string (chaîne encodée en UTF-8).

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

• IAMDatabaseAuthenticationEnabled : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• InstanceCreateTime : horodatage de type : timestamp (point dans le temps, généralement défini comme un décalage par rapport à minuit le 1er janvier 1970).

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

• Iops : entier facultatif de type : integer (entier signé de 32 bits).

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

• KmsKeyId : chaîne de type : string (chaîne encodée en UTF-8).

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

• LatestRestorableTime : horodatage de type : timestamp (point dans le temps, généralement défini comme un décalage par rapport à minuit le 1er janvier 1970).

  Spécifie la dernière heure à laquelle une base de données peut être restaurée avec une restauration à un moment donné.

• LicenseModel : chaîne de type : string (chaîne encodée en UTF-8).

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

• MonitoringInterval : entier facultatif de type : integer (entier signé de 32 bits).

  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 de type : string (chaîne encodée en UTF-8).

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

• MultiAZ : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• PendingModifiedValues : 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 de type : string (chaîne encodée en 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 de type : string (chaîne encodée en 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 : entier facultatif de type : integer (entier signé de 32 bits).

  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 : valeur booléenne de type : boolean (valeur booléenne : true ou false).

  Cet indicateur ne doit plus être utilisé.

• ReadReplicaDBClusterIdentifiers : chaîne de type : string (chaîne encodée en UTF-8).

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

• ReadReplicaDBInstanceIdentifiers : chaîne de type : string (chaîne encodée en UTF-8).

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

• ReadReplicaSourceDBInstanceIdentifier : chaîne de type : string (chaîne encodée en 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 de type : string (chaîne encodée en 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’objets DBInstanceStatusInfo.

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

• StorageEncrypted : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• StorageType : chaîne de type : string (chaîne encodée en UTF-8).

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

• TdeCredentialArn : chaîne de type : string (chaîne encodée en UTF-8).

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

• Timezone : chaîne de type : string (chaîne encodée en UTF-8).

  Non pris en charge.

• VpcSecurityGroups : tableau d’objets VpcSecurityGroupMembership.

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

Erreurs

• InvalidDBInstanceStateFault

• InvalidDBSecurityGroupStateFault

• DBInstanceAlreadyExistsFault

• DBInstanceNotFoundFault

• DBSecurityGroupNotFoundFault

• DBParameterGroupNotFoundFault

• InsufficientDBInstanceCapacityFault

• StorageQuotaExceededFault

• InvalidVPCNetworkStateFault

• ProvisionedIopsNotAvailableInAZFault

• OptionGroupNotFoundFault

• DBUpgradeDependencyFailureFault

• StorageTypeNotSupportedFault

• AuthorizationNotFoundFault

• CertificateNotFoundFault

• DomainNotFoundFault

RebootDBInstance (action)

        Le nom AWS CLI de cette API 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) : obligatoire : chaîne de type : string (chaîne encodée en 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 (dans la CLI : --force-failover) : élément BooleanOptional de type : boolean (valeur booléenne : true ou false).

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

  Contrainte : vous ne pouvez pas spécifier true si 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 : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• AvailabilityZone : chaîne de type : string (chaîne encodée en UTF-8).

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

• BackupRetentionPeriod : entier de type : integer (entier signé de 32 bits).

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

• CACertificateIdentifier : chaîne de type : string (chaîne encodée en UTF-8).

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

• CopyTagsToSnapshot : valeur booléenne de type : boolean (valeur booléenne : true ou false).

  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 de type : string (chaîne encodée en 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 de type : string (chaîne encodée en UTF-8).

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

• DBInstanceClass : chaîne de type : string (chaîne encodée en 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 de type : string (chaîne encodée en 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 : entier de type : integer (entier signé de 32 bits).

  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 de type : string (chaîne encodée en UTF-8).

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

• DbiResourceId : chaîne de type : string (chaîne encodée en UTF-8).

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

• DBName : chaîne de type : string (chaîne encodée en UTF-8).

  Nom de la base de données.

• DBParameterGroups : tableau d’objets DBParameterGroupStatus.

  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’objets DBSecurityGroupMembership.

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

• DBSubnetGroup : 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 : valeur booléenne facultative de type : boolean (valeur booléenne : true ou false).

  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 : tableau d’objets DomainMembership.

  Non pris en charge

• EnabledCloudwatchLogsExports : chaîne de type : string (chaîne encodée en UTF-8).

  Liste des types de journaux pour lesquels cette instance de base de données est configurée et qui sont exportés vers CloudWatch Logs.

• Endpoint : objet Point de terminaison.

  Spécifie le point de terminaison de la connexion.

• Engine : chaîne de type : string (chaîne encodée en UTF-8).

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

• EngineVersion : chaîne de type : string (chaîne encodée en UTF-8).

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

• EnhancedMonitoringResourceArn : chaîne de type : string (chaîne encodée en UTF-8).

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

• IAMDatabaseAuthenticationEnabled : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• InstanceCreateTime : horodatage de type : timestamp (point dans le temps, généralement défini comme un décalage par rapport à minuit le 1er janvier 1970).

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

• Iops : entier facultatif de type : integer (entier signé de 32 bits).

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

• KmsKeyId : chaîne de type : string (chaîne encodée en UTF-8).

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

• LatestRestorableTime : horodatage de type : timestamp (point dans le temps, généralement défini comme un décalage par rapport à minuit le 1er janvier 1970).

  Spécifie la dernière heure à laquelle une base de données peut être restaurée avec une restauration à un moment donné.

• LicenseModel : chaîne de type : string (chaîne encodée en UTF-8).

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

• MonitoringInterval : entier facultatif de type : integer (entier signé de 32 bits).

  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 de type : string (chaîne encodée en UTF-8).

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

• MultiAZ : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• PendingModifiedValues : 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 de type : string (chaîne encodée en 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 de type : string (chaîne encodée en 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 : entier facultatif de type : integer (entier signé de 32 bits).

  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 : valeur booléenne de type : boolean (valeur booléenne : true ou false).

  Cet indicateur ne doit plus être utilisé.

• ReadReplicaDBClusterIdentifiers : chaîne de type : string (chaîne encodée en UTF-8).

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

• ReadReplicaDBInstanceIdentifiers : chaîne de type : string (chaîne encodée en UTF-8).

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

• ReadReplicaSourceDBInstanceIdentifier : chaîne de type : string (chaîne encodée en 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 de type : string (chaîne encodée en 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’objets DBInstanceStatusInfo.

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

• StorageEncrypted : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• StorageType : chaîne de type : string (chaîne encodée en UTF-8).

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

• TdeCredentialArn : chaîne de type : string (chaîne encodée en UTF-8).

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

• Timezone : chaîne de type : string (chaîne encodée en UTF-8).

  Non pris en charge.

• VpcSecurityGroups : tableau d’objets VpcSecurityGroupMembership.

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

Erreurs

• InvalidDBInstanceStateFault

• DBInstanceNotFoundFault

DescribeDBInstances (action)

        Le nom AWS CLI de cette API 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 (dans la CLI : --db-instance-identifier) : chaîne de type : string (chaîne encodée en 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 (dans la CLI : --filters) : tableau d’objets Filtre.

  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 bases de données et les Amazon Resource Names (ARN) de cluster de bases 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 invoquer cette API à partir de l'interface de ligne de commande Amazon et effectuer un filtrage 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 (dans la CLI : --marker) : chaîne de type : string (chaîne encodée en 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 (dans la CLI : --max-records) : élément IntegerOptional de type : integer (entier signé de 32 bits).

  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 : tableau d’objets DBInstance.

  Liste des instances DBInstance (structure).

• Marker : chaîne de type : string (chaîne encodée en 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.

Erreurs

• DBInstanceNotFoundFault

DescribeOrderableDBInstanceOptions (action)

        Le nom AWS CLI de cette API 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) : chaîne de type : string (chaîne encodée en 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 (dans la CLI : --engine) : obligatoire : chaîne de type : string (chaîne encodée en 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) : chaîne de type : string (chaîne encodée en 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) : tableau d’objets Filtre.

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

• LicenseModel (dans la CLI : --license-model) : chaîne de type : string (chaîne encodée en 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 (dans la CLI : --marker) : chaîne de type : string (chaîne encodée en UTF-8).

  Jeton de pagination facultatif fourni par une demande DescribeOrderableDBInstanceOptions 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 (dans la CLI : --max-records) : élément IntegerOptional de type : integer (entier signé de 32 bits).

  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) : élément BooleanOptional de type : boolean (valeur booléenne : true ou false).

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

Réponse

• Marker : chaîne de type : string (chaîne encodée en UTF-8).

  Jeton de pagination facultatif fourni par une demande OrderableDBInstanceOptions 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.

• OrderableDBInstanceOptions : tableau d’objets OrderableDBInstanceOption.

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

DescribeValidDBInstanceModifications (action)

        Le nom AWS CLI de cette API 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 (dans la CLI : --db-instance-identifier) : obligatoire : chaîne de type : string (chaîne encodée en 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 : tableau d’objets ValidStorageOptions.

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

Erreurs

• DBInstanceNotFoundFault

• InvalidDBInstanceStateFault

Structures :

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 : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• AvailabilityZone : chaîne de type : string (chaîne encodée en UTF-8).

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

• BackupRetentionPeriod : entier de type : integer (entier signé de 32 bits).

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

• CACertificateIdentifier : chaîne de type : string (chaîne encodée en UTF-8).

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

• CopyTagsToSnapshot : valeur booléenne de type : boolean (valeur booléenne : true ou false).

  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 de type : string (chaîne encodée en 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 de type : string (chaîne encodée en UTF-8).

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

• DBInstanceClass : chaîne de type : string (chaîne encodée en 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 de type : string (chaîne encodée en 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 : entier de type : integer (entier signé de 32 bits).

  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 de type : string (chaîne encodée en UTF-8).

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

• DbiResourceId : chaîne de type : string (chaîne encodée en UTF-8).

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

• DBName : chaîne de type : string (chaîne encodée en UTF-8).

  Nom de la base de données.

• DBParameterGroups : tableau d’objets DBParameterGroupStatus.

  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’objets DBSecurityGroupMembership.

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

• DBSubnetGroup : 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 : valeur booléenne facultative de type : boolean (valeur booléenne : true ou false).

  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 : tableau d’objets DomainMembership.

  Non pris en charge

• EnabledCloudwatchLogsExports : chaîne de type : string (chaîne encodée en UTF-8).

  Liste des types de journaux pour lesquels cette instance de base de données est configurée et qui sont exportés vers CloudWatch Logs.

• Endpoint : objet Point de terminaison.

  Spécifie le point de terminaison de la connexion.

• Engine : chaîne de type : string (chaîne encodée en UTF-8).

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

• EngineVersion : chaîne de type : string (chaîne encodée en UTF-8).

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

• EnhancedMonitoringResourceArn : chaîne de type : string (chaîne encodée en UTF-8).

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

• IAMDatabaseAuthenticationEnabled : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• InstanceCreateTime : horodatage de type : timestamp (point dans le temps, généralement défini comme un décalage par rapport à minuit le 1er janvier 1970).

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

• Iops : entier facultatif de type : integer (entier signé de 32 bits).

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

• KmsKeyId : chaîne de type : string (chaîne encodée en UTF-8).

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

• LatestRestorableTime : horodatage de type : timestamp (point dans le temps, généralement défini comme un décalage par rapport à minuit le 1er janvier 1970).

  Spécifie la dernière heure à laquelle une base de données peut être restaurée avec une restauration à un moment donné.

• LicenseModel : chaîne de type : string (chaîne encodée en UTF-8).

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

• MonitoringInterval : entier facultatif de type : integer (entier signé de 32 bits).

  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 de type : string (chaîne encodée en UTF-8).

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

• MultiAZ : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• PendingModifiedValues : 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 de type : string (chaîne encodée en 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 de type : string (chaîne encodée en 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 : entier facultatif de type : integer (entier signé de 32 bits).

  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 : valeur booléenne de type : boolean (valeur booléenne : true ou false).

  Cet indicateur ne doit plus être utilisé.

• ReadReplicaDBClusterIdentifiers : chaîne de type : string (chaîne encodée en UTF-8).

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

• ReadReplicaDBInstanceIdentifiers : chaîne de type : string (chaîne encodée en UTF-8).

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

• ReadReplicaSourceDBInstanceIdentifier : chaîne de type : string (chaîne encodée en 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 de type : string (chaîne encodée en 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’objets DBInstanceStatusInfo.

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

• StorageEncrypted : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• StorageType : chaîne de type : string (chaîne encodée en UTF-8).

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

• TdeCredentialArn : chaîne de type : string (chaîne encodée en UTF-8).

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

• Timezone : chaîne de type : string (chaîne encodée en UTF-8).

  Non pris en charge.

• VpcSecurityGroups : tableau d’objets 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 :

• CreateDBInstance

• DeleteDBInstance

• ModifyDBInstance

• RebootDBInstance

DBInstanceStatusInfo (structure)

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

Champs

• Message : chaîne de type : string (chaîne encodée en 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 : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• Status : chaîne de type : string (chaîne encodée en UTF-8).

  Statut de l'instance de base de données. La valeur du champ StatusType du réplica en lecture peut indiquer une réplication en cours, une erreur, un arrêt ou une résiliation.

• StatusType : chaîne de type : string (chaîne encodée en UTF-8).

  Cette valeur est actuellement « read replication ».

OrderableDBInstanceOption (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 : tableau d’objets AvailabilityZone.

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

• DBInstanceClass : chaîne de type : string (chaîne encodée en UTF-8).

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

• Engine : chaîne de type : string (chaîne encodée en UTF-8).

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

• EngineVersion : chaîne de type : string (chaîne encodée en UTF-8).

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

• LicenseModel : chaîne de type : string (chaîne encodée en UTF-8).

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

• MaxIopsPerDbInstance : entier facultatif de type : integer (entier signé de 32 bits).

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

• MaxIopsPerGib : double facultatif de type : double (nombre à virgule flottante IEEE 754 à double précision).

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

• MaxStorageSize : entier facultatif de type : integer (entier signé de 32 bits).

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

• MinIopsPerDbInstance : entier facultatif de type : integer (entier signé de 32 bits).

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

• MinIopsPerGib : double facultatif de type : double (nombre à virgule flottante IEEE 754 à double précision).

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

• MinStorageSize : entier facultatif de type : integer (entier signé de 32 bits).

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

• MultiAZCapable : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• ReadReplicaCapable : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• StorageType : chaîne de type : string (chaîne encodée en UTF-8).

  Non applicable. Dans Neptune, le type de stockage est géré au niveau du cluster de bases de données.

• SupportsEnhancedMonitoring : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• SupportsGlobalDatabases : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• SupportsIAMDatabaseAuthentication : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• SupportsIops : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• SupportsStorageEncryption : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

• Vpc : valeur booléenne de type : boolean (valeur booléenne : true ou false).

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

PendingModifiedValues (structure)

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

Champs

• AllocatedStorage : entier facultatif de type : integer (entier signé de 32 bits).

  Contient la nouvelle taille AllocatedStorage pour l'instance de base de données qui sera appliquée ou est actuellement appliquée.

• BackupRetentionPeriod : entier facultatif de type : integer (entier signé de 32 bits).

  Spécifie le nombre de jours en attente pour lesquels des sauvegardes automatiques sont conservées.

• CACertificateIdentifier : chaîne de type : string (chaîne encodée en UTF-8).

  Spécifie l'identifiant du certificat CA pour l'instance de base de données.

• DBInstanceClass : chaîne de type : string (chaîne encodée en UTF-8).

  Contient le nouveau paramètre DBInstanceClass pour l’instance de base de données qui sera appliqué ou est actuellement appliqué.

• DBInstanceIdentifier : chaîne de type : string (chaîne encodée en UTF-8).

  Contient le nouveau paramètre DBInstanceIdentifier pour l’instance de base de données qui sera appliqué ou est actuellement appliqué.

• DBSubnetGroupName : chaîne de type : string (chaîne encodée en UTF-8).

  Nouveau groupe de sous-réseaux de l’instance de base de données.

• EngineVersion : chaîne de type : string (chaîne encodée en UTF-8).

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

• Iops : entier facultatif de type : integer (entier signé de 32 bits).

  Spécifie la nouvelle valeur d'IOPS provisionnés pour l'instance de base de données qui sera appliquée ou est actuellement appliquée.

• MultiAZ : valeur booléenne facultative de type : boolean (valeur booléenne : true ou false).

  Indique que l'instance de base de données mono-AZ doit être remplacée par un déploiement multi-AZ.

• PendingCloudwatchLogsExports : objet PendingCloudwatchLogsExports.

  Cette structure PendingCloudwatchLogsExports spécifie les modifications en attente pour lesquelles les journaux CloudWatch sont activés et qui sont désactivées.

• Port : entier facultatif de type : integer (entier signé de 32 bits).

  Spécifie le port en attente pour l'instance de base de données.

• StorageType : chaîne de type : string (chaîne encodée en UTF-8).

  Non applicable. Dans Neptune, le type de stockage est géré au niveau du cluster de bases de données.

ValidStorageOptions (structure)

Non applicable. Dans Neptune, le type de stockage est géré au niveau du cluster de bases de données.

Champs

• IopsToStorageRatio : tableau d’objets DoubleRange.

  Non applicable. Dans Neptune, le type de stockage est géré au niveau du cluster de bases de données.

• ProvisionedIops : tableau d’objets Range.

  Non applicable. Dans Neptune, le type de stockage est géré au niveau du cluster de bases de données.

• StorageSize : tableau d’objets Range.

  Non applicable. Dans Neptune, le type de stockage est géré au niveau du cluster de bases de données.

• StorageType : chaîne de type : string (chaîne encodée en UTF-8).

  Non applicable. Dans Neptune, le type de stockage est géré au niveau du cluster de bases de données.

ValidDBInstanceModificationsMessage (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’objets ValidStorageOptions.

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

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

• DescribeValidDBInstanceModifications