API pour clusters de bases de données Neptune

Actions :

• CreateDBCluster (action)

• DeleteDBCluster (action)

• ModifyDBCluster (action)

• StartDBCluster (action)

• StopDBCluster (action)

• AddRoleToDBCluster (action)

• RemoveRoleFromDBCluster (action)

• FailoverDBCluster (action)

• PromoteReadReplicaDBCluster (action)

• DescribeDBClusters (action)

Structures :

• DBCluster (structure)

• DBClusterMember (structure)

• DBClusterRole (structure)

• CloudwatchLogsExportConfiguration (structure)

• PendingCloudwatchLogsExports (structure)

• ClusterPendingModifiedValues (structure)

CreateDBCluster (action)

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

Crée un cluster de base de données Amazon Neptune.

Vous pouvez utiliser le paramètre ReplicationSourceIdentifier pour créer le cluster de base de données en tant que réplica en lecture d'un autre cluster de base de données ou d'une instance de base de données Amazon Neptune.

Notez que lorsque vous créez un nouveau cluster en utilisant CreateDBCluster directement, la protection contre la suppression est désactivée par défaut (lorsque vous créez un nouveau cluster de production dans la console, la protection contre la suppression est activée par défaut). Vous ne pouvez supprimer un cluster de base de données que si son champ DeletionProtection est défini sur false.

Demande

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

  Liste des zones de disponibilité EC2 dans lesquelles les instances du cluster de base de données peuvent être créées.

• 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. Vous devez spécifier une valeur minimale de 1.

  Par défaut : 1

  Contraintes :

  • Doit être une valeur comprise entre 1 et 35

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

  Si cette valeur est définie sur true, les balises sont copiées dans n'importe quel instantané du cluster de bases de données créé.

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

  Nom de votre base de données comprenant au maximum 64 caractères alphanumériques. Si vous ne fournissez pas de nom, Amazon Neptune ne crée pas de base de données dans le cluster de base de données que vous créez.

• 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. 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 : my-cluster1

• DBClusterParameterGroupName (dans la CLI : --db-cluster-parameter-group-name) : chaîne de type : string (chaîne encodée en UTF-8).

  Nom du groupe de paramètres de cluster DB à associer à ce cluster DB. Si cet argument est omis, la valeur par défaut est utilisée.

  Contraintes :

  • S’il est fourni, doit correspondre au nom d’un DBClusterParameterGroup existant.

• 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 à ce cluster de base de données.

  Contraintes : Doit correspondre au nom d'un groupe de sous-réseaux de base de données existant. Impossible de conserver le nom par défaut.

  Exemple : mySubnetgroup

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

  Valeur qui indique si la protection contre la suppression est activée pour le cluster de bases 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.

• 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 que ce cluster de bases de données doit exporter dans CloudWatch Logs. Les types de journaux valides sont : audit (pour publier les journaux d’audit) et slowquery (pour publier les journaux de requêtes lentes). Pour plus d'informations, consultez Publication de journaux Neptune dans Amazon CloudWatch Logs.

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

  Si cette valeur est définie sur true, active l'authentification Amazon Identity and Access Management (IAM) pour l'ensemble du cluster de bases de données (ce qui ne peut pas être défini au niveau de l'instance).

  Par défaut: false.

• 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 ce cluster de base de données.

  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 pour le nouveau cluster de bases de données.

  Exemple : 1.2.1.0

• GlobalClusterIdentifier (dans la CLI : --global-cluster-identifier) : élément GlobalClusterIdentifier de type : string (chaîne encodée en UTF-8), compris entre 1 et 255 ?st?s, correspondant à cette expression régulière : [A-Za-z][0-9A-Za-z-:._]*.

  ID de la base de données globale Neptune dans laquelle ce nouveau cluster de bases de données doit être ajouté.

• 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 un cluster de bases de données chiffré.

  L’identifiant de clé KMS est l’Amazon Resource Name (ARN) de la clé de chiffrement KMS. Si vous créez un cluster de bases de données avec le compte Amazon qui possède la clé de chiffrement KMS utilisée pour chiffrer le nouveau cluster de bases de données, vous pouvez utiliser l'alias de clé KMS au lieu de l'ARN de la clé de chiffrement KMS.

  Si aucune clé de chiffrement n'est spécifiée dans KmsKeyId :

  • Si ReplicationSourceIdentifier identifie une source chiffrée, Amazon Neptune utilise la clé de chiffrement qui a servi à chiffrer la source. Sinon, Amazon Neptune utilise votre clé de chiffrement par défaut.

  • Si le paramètre StorageEncrypted a la valeur true et que ReplicationSourceIdentifier n'est pas spécifié, Amazon Neptune utilise 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.

  Si vous créez un réplica en lecture d'un cluster de bases de données chiffré dans une autre région Amazon, vous devez définir KmsKeyId sur un ID de clé KMS qui est valide dans la région Amazon de destination. Cette clé est utilisée pour chiffrer le réplica en lecture dans cette région Amazon.

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

  Numéro de port au niveau duquel les instances du cluster de base de données acceptent les connexions.

  Par défaut : 8182

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

  Plage de temps quotidienne au cours de laquelle les sauvegardes automatiques sont créées si cette fonctionnalité est activée via le paramètre BackupRetentionPeriod.

  Par défaut, une fenêtre de 30 minutes est sélectionnée de manière aléatoire sur un bloc horaire de 8 heures pour chaque région Amazon. Pour voir les blocs horaires disponibles, consultez Fenêtre de maintenance de Neptune dans le Guide de l'utilisateur Amazon Neptune.

  Contraintes :

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

  • Doit être exprimée en heure UTC (Universal Coordinated Time).

  • 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 Universal Coordinated Time (UTC), 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. Pour voir les blocs horaires disponibles, consultez Fenêtre de maintenance de Neptune dans le Guide de l'utilisateur Amazon Neptune.

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

  Contraintes : fenêtre minimale de 30 minutes.

• PreSignedUrl (dans la CLI : --pre-signed-url) : chaîne de type : string (chaîne encodée en UTF-8).

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

• ReplicationSourceIdentifier (dans la CLI : --replication-source-identifier) : chaîne de type : string (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de l'instance de base de données ou du cluster de base de données source, si ce cluster de base de données est créé en tant que réplica en lecture.

• ServerlessV2ScalingConfiguration (dans la CLI : --serverless-v2-scaling-configuration) : objet ServerlessV2ScalingConfiguration.

  Contient la configuration de mise à l'échelle d'un cluster de bases de données Neptune sans serveur.

  Pour plus d'informations, consultez Utilisation d'Amazon Neptune sans serveur dans le Guide de l'utilisateur Amazon Neptune.

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

  Indique si le cluster de base de données est chiffré.

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

  Type de stockage pour le cluster de bases de données.

  Valeurs valides :

  • standard : (valeur par défaut) configure un stockage de base de données rentable pour les applications dont l’utilisation des E/S est modérée à faible. Lorsqu’il est défini sur standard, le type de stockage n’est pas renvoyé dans la réponse.

  • iopt1 : permet un stockage optimisé pour les E/S qui est conçu pour satisfaire les besoins des charges de travail de graphe gourmandes en E/S qui requièrent une tarification prévisible avec une faible latence des E/S et un débit d’E/S homogène.

    Le stockage optimisé pour les E/S Neptune n’est disponible qu’à partir de la version 1.3.0.0 du moteur.

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

  Balises à affecter au nouveau cluster 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 à ce cluster de base de données.

Réponse

Contient les détails d’un cluster de bases de données Amazon Neptune.

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

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

  AllocatedStorage renvoie toujours la valeur 1, car la taille de stockage d’un cluster de bases de données Neptune n’est pas fixe ; elle s’ajuste automatiquement en fonction des besoins.

• AssociatedRoles : tableau d’objets DBClusterRole.

  Fournit la liste des rôles Amazon Identity and Access Management (IAM) associés au cluster de bases de données. Les rôles IAM associés à un cluster de bases de données autorisent celui-ci à accéder aux autres services Amazon en votre nom.

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

  Heure à laquelle le cluster de bases de données sera automatiquement redémarré.

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

  Fournit la liste des zones de disponibilité EC2 dans lesquelles les instances du cluster de bases de données peuvent être créées.

• BacktrackConsumedChangeRecords : long facultatif de type : long (entier signé de 64 bits).

  Non pris en charge par Neptune.

• BacktrackWindow : long facultatif de type : long (entier signé de 64 bits).

  Non pris en charge par Neptune.

• BackupRetentionPeriod : entier facultatif 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.

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

  Non pris en charge par Neptune.

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

  Identifie le groupe de clones auquel est associé le cluster de bases de données.

• ClusterCreateTime : 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 l’heure à laquelle le cluster de bases de données a été créé, en heure UTC (Universal Coordinated Time).

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

  Si cette valeur est définie sur true, les balises sont copiées dans n'importe quel instantané du cluster de bases de données créé.

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

  Si cette valeur est définie sur true, le cluster de bases de données peut être cloné sur plusieurs comptes.

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

  Contient le nom de la base de données initiale de ce cluster de bases de données qui a été fourni au moment de la création, dans la mesure où un nom a été spécifié au moment de créer le cluster de bases de données. Ce même nom est renvoyé pendant la durée de vie du cluster de bases de données.

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

  Amazon Resource Name (ARN) du cluster de bases de données.

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

  Contient un identifiant de cluster de bases de données fourni par l’utilisateur. Cet identifiant est la clé unique qui identifie un cluster de bases de données.

• DBClusterMembers : tableau d’objets DBClusterMember.

  Fournit la liste des instances qui composent le cluster de bases de données.

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

  Spécifie le nom du groupe de paramètres de cluster de base de données pour le cluster de base de données.

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

  Identifiant immuable et propre à la région Amazon du cluster de bases de données. Cet identifiant se trouve dans les entrées du journal Amazon CloudTrail chaque fois que la clé Amazon KMS du cluster de bases de données fait l'objet d'un accès.

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

  Spécifie les informations sur le groupe de sous-réseaux associé au cluster de bases de données, notamment 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 est activée pour le cluster de bases de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée.

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

  Non pris en charge par Neptune.

• EarliestRestorableTime : 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 première heure à laquelle une base de données peut être restaurée avec une restauration à un moment donné.

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

  Liste des types de journaux pour lesquels ce cluster de bases de données est configuré et qui sont exportés vers CloudWatch Logs. Les types de journaux valides sont les suivants : audit (pour publier les journaux d'audit sur CloudWatch) et slowquery (pour publier les journaux de requêtes lentes sur CloudWatch). Pour plus d'informations, consultez Publication de journaux Neptune dans Amazon CloudWatch Logs.

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

  Spécifie le point de terminaison de connexion pour l’instance principale du cluster de bases de données.

• 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 ce cluster de bases 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.

• GlobalClusterIdentifier : identifiant de cluster global de type : string (chaîne encodée en UTF-8), compris entre 1 et 255 ?st?s, correspondant à cette expression régulière : [A-Za-z][0-9A-Za-z-:._]*.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.

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

  Spécifie l’ID attribué par Amazon Route 53 lorsque vous créez une zone hébergée.

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

  Valeur true (vrai) si le mappage des comptes Amazon Identity and Access Management (IAM) aux comptes de base de données est activé ; sinon, valeur false (faux).

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

  La prochaine fois, vous pourrez modifier le cluster de bases de données de façon à utiliser le type de stockage iopt1.

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

  Si StorageEncrypted a la valeur true (vrai), identifiant de clé Amazon KMS pour le cluster de bases de données chiffré.

• 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é.

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

  Indique si le cluster de bases de données possède des instances dans plusieurs zones de disponibilité.

• PendingModifiedValues : objet ClusterPendingModifiedValues.

  Ce type de données est utilisé comme élément de réponse dans l’opération ModifyDBCluster et contient les modifications qui seront appliquées lors de la fenêtre de maintenance suivante.

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

  Spécifie la progression de l’opération sous forme de pourcentage.

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

  Spécifie le port sur lequel le moteur de base de données est à l’écoute.

• 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.

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

  Point de terminaison du lecteur pour le cluster de bases de données. Le point de terminaison du lecteur d'un cluster de bases de données équilibre la charge des connexions entre les réplicas en lecture qui sont disponibles dans un cluster de bases de données. À mesure que les clients demandent de nouvelles connexions au point de terminaison du lecteur, Neptune répartit les demandes de connexion entre les réplicas en lecture du cluster de bases de données. Cette fonctionnalité peut contribuer à équilibrer votre charge de travail entre les différents réplicas en lecture de votre cluster de bases de données.

  Si un basculement se produit et que le réplica en lecture auquel vous êtes connecté est promu en instance principale, votre connexion est supprimée. Pour continuer à envoyer votre charge de travail de lecture à d’autres réplicas en lecture du cluster, vous pouvez alors vous reconnecter au point de terminaison du lecteur.

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

  Contient un ou plusieurs identifiants des réplicas en lecture associés à ce cluster de bases de données.

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

  Non pris en charge par Neptune.

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

  Non pris en charge par Neptune.

• ServerlessV2ScalingConfiguration : objet ServerlessV2ScalingConfigurationInfo.

  Affiche la configuration de mise à l'échelle pour un cluster de bases de données Neptune sans serveur.

  Pour plus d'informations, consultez Utilisation d'Amazon Neptune sans serveur dans le Guide de l'utilisateur Amazon Neptune.

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

  Spécifie l’état actuel de ce cluster de base de données.

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

  Indique si le cluster de base de données est chiffré.

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

  Type de stockage utilisé par le cluster de bases de données.

  Valeurs valides :

  • standard : (valeur par défaut) fournit un stockage de base de données économique pour les applications dont l’utilisation des E/S est modérée à faible.

  • iopt1 : permet un stockage optimisé pour les E/S qui est conçu pour satisfaire les besoins des charges de travail de graphe gourmandes en E/S qui requièrent une tarification prévisible avec une faible latence des E/S et un débit d’E/S homogène.

    Le stockage optimisé pour les E/S Neptune n’est disponible qu’à partir de la version 1.3.0.0 du moteur.

• VpcSecurityGroups : tableau d’objets VpcSecurityGroupMembership.

  Fournit la liste des groupes de sécurité VPC auxquels appartient le cluster de base de données.

Erreurs

• DBClusterAlreadyExistsFault

• InsufficientStorageClusterCapacityFault

• DBClusterQuotaExceededFault

• StorageQuotaExceededFault

• DBSubnetGroupNotFoundFault

• InvalidVPCNetworkStateFault

• InvalidDBClusterStateFault

• InvalidDBSubnetGroupStateFault

• InvalidSubnet

• InvalidDBInstanceStateFault

• DBClusterParameterGroupNotFoundFault

• KMSKeyNotAccessibleFault

• DBClusterNotFoundFault

• DBInstanceNotFoundFault

• DBSubnetGroupDoesNotCoverEnoughAZs

• GlobalClusterNotFoundFault

• InvalidGlobalClusterStateFault

DeleteDBCluster (action)

        Le nom AWS CLI de cette API est : delete-db-cluster.

L'action DeleteDBCluster supprime un cluster de base de données alloué précédemment. Quand vous supprimez un cluster de base de données, toutes les sauvegardes automatiques de ce cluster de base de données sont supprimées et ne peuvent pas être récupérées. Les instantanés manuels du cluster de base de données spécifié ne sont pas supprimés.

Notez que le cluster de base de données ne peut pas être supprimé si la protection contre la suppression est activée. Pour le supprimer, vous devez d'abord définir son champ DeletionProtection sur False.

Demande

• DBClusterIdentifier (dans la CLI : --db-cluster-identifier) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

  Identifiant du cluster de base de données à supprimer. Ce paramètre n’est pas sensible à la casse.

  Contraintes :

  • Doit correspondre à un DBClusterIdentifier existant.

• FinalDBSnapshotIdentifier (dans la CLI : --final-db-snapshot-identifier) : chaîne de type : string (chaîne encodée en UTF-8).

  Identifiant du nouvel instantané de cluster de base de données créé lorsque SkipFinalSnapshot a la valeur 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, 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

• 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 cluster de base de données final est créé avant la suppression du cluster de base de données. Si true est spécifié, aucun instantané de cluster de base de données n'est créé. Si false est spécifié, un instantané de cluster de base de données est créé avant la suppression du cluster de base de données.

  Note

  Vous devez spécifier un paramètre FinalDBSnapshotIdentifier si SkipFinalSnapshot a la valeur false.

  Par défaut : false

Réponse

Contient les détails d’un cluster de bases de données Amazon Neptune.

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

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

  AllocatedStorage renvoie toujours la valeur 1, car la taille de stockage d’un cluster de bases de données Neptune n’est pas fixe ; elle s’ajuste automatiquement en fonction des besoins.

• AssociatedRoles : tableau d’objets DBClusterRole.

  Fournit la liste des rôles Amazon Identity and Access Management (IAM) associés au cluster de bases de données. Les rôles IAM associés à un cluster de bases de données autorisent celui-ci à accéder aux autres services Amazon en votre nom.

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

  Heure à laquelle le cluster de bases de données sera automatiquement redémarré.

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

  Fournit la liste des zones de disponibilité EC2 dans lesquelles les instances du cluster de bases de données peuvent être créées.

• BacktrackConsumedChangeRecords : long facultatif de type : long (entier signé de 64 bits).

  Non pris en charge par Neptune.

• BacktrackWindow : long facultatif de type : long (entier signé de 64 bits).

  Non pris en charge par Neptune.

• BackupRetentionPeriod : entier facultatif 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.

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

  Non pris en charge par Neptune.

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

  Identifie le groupe de clones auquel est associé le cluster de bases de données.

• ClusterCreateTime : 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 l’heure à laquelle le cluster de bases de données a été créé, en heure UTC (Universal Coordinated Time).

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

  Si cette valeur est définie sur true, les balises sont copiées dans n'importe quel instantané du cluster de bases de données créé.

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

  Si cette valeur est définie sur true, le cluster de bases de données peut être cloné sur plusieurs comptes.

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

  Contient le nom de la base de données initiale de ce cluster de bases de données qui a été fourni au moment de la création, dans la mesure où un nom a été spécifié au moment de créer le cluster de bases de données. Ce même nom est renvoyé pendant la durée de vie du cluster de bases de données.

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

  Amazon Resource Name (ARN) du cluster de bases de données.

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

  Contient un identifiant de cluster de bases de données fourni par l’utilisateur. Cet identifiant est la clé unique qui identifie un cluster de bases de données.

• DBClusterMembers : tableau d’objets DBClusterMember.

  Fournit la liste des instances qui composent le cluster de bases de données.

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

  Spécifie le nom du groupe de paramètres de cluster de base de données pour le cluster de base de données.

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

  Identifiant immuable et propre à la région Amazon du cluster de bases de données. Cet identifiant se trouve dans les entrées du journal Amazon CloudTrail chaque fois que la clé Amazon KMS du cluster de bases de données fait l'objet d'un accès.

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

  Spécifie les informations sur le groupe de sous-réseaux associé au cluster de bases de données, notamment 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 est activée pour le cluster de bases de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée.

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

  Non pris en charge par Neptune.

• EarliestRestorableTime : 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 première heure à laquelle une base de données peut être restaurée avec une restauration à un moment donné.

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

  Liste des types de journaux pour lesquels ce cluster de bases de données est configuré et qui sont exportés vers CloudWatch Logs. Les types de journaux valides sont les suivants : audit (pour publier les journaux d'audit sur CloudWatch) et slowquery (pour publier les journaux de requêtes lentes sur CloudWatch). Pour plus d'informations, consultez Publication de journaux Neptune dans Amazon CloudWatch Logs.

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

  Spécifie le point de terminaison de connexion pour l’instance principale du cluster de bases de données.

• 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 ce cluster de bases 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.

• GlobalClusterIdentifier : identifiant de cluster global de type : string (chaîne encodée en UTF-8), compris entre 1 et 255 ?st?s, correspondant à cette expression régulière : [A-Za-z][0-9A-Za-z-:._]*.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.

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

  Spécifie l’ID attribué par Amazon Route 53 lorsque vous créez une zone hébergée.

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

  Valeur true (vrai) si le mappage des comptes Amazon Identity and Access Management (IAM) aux comptes de base de données est activé ; sinon, valeur false (faux).

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

  La prochaine fois, vous pourrez modifier le cluster de bases de données de façon à utiliser le type de stockage iopt1.

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

  Si StorageEncrypted a la valeur true (vrai), identifiant de clé Amazon KMS pour le cluster de bases de données chiffré.

• 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é.

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

  Indique si le cluster de bases de données possède des instances dans plusieurs zones de disponibilité.

• PendingModifiedValues : objet ClusterPendingModifiedValues.

  Ce type de données est utilisé comme élément de réponse dans l’opération ModifyDBCluster et contient les modifications qui seront appliquées lors de la fenêtre de maintenance suivante.

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

  Spécifie la progression de l’opération sous forme de pourcentage.

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

  Spécifie le port sur lequel le moteur de base de données est à l’écoute.

• 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.

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

  Point de terminaison du lecteur pour le cluster de bases de données. Le point de terminaison du lecteur d'un cluster de bases de données équilibre la charge des connexions entre les réplicas en lecture qui sont disponibles dans un cluster de bases de données. À mesure que les clients demandent de nouvelles connexions au point de terminaison du lecteur, Neptune répartit les demandes de connexion entre les réplicas en lecture du cluster de bases de données. Cette fonctionnalité peut contribuer à équilibrer votre charge de travail entre les différents réplicas en lecture de votre cluster de bases de données.

  Si un basculement se produit et que le réplica en lecture auquel vous êtes connecté est promu en instance principale, votre connexion est supprimée. Pour continuer à envoyer votre charge de travail de lecture à d’autres réplicas en lecture du cluster, vous pouvez alors vous reconnecter au point de terminaison du lecteur.

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

  Contient un ou plusieurs identifiants des réplicas en lecture associés à ce cluster de bases de données.

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

  Non pris en charge par Neptune.

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

  Non pris en charge par Neptune.

• ServerlessV2ScalingConfiguration : objet ServerlessV2ScalingConfigurationInfo.

  Affiche la configuration de mise à l'échelle pour un cluster de bases de données Neptune sans serveur.

  Pour plus d'informations, consultez Utilisation d'Amazon Neptune sans serveur dans le Guide de l'utilisateur Amazon Neptune.

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

  Spécifie l’état actuel de ce cluster de base de données.

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

  Indique si le cluster de base de données est chiffré.

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

  Type de stockage utilisé par le cluster de bases de données.

  Valeurs valides :

  • standard : (valeur par défaut) fournit un stockage de base de données économique pour les applications dont l’utilisation des E/S est modérée à faible.

  • iopt1 : permet un stockage optimisé pour les E/S qui est conçu pour satisfaire les besoins des charges de travail de graphe gourmandes en E/S qui requièrent une tarification prévisible avec une faible latence des E/S et un débit d’E/S homogène.

    Le stockage optimisé pour les E/S Neptune n’est disponible qu’à partir de la version 1.3.0.0 du moteur.

• VpcSecurityGroups : tableau d’objets VpcSecurityGroupMembership.

  Fournit la liste des groupes de sécurité VPC auxquels appartient le cluster de base de données.

Erreurs

• DBClusterNotFoundFault

• InvalidDBClusterStateFault

• DBClusterSnapshotAlreadyExistsFault

• SnapshotQuotaExceededFault

• InvalidDBClusterSnapshotStateFault

ModifyDBCluster (action)

        Le nom AWS CLI de cette API est : modify-db-cluster.

Permet de modifier un paramètre de cluster 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.

Demande

• AllowMajorVersionUpgrade (dans la CLI : --allow-major-version-upgrade) : valeur booléenne de type : boolean (valeur booléenne : true ou false).

  Valeur qui indique si les mises à niveau entre différentes version majeures sont autorisées.

  Contraintes : vous devez définir l'indicateur allow-major-version-upgrade lorsque vous fournissez un paramètre EngineVersion utilisant une version majeure différente de la version actuelle du cluster de bases de données.

• ApplyImmediately (dans la CLI : --apply-immediately) : valeur booléenne de type : boolean (valeur booléenne : true ou false).

  Valeur qui indique si les modifications au niveau de cette demande et toutes les modifications en attente sont appliquées de manière asynchrone dès que possible, indépendamment du paramètre PreferredMaintenanceWindow du cluster de base de données. Si ce paramètre a la valeur false, les modifications apportées au cluster de base de données sont appliquées pendant la fenêtre de maintenance suivante.

  Le paramètre ApplyImmediately affecte uniquement les valeurs NewDBClusterIdentifier. Si vous définissez la valeur du paramètre ApplyImmediately sur false, les modifications apportées à la valeur NewDBClusterIdentifier seront appliquées pendant la fenêtre de maintenance suivante. Toutes les autres modifications sont appliquées immédiatement, quelle que soit la valeur du paramètre ApplyImmediately.

  Par défaut : false

• 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. Vous devez spécifier une valeur minimale de 1.

  Par défaut : 1

  Contraintes :

  • Doit être une valeur comprise entre 1 et 35

• 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 un cluster de base de données spécifique. Consultez la section Utilisation de l'interface de ligne de commande pour publier les journaux d'audit Neptune dans CloudWatch Logs.

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

  Si cette valeur est définie sur true, les balises sont copiées dans n'importe quel instantané du cluster de bases de données créé.

• 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 en cours de modification. Ce paramètre n’est pas sensible à la casse.

  Contraintes :

  • Doit correspondre à l’identifiant d’un cluster de bases de données existant.

• DBClusterParameterGroupName (dans la CLI : --db-cluster-parameter-group-name) : chaîne de type : string (chaîne encodée en UTF-8).

  Nom du groupe de paramètres de cluster de base de données à utiliser pour le cluster de base de données.

• DBInstanceParameterGroupName (dans la CLI : --db-instance-parameter-group-name) : chaîne de type : string (chaîne encodée en UTF-8).

  Le nom du groupe de paramètres de base de données à appliquer à toutes les instances du cluster de base de données.

  Note

  Lorsque vous appliquez un groupe de paramètres à l'aide de DBInstanceParameterGroupName, les modifications de paramètres ne seront pas appliquées lors de la fenêtre de maintenance suivante. Elles sont effectives immédiatement.

  Par défaut : le paramètre de nom existant

  Contraintes :

  • Le groupe de paramètres de la base de données doit faire partie de la même famille de groupes de paramètres de la base de données que la version de ce cluster de bases de données cible.

  • Le paramètre DBInstanceParameterGroupName n'est valide qu'en combinaison avec le paramètre AllowMajorVersionUpgrade.

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

  Valeur qui indique si la protection contre la suppression est activée pour le cluster de bases 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.

• 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.

  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 vous souhaitez effectuer la mise à niveau. La modification de ce paramètre entraîne une interruption. La modification est appliquée pendant la fenêtre de maintenance suivante, sauf si le paramètre ApplyImmediately a la valeur true.

  Pour obtenir la liste des versions de moteur valides, consultez Versions du moteur pour Amazon Neptune, ou appelez DescribeDBEngineVersions (action).

• NewDBClusterIdentifier (dans la CLI : --new-db-cluster-identifier) : chaîne de type : string (chaîne encodée en UTF-8).

  Nouvel identifiant du cluster de base de données lorsque celui-ci est renommé. 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 : my-cluster2

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

  Le numéro de port sur lequel le cluster DB accepte des connexions.

  Contraintes : La valeur doit être comprise dans la plage 1150-65535

  Valeur par défaut : port du cluster de bases de données d’origine.

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

  Plage de temps quotidienne au cours de laquelle les sauvegardes automatiques sont créées si cette fonctionnalité est activée via le paramètre BackupRetentionPeriod.

  Par défaut, une fenêtre de 30 minutes est sélectionnée de manière aléatoire sur un bloc horaire de 8 heures pour chaque région Amazon.

  Contraintes :

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

  • Doit être exprimée en heure UTC (Universal Coordinated Time).

  • 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 Universal Coordinated Time (UTC), 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.

• ServerlessV2ScalingConfiguration (dans la CLI : --serverless-v2-scaling-configuration) : objet ServerlessV2ScalingConfiguration.

  Contient la configuration de mise à l'échelle d'un cluster de bases de données Neptune sans serveur.

  Pour plus d'informations, consultez Utilisation d'Amazon Neptune sans serveur dans le Guide de l'utilisateur Amazon Neptune.

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

  Type de stockage à associer au cluster de base de données.

  Valeurs valides :

  • standard : (valeur par défaut) configure un stockage de base de données rentable pour les applications dont l’utilisation des E/S est modérée à faible.

  • iopt1 : permet un stockage optimisé pour les E/S qui est conçu pour satisfaire les besoins des charges de travail de graphe gourmandes en E/S qui requièrent une tarification prévisible avec une faible latence des E/S et un débit d’E/S homogène.

    Le stockage optimisé pour les E/S Neptune n’est disponible qu’à partir de la version 1.3.0.0 du moteur.

• 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 auxquels le cluster de base de données appartiendra.

Réponse

Contient les détails d’un cluster de bases de données Amazon Neptune.

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

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

  AllocatedStorage renvoie toujours la valeur 1, car la taille de stockage d’un cluster de bases de données Neptune n’est pas fixe ; elle s’ajuste automatiquement en fonction des besoins.

• AssociatedRoles : tableau d’objets DBClusterRole.

  Fournit la liste des rôles Amazon Identity and Access Management (IAM) associés au cluster de bases de données. Les rôles IAM associés à un cluster de bases de données autorisent celui-ci à accéder aux autres services Amazon en votre nom.

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

  Heure à laquelle le cluster de bases de données sera automatiquement redémarré.

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

  Fournit la liste des zones de disponibilité EC2 dans lesquelles les instances du cluster de bases de données peuvent être créées.

• BacktrackConsumedChangeRecords : long facultatif de type : long (entier signé de 64 bits).

  Non pris en charge par Neptune.

• BacktrackWindow : long facultatif de type : long (entier signé de 64 bits).

  Non pris en charge par Neptune.

• BackupRetentionPeriod : entier facultatif 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.

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

  Non pris en charge par Neptune.

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

  Identifie le groupe de clones auquel est associé le cluster de bases de données.

• ClusterCreateTime : 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 l’heure à laquelle le cluster de bases de données a été créé, en heure UTC (Universal Coordinated Time).

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

  Si cette valeur est définie sur true, les balises sont copiées dans n'importe quel instantané du cluster de bases de données créé.

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

  Si cette valeur est définie sur true, le cluster de bases de données peut être cloné sur plusieurs comptes.

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

  Contient le nom de la base de données initiale de ce cluster de bases de données qui a été fourni au moment de la création, dans la mesure où un nom a été spécifié au moment de créer le cluster de bases de données. Ce même nom est renvoyé pendant la durée de vie du cluster de bases de données.

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

  Amazon Resource Name (ARN) du cluster de bases de données.

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

  Contient un identifiant de cluster de bases de données fourni par l’utilisateur. Cet identifiant est la clé unique qui identifie un cluster de bases de données.

• DBClusterMembers : tableau d’objets DBClusterMember.

  Fournit la liste des instances qui composent le cluster de bases de données.

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

  Spécifie le nom du groupe de paramètres de cluster de base de données pour le cluster de base de données.

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

  Identifiant immuable et propre à la région Amazon du cluster de bases de données. Cet identifiant se trouve dans les entrées du journal Amazon CloudTrail chaque fois que la clé Amazon KMS du cluster de bases de données fait l'objet d'un accès.

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

  Spécifie les informations sur le groupe de sous-réseaux associé au cluster de bases de données, notamment 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 est activée pour le cluster de bases de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée.

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

  Non pris en charge par Neptune.

• EarliestRestorableTime : 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 première heure à laquelle une base de données peut être restaurée avec une restauration à un moment donné.

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

  Liste des types de journaux pour lesquels ce cluster de bases de données est configuré et qui sont exportés vers CloudWatch Logs. Les types de journaux valides sont les suivants : audit (pour publier les journaux d'audit sur CloudWatch) et slowquery (pour publier les journaux de requêtes lentes sur CloudWatch). Pour plus d'informations, consultez Publication de journaux Neptune dans Amazon CloudWatch Logs.

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

  Spécifie le point de terminaison de connexion pour l’instance principale du cluster de bases de données.

• 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 ce cluster de bases 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.

• GlobalClusterIdentifier : identifiant de cluster global de type : string (chaîne encodée en UTF-8), compris entre 1 et 255 ?st?s, correspondant à cette expression régulière : [A-Za-z][0-9A-Za-z-:._]*.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.

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

  Spécifie l’ID attribué par Amazon Route 53 lorsque vous créez une zone hébergée.

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

  Valeur true (vrai) si le mappage des comptes Amazon Identity and Access Management (IAM) aux comptes de base de données est activé ; sinon, valeur false (faux).

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

  La prochaine fois, vous pourrez modifier le cluster de bases de données de façon à utiliser le type de stockage iopt1.

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

  Si StorageEncrypted a la valeur true (vrai), identifiant de clé Amazon KMS pour le cluster de bases de données chiffré.

• 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é.

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

  Indique si le cluster de bases de données possède des instances dans plusieurs zones de disponibilité.

• PendingModifiedValues : objet ClusterPendingModifiedValues.

  Ce type de données est utilisé comme élément de réponse dans l’opération ModifyDBCluster et contient les modifications qui seront appliquées lors de la fenêtre de maintenance suivante.

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

  Spécifie la progression de l’opération sous forme de pourcentage.

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

  Spécifie le port sur lequel le moteur de base de données est à l’écoute.

• 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.

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

  Point de terminaison du lecteur pour le cluster de bases de données. Le point de terminaison du lecteur d'un cluster de bases de données équilibre la charge des connexions entre les réplicas en lecture qui sont disponibles dans un cluster de bases de données. À mesure que les clients demandent de nouvelles connexions au point de terminaison du lecteur, Neptune répartit les demandes de connexion entre les réplicas en lecture du cluster de bases de données. Cette fonctionnalité peut contribuer à équilibrer votre charge de travail entre les différents réplicas en lecture de votre cluster de bases de données.

  Si un basculement se produit et que le réplica en lecture auquel vous êtes connecté est promu en instance principale, votre connexion est supprimée. Pour continuer à envoyer votre charge de travail de lecture à d’autres réplicas en lecture du cluster, vous pouvez alors vous reconnecter au point de terminaison du lecteur.

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

  Contient un ou plusieurs identifiants des réplicas en lecture associés à ce cluster de bases de données.

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

  Non pris en charge par Neptune.

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

  Non pris en charge par Neptune.

• ServerlessV2ScalingConfiguration : objet ServerlessV2ScalingConfigurationInfo.

  Affiche la configuration de mise à l'échelle pour un cluster de bases de données Neptune sans serveur.

  Pour plus d'informations, consultez Utilisation d'Amazon Neptune sans serveur dans le Guide de l'utilisateur Amazon Neptune.

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

  Spécifie l’état actuel de ce cluster de base de données.

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

  Indique si le cluster de base de données est chiffré.

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

  Type de stockage utilisé par le cluster de bases de données.

  Valeurs valides :

  • standard : (valeur par défaut) fournit un stockage de base de données économique pour les applications dont l’utilisation des E/S est modérée à faible.

  • iopt1 : permet un stockage optimisé pour les E/S qui est conçu pour satisfaire les besoins des charges de travail de graphe gourmandes en E/S qui requièrent une tarification prévisible avec une faible latence des E/S et un débit d’E/S homogène.

    Le stockage optimisé pour les E/S Neptune n’est disponible qu’à partir de la version 1.3.0.0 du moteur.

• VpcSecurityGroups : tableau d’objets VpcSecurityGroupMembership.

  Fournit la liste des groupes de sécurité VPC auxquels appartient le cluster de base de données.

Erreurs

• DBClusterNotFoundFault

• InvalidDBClusterStateFault

• StorageQuotaExceededFault

• DBSubnetGroupNotFoundFault

• InvalidVPCNetworkStateFault

• InvalidDBSubnetGroupStateFault

• InvalidSubnet

• DBClusterParameterGroupNotFoundFault

• InvalidDBSecurityGroupStateFault

• InvalidDBInstanceStateFault

• DBClusterAlreadyExistsFault

• StorageTypeNotSupportedFault

StartDBCluster (action)

        Le nom AWS CLI de cette API est : start-db-cluster.

Démarre un cluster de bases de données Amazon Neptune arrêté à l'aide de la console AWS, de la commande Amazon CLI stop-db-cluster ou de l'API StopDBCluster.

Demande

• DBClusterIdentifier (dans la CLI : --db-cluster-identifier) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

  Identifiant du cluster de base de données Neptune à démarrer. Ce paramètre est stocké sous la forme d’une chaîne en lettres minuscules.

Réponse

Contient les détails d’un cluster de bases de données Amazon Neptune.

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

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

  AllocatedStorage renvoie toujours la valeur 1, car la taille de stockage d’un cluster de bases de données Neptune n’est pas fixe ; elle s’ajuste automatiquement en fonction des besoins.

• AssociatedRoles : tableau d’objets DBClusterRole.

  Fournit la liste des rôles Amazon Identity and Access Management (IAM) associés au cluster de bases de données. Les rôles IAM associés à un cluster de bases de données autorisent celui-ci à accéder aux autres services Amazon en votre nom.

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

  Heure à laquelle le cluster de bases de données sera automatiquement redémarré.

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

  Fournit la liste des zones de disponibilité EC2 dans lesquelles les instances du cluster de bases de données peuvent être créées.

• BacktrackConsumedChangeRecords : long facultatif de type : long (entier signé de 64 bits).

  Non pris en charge par Neptune.

• BacktrackWindow : long facultatif de type : long (entier signé de 64 bits).

  Non pris en charge par Neptune.

• BackupRetentionPeriod : entier facultatif 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.

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

  Non pris en charge par Neptune.

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

  Identifie le groupe de clones auquel est associé le cluster de bases de données.

• ClusterCreateTime : 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 l’heure à laquelle le cluster de bases de données a été créé, en heure UTC (Universal Coordinated Time).

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

  Si cette valeur est définie sur true, les balises sont copiées dans n'importe quel instantané du cluster de bases de données créé.

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

  Si cette valeur est définie sur true, le cluster de bases de données peut être cloné sur plusieurs comptes.

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

  Contient le nom de la base de données initiale de ce cluster de bases de données qui a été fourni au moment de la création, dans la mesure où un nom a été spécifié au moment de créer le cluster de bases de données. Ce même nom est renvoyé pendant la durée de vie du cluster de bases de données.

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

  Amazon Resource Name (ARN) du cluster de bases de données.

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

  Contient un identifiant de cluster de bases de données fourni par l’utilisateur. Cet identifiant est la clé unique qui identifie un cluster de bases de données.

• DBClusterMembers : tableau d’objets DBClusterMember.

  Fournit la liste des instances qui composent le cluster de bases de données.

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

  Spécifie le nom du groupe de paramètres de cluster de base de données pour le cluster de base de données.

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

  Identifiant immuable et propre à la région Amazon du cluster de bases de données. Cet identifiant se trouve dans les entrées du journal Amazon CloudTrail chaque fois que la clé Amazon KMS du cluster de bases de données fait l'objet d'un accès.

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

  Spécifie les informations sur le groupe de sous-réseaux associé au cluster de bases de données, notamment 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 est activée pour le cluster de bases de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée.

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

  Non pris en charge par Neptune.

• EarliestRestorableTime : 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 première heure à laquelle une base de données peut être restaurée avec une restauration à un moment donné.

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

  Liste des types de journaux pour lesquels ce cluster de bases de données est configuré et qui sont exportés vers CloudWatch Logs. Les types de journaux valides sont les suivants : audit (pour publier les journaux d'audit sur CloudWatch) et slowquery (pour publier les journaux de requêtes lentes sur CloudWatch). Pour plus d'informations, consultez Publication de journaux Neptune dans Amazon CloudWatch Logs.

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

  Spécifie le point de terminaison de connexion pour l’instance principale du cluster de bases de données.

• 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 ce cluster de bases 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.

• GlobalClusterIdentifier : identifiant de cluster global de type : string (chaîne encodée en UTF-8), compris entre 1 et 255 ?st?s, correspondant à cette expression régulière : [A-Za-z][0-9A-Za-z-:._]*.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.

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

  Spécifie l’ID attribué par Amazon Route 53 lorsque vous créez une zone hébergée.

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

  Valeur true (vrai) si le mappage des comptes Amazon Identity and Access Management (IAM) aux comptes de base de données est activé ; sinon, valeur false (faux).

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

  La prochaine fois, vous pourrez modifier le cluster de bases de données de façon à utiliser le type de stockage iopt1.

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

  Si StorageEncrypted a la valeur true (vrai), identifiant de clé Amazon KMS pour le cluster de bases de données chiffré.

• 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é.

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

  Indique si le cluster de bases de données possède des instances dans plusieurs zones de disponibilité.

• PendingModifiedValues : objet ClusterPendingModifiedValues.

  Ce type de données est utilisé comme élément de réponse dans l’opération ModifyDBCluster et contient les modifications qui seront appliquées lors de la fenêtre de maintenance suivante.

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

  Spécifie la progression de l’opération sous forme de pourcentage.

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

  Spécifie le port sur lequel le moteur de base de données est à l’écoute.

• 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.

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

  Point de terminaison du lecteur pour le cluster de bases de données. Le point de terminaison du lecteur d'un cluster de bases de données équilibre la charge des connexions entre les réplicas en lecture qui sont disponibles dans un cluster de bases de données. À mesure que les clients demandent de nouvelles connexions au point de terminaison du lecteur, Neptune répartit les demandes de connexion entre les réplicas en lecture du cluster de bases de données. Cette fonctionnalité peut contribuer à équilibrer votre charge de travail entre les différents réplicas en lecture de votre cluster de bases de données.

  Si un basculement se produit et que le réplica en lecture auquel vous êtes connecté est promu en instance principale, votre connexion est supprimée. Pour continuer à envoyer votre charge de travail de lecture à d’autres réplicas en lecture du cluster, vous pouvez alors vous reconnecter au point de terminaison du lecteur.

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

  Contient un ou plusieurs identifiants des réplicas en lecture associés à ce cluster de bases de données.

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

  Non pris en charge par Neptune.

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

  Non pris en charge par Neptune.

• ServerlessV2ScalingConfiguration : objet ServerlessV2ScalingConfigurationInfo.

  Affiche la configuration de mise à l'échelle pour un cluster de bases de données Neptune sans serveur.

  Pour plus d'informations, consultez Utilisation d'Amazon Neptune sans serveur dans le Guide de l'utilisateur Amazon Neptune.

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

  Spécifie l’état actuel de ce cluster de base de données.

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

  Indique si le cluster de base de données est chiffré.

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

  Type de stockage utilisé par le cluster de bases de données.

  Valeurs valides :

  • standard : (valeur par défaut) fournit un stockage de base de données économique pour les applications dont l’utilisation des E/S est modérée à faible.

  • iopt1 : permet un stockage optimisé pour les E/S qui est conçu pour satisfaire les besoins des charges de travail de graphe gourmandes en E/S qui requièrent une tarification prévisible avec une faible latence des E/S et un débit d’E/S homogène.

    Le stockage optimisé pour les E/S Neptune n’est disponible qu’à partir de la version 1.3.0.0 du moteur.

• VpcSecurityGroups : tableau d’objets VpcSecurityGroupMembership.

  Fournit la liste des groupes de sécurité VPC auxquels appartient le cluster de base de données.

Erreurs

• DBClusterNotFoundFault

• InvalidDBClusterStateFault

• InvalidDBInstanceStateFault

StopDBCluster (action)

        Le nom AWS CLI de cette API est : stop-db-cluster.

Arrête un cluster de base de données Amazon Neptune. Lorsque vous arrêtez un cluster de base de données, Neptune conserve les métadonnées du cluster de base de données, y compris ses points de terminaison et ses groupes de paramètres de base de données.

Neptune conserve également les journaux de transactions afin que vous puissiez effectuer une restauration ponctuelle si nécessaire.

Demande

• DBClusterIdentifier (dans la CLI : --db-cluster-identifier) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

  Identifiant de cluster de base de données Neptune à arrêter. Ce paramètre est stocké sous la forme d’une chaîne en lettres minuscules.

Réponse

Contient les détails d’un cluster de bases de données Amazon Neptune.

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

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

  AllocatedStorage renvoie toujours la valeur 1, car la taille de stockage d’un cluster de bases de données Neptune n’est pas fixe ; elle s’ajuste automatiquement en fonction des besoins.

• AssociatedRoles : tableau d’objets DBClusterRole.

  Fournit la liste des rôles Amazon Identity and Access Management (IAM) associés au cluster de bases de données. Les rôles IAM associés à un cluster de bases de données autorisent celui-ci à accéder aux autres services Amazon en votre nom.

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

  Heure à laquelle le cluster de bases de données sera automatiquement redémarré.

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

  Fournit la liste des zones de disponibilité EC2 dans lesquelles les instances du cluster de bases de données peuvent être créées.

• BacktrackConsumedChangeRecords : long facultatif de type : long (entier signé de 64 bits).

  Non pris en charge par Neptune.

• BacktrackWindow : long facultatif de type : long (entier signé de 64 bits).

  Non pris en charge par Neptune.

• BackupRetentionPeriod : entier facultatif 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.

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

  Non pris en charge par Neptune.

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

  Identifie le groupe de clones auquel est associé le cluster de bases de données.

• ClusterCreateTime : 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 l’heure à laquelle le cluster de bases de données a été créé, en heure UTC (Universal Coordinated Time).

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

  Si cette valeur est définie sur true, les balises sont copiées dans n'importe quel instantané du cluster de bases de données créé.

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

  Si cette valeur est définie sur true, le cluster de bases de données peut être cloné sur plusieurs comptes.

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

  Contient le nom de la base de données initiale de ce cluster de bases de données qui a été fourni au moment de la création, dans la mesure où un nom a été spécifié au moment de créer le cluster de bases de données. Ce même nom est renvoyé pendant la durée de vie du cluster de bases de données.

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

  Amazon Resource Name (ARN) du cluster de bases de données.

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

  Contient un identifiant de cluster de bases de données fourni par l’utilisateur. Cet identifiant est la clé unique qui identifie un cluster de bases de données.

• DBClusterMembers : tableau d’objets DBClusterMember.

  Fournit la liste des instances qui composent le cluster de bases de données.

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

  Spécifie le nom du groupe de paramètres de cluster de base de données pour le cluster de base de données.

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

  Identifiant immuable et propre à la région Amazon du cluster de bases de données. Cet identifiant se trouve dans les entrées du journal Amazon CloudTrail chaque fois que la clé Amazon KMS du cluster de bases de données fait l'objet d'un accès.

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

  Spécifie les informations sur le groupe de sous-réseaux associé au cluster de bases de données, notamment 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 est activée pour le cluster de bases de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée.

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

  Non pris en charge par Neptune.

• EarliestRestorableTime : 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 première heure à laquelle une base de données peut être restaurée avec une restauration à un moment donné.

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

  Liste des types de journaux pour lesquels ce cluster de bases de données est configuré et qui sont exportés vers CloudWatch Logs. Les types de journaux valides sont les suivants : audit (pour publier les journaux d'audit sur CloudWatch) et slowquery (pour publier les journaux de requêtes lentes sur CloudWatch). Pour plus d'informations, consultez Publication de journaux Neptune dans Amazon CloudWatch Logs.

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

  Spécifie le point de terminaison de connexion pour l’instance principale du cluster de bases de données.

• 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 ce cluster de bases 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.

• GlobalClusterIdentifier : identifiant de cluster global de type : string (chaîne encodée en UTF-8), compris entre 1 et 255 ?st?s, correspondant à cette expression régulière : [A-Za-z][0-9A-Za-z-:._]*.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.

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

  Spécifie l’ID attribué par Amazon Route 53 lorsque vous créez une zone hébergée.

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

  Valeur true (vrai) si le mappage des comptes Amazon Identity and Access Management (IAM) aux comptes de base de données est activé ; sinon, valeur false (faux).

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

  La prochaine fois, vous pourrez modifier le cluster de bases de données de façon à utiliser le type de stockage iopt1.

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

  Si StorageEncrypted a la valeur true (vrai), identifiant de clé Amazon KMS pour le cluster de bases de données chiffré.

• 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é.

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

  Indique si le cluster de bases de données possède des instances dans plusieurs zones de disponibilité.

• PendingModifiedValues : objet ClusterPendingModifiedValues.

  Ce type de données est utilisé comme élément de réponse dans l’opération ModifyDBCluster et contient les modifications qui seront appliquées lors de la fenêtre de maintenance suivante.

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

  Spécifie la progression de l’opération sous forme de pourcentage.

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

  Spécifie le port sur lequel le moteur de base de données est à l’écoute.

• 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.

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

  Point de terminaison du lecteur pour le cluster de bases de données. Le point de terminaison du lecteur d'un cluster de bases de données équilibre la charge des connexions entre les réplicas en lecture qui sont disponibles dans un cluster de bases de données. À mesure que les clients demandent de nouvelles connexions au point de terminaison du lecteur, Neptune répartit les demandes de connexion entre les réplicas en lecture du cluster de bases de données. Cette fonctionnalité peut contribuer à équilibrer votre charge de travail entre les différents réplicas en lecture de votre cluster de bases de données.

  Si un basculement se produit et que le réplica en lecture auquel vous êtes connecté est promu en instance principale, votre connexion est supprimée. Pour continuer à envoyer votre charge de travail de lecture à d’autres réplicas en lecture du cluster, vous pouvez alors vous reconnecter au point de terminaison du lecteur.

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

  Contient un ou plusieurs identifiants des réplicas en lecture associés à ce cluster de bases de données.

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

  Non pris en charge par Neptune.

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

  Non pris en charge par Neptune.

• ServerlessV2ScalingConfiguration : objet ServerlessV2ScalingConfigurationInfo.

  Affiche la configuration de mise à l'échelle pour un cluster de bases de données Neptune sans serveur.

  Pour plus d'informations, consultez Utilisation d'Amazon Neptune sans serveur dans le Guide de l'utilisateur Amazon Neptune.

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

  Spécifie l’état actuel de ce cluster de base de données.

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

  Indique si le cluster de base de données est chiffré.

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

  Type de stockage utilisé par le cluster de bases de données.

  Valeurs valides :

  • standard : (valeur par défaut) fournit un stockage de base de données économique pour les applications dont l’utilisation des E/S est modérée à faible.

  • iopt1 : permet un stockage optimisé pour les E/S qui est conçu pour satisfaire les besoins des charges de travail de graphe gourmandes en E/S qui requièrent une tarification prévisible avec une faible latence des E/S et un débit d’E/S homogène.

    Le stockage optimisé pour les E/S Neptune n’est disponible qu’à partir de la version 1.3.0.0 du moteur.

• VpcSecurityGroups : tableau d’objets VpcSecurityGroupMembership.

  Fournit la liste des groupes de sécurité VPC auxquels appartient le cluster de base de données.

Erreurs

• DBClusterNotFoundFault

• InvalidDBClusterStateFault

• InvalidDBInstanceStateFault

AddRoleToDBCluster (action)

        Le nom AWS CLI de cette API est : add-role-to-db-cluster.

Associe un rôle Identity and Access Management (IAM) à partir d'un cluster de bases de données Neptune.

Demande

• DBClusterIdentifier (dans la CLI : --db-cluster-identifier) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

  Nom du cluster de base de données auquel associer le rôle IAM.

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

  Nom de la fonctionnalité de cluster de bases de données auquel le rôle IAM doit être associé. Pour obtenir la liste des noms de fonctions pris en charge, consultez DBEngineVersion (structure).

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

  Amazon Resource Name (ARN) du rôle IAM à associer au cluster de base de données, par exemple arn:aws:iam::123456789012:role/NeptuneAccessRole.

Réponse

• Paramètres d’absence de réponse.

Erreurs

• DBClusterNotFoundFault

• DBClusterRoleAlreadyExistsFault

• InvalidDBClusterStateFault

• DBClusterRoleQuotaExceededFault

RemoveRoleFromDBCluster (action)

        Le nom AWS CLI de cette API est : remove-role-from-db-cluster.

Dissocie un rôle Identity and Access Management (IAM) d'un cluster de base de données.

Demande

• DBClusterIdentifier (dans la CLI : --db-cluster-identifier) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

  Nom du cluster de base de données à partir duquel le rôle IAM doit être dissocié.

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

  Nom de la fonctionnalité de cluster de bases de données dont le rôle IAM doit être dissocié. Pour obtenir la liste des noms de fonctions pris en charge, consultez DescribeDBEngineVersions (action).

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

  Amazon Resource Name (ARN) du rôle IAM à dissocier du cluster de base de données, par exemple arn:aws:iam::123456789012:role/NeptuneAccessRole.

Réponse

• Paramètres d’absence de réponse.

Erreurs

• DBClusterNotFoundFault

• DBClusterRoleNotFoundFault

• InvalidDBClusterStateFault

FailoverDBCluster (action)

        Le nom AWS CLI de cette API est : failover-db-cluster.

Force un basculement pour un cluster de base de données.

Un basculement pour un cluster de bases de données promeut l'un des réplicas en lecture (instances en lecture seule) du cluster de bases de données en instance principale (enregistreur du cluster).

Amazon Neptune bascule automatiquement vers un réplica en lecture, s'il en existe un, lorsque l'instance principale échoue. Vous pouvez forcer un basculement lorsque vous souhaitez simuler un échec d'une instance principale à des fins de test. Étant donné que chaque instance d'un cluster de base de données possède sa propre adresse de point de terminaison, vous devez nettoyer et établir à nouveau toutes les connexions existantes qui utilisent ces adresses de point de terminaison lorsque le basculement est effectué.

Demande

• DBClusterIdentifier (dans la CLI : --db-cluster-identifier) : chaîne de type : string (chaîne encodée en UTF-8).

  Identifiant de cluster de base de données pour lequel forcer un basculement. Ce paramètre n’est pas sensible à la casse.

  Contraintes :

  • Doit correspondre à l’identifiant d’un cluster de bases de données existant.

• TargetDBInstanceIdentifier (dans la CLI : --target-db-instance-identifier) : chaîne de type : string (chaîne encodée en UTF-8).

  Nom de l'instance à promouvoir en instance principale.

  Vous devez spécifier l'identifiant d'instance pour un réplica en lecture du cluster de base de données. Par exemple, mydbcluster-replica1.

Réponse

Contient les détails d’un cluster de bases de données Amazon Neptune.

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

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

  AllocatedStorage renvoie toujours la valeur 1, car la taille de stockage d’un cluster de bases de données Neptune n’est pas fixe ; elle s’ajuste automatiquement en fonction des besoins.

• AssociatedRoles : tableau d’objets DBClusterRole.

  Fournit la liste des rôles Amazon Identity and Access Management (IAM) associés au cluster de bases de données. Les rôles IAM associés à un cluster de bases de données autorisent celui-ci à accéder aux autres services Amazon en votre nom.

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

  Heure à laquelle le cluster de bases de données sera automatiquement redémarré.

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

  Fournit la liste des zones de disponibilité EC2 dans lesquelles les instances du cluster de bases de données peuvent être créées.

• BacktrackConsumedChangeRecords : long facultatif de type : long (entier signé de 64 bits).

  Non pris en charge par Neptune.

• BacktrackWindow : long facultatif de type : long (entier signé de 64 bits).

  Non pris en charge par Neptune.

• BackupRetentionPeriod : entier facultatif 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.

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

  Non pris en charge par Neptune.

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

  Identifie le groupe de clones auquel est associé le cluster de bases de données.

• ClusterCreateTime : 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 l’heure à laquelle le cluster de bases de données a été créé, en heure UTC (Universal Coordinated Time).

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

  Si cette valeur est définie sur true, les balises sont copiées dans n'importe quel instantané du cluster de bases de données créé.

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

  Si cette valeur est définie sur true, le cluster de bases de données peut être cloné sur plusieurs comptes.

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

  Contient le nom de la base de données initiale de ce cluster de bases de données qui a été fourni au moment de la création, dans la mesure où un nom a été spécifié au moment de créer le cluster de bases de données. Ce même nom est renvoyé pendant la durée de vie du cluster de bases de données.

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

  Amazon Resource Name (ARN) du cluster de bases de données.

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

  Contient un identifiant de cluster de bases de données fourni par l’utilisateur. Cet identifiant est la clé unique qui identifie un cluster de bases de données.

• DBClusterMembers : tableau d’objets DBClusterMember.

  Fournit la liste des instances qui composent le cluster de bases de données.

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

  Spécifie le nom du groupe de paramètres de cluster de base de données pour le cluster de base de données.

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

  Identifiant immuable et propre à la région Amazon du cluster de bases de données. Cet identifiant se trouve dans les entrées du journal Amazon CloudTrail chaque fois que la clé Amazon KMS du cluster de bases de données fait l'objet d'un accès.

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

  Spécifie les informations sur le groupe de sous-réseaux associé au cluster de bases de données, notamment 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 est activée pour le cluster de bases de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée.

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

  Non pris en charge par Neptune.

• EarliestRestorableTime : 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 première heure à laquelle une base de données peut être restaurée avec une restauration à un moment donné.

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

  Liste des types de journaux pour lesquels ce cluster de bases de données est configuré et qui sont exportés vers CloudWatch Logs. Les types de journaux valides sont les suivants : audit (pour publier les journaux d'audit sur CloudWatch) et slowquery (pour publier les journaux de requêtes lentes sur CloudWatch). Pour plus d'informations, consultez Publication de journaux Neptune dans Amazon CloudWatch Logs.

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

  Spécifie le point de terminaison de connexion pour l’instance principale du cluster de bases de données.

• 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 ce cluster de bases 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.

• GlobalClusterIdentifier : identifiant de cluster global de type : string (chaîne encodée en UTF-8), compris entre 1 et 255 ?st?s, correspondant à cette expression régulière : [A-Za-z][0-9A-Za-z-:._]*.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.

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

  Spécifie l’ID attribué par Amazon Route 53 lorsque vous créez une zone hébergée.

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

  Valeur true (vrai) si le mappage des comptes Amazon Identity and Access Management (IAM) aux comptes de base de données est activé ; sinon, valeur false (faux).

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

  La prochaine fois, vous pourrez modifier le cluster de bases de données de façon à utiliser le type de stockage iopt1.

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

  Si StorageEncrypted a la valeur true (vrai), identifiant de clé Amazon KMS pour le cluster de bases de données chiffré.

• 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é.

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

  Indique si le cluster de bases de données possède des instances dans plusieurs zones de disponibilité.

• PendingModifiedValues : objet ClusterPendingModifiedValues.

  Ce type de données est utilisé comme élément de réponse dans l’opération ModifyDBCluster et contient les modifications qui seront appliquées lors de la fenêtre de maintenance suivante.

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

  Spécifie la progression de l’opération sous forme de pourcentage.

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

  Spécifie le port sur lequel le moteur de base de données est à l’écoute.

• 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.

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

  Point de terminaison du lecteur pour le cluster de bases de données. Le point de terminaison du lecteur d'un cluster de bases de données équilibre la charge des connexions entre les réplicas en lecture qui sont disponibles dans un cluster de bases de données. À mesure que les clients demandent de nouvelles connexions au point de terminaison du lecteur, Neptune répartit les demandes de connexion entre les réplicas en lecture du cluster de bases de données. Cette fonctionnalité peut contribuer à équilibrer votre charge de travail entre les différents réplicas en lecture de votre cluster de bases de données.

  Si un basculement se produit et que le réplica en lecture auquel vous êtes connecté est promu en instance principale, votre connexion est supprimée. Pour continuer à envoyer votre charge de travail de lecture à d’autres réplicas en lecture du cluster, vous pouvez alors vous reconnecter au point de terminaison du lecteur.

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

  Contient un ou plusieurs identifiants des réplicas en lecture associés à ce cluster de bases de données.

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

  Non pris en charge par Neptune.

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

  Non pris en charge par Neptune.

• ServerlessV2ScalingConfiguration : objet ServerlessV2ScalingConfigurationInfo.

  Affiche la configuration de mise à l'échelle pour un cluster de bases de données Neptune sans serveur.

  Pour plus d'informations, consultez Utilisation d'Amazon Neptune sans serveur dans le Guide de l'utilisateur Amazon Neptune.

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

  Spécifie l’état actuel de ce cluster de base de données.

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

  Indique si le cluster de base de données est chiffré.

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

  Type de stockage utilisé par le cluster de bases de données.

  Valeurs valides :

  • standard : (valeur par défaut) fournit un stockage de base de données économique pour les applications dont l’utilisation des E/S est modérée à faible.

  • iopt1 : permet un stockage optimisé pour les E/S qui est conçu pour satisfaire les besoins des charges de travail de graphe gourmandes en E/S qui requièrent une tarification prévisible avec une faible latence des E/S et un débit d’E/S homogène.

    Le stockage optimisé pour les E/S Neptune n’est disponible qu’à partir de la version 1.3.0.0 du moteur.

• VpcSecurityGroups : tableau d’objets VpcSecurityGroupMembership.

  Fournit la liste des groupes de sécurité VPC auxquels appartient le cluster de base de données.

Erreurs

• DBClusterNotFoundFault

• InvalidDBClusterStateFault

• InvalidDBInstanceStateFault

PromoteReadReplicaDBCluster (action)

        Le nom AWS CLI de cette API est : promote-read-replica-db-cluster.

Non pris en charge.

Demande

• DBClusterIdentifier (dans la CLI : --db-cluster-identifier) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

  Non pris en charge.

Réponse

Contient les détails d’un cluster de bases de données Amazon Neptune.

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

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

  AllocatedStorage renvoie toujours la valeur 1, car la taille de stockage d’un cluster de bases de données Neptune n’est pas fixe ; elle s’ajuste automatiquement en fonction des besoins.

• AssociatedRoles : tableau d’objets DBClusterRole.

  Fournit la liste des rôles Amazon Identity and Access Management (IAM) associés au cluster de bases de données. Les rôles IAM associés à un cluster de bases de données autorisent celui-ci à accéder aux autres services Amazon en votre nom.

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

  Heure à laquelle le cluster de bases de données sera automatiquement redémarré.

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

  Fournit la liste des zones de disponibilité EC2 dans lesquelles les instances du cluster de bases de données peuvent être créées.

• BacktrackConsumedChangeRecords : long facultatif de type : long (entier signé de 64 bits).

  Non pris en charge par Neptune.

• BacktrackWindow : long facultatif de type : long (entier signé de 64 bits).

  Non pris en charge par Neptune.

• BackupRetentionPeriod : entier facultatif 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.

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

  Non pris en charge par Neptune.

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

  Identifie le groupe de clones auquel est associé le cluster de bases de données.

• ClusterCreateTime : 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 l’heure à laquelle le cluster de bases de données a été créé, en heure UTC (Universal Coordinated Time).

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

  Si cette valeur est définie sur true, les balises sont copiées dans n'importe quel instantané du cluster de bases de données créé.

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

  Si cette valeur est définie sur true, le cluster de bases de données peut être cloné sur plusieurs comptes.

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

  Contient le nom de la base de données initiale de ce cluster de bases de données qui a été fourni au moment de la création, dans la mesure où un nom a été spécifié au moment de créer le cluster de bases de données. Ce même nom est renvoyé pendant la durée de vie du cluster de bases de données.

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

  Amazon Resource Name (ARN) du cluster de bases de données.

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

  Contient un identifiant de cluster de bases de données fourni par l’utilisateur. Cet identifiant est la clé unique qui identifie un cluster de bases de données.

• DBClusterMembers : tableau d’objets DBClusterMember.

  Fournit la liste des instances qui composent le cluster de bases de données.

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

  Spécifie le nom du groupe de paramètres de cluster de base de données pour le cluster de base de données.

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

  Identifiant immuable et propre à la région Amazon du cluster de bases de données. Cet identifiant se trouve dans les entrées du journal Amazon CloudTrail chaque fois que la clé Amazon KMS du cluster de bases de données fait l'objet d'un accès.

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

  Spécifie les informations sur le groupe de sous-réseaux associé au cluster de bases de données, notamment 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 est activée pour le cluster de bases de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée.

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

  Non pris en charge par Neptune.

• EarliestRestorableTime : 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 première heure à laquelle une base de données peut être restaurée avec une restauration à un moment donné.

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

  Liste des types de journaux pour lesquels ce cluster de bases de données est configuré et qui sont exportés vers CloudWatch Logs. Les types de journaux valides sont les suivants : audit (pour publier les journaux d'audit sur CloudWatch) et slowquery (pour publier les journaux de requêtes lentes sur CloudWatch). Pour plus d'informations, consultez Publication de journaux Neptune dans Amazon CloudWatch Logs.

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

  Spécifie le point de terminaison de connexion pour l’instance principale du cluster de bases de données.

• 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 ce cluster de bases 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.

• GlobalClusterIdentifier : identifiant de cluster global de type : string (chaîne encodée en UTF-8), compris entre 1 et 255 ?st?s, correspondant à cette expression régulière : [A-Za-z][0-9A-Za-z-:._]*.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.

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

  Spécifie l’ID attribué par Amazon Route 53 lorsque vous créez une zone hébergée.

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

  Valeur true (vrai) si le mappage des comptes Amazon Identity and Access Management (IAM) aux comptes de base de données est activé ; sinon, valeur false (faux).

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

  La prochaine fois, vous pourrez modifier le cluster de bases de données de façon à utiliser le type de stockage iopt1.

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

  Si StorageEncrypted a la valeur true (vrai), identifiant de clé Amazon KMS pour le cluster de bases de données chiffré.

• 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é.

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

  Indique si le cluster de bases de données possède des instances dans plusieurs zones de disponibilité.

• PendingModifiedValues : objet ClusterPendingModifiedValues.

  Ce type de données est utilisé comme élément de réponse dans l’opération ModifyDBCluster et contient les modifications qui seront appliquées lors de la fenêtre de maintenance suivante.

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

  Spécifie la progression de l’opération sous forme de pourcentage.

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

  Spécifie le port sur lequel le moteur de base de données est à l’écoute.

• 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.

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

  Point de terminaison du lecteur pour le cluster de bases de données. Le point de terminaison du lecteur d'un cluster de bases de données équilibre la charge des connexions entre les réplicas en lecture qui sont disponibles dans un cluster de bases de données. À mesure que les clients demandent de nouvelles connexions au point de terminaison du lecteur, Neptune répartit les demandes de connexion entre les réplicas en lecture du cluster de bases de données. Cette fonctionnalité peut contribuer à équilibrer votre charge de travail entre les différents réplicas en lecture de votre cluster de bases de données.

  Si un basculement se produit et que le réplica en lecture auquel vous êtes connecté est promu en instance principale, votre connexion est supprimée. Pour continuer à envoyer votre charge de travail de lecture à d’autres réplicas en lecture du cluster, vous pouvez alors vous reconnecter au point de terminaison du lecteur.

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

  Contient un ou plusieurs identifiants des réplicas en lecture associés à ce cluster de bases de données.

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

  Non pris en charge par Neptune.

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

  Non pris en charge par Neptune.

• ServerlessV2ScalingConfiguration : objet ServerlessV2ScalingConfigurationInfo.

  Affiche la configuration de mise à l'échelle pour un cluster de bases de données Neptune sans serveur.

  Pour plus d'informations, consultez Utilisation d'Amazon Neptune sans serveur dans le Guide de l'utilisateur Amazon Neptune.

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

  Spécifie l’état actuel de ce cluster de base de données.

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

  Indique si le cluster de base de données est chiffré.

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

  Type de stockage utilisé par le cluster de bases de données.

  Valeurs valides :

  • standard : (valeur par défaut) fournit un stockage de base de données économique pour les applications dont l’utilisation des E/S est modérée à faible.

  • iopt1 : permet un stockage optimisé pour les E/S qui est conçu pour satisfaire les besoins des charges de travail de graphe gourmandes en E/S qui requièrent une tarification prévisible avec une faible latence des E/S et un débit d’E/S homogène.

    Le stockage optimisé pour les E/S Neptune n’est disponible qu’à partir de la version 1.3.0.0 du moteur.

• VpcSecurityGroups : tableau d’objets VpcSecurityGroupMembership.

  Fournit la liste des groupes de sécurité VPC auxquels appartient le cluster de base de données.

Erreurs

• DBClusterNotFoundFault

• InvalidDBClusterStateFault

DescribeDBClusters (action)

        Le nom AWS CLI de cette API est : describe-db-clusters.

Renvoie des informations sur les clusters de base de données provisionnés et prend en charge la pagination.

Note

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

Demande

• DBClusterIdentifier (dans la CLI : --db-cluster-identifier) : chaîne de type : string (chaîne encodée en UTF-8).

  Identifiant de cluster de base de données fourni par l'utilisateur. Si ce paramètre est spécifié, seules les informations concernant le cluster de base de données en question sont renvoyées. Ce paramètre n’est pas sensible à la casse.

  Contraintes :

  • S'il est fourni, doit correspondre à un DBClusterIdentifier existant.

• Filters (dans la CLI : --filters) : tableau d’objets Filtre.

  Filtre qui spécifie un ou plusieurs clusters de base 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 comprend uniquement des informations sur les clusters de base 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 clusters de base de données créés par ce moteur.

  Par exemple, pour invoquer cette API à partir de l'interface de ligne de commande Amazon et effectuer un filtrage afin que seuls les clusters de bases de données Neptune soient renvoyés, vous pouvez utiliser la commande suivante :

  aws neptune describe-db-clusters \
              --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 DescribeDBClusters (action) 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

• DBClusters : tableau d’objets DBCluster.

  Contient une liste de clusters de base de données pour l'utilisateur.

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

  Jeton de pagination qui peut être utilisée dans une demande DescribeDBClusters ultérieure.

Erreurs

• DBClusterNotFoundFault

Structures :

DBCluster (structure)

Contient les détails d’un cluster de bases de données Amazon Neptune.

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

Champs

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

  AllocatedStorage renvoie toujours la valeur 1, car la taille de stockage d’un cluster de bases de données Neptune n’est pas fixe ; elle s’ajuste automatiquement en fonction des besoins.

• AssociatedRoles : tableau d’objets DBClusterRole.

  Fournit la liste des rôles Amazon Identity and Access Management (IAM) associés au cluster de bases de données. Les rôles IAM associés à un cluster de bases de données autorisent celui-ci à accéder aux autres services Amazon en votre nom.

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

  Heure à laquelle le cluster de bases de données sera automatiquement redémarré.

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

  Fournit la liste des zones de disponibilité EC2 dans lesquelles les instances du cluster de bases de données peuvent être créées.

• BacktrackConsumedChangeRecords : long facultatif de type : long (entier signé de 64 bits).

  Non pris en charge par Neptune.

• BacktrackWindow : long facultatif de type : long (entier signé de 64 bits).

  Non pris en charge par Neptune.

• BackupRetentionPeriod : entier facultatif 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.

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

  Non pris en charge par Neptune.

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

  Identifie le groupe de clones auquel est associé le cluster de bases de données.

• ClusterCreateTime : 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 l’heure à laquelle le cluster de bases de données a été créé, en heure UTC (Universal Coordinated Time).

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

  Si cette valeur est définie sur true, les balises sont copiées dans n'importe quel instantané du cluster de bases de données créé.

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

  Si cette valeur est définie sur true, le cluster de bases de données peut être cloné sur plusieurs comptes.

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

  Contient le nom de la base de données initiale de ce cluster de bases de données qui a été fourni au moment de la création, dans la mesure où un nom a été spécifié au moment de créer le cluster de bases de données. Ce même nom est renvoyé pendant la durée de vie du cluster de bases de données.

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

  Amazon Resource Name (ARN) du cluster de bases de données.

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

  Contient un identifiant de cluster de bases de données fourni par l’utilisateur. Cet identifiant est la clé unique qui identifie un cluster de bases de données.

• DBClusterMembers : tableau d’objets DBClusterMember.

  Fournit la liste des instances qui composent le cluster de bases de données.

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

  Spécifie le nom du groupe de paramètres de cluster de base de données pour le cluster de base de données.

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

  Identifiant immuable et propre à la région Amazon du cluster de bases de données. Cet identifiant se trouve dans les entrées du journal Amazon CloudTrail chaque fois que la clé Amazon KMS du cluster de bases de données fait l'objet d'un accès.

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

  Spécifie les informations sur le groupe de sous-réseaux associé au cluster de bases de données, notamment 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 est activée pour le cluster de bases de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée.

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

  Non pris en charge par Neptune.

• EarliestRestorableTime : 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 première heure à laquelle une base de données peut être restaurée avec une restauration à un moment donné.

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

  Liste des types de journaux pour lesquels ce cluster de bases de données est configuré et qui sont exportés vers CloudWatch Logs. Les types de journaux valides sont les suivants : audit (pour publier les journaux d'audit sur CloudWatch) et slowquery (pour publier les journaux de requêtes lentes sur CloudWatch). Pour plus d'informations, consultez Publication de journaux Neptune dans Amazon CloudWatch Logs.

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

  Spécifie le point de terminaison de connexion pour l’instance principale du cluster de bases de données.

• 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 ce cluster de bases 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.

• GlobalClusterIdentifier : identifiant de cluster global de type : string (chaîne encodée en UTF-8), compris entre 1 et 255 ?st?s, correspondant à cette expression régulière : [A-Za-z][0-9A-Za-z-:._]*.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.

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

  Spécifie l’ID attribué par Amazon Route 53 lorsque vous créez une zone hébergée.

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

  Valeur true (vrai) si le mappage des comptes Amazon Identity and Access Management (IAM) aux comptes de base de données est activé ; sinon, valeur false (faux).

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

  La prochaine fois, vous pourrez modifier le cluster de bases de données de façon à utiliser le type de stockage iopt1.

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

  Si StorageEncrypted a la valeur true (vrai), identifiant de clé Amazon KMS pour le cluster de bases de données chiffré.

• 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é.

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

  Indique si le cluster de bases de données possède des instances dans plusieurs zones de disponibilité.

• PendingModifiedValues : objet ClusterPendingModifiedValues.

  Ce type de données est utilisé comme élément de réponse dans l’opération ModifyDBCluster et contient les modifications qui seront appliquées lors de la fenêtre de maintenance suivante.

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

  Spécifie la progression de l’opération sous forme de pourcentage.

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

  Spécifie le port sur lequel le moteur de base de données est à l’écoute.

• 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.

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

  Point de terminaison du lecteur pour le cluster de bases de données. Le point de terminaison du lecteur d'un cluster de bases de données équilibre la charge des connexions entre les réplicas en lecture qui sont disponibles dans un cluster de bases de données. À mesure que les clients demandent de nouvelles connexions au point de terminaison du lecteur, Neptune répartit les demandes de connexion entre les réplicas en lecture du cluster de bases de données. Cette fonctionnalité peut contribuer à équilibrer votre charge de travail entre les différents réplicas en lecture de votre cluster de bases de données.

  Si un basculement se produit et que le réplica en lecture auquel vous êtes connecté est promu en instance principale, votre connexion est supprimée. Pour continuer à envoyer votre charge de travail de lecture à d’autres réplicas en lecture du cluster, vous pouvez alors vous reconnecter au point de terminaison du lecteur.

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

  Contient un ou plusieurs identifiants des réplicas en lecture associés à ce cluster de bases de données.

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

  Non pris en charge par Neptune.

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

  Non pris en charge par Neptune.

• ServerlessV2ScalingConfiguration : objet ServerlessV2ScalingConfigurationInfo.

  Affiche la configuration de mise à l'échelle pour un cluster de bases de données Neptune sans serveur.

  Pour plus d'informations, consultez Utilisation d'Amazon Neptune sans serveur dans le Guide de l'utilisateur Amazon Neptune.

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

  Spécifie l’état actuel de ce cluster de base de données.

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

  Indique si le cluster de base de données est chiffré.

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

  Type de stockage utilisé par le cluster de bases de données.

  Valeurs valides :

  • standard : (valeur par défaut) fournit un stockage de base de données économique pour les applications dont l’utilisation des E/S est modérée à faible.

  • iopt1 : permet un stockage optimisé pour les E/S qui est conçu pour satisfaire les besoins des charges de travail de graphe gourmandes en E/S qui requièrent une tarification prévisible avec une faible latence des E/S et un débit d’E/S homogène.

    Le stockage optimisé pour les E/S Neptune n’est disponible qu’à partir de la version 1.3.0.0 du moteur.

• VpcSecurityGroups : tableau d’objets VpcSecurityGroupMembership.

  Fournit la liste des groupes de sécurité VPC auxquels appartient le cluster de base de données.

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

• CreateDBCluster

• DeleteDBCluster

• FailoverDBCluster

• ModifyDBCluster

• PromoteReadReplicaDBCluster

• RestoreDBClusterFromSnapshot

• RestoreDBClusterToPointInTime

• StartDBCluster

• StopDBCluster

DBClusterMember (structure)

Contient des informations sur une instance qui fait partie d'un cluster de base de données.

Champs

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

  Spécifie l'état du groupe de paramètres de cluster de base de données pour ce membre du cluster de base de données.

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

  Spécifie l'identifiant d'instance de ce membre du cluster de base de données.

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

  Valeur true si le membre du cluster est l'instance principale du cluster de base de données ; valeur false dans le cas contraire.

• 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.

DBClusterRole (structure)

Décrit un rôle Amazon Identity and Access Management (IAM) associé à un cluster de base de données.

Champs

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

  Le nom de la fonctionnalité associée au rôle Amazon Identity and Access Management (IAM). Pour obtenir la liste des noms de fonctions pris en charge, consultez DescribeDBEngineVersions (action).

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

  L'Amazon Resource Name (ARN) du rôle IAM associé au cluster de base de données.

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

  Décrit l'état de l'association entre le rôle IAM et le cluster de base de données. La propriété Status renvoie l'une des valeurs suivantes :

  • ACTIVE : l'ARN du rôle IAM est associé au cluster de bases de données et peut être utilisé pour accéder à d'autres services Amazon en votre nom.

  • PENDING : l'ARN du rôle IAM est en cours d'association au cluster de bases de données.

  • INVALID : l'ARN du rôle IAM est associé au cluster de bases de données, mais le cluster de bases de données n'est pas en mesure d'endosser le rôle IAM pour accéder aux autres services Amazon en votre nom.

CloudwatchLogsExportConfiguration (structure)

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.

Les tableaux EnableLogTypes et DisableLogTypes déterminent les journaux qui seront exportées (ou non) vers CloudWatch Logs.

Les types de journaux valides sont : audit (pour publier les journaux d’audit) et slowquery (pour publier les journaux de requêtes lentes). Pour plus d'informations, consultez Publication de journaux Neptune dans Amazon CloudWatch Logs.

Champs

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

  Liste des types de journaux à désactiver.

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

  Liste des types de journaux à activer.

PendingCloudwatchLogsExports (structure)

Liste des types de journaux dont la configuration est toujours en attente. En d'autres termes, ces types de journaux sont en cours d'activation ou de désactivation.

Les types de journaux valides sont : audit (pour publier les journaux d’audit) et slowquery (pour publier les journaux de requêtes lentes). Pour plus d'informations, consultez Publication de journaux Neptune dans Amazon CloudWatch Logs.

Champs

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

  Types de journaux en cours d'activation. Une fois qu'ils sont activés, ces types de journaux sont exportés vers CloudWatch Logs.

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

  Types de journaux en cours de désactivation. Une fois désactivés, ces types de journaux ne sont pas exportés vers CloudWatch Logs.

ClusterPendingModifiedValues (structure)

Ce type de données est utilisé comme élément de réponse dans l’opération ModifyDBCluster et contient les modifications qui seront appliquées lors de la fenêtre de maintenance suivante.

Champs

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

  Taille de stockage allouée en gibioctets (Gio) pour les moteurs de bases de données. Pour Neptune, AllocatedStorage renvoie toujours la valeur 1, car la taille de stockage d'un cluster de bases de données Neptune n'est pas fixe. Elle s'ajuste automatiquement en fonction des besoins.

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

  Nombre de jours de conservation des instantanés de base de données automatiques.

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

  Valeur DBClusterIdentifier du cluster de bases de données.

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

  Version du moteur de base de données.

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

  Valeur qui indique si le mappage des comptes AWS Identity and Access Management (IAM) avec les comptes de base de données est activé.

• 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). Ce paramètre ne s’applique qu’aux clusters de bases de données 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.

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

  Modification en attente du type de stockage pour le cluster de bases de données.   Valeurs valides :

  • standard : (valeur par défaut) configure un stockage de base de données rentable pour les applications dont l’utilisation des E/S est modérée à faible.

  • iopt1 : permet un stockage optimisé pour les E/S qui est conçu pour satisfaire les besoins des charges de travail de graphe gourmandes en E/S qui requièrent une tarification prévisible avec une faible latence des E/S et un débit d’E/S homogène.

    Le stockage optimisé pour les E/S Neptune n’est disponible qu’à partir de la version 1.3.0.0 du moteur.