API pour clusters de base de données Neptune - Amazon Neptune

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

API pour clusters de base de données Neptune

Structures :

Actions :

DBCluster (structure)

Contient les détails d'un cluster de base de données Amazon Neptune.

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

Champs

  • AllocatedStorage – Nombre (entier).

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

  • AssociatedRoles— Tableau d'élémentsDBClusterRoleDBClusterRole objets.

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

  • AutomaticRestartTime – Horodatage.

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

  • AvailabilityZones— Tableau d'éléments AvailabilityZone— Chaîne UTF-8.

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

  • BacktrackConsumedChangeRecords – Nombre (long).

    Non pris en charge par Neptune.

  • BacktrackWindow – Nombre (long).

    Non pris en charge par Neptune.

  • BackupRetentionPeriod – Nombre (entier).

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

  • Capacity – Nombre (entier).

    Non pris en charge par Neptune.

  • CloneGroupId – Chaîne UTF-8.

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

  • ClusterCreateTime – Horodatage.

    Spécifie l'heure à laquelle le cluster de base de données a été créé, en heure UTC (Universal Coordinated Time).

  • CopyTagsToSnapshot – Booléen.

    Si défini surtrue, les balises sont copiées sur n'importe quel instantané du cluster de bases de données créé.

  • CrossAccountClone – Booléen.

    Si défini surtrue, le cluster de bases de données peut être cloné sur plusieurs comptes.

  • DatabaseName – Chaîne UTF-8.

    Contient le nom de la base de données initiale de ce cluster de base 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 base de données. Ce même nom est renvoyé pendant la durée de vie du cluster de base de données.

  • DBClusterArn – Chaîne UTF-8.

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

  • DBClusterIdentifier – Chaîne UTF-8.

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

  • DBClusterMembers— Tableau d'élémentsDBClusterMemberDBClusterMember objets.

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

  • DBClusterParameterGroup – Chaîne 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 UTF-8.

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

  • DBSubnetGroup – Chaîne UTF-8.

    Spécifie les informations sur le groupe de sous-réseaux associé au cluster de base de données, notamment le nom, la description et les sous-réseaux du groupe de sous-réseaux.

  • DeletionProtection – Booléen.

    Indique si la protection contre la suppression est activée pour le cluster de base de données. La base de données ne peut pas être supprimé lorsque la protection contre la suppression est activée.

  • EarliestBacktrackTime – Horodatage.

    Non pris en charge par Neptune.

  • EarliestRestorableTime – Horodatage.

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

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

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

  • Endpoint – Chaîne UTF-8.

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

  • Engine – Chaîne UTF-8.

    Fournit le nom du moteur de base de données à utiliser pour ce cluster de base de données.

  • EngineVersion – Chaîne UTF-8.

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

  • HostedZoneId – Chaîne UTF-8.

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

  • IAMDatabaseAuthenticationEnabled – Booléen.

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

  • KmsKeyId – Chaîne UTF-8.

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

  • LatestRestorableTime – Horodatage.

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

  • MultiAZ – Booléen.

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

  • PendingModifiedValues – Un objet ClusterPendingModifiedValues.

    Non pris en charge par Neptune.

  • PercentProgress – Chaîne UTF-8.

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

  • Port – Nombre (entier).

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

  • PreferredBackupWindow – Chaîne UTF-8.

    Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété BackupRetentionPeriod.

  • PreferredMaintenanceWindow – Chaîne UTF-8.

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

  • ReaderEndpoint – Chaîne UTF-8.

    Point de terminaison du lecteur pour le cluster de base de données. Le point de terminaison du lecteur d'un cluster de base de données équilibre la charge des connexions entre les réplicas en lecture qui sont disponibles dans un cluster de base 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 base de données. Cette fonctionnalité peut contribuer à équilibrer votre charge de travail entre les différents réplicas en lecture de votre cluster de base 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— Tableau d'éléments ReadReplicaIdentifier— Chaîne UTF-8.

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

  • ReplicationSourceIdentifier – Chaîne UTF-8.

    Non pris en charge par Neptune.

  • ReplicationType – Chaîne UTF-8.

    Non pris en charge par Neptune.

  • Status – Chaîne UTF-8.

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

  • StorageEncrypted – Booléen.

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

  • VpcSecurityGroups – Un tableau d'objets VpcSecurityGroupMembership 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 :

DBClusterMember (structure)

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

Champs

  • DBClusterParameterGroupStatus – Chaîne 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 UTF-8.

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

  • IsClusterWriter – Booléen.

    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 – Nombre (entier).

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

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 UTF-8.

    Nom de la fonction associée au rôle Amazon Identity and Access Management (IAM). Pour obtenir la liste des noms de fonctions pris en charge, veuillez consulterDécrit BEngineVersions.

  • RoleArn – Chaîne UTF-8.

    Amazon Resource Name (ARN) du rôle IAM associé au cluster de base de données.

  • Status – Chaîne 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 base 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 base de données.

    • INVALID— L'ARN du rôle IAM est associé au cluster de base de données, mais le cluster de base de données n'est pas en mesure d'assumer le rôle IAM pour accéder aux autres services Amazon en votre nom.

ClusterPendingModifiedValues (structure)

Définit les modifications en attente d'un cluster de base de données.

Champs

  • PendingCloudwatchLogsExports – Un objet PendingCloudwatchLogsExports.

    CettePendingCloudwatchLogsExportsstructure spécifie les modifications en attente pour lesquelles CloudWatch les journaux sont activés et qui sont désactivés.

CreateDBCluster (action)

        Le nom d'interface de ligne de commande Amazon pour cette API est :create-db-cluster, et le nom Python 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, ou en Python :availability_zones) — Tableau d'éléments AvailabilityZone— Chaîne 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, ou en Python :backup_retention_period) – Nombre (entier).

    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, ou en Python :copy_tags_to_snapshot) – Booléen.

    Si défini surtrue, les balises sont copiées sur n'importe quel instantané du cluster de bases de données créé.

  • DatabaseName(dans la CLI :--database-name, ou en Python :database_name) – Chaîne 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, ou en Python :db_cluster_identifier) –Obligatoire : Chaîne 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, ou en Python :db_cluster_parameter_group_name) – Chaîne 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'une base de données existanteClusterParameterGroup.

  • DBSubnetGroupName(dans la CLI :--db-subnet-group-name, ou en Python :db_subnet_group_name) – Chaîne UTF-8.

    Groupe de sous-réseaux de base de données à associer à ce cluster de base de données.

    Contraintes : Doit correspondre au nom d'une base de données existanteSubnetGroup. Impossible de conserver le nom par défaut.

    Exemple : mySubnetgroup

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

    Valeur qui indique si la protection contre la suppression est activée pour le cluster de base de données. La base de données ne peut pas être supprimé lorsque la protection contre la suppression est activée. Par défaut, la protection contre la suppression est désactivée.

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

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

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

    Si défini surtrue, active l'authentification IAM (Amazon Identity and Access Management) pour l'ensemble du cluster de base de données (cela ne peut pas être défini au niveau de l'instance).

    Par défaut: false.

  • Engine(dans la CLI :--engine, ou en Python :engine) –Obligatoire : Chaîne 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, ou en Python :engine_version) – Chaîne 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.0.2.1

  • GlobalClusterIdentifier(dans la CLI :--global-cluster-identifier, ou en Python :global_cluster_identifier) — Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant à l'expression régulière : « [A-za-za-za-za-z0-[ A-za-z0-[ A-za-za-za-z0-.

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

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

    Identifiant de clé Amazon KMS pour un cluster de base 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 base de données chiffré dans une autre région Amazon, vous devez définirKmsKeyIdà un ID de clé KMS 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, ou en Python :port) – Nombre (entier).

    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, ou en Python :preferred_backup_window) – Chaîne 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 Ajustement de la fenêtre de maintenance préférée 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, ou en Python :preferred_maintenance_window) – Chaîne 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 sur 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 Ajustement de la fenêtre de maintenance préférée dans le Guide de l'utilisateur Amazon Neptune.

    Objets : Mon, Wed, Wed, Wed, Sun

    Contraintes : Fenêtre minimale de 30 minutes.

  • PreSignedUrl(dans la CLI :--pre-signed-url, ou en Python :pre_signed_url) – Chaîne UTF-8.

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

  • ReplicationSourceIdentifier(dans la CLI :--replication-source-identifier, ou en Python :replication_source_identifier) – Chaîne 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.

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

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

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

    Balises à affecter au nouveau cluster de base de données.

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

    Liste des groupes de sécurité VPC EC2 à associer à ce cluster de base de données.

Réponse

Contient les détails d'un cluster de base de données Amazon Neptune.

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

  • AllocatedStorage(dans la CLI :--allocated-storage, ou en Python :allocated_storage) – Nombre (entier).

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

  • AssociatedRoles(dans la CLI :--associated-roles, ou en Python :associated_roles) — Tableau d'élémentsDBClusterRoleDBClusterRole objets.

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

  • AutomaticRestartTime(dans la CLI :--automatic-restart-time, ou en Python :automatic_restart_time) – Horodatage.

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

  • AvailabilityZones(dans la CLI :--availability-zones, ou en Python :availability_zones) — Tableau d'éléments AvailabilityZone— Chaîne UTF-8.

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

  • BacktrackConsumedChangeRecords(dans la CLI :--backtrack-consumed-change-records, ou en Python :backtrack_consumed_change_records) – Nombre (long).

    Non pris en charge par Neptune.

  • BacktrackWindow(dans la CLI :--backtrack-window, ou en Python :backtrack_window) – Nombre (long).

    Non pris en charge par Neptune.

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

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

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

    Non pris en charge par Neptune.

  • CloneGroupId(dans la CLI :--clone-group-id, ou en Python :clone_group_id) – Chaîne UTF-8.

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

  • ClusterCreateTime(dans la CLI :--cluster-create-time, ou en Python :cluster_create_time) – Horodatage.

    Spécifie l'heure à laquelle le cluster de base de données a été créé, en heure UTC (Universal Coordinated Time).

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

    Si défini surtrue, les balises sont copiées sur n'importe quel instantané du cluster de bases de données créé.

  • CrossAccountClone(dans la CLI :--cross-account-clone, ou en Python :cross_account_clone) – Booléen.

    Si défini surtrue, le cluster de bases de données peut être cloné sur plusieurs comptes.

  • DatabaseName(dans la CLI :--database-name, ou en Python :database_name) – Chaîne UTF-8.

    Contient le nom de la base de données initiale de ce cluster de base 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 base de données. Ce même nom est renvoyé pendant la durée de vie du cluster de base de données.

  • DBClusterArn(dans la CLI :--db-cluster-arn, ou en Python :db_cluster_arn) – Chaîne UTF-8.

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

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

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

  • DBClusterMembers(dans la CLI :--db-cluster-members, ou en Python :db_cluster_members) — Tableau d'élémentsDBClusterMemberDBClusterMember objets.

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

  • DBClusterParameterGroup(dans la CLI :--db-cluster-parameter-group, ou en Python :db_cluster_parameter_group) – Chaîne 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(dans la CLI :--db-cluster-resource-id, ou en Python :db_cluster_resource_id) – Chaîne UTF-8.

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

  • DBSubnetGroup(dans la CLI :--db-subnet-group, ou en Python :db_subnet_group) – Chaîne UTF-8.

    Spécifie les informations sur le groupe de sous-réseaux associé au cluster de base de données, notamment le nom, la description et les sous-réseaux du groupe de sous-réseaux.

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

    Indique si la protection contre la suppression est activée pour le cluster de base de données. La base de données ne peut pas être supprimé lorsque la protection contre la suppression est activée.

  • EarliestBacktrackTime(dans la CLI :--earliest-backtrack-time, ou en Python :earliest_backtrack_time) – Horodatage.

    Non pris en charge par Neptune.

  • EarliestRestorableTime(dans la CLI :--earliest-restorable-time, ou en Python :earliest_restorable_time) – Horodatage.

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

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

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

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

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

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

    Fournit le nom du moteur de base de données à utiliser pour ce cluster de base de données.

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

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

  • HostedZoneId(dans la CLI :--hosted-zone-id, ou en Python :hosted_zone_id) – Chaîne UTF-8.

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

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

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

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

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

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

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

  • MultiAZ(dans la CLI :--multi-az, ou en Python :multi_az) – Booléen.

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

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

    Non pris en charge par Neptune.

  • PercentProgress(dans la CLI :--percent-progress, ou en Python :percent_progress) – Chaîne UTF-8.

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

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

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

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

    Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété BackupRetentionPeriod.

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

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

  • ReaderEndpoint(dans la CLI :--reader-endpoint, ou en Python :reader_endpoint) – Chaîne UTF-8.

    Point de terminaison du lecteur pour le cluster de base de données. Le point de terminaison du lecteur d'un cluster de base de données équilibre la charge des connexions entre les réplicas en lecture qui sont disponibles dans un cluster de base 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 base de données. Cette fonctionnalité peut contribuer à équilibrer votre charge de travail entre les différents réplicas en lecture de votre cluster de base 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(dans la CLI :--read-replica-identifiers, ou en Python :read_replica_identifiers) — Tableau d'éléments ReadReplicaIdentifier— Chaîne UTF-8.

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

  • ReplicationSourceIdentifier(dans la CLI :--replication-source-identifier, ou en Python :replication_source_identifier) – Chaîne UTF-8.

    Non pris en charge par Neptune.

  • ReplicationType(dans la CLI :--replication-type, ou en Python :replication_type) – Chaîne UTF-8.

    Non pris en charge par Neptune.

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

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

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

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

  • VpcSecurityGroups(dans la CLI :--vpc-security-groups, ou en Python :vpc_security_groups) — Tableau d'élémentsVpcSecurityGroupMembership VpcSecurityGroupMembership objets.

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

DeleteDBCluster (action)

        Le nom d'interface de ligne de commande Amazon pour cette API est :delete-db-cluster, et le nom Python 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, ou en Python :db_cluster_identifier) –Obligatoire : Chaîne UTF-8.

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

    Contraintes :

    • Doit correspondre à un DB existantClusterIdentifier.

  • FinalDBSnapshotIdentifier(dans la CLI :--final-db-snapshot-identifier, ou en Python :final_db_snapshot_identifier) – Chaîne 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, ou en Python :skip_final_snapshot) – Booléen.

    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 base de données Amazon Neptune.

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

  • AllocatedStorage(dans la CLI :--allocated-storage, ou en Python :allocated_storage) – Nombre (entier).

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

  • AssociatedRoles(dans la CLI :--associated-roles, ou en Python :associated_roles) — Tableau d'élémentsDBClusterRoleDBClusterRole objets.

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

  • AutomaticRestartTime(dans la CLI :--automatic-restart-time, ou en Python :automatic_restart_time) – Horodatage.

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

  • AvailabilityZones(dans la CLI :--availability-zones, ou en Python :availability_zones) — Tableau d'éléments AvailabilityZone— Chaîne UTF-8.

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

  • BacktrackConsumedChangeRecords(dans la CLI :--backtrack-consumed-change-records, ou en Python :backtrack_consumed_change_records) – Nombre (long).

    Non pris en charge par Neptune.

  • BacktrackWindow(dans la CLI :--backtrack-window, ou en Python :backtrack_window) – Nombre (long).

    Non pris en charge par Neptune.

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

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

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

    Non pris en charge par Neptune.

  • CloneGroupId(dans la CLI :--clone-group-id, ou en Python :clone_group_id) – Chaîne UTF-8.

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

  • ClusterCreateTime(dans la CLI :--cluster-create-time, ou en Python :cluster_create_time) – Horodatage.

    Spécifie l'heure à laquelle le cluster de base de données a été créé, en heure UTC (Universal Coordinated Time).

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

    Si défini surtrue, les balises sont copiées sur n'importe quel instantané du cluster de bases de données créé.

  • CrossAccountClone(dans la CLI :--cross-account-clone, ou en Python :cross_account_clone) – Booléen.

    Si défini surtrue, le cluster de bases de données peut être cloné sur plusieurs comptes.

  • DatabaseName(dans la CLI :--database-name, ou en Python :database_name) – Chaîne UTF-8.

    Contient le nom de la base de données initiale de ce cluster de base 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 base de données. Ce même nom est renvoyé pendant la durée de vie du cluster de base de données.

  • DBClusterArn(dans la CLI :--db-cluster-arn, ou en Python :db_cluster_arn) – Chaîne UTF-8.

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

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

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

  • DBClusterMembers(dans la CLI :--db-cluster-members, ou en Python :db_cluster_members) — Tableau d'élémentsDBClusterMemberDBClusterMember objets.

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

  • DBClusterParameterGroup(dans la CLI :--db-cluster-parameter-group, ou en Python :db_cluster_parameter_group) – Chaîne 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(dans la CLI :--db-cluster-resource-id, ou en Python :db_cluster_resource_id) – Chaîne UTF-8.

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

  • DBSubnetGroup(dans la CLI :--db-subnet-group, ou en Python :db_subnet_group) – Chaîne UTF-8.

    Spécifie les informations sur le groupe de sous-réseaux associé au cluster de base de données, notamment le nom, la description et les sous-réseaux du groupe de sous-réseaux.

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

    Indique si la protection contre la suppression est activée pour le cluster de base de données. La base de données ne peut pas être supprimé lorsque la protection contre la suppression est activée.

  • EarliestBacktrackTime(dans la CLI :--earliest-backtrack-time, ou en Python :earliest_backtrack_time) – Horodatage.

    Non pris en charge par Neptune.

  • EarliestRestorableTime(dans la CLI :--earliest-restorable-time, ou en Python :earliest_restorable_time) – Horodatage.

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

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

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

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

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

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

    Fournit le nom du moteur de base de données à utiliser pour ce cluster de base de données.

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

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

  • HostedZoneId(dans la CLI :--hosted-zone-id, ou en Python :hosted_zone_id) – Chaîne UTF-8.

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

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

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

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

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

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

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

  • MultiAZ(dans la CLI :--multi-az, ou en Python :multi_az) – Booléen.

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

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

    Non pris en charge par Neptune.

  • PercentProgress(dans la CLI :--percent-progress, ou en Python :percent_progress) – Chaîne UTF-8.

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

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

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

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

    Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété BackupRetentionPeriod.

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

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

  • ReaderEndpoint(dans la CLI :--reader-endpoint, ou en Python :reader_endpoint) – Chaîne UTF-8.

    Point de terminaison du lecteur pour le cluster de base de données. Le point de terminaison du lecteur d'un cluster de base de données équilibre la charge des connexions entre les réplicas en lecture qui sont disponibles dans un cluster de base 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 base de données. Cette fonctionnalité peut contribuer à équilibrer votre charge de travail entre les différents réplicas en lecture de votre cluster de base 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(dans la CLI :--read-replica-identifiers, ou en Python :read_replica_identifiers) — Tableau d'éléments ReadReplicaIdentifier— Chaîne UTF-8.

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

  • ReplicationSourceIdentifier(dans la CLI :--replication-source-identifier, ou en Python :replication_source_identifier) – Chaîne UTF-8.

    Non pris en charge par Neptune.

  • ReplicationType(dans la CLI :--replication-type, ou en Python :replication_type) – Chaîne UTF-8.

    Non pris en charge par Neptune.

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

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

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

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

  • VpcSecurityGroups(dans la CLI :--vpc-security-groups, ou en Python :vpc_security_groups) — Tableau d'élémentsVpcSecurityGroupMembership VpcSecurityGroupMembership objets.

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

ModifyDBCluster (action)

        Le nom d'interface de ligne de commande Amazon pour cette API est :modify-db-cluster, et le nom Python 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, ou en Python :allow_major_version_upgrade) – Booléen.

    Une valeur qui indique que les mises à niveau entre différentes versions majeures sont autorisées.

    Contraintes : Vous devez définir le paramètre allow-major-version-upgrade indicateur lors de la fourniture d'unEngineVersionparamètre qui utilise une version majeure différente de la version actuelle du cluster de base de données.

  • ApplyImmediately(dans la CLI :--apply-immediately, ou en Python :apply_immediately) – Booléen.

    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.

    LeApplyImmediatelyparamètre n'affecte queNewDBClusterIdentifierobjets. Si vous définissez l'optionApplyImmediatelyvaleur du paramètre sur false, puis passe àNewDBClusterIdentifierles valeurs sont appliquées pendant le créneau de maintenance suivant. 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, ou en Python :backup_retention_period) – Nombre (entier).

    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, ou en Python :cloudwatch_logs_export_configuration) — UNCloudwatchLogsExportConfigurationobjets.

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

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

    Si défini surtrue, les balises sont copiées sur n'importe quel instantané du cluster de bases de données créé.

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

    Identifiant du cluster de base de données qui fait l'objet d'une modification. Ce paramètre n'est pas sensible à la casse.

    Contraintes :

    • Doit correspondre à l'identifiant d'un cluster de base de données existant.

  • DBClusterParameterGroupName(dans la CLI :--db-cluster-parameter-group-name, ou en Python :db_cluster_parameter_group_name) – Chaîne 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, ou en Python :db_instance_parameter_group_name) – Chaîne UTF-8.

    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 deDBInstanceParameterGroupName, les modifications de paramètres ne sont pas appliquées pendant le créneau de maintenance suivant mais sont appliquées immédiatement.

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

    Contraintes :

    • Le groupe de paramètres de base de données doit être dans la même famille de groupe de paramètres de base de données que la version du cluster de base de

    • LeDBInstanceParameterGroupNamen'est valide qu'en combinaison avec le paramètreAllowMajorVersionUpgrade  Paramètre .

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

    Valeur qui indique si la protection contre la suppression est activée pour le cluster de base de données. La base de données ne peut pas être supprimé lorsque la protection contre la suppression est activée. Par défaut, la protection contre la suppression est désactivée.

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

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

    Par défaut : false

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

    Numéro de version du moteur de base de données vers lequel 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, veuillez consulterVersions du moteur pour Amazon Neptune, ou l'objetDécrit BEngineVersions.

  • NewDBClusterIdentifier(dans la CLI :--new-db-cluster-identifier, ou en Python :new_db_cluster_identifier) – Chaîne 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, ou en Python :port) – Nombre (entier).

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

    Contraintes : La valeur doit être1150-65535

    Par défaut: Port du cluster de base de données d'origine.

  • PreferredBackupWindow(dans la CLI :--preferred-backup-window, ou en Python :preferred_backup_window) – Chaîne 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, ou en Python :preferred_maintenance_window) – Chaîne 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 sur un bloc de 8 heures pour chaque région Amazon, se produisant un jour choisi au hasard dans la semaine.

    Objets : Mon, Wed, Wed, Wed, Sun

    Contraintes : Fenêtre minimale de 30 minutes.

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

    Liste des groupes de sécurité VPC auxquels le cluster de base de données appartiendra.

Réponse

Contient les détails d'un cluster de base de données Amazon Neptune.

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

  • AllocatedStorage(dans la CLI :--allocated-storage, ou en Python :allocated_storage) – Nombre (entier).

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

  • AssociatedRoles(dans la CLI :--associated-roles, ou en Python :associated_roles) — Tableau d'élémentsDBClusterRoleDBClusterRole objets.

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

  • AutomaticRestartTime(dans la CLI :--automatic-restart-time, ou en Python :automatic_restart_time) – Horodatage.

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

  • AvailabilityZones(dans la CLI :--availability-zones, ou en Python :availability_zones) — Tableau d'éléments AvailabilityZone— Chaîne UTF-8.

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

  • BacktrackConsumedChangeRecords(dans la CLI :--backtrack-consumed-change-records, ou en Python :backtrack_consumed_change_records) – Nombre (long).

    Non pris en charge par Neptune.

  • BacktrackWindow(dans la CLI :--backtrack-window, ou en Python :backtrack_window) – Nombre (long).

    Non pris en charge par Neptune.

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

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

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

    Non pris en charge par Neptune.

  • CloneGroupId(dans la CLI :--clone-group-id, ou en Python :clone_group_id) – Chaîne UTF-8.

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

  • ClusterCreateTime(dans la CLI :--cluster-create-time, ou en Python :cluster_create_time) – Horodatage.

    Spécifie l'heure à laquelle le cluster de base de données a été créé, en heure UTC (Universal Coordinated Time).

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

    Si défini surtrue, les balises sont copiées sur n'importe quel instantané du cluster de bases de données créé.

  • CrossAccountClone(dans la CLI :--cross-account-clone, ou en Python :cross_account_clone) – Booléen.

    Si défini surtrue, le cluster de bases de données peut être cloné sur plusieurs comptes.

  • DatabaseName(dans la CLI :--database-name, ou en Python :database_name) – Chaîne UTF-8.

    Contient le nom de la base de données initiale de ce cluster de base 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 base de données. Ce même nom est renvoyé pendant la durée de vie du cluster de base de données.

  • DBClusterArn(dans la CLI :--db-cluster-arn, ou en Python :db_cluster_arn) – Chaîne UTF-8.

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

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

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

  • DBClusterMembers(dans la CLI :--db-cluster-members, ou en Python :db_cluster_members) — Tableau d'élémentsDBClusterMemberDBClusterMember objets.

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

  • DBClusterParameterGroup(dans la CLI :--db-cluster-parameter-group, ou en Python :db_cluster_parameter_group) – Chaîne 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(dans la CLI :--db-cluster-resource-id, ou en Python :db_cluster_resource_id) – Chaîne UTF-8.

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

  • DBSubnetGroup(dans la CLI :--db-subnet-group, ou en Python :db_subnet_group) – Chaîne UTF-8.

    Spécifie les informations sur le groupe de sous-réseaux associé au cluster de base de données, notamment le nom, la description et les sous-réseaux du groupe de sous-réseaux.

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

    Indique si la protection contre la suppression est activée pour le cluster de base de données. La base de données ne peut pas être supprimé lorsque la protection contre la suppression est activée.

  • EarliestBacktrackTime(dans la CLI :--earliest-backtrack-time, ou en Python :earliest_backtrack_time) – Horodatage.

    Non pris en charge par Neptune.

  • EarliestRestorableTime(dans la CLI :--earliest-restorable-time, ou en Python :earliest_restorable_time) – Horodatage.

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

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

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

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

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

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

    Fournit le nom du moteur de base de données à utiliser pour ce cluster de base de données.

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

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

  • HostedZoneId(dans la CLI :--hosted-zone-id, ou en Python :hosted_zone_id) – Chaîne UTF-8.

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

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

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

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

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

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

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

  • MultiAZ(dans la CLI :--multi-az, ou en Python :multi_az) – Booléen.

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

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

    Non pris en charge par Neptune.

  • PercentProgress(dans la CLI :--percent-progress, ou en Python :percent_progress) – Chaîne UTF-8.

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

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

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

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

    Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété BackupRetentionPeriod.

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

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

  • ReaderEndpoint(dans la CLI :--reader-endpoint, ou en Python :reader_endpoint) – Chaîne UTF-8.

    Point de terminaison du lecteur pour le cluster de base de données. Le point de terminaison du lecteur d'un cluster de base de données équilibre la charge des connexions entre les réplicas en lecture qui sont disponibles dans un cluster de base 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 base de données. Cette fonctionnalité peut contribuer à équilibrer votre charge de travail entre les différents réplicas en lecture de votre cluster de base 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(dans la CLI :--read-replica-identifiers, ou en Python :read_replica_identifiers) — Tableau d'éléments ReadReplicaIdentifier— Chaîne UTF-8.

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

  • ReplicationSourceIdentifier(dans la CLI :--replication-source-identifier, ou en Python :replication_source_identifier) – Chaîne UTF-8.

    Non pris en charge par Neptune.

  • ReplicationType(dans la CLI :--replication-type, ou en Python :replication_type) – Chaîne UTF-8.

    Non pris en charge par Neptune.

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

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

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

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

  • VpcSecurityGroups(dans la CLI :--vpc-security-groups, ou en Python :vpc_security_groups) — Tableau d'élémentsVpcSecurityGroupMembership VpcSecurityGroupMembership objets.

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

StartDBCluster (action)

        Le nom d'interface de ligne de commande Amazon pour cette API est :start-db-cluster, et le nom Python est :start_db_cluster.

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

Demande

  • DBClusterIdentifier(dans la CLI :--db-cluster-identifier, ou en Python :db_cluster_identifier) –Obligatoire : Chaîne 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 base de données Amazon Neptune.

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

  • AllocatedStorage(dans la CLI :--allocated-storage, ou en Python :allocated_storage) – Nombre (entier).

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

  • AssociatedRoles(dans la CLI :--associated-roles, ou en Python :associated_roles) — Tableau d'élémentsDBClusterRoleDBClusterRole objets.

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

  • AutomaticRestartTime(dans la CLI :--automatic-restart-time, ou en Python :automatic_restart_time) – Horodatage.

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

  • AvailabilityZones(dans la CLI :--availability-zones, ou en Python :availability_zones) — Tableau d'éléments AvailabilityZone— Chaîne UTF-8.

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

  • BacktrackConsumedChangeRecords(dans la CLI :--backtrack-consumed-change-records, ou en Python :backtrack_consumed_change_records) – Nombre (long).

    Non pris en charge par Neptune.

  • BacktrackWindow(dans la CLI :--backtrack-window, ou en Python :backtrack_window) – Nombre (long).

    Non pris en charge par Neptune.

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

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

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

    Non pris en charge par Neptune.

  • CloneGroupId(dans la CLI :--clone-group-id, ou en Python :clone_group_id) – Chaîne UTF-8.

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

  • ClusterCreateTime(dans la CLI :--cluster-create-time, ou en Python :cluster_create_time) – Horodatage.

    Spécifie l'heure à laquelle le cluster de base de données a été créé, en heure UTC (Universal Coordinated Time).

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

    Si défini surtrue, les balises sont copiées sur n'importe quel instantané du cluster de bases de données créé.

  • CrossAccountClone(dans la CLI :--cross-account-clone, ou en Python :cross_account_clone) – Booléen.

    Si défini surtrue, le cluster de bases de données peut être cloné sur plusieurs comptes.

  • DatabaseName(dans la CLI :--database-name, ou en Python :database_name) – Chaîne UTF-8.

    Contient le nom de la base de données initiale de ce cluster de base 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 base de données. Ce même nom est renvoyé pendant la durée de vie du cluster de base de données.

  • DBClusterArn(dans la CLI :--db-cluster-arn, ou en Python :db_cluster_arn) – Chaîne UTF-8.

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

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

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

  • DBClusterMembers(dans la CLI :--db-cluster-members, ou en Python :db_cluster_members) — Tableau d'élémentsDBClusterMemberDBClusterMember objets.

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

  • DBClusterParameterGroup(dans la CLI :--db-cluster-parameter-group, ou en Python :db_cluster_parameter_group) – Chaîne 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(dans la CLI :--db-cluster-resource-id, ou en Python :db_cluster_resource_id) – Chaîne UTF-8.

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

  • DBSubnetGroup(dans la CLI :--db-subnet-group, ou en Python :db_subnet_group) – Chaîne UTF-8.

    Spécifie les informations sur le groupe de sous-réseaux associé au cluster de base de données, notamment le nom, la description et les sous-réseaux du groupe de sous-réseaux.

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

    Indique si la protection contre la suppression est activée pour le cluster de base de données. La base de données ne peut pas être supprimé lorsque la protection contre la suppression est activée.

  • EarliestBacktrackTime(dans la CLI :--earliest-backtrack-time, ou en Python :earliest_backtrack_time) – Horodatage.

    Non pris en charge par Neptune.

  • EarliestRestorableTime(dans la CLI :--earliest-restorable-time, ou en Python :earliest_restorable_time) – Horodatage.

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

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

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

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

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

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

    Fournit le nom du moteur de base de données à utiliser pour ce cluster de base de données.

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

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

  • HostedZoneId(dans la CLI :--hosted-zone-id, ou en Python :hosted_zone_id) – Chaîne UTF-8.

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

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

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

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

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

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

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

  • MultiAZ(dans la CLI :--multi-az, ou en Python :multi_az) – Booléen.

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

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

    Non pris en charge par Neptune.

  • PercentProgress(dans la CLI :--percent-progress, ou en Python :percent_progress) – Chaîne UTF-8.

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

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

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

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

    Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété BackupRetentionPeriod.

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

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

  • ReaderEndpoint(dans la CLI :--reader-endpoint, ou en Python :reader_endpoint) – Chaîne UTF-8.

    Point de terminaison du lecteur pour le cluster de base de données. Le point de terminaison du lecteur d'un cluster de base de données équilibre la charge des connexions entre les réplicas en lecture qui sont disponibles dans un cluster de base 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 base de données. Cette fonctionnalité peut contribuer à équilibrer votre charge de travail entre les différents réplicas en lecture de votre cluster de base 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(dans la CLI :--read-replica-identifiers, ou en Python :read_replica_identifiers) — Tableau d'éléments ReadReplicaIdentifier— Chaîne UTF-8.

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

  • ReplicationSourceIdentifier(dans la CLI :--replication-source-identifier, ou en Python :replication_source_identifier) – Chaîne UTF-8.

    Non pris en charge par Neptune.

  • ReplicationType(dans la CLI :--replication-type, ou en Python :replication_type) – Chaîne UTF-8.

    Non pris en charge par Neptune.

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

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

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

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

  • VpcSecurityGroups(dans la CLI :--vpc-security-groups, ou en Python :vpc_security_groups) — Tableau d'élémentsVpcSecurityGroupMembership VpcSecurityGroupMembership objets.

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

StopDBCluster (action)

        Le nom d'interface de ligne de commande Amazon pour cette API est :stop-db-cluster, et le nom Python 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 point-in-timeRestaurez si nécessaire.

Demande

  • DBClusterIdentifier(dans la CLI :--db-cluster-identifier, ou en Python :db_cluster_identifier) –Obligatoire : Chaîne 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 base de données Amazon Neptune.

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

  • AllocatedStorage(dans la CLI :--allocated-storage, ou en Python :allocated_storage) – Nombre (entier).

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

  • AssociatedRoles(dans la CLI :--associated-roles, ou en Python :associated_roles) — Tableau d'élémentsDBClusterRoleDBClusterRole objets.

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

  • AutomaticRestartTime(dans la CLI :--automatic-restart-time, ou en Python :automatic_restart_time) – Horodatage.

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

  • AvailabilityZones(dans la CLI :--availability-zones, ou en Python :availability_zones) — Tableau d'éléments AvailabilityZone— Chaîne UTF-8.

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

  • BacktrackConsumedChangeRecords(dans la CLI :--backtrack-consumed-change-records, ou en Python :backtrack_consumed_change_records) – Nombre (long).

    Non pris en charge par Neptune.

  • BacktrackWindow(dans la CLI :--backtrack-window, ou en Python :backtrack_window) – Nombre (long).

    Non pris en charge par Neptune.

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

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

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

    Non pris en charge par Neptune.

  • CloneGroupId(dans la CLI :--clone-group-id, ou en Python :clone_group_id) – Chaîne UTF-8.

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

  • ClusterCreateTime(dans la CLI :--cluster-create-time, ou en Python :cluster_create_time) – Horodatage.

    Spécifie l'heure à laquelle le cluster de base de données a été créé, en heure UTC (Universal Coordinated Time).

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

    Si défini surtrue, les balises sont copiées sur n'importe quel instantané du cluster de bases de données créé.

  • CrossAccountClone(dans la CLI :--cross-account-clone, ou en Python :cross_account_clone) – Booléen.

    Si défini surtrue, le cluster de bases de données peut être cloné sur plusieurs comptes.

  • DatabaseName(dans la CLI :--database-name, ou en Python :database_name) – Chaîne UTF-8.

    Contient le nom de la base de données initiale de ce cluster de base 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 base de données. Ce même nom est renvoyé pendant la durée de vie du cluster de base de données.

  • DBClusterArn(dans la CLI :--db-cluster-arn, ou en Python :db_cluster_arn) – Chaîne UTF-8.

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

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

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

  • DBClusterMembers(dans la CLI :--db-cluster-members, ou en Python :db_cluster_members) — Tableau d'élémentsDBClusterMemberDBClusterMember objets.

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

  • DBClusterParameterGroup(dans la CLI :--db-cluster-parameter-group, ou en Python :db_cluster_parameter_group) – Chaîne 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(dans la CLI :--db-cluster-resource-id, ou en Python :db_cluster_resource_id) – Chaîne UTF-8.

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

  • DBSubnetGroup(dans la CLI :--db-subnet-group, ou en Python :db_subnet_group) – Chaîne UTF-8.

    Spécifie les informations sur le groupe de sous-réseaux associé au cluster de base de données, notamment le nom, la description et les sous-réseaux du groupe de sous-réseaux.

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

    Indique si la protection contre la suppression est activée pour le cluster de base de données. La base de données ne peut pas être supprimé lorsque la protection contre la suppression est activée.

  • EarliestBacktrackTime(dans la CLI :--earliest-backtrack-time, ou en Python :earliest_backtrack_time) – Horodatage.

    Non pris en charge par Neptune.

  • EarliestRestorableTime(dans la CLI :--earliest-restorable-time, ou en Python :earliest_restorable_time) – Horodatage.

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

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

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

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

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

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

    Fournit le nom du moteur de base de données à utiliser pour ce cluster de base de données.

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

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

  • HostedZoneId(dans la CLI :--hosted-zone-id, ou en Python :hosted_zone_id) – Chaîne UTF-8.

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

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

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

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

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

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

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

  • MultiAZ(dans la CLI :--multi-az, ou en Python :multi_az) – Booléen.

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

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

    Non pris en charge par Neptune.

  • PercentProgress(dans la CLI :--percent-progress, ou en Python :percent_progress) – Chaîne UTF-8.

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

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

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

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

    Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété BackupRetentionPeriod.

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

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

  • ReaderEndpoint(dans la CLI :--reader-endpoint, ou en Python :reader_endpoint) – Chaîne UTF-8.

    Point de terminaison du lecteur pour le cluster de base de données. Le point de terminaison du lecteur d'un cluster de base de données équilibre la charge des connexions entre les réplicas en lecture qui sont disponibles dans un cluster de base 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 base de données. Cette fonctionnalité peut contribuer à équilibrer votre charge de travail entre les différents réplicas en lecture de votre cluster de base 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(dans la CLI :--read-replica-identifiers, ou en Python :read_replica_identifiers) — Tableau d'éléments ReadReplicaIdentifier— Chaîne UTF-8.

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

  • ReplicationSourceIdentifier(dans la CLI :--replication-source-identifier, ou en Python :replication_source_identifier) – Chaîne UTF-8.

    Non pris en charge par Neptune.

  • ReplicationType(dans la CLI :--replication-type, ou en Python :replication_type) – Chaîne UTF-8.

    Non pris en charge par Neptune.

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

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

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

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

  • VpcSecurityGroups(dans la CLI :--vpc-security-groups, ou en Python :vpc_security_groups) — Tableau d'élémentsVpcSecurityGroupMembership VpcSecurityGroupMembership objets.

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

AddRoleToDBCluster (action)

        Le nom d'interface de ligne de commande Amazon pour cette API est :add-role-to-db-cluster, et le nom Python est :add_role_to_db_cluster.

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

Demande

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

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

  • FeatureName(dans la CLI :--feature-name, ou en Python :feature_name) – Chaîne UTF-8.

    Nom de la fonctionnalité du cluster de bases de données Neptune auquel le rôle IAM doit être associé. Pour obtenir la liste des noms de fonctions pris en charge, veuillez consulterDBEngineVersion.

  • RoleArn(dans la CLI :--role-arn, ou en Python :role_arn) –Obligatoire : Chaîne 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.

RemoveRoleFromDBCluster (action)

        Le nom d'interface de ligne de commande Amazon pour cette API est :remove-role-from-db-cluster, et le nom Python 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, ou en Python :db_cluster_identifier) –Obligatoire : Chaîne 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, ou en Python :feature_name) – Chaîne UTF-8.

    Nom de la fonctionnalité du 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, veuillez consulterDécrit BEngineVersions.

  • RoleArn(dans la CLI :--role-arn, ou en Python :role_arn) –Obligatoire : Chaîne 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.

FailoverDBCluster (action)

        Le nom d'interface de ligne de commande Amazon pour cette API est :failover-db-cluster, et le nom Python est :failover_db_cluster.

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

Un basculement pour un cluster de base de données promeut l'un des réplica en lecture (instances en lecture seule) du cluster de base 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, ou en Python :db_cluster_identifier) – Chaîne 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 base de données existant.

  • TargetDBInstanceIdentifier(dans la CLI :--target-db-instance-identifier, ou en Python :target_db_instance_identifier) – Chaîne 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 base de données Amazon Neptune.

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

  • AllocatedStorage(dans la CLI :--allocated-storage, ou en Python :allocated_storage) – Nombre (entier).

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

  • AssociatedRoles(dans la CLI :--associated-roles, ou en Python :associated_roles) — Tableau d'élémentsDBClusterRoleDBClusterRole objets.

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

  • AutomaticRestartTime(dans la CLI :--automatic-restart-time, ou en Python :automatic_restart_time) – Horodatage.

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

  • AvailabilityZones(dans la CLI :--availability-zones, ou en Python :availability_zones) — Tableau d'éléments AvailabilityZone— Chaîne UTF-8.

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

  • BacktrackConsumedChangeRecords(dans la CLI :--backtrack-consumed-change-records, ou en Python :backtrack_consumed_change_records) – Nombre (long).

    Non pris en charge par Neptune.

  • BacktrackWindow(dans la CLI :--backtrack-window, ou en Python :backtrack_window) – Nombre (long).

    Non pris en charge par Neptune.

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

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

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

    Non pris en charge par Neptune.

  • CloneGroupId(dans la CLI :--clone-group-id, ou en Python :clone_group_id) – Chaîne UTF-8.

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

  • ClusterCreateTime(dans la CLI :--cluster-create-time, ou en Python :cluster_create_time) – Horodatage.

    Spécifie l'heure à laquelle le cluster de base de données a été créé, en heure UTC (Universal Coordinated Time).

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

    Si défini surtrue, les balises sont copiées sur n'importe quel instantané du cluster de bases de données créé.

  • CrossAccountClone(dans la CLI :--cross-account-clone, ou en Python :cross_account_clone) – Booléen.

    Si défini surtrue, le cluster de bases de données peut être cloné sur plusieurs comptes.

  • DatabaseName(dans la CLI :--database-name, ou en Python :database_name) – Chaîne UTF-8.

    Contient le nom de la base de données initiale de ce cluster de base 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 base de données. Ce même nom est renvoyé pendant la durée de vie du cluster de base de données.

  • DBClusterArn(dans la CLI :--db-cluster-arn, ou en Python :db_cluster_arn) – Chaîne UTF-8.

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

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

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

  • DBClusterMembers(dans la CLI :--db-cluster-members, ou en Python :db_cluster_members) — Tableau d'élémentsDBClusterMemberDBClusterMember objets.

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

  • DBClusterParameterGroup(dans la CLI :--db-cluster-parameter-group, ou en Python :db_cluster_parameter_group) – Chaîne 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(dans la CLI :--db-cluster-resource-id, ou en Python :db_cluster_resource_id) – Chaîne UTF-8.

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

  • DBSubnetGroup(dans la CLI :--db-subnet-group, ou en Python :db_subnet_group) – Chaîne UTF-8.

    Spécifie les informations sur le groupe de sous-réseaux associé au cluster de base de données, notamment le nom, la description et les sous-réseaux du groupe de sous-réseaux.

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

    Indique si la protection contre la suppression est activée pour le cluster de base de données. La base de données ne peut pas être supprimé lorsque la protection contre la suppression est activée.

  • EarliestBacktrackTime(dans la CLI :--earliest-backtrack-time, ou en Python :earliest_backtrack_time) – Horodatage.

    Non pris en charge par Neptune.

  • EarliestRestorableTime(dans la CLI :--earliest-restorable-time, ou en Python :earliest_restorable_time) – Horodatage.

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

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

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

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

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

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

    Fournit le nom du moteur de base de données à utiliser pour ce cluster de base de données.

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

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

  • HostedZoneId(dans la CLI :--hosted-zone-id, ou en Python :hosted_zone_id) – Chaîne UTF-8.

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

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

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

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

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

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

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

  • MultiAZ(dans la CLI :--multi-az, ou en Python :multi_az) – Booléen.

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

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

    Non pris en charge par Neptune.

  • PercentProgress(dans la CLI :--percent-progress, ou en Python :percent_progress) – Chaîne UTF-8.

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

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

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

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

    Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété BackupRetentionPeriod.

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

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

  • ReaderEndpoint(dans la CLI :--reader-endpoint, ou en Python :reader_endpoint) – Chaîne UTF-8.

    Point de terminaison du lecteur pour le cluster de base de données. Le point de terminaison du lecteur d'un cluster de base de données équilibre la charge des connexions entre les réplicas en lecture qui sont disponibles dans un cluster de base 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 base de données. Cette fonctionnalité peut contribuer à équilibrer votre charge de travail entre les différents réplicas en lecture de votre cluster de base 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(dans la CLI :--read-replica-identifiers, ou en Python :read_replica_identifiers) — Tableau d'éléments ReadReplicaIdentifier— Chaîne UTF-8.

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

  • ReplicationSourceIdentifier(dans la CLI :--replication-source-identifier, ou en Python :replication_source_identifier) – Chaîne UTF-8.

    Non pris en charge par Neptune.

  • ReplicationType(dans la CLI :--replication-type, ou en Python :replication_type) – Chaîne UTF-8.

    Non pris en charge par Neptune.

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

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

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

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

  • VpcSecurityGroups(dans la CLI :--vpc-security-groups, ou en Python :vpc_security_groups) — Tableau d'élémentsVpcSecurityGroupMembership VpcSecurityGroupMembership objets.

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

PromoteReadReplicaDBCluster (action)

        Le nom d'interface de ligne de commande Amazon pour cette API est :promote-read-replica-db-cluster, et le nom Python est :promote_read_replica_db_cluster.

Non pris en charge.

Demande

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

    Non pris en charge.

Réponse

Contient les détails d'un cluster de base de données Amazon Neptune.

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

  • AllocatedStorage(dans la CLI :--allocated-storage, ou en Python :allocated_storage) – Nombre (entier).

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

  • AssociatedRoles(dans la CLI :--associated-roles, ou en Python :associated_roles) — Tableau d'élémentsDBClusterRoleDBClusterRole objets.

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

  • AutomaticRestartTime(dans la CLI :--automatic-restart-time, ou en Python :automatic_restart_time) – Horodatage.

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

  • AvailabilityZones(dans la CLI :--availability-zones, ou en Python :availability_zones) — Tableau d'éléments AvailabilityZone— Chaîne UTF-8.

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

  • BacktrackConsumedChangeRecords(dans la CLI :--backtrack-consumed-change-records, ou en Python :backtrack_consumed_change_records) – Nombre (long).

    Non pris en charge par Neptune.

  • BacktrackWindow(dans la CLI :--backtrack-window, ou en Python :backtrack_window) – Nombre (long).

    Non pris en charge par Neptune.

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

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

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

    Non pris en charge par Neptune.

  • CloneGroupId(dans la CLI :--clone-group-id, ou en Python :clone_group_id) – Chaîne UTF-8.

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

  • ClusterCreateTime(dans la CLI :--cluster-create-time, ou en Python :cluster_create_time) – Horodatage.

    Spécifie l'heure à laquelle le cluster de base de données a été créé, en heure UTC (Universal Coordinated Time).

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

    Si défini surtrue, les balises sont copiées sur n'importe quel instantané du cluster de bases de données créé.

  • CrossAccountClone(dans la CLI :--cross-account-clone, ou en Python :cross_account_clone) – Booléen.

    Si défini surtrue, le cluster de bases de données peut être cloné sur plusieurs comptes.

  • DatabaseName(dans la CLI :--database-name, ou en Python :database_name) – Chaîne UTF-8.

    Contient le nom de la base de données initiale de ce cluster de base 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 base de données. Ce même nom est renvoyé pendant la durée de vie du cluster de base de données.

  • DBClusterArn(dans la CLI :--db-cluster-arn, ou en Python :db_cluster_arn) – Chaîne UTF-8.

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

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

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

  • DBClusterMembers(dans la CLI :--db-cluster-members, ou en Python :db_cluster_members) — Tableau d'élémentsDBClusterMemberDBClusterMember objets.

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

  • DBClusterParameterGroup(dans la CLI :--db-cluster-parameter-group, ou en Python :db_cluster_parameter_group) – Chaîne 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(dans la CLI :--db-cluster-resource-id, ou en Python :db_cluster_resource_id) – Chaîne UTF-8.

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

  • DBSubnetGroup(dans la CLI :--db-subnet-group, ou en Python :db_subnet_group) – Chaîne UTF-8.

    Spécifie les informations sur le groupe de sous-réseaux associé au cluster de base de données, notamment le nom, la description et les sous-réseaux du groupe de sous-réseaux.

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

    Indique si la protection contre la suppression est activée pour le cluster de base de données. La base de données ne peut pas être supprimé lorsque la protection contre la suppression est activée.

  • EarliestBacktrackTime(dans la CLI :--earliest-backtrack-time, ou en Python :earliest_backtrack_time) – Horodatage.

    Non pris en charge par Neptune.

  • EarliestRestorableTime(dans la CLI :--earliest-restorable-time, ou en Python :earliest_restorable_time) – Horodatage.

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

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

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

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

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

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

    Fournit le nom du moteur de base de données à utiliser pour ce cluster de base de données.

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

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

  • HostedZoneId(dans la CLI :--hosted-zone-id, ou en Python :hosted_zone_id) – Chaîne UTF-8.

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

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

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

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

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

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

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

  • MultiAZ(dans la CLI :--multi-az, ou en Python :multi_az) – Booléen.

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

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

    Non pris en charge par Neptune.

  • PercentProgress(dans la CLI :--percent-progress, ou en Python :percent_progress) – Chaîne UTF-8.

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

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

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

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

    Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété BackupRetentionPeriod.

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

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

  • ReaderEndpoint(dans la CLI :--reader-endpoint, ou en Python :reader_endpoint) – Chaîne UTF-8.

    Point de terminaison du lecteur pour le cluster de base de données. Le point de terminaison du lecteur d'un cluster de base de données équilibre la charge des connexions entre les réplicas en lecture qui sont disponibles dans un cluster de base 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 base de données. Cette fonctionnalité peut contribuer à équilibrer votre charge de travail entre les différents réplicas en lecture de votre cluster de base 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(dans la CLI :--read-replica-identifiers, ou en Python :read_replica_identifiers) — Tableau d'éléments ReadReplicaIdentifier— Chaîne UTF-8.

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

  • ReplicationSourceIdentifier(dans la CLI :--replication-source-identifier, ou en Python :replication_source_identifier) – Chaîne UTF-8.

    Non pris en charge par Neptune.

  • ReplicationType(dans la CLI :--replication-type, ou en Python :replication_type) – Chaîne UTF-8.

    Non pris en charge par Neptune.

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

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

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

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

  • VpcSecurityGroups(dans la CLI :--vpc-security-groups, ou en Python :vpc_security_groups) — Tableau d'élémentsVpcSecurityGroupMembership VpcSecurityGroupMembership objets.

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

DescribeDBClusters (action)

        Le nom d'interface de ligne de commande Amazon pour cette API est :describe-db-clusters, et le nom Python 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, ou en Python :db_cluster_identifier) – Chaîne 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 à une base de données existanteClusterIdentifier.

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

    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 base de données et les Amazon Resource Names (ARN) de cluster de base 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 appeler cette API à partir de l'interface de ligne de commande Amazon et filtrer afin que seuls les clusters de base 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, ou en Python :marker) – Chaîne 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, ou en Python :max_records) – Nombre (entier).

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

    Par défaut: 100

    Contraintes : Minimum 20, maximum 100.

Réponse

  • DBClusters(dans la CLI :--db-clusters, ou en Python :db_clusters) — Tableau d'élémentsDBClusterObjets DBCluster.

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

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

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