API de paramètres Neptune - Amazon Neptune
CopyDBParameterGroupCopyDBClusterParameterGroupCreateDBParameterGroupCreateDBClusterParameterGroupDeleteDBParameterGroupDeleteDBClusterParameterGroupModifyDBParameterGroupModifyDBClusterParameterGroupResetDBParameterGroupResetDBClusterParameterGroupDescribeDBParametersDescribeDBParameterGroupsDescribeDBClusterParametersDescribeDBClusterParameterGroupsDescribeEngineDefaultParametersDescribeEngineDefaultClusterParameters________________________ParamètreDBParameterGroupDBClusterParameterGroupDBParameterGroupStatus

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 de paramètres Neptune

Actions :

Structures :

CopyDBParameterGroup (action)

        Le nom AWS CLI de cette API est : copy-db-parameter-group.

Copie le groupe de paramètres de base de données spécifié.

Demande

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

    Identifiant ou ARN du groupe de paramètres de base de données source. Pour plus d'informations sur la création d'un ARN, consultez Création d'un Amazon Resource Name (ARN).

    Contraintes :

    • Doit spécifier un groupe de paramètres de base de données valide.

    • Doit spécifier un identifiant de groupe de paramètres de base de données valide, par exemple my-db-param-group, ou un ARN valide.

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

    Balises à attribuer au groupe de paramètres de base de données copié.

  • TargetDBParameterGroupDescription (dans la CLI : --target-db-parameter-group-description) : obligatoire : chaîne de type : string (chaîne encodée en UTF-8).

    Description du groupe de paramètres de base de données copié.

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

    Identifiant du groupe de paramètres de base de données copié.

    Contraintes :

    • Ne peut pas être null ou vide.

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

    Exemple : my-db-parameter-group

Réponse

Contient les détails d'un groupe de paramètres de base de données Amazon Neptune.

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

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

    Amazon Resource Name (ARN) du groupe de paramètres de base de données.

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

    Fournit le nom de la famille de groupe de paramètres de base de données avec laquelle ce groupe de paramètres de base de données est compatible.

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

    Fournit le nom du groupe de paramètres de base de données.

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

    Fournit la description spécifiée par le client de ce groupe de paramètres de base de données.

Erreurs

CopyDBClusterParameterGroup (action)

        Le nom AWS CLI de cette API est : copy-db-cluster-parameter-group.

Copie le groupe de paramètres de cluster de bases de données spécifié.

Demande

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

    Identifiant ou Amazon Resource Name (ARN) du groupe de paramètres de cluster de bases de données source. Pour plus d'informations sur la création d'un ARN, consultez Création d'un Amazon Resource Name (ARN).

    Contraintes :

    • Doit spécifier un groupe de paramètres de cluster de bases de données valide.

    • Si le groupe de paramètres de cluster de bases de données source se trouve dans la même région Amazon que la copie, spécifiez un identifiant de groupe de paramètres de base de données valide, par exemple my-db-cluster-param-group, ou un ARN valide.

    • Si le groupe de paramètres de base de données source se trouve dans une autre région Amazon que la copie, spécifiez un ARN de groupe de paramètres de cluster de bases de données valide, par exemple arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.

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

    Balises à attribuer au groupe de paramètres de cluster de bases de données copié.

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

    Description du groupe de paramètres de cluster de bases de données copié.

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

    Identifiant du groupe de paramètres de cluster de bases de données copié.

    Contraintes :

    • Ne peut pas être null ou vide

    • Doit contenir 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

    Exemple : my-cluster-param-group1

Réponse

Contient les détails d'un groupe de paramètres de cluster de bases de données Amazon Neptune.

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

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

    Amazon Resource Name (ARN) du groupe de paramètres de cluster de bases de données.

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

    Fournit le nom du groupe de paramètres du cluster de bases de données.

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

    Fournit le nom de la famille de groupe de paramètres de base de données avec laquelle ce groupe de paramètres de cluster de bases de données est compatible.

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

    Fournit la description spécifiée par le client de ce groupe de paramètres du cluster de bases de données.

Erreurs

CreateDBParameterGroup (action)

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

Crée un groupe de paramètres de base de données.

Un groupe de paramètres de base de données est initialement créé avec les paramètres par défaut pour le moteur de base de données utilisé par l'instance de base de données. Pour fournir des valeurs personnalisées aux paramètres, vous devez modifier le groupe après sa création de l'aide de ModifyDBParameterGroup. Après avoir créé un groupe de paramètres de base de données, vous devez l'associer à votre instance de base de données à l'aide de ModifyDBInstance. Lorsque vous associez un nouveau groupe de paramètres de base de données à une instance de base de données en cours d'exécution, vous devez redémarrer l'instance de base de données sans basculement, pour que le nouveau groupe de paramètres de base de données et les paramètres associés soient pris en compte.

Important

Après la création d'un groupe de paramètres DB, veuillez patienter au moins 5 minutes avant de créer votre première instance de base de données qui utilise ce groupe comme groupe de paramètres par défaut. Cela permet à Amazon Neptune de terminer complètement l'action de création avant que le groupe de paramètres soit utilisé par défaut pour une nouvelle instance de base de données. Cela est spécialement important pour des paramètres qui sont essentiels lors de la création de la base de données par défaut pour une instance de base de données, tels que le jeu de caractères pour la base de données par défaut définie par le paramètre character_set_database. Vous pouvez utiliser l'option Parameter Groups de la console Amazon Neptune ou la commande DescribeDBParameters pour vérifier que votre groupe de paramètres de base de données a été créé ou modifié.

Demande

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

    Nom de la famille de groupe de paramètres de base de données. Un groupe de paramètres de base de données peut être associé à une seule famille de groupe de paramètres de base de données, et peut être uniquement appliqué à une instance de base de données exécutant un moteur de base de données et une version de moteur compatibles avec cette famille de groupe de paramètres de base de données.

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

    Nom du groupe de paramètres de base de données.

    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

    Note

    Cette valeur est stockée sous la forme d'une chaîne en minuscules.

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

    Description du groupe de paramètres de base de données.

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

    Balises à attribuer au nouveau groupe de paramètres de base de données.

Réponse

Contient les détails d'un groupe de paramètres de base de données Amazon Neptune.

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

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

    Amazon Resource Name (ARN) du groupe de paramètres de base de données.

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

    Fournit le nom de la famille de groupe de paramètres de base de données avec laquelle ce groupe de paramètres de base de données est compatible.

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

    Fournit le nom du groupe de paramètres de base de données.

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

    Fournit la description spécifiée par le client de ce groupe de paramètres de base de données.

Erreurs

CreateDBClusterParameterGroup (action)

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

Crée un groupe de paramètres de cluster de bases de données.

Les paramètres d'un groupe de paramètres de cluster de bases de données s'appliquent à toutes les instances d'un cluster de bases de données.

Un groupe de paramètres de cluster de bases de données est initialement créé avec les paramètres par défaut pour le moteur de base de données utilisé par les instances de base de données du cluster de bases de données. Pour fournir des valeurs personnalisées aux paramètres, vous devez modifier le groupe après sa création de l'aide de ModifyDBClusterParameterGroup (action). Après avoir créé un groupe de paramètres de cluster de bases de données, vous devez l'associer à votre cluster de bases de données à l'aide de ModifyDBCluster (action). Lorsque vous associez un nouveau groupe de paramètres de cluster de bases de données à un cluster de bases de données en cours d'exécution, vous devez redémarrer les instances de base de données sans basculement, pour que le nouveau groupe de paramètres de cluster de bases de données et les paramètres associés soient pris en compte.

Important

Après avoir créé un groupe de paramètres de cluster de bases de données, vous devez patienter au moins 5 minutes avant de créer votre premier cluster de bases de données qui utilise ce groupe de paramètres de cluster de bases de données comme groupe de paramètres par défaut. Cela permet à Amazon Neptune de terminer complètement l'action de création avant que le groupe de paramètres de cluster de bases de données soit utilisé par défaut pour un nouveau cluster de bases de données. Ce point est particulièrement important pour les paramètres essentiels lors de la création de la base de données par défaut pour un cluster de bases de données, tels que le jeu de caractères pour la base de données par défaut définie par le paramètre character_set_database. Vous pouvez utiliser l'option Groupe de paramètres de la console Amazon Neptune ou de la commande DescribeDBClusterParameters (action) pour vérifier que votre groupe de paramètres de cluster de bases de données a été créé ou modifié.

Demande

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

    Nom du groupe de paramètres de cluster de bases de données.

    Contraintes :

    • Doit correspondre au nom d'un DBClusterParameterGroup existant.

    Note

    Cette valeur est stockée sous la forme d'une chaîne en minuscules.

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

    Nom de la famille de groupe de paramètres de cluster de bases de données. Un groupe de paramètres de cluster de bases de données peut être associé à une seule famille de groupe de paramètres de cluster de bases de données, et peut être uniquement appliqué à un cluster de bases de données exécutant un moteur de base de données et une version de moteur compatibles avec cette famille de groupe de paramètres de cluster de bases de données.

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

    Description du groupe de paramètres de cluster de bases de données.

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

    Balises à attribuer au nouveau groupe de paramètres de cluster de bases de données.

Réponse

Contient les détails d'un groupe de paramètres de cluster de bases de données Amazon Neptune.

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

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

    Amazon Resource Name (ARN) du groupe de paramètres de cluster de bases de données.

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

    Fournit le nom du groupe de paramètres du cluster de bases de données.

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

    Fournit le nom de la famille de groupe de paramètres de base de données avec laquelle ce groupe de paramètres de cluster de bases de données est compatible.

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

    Fournit la description spécifiée par le client de ce groupe de paramètres du cluster de bases de données.

Erreurs

DeleteDBParameterGroup (action)

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

Supprime un DBParameterGroup spécifié. Le paramètre DBParameterGroup à supprimer ne peut être associé à aucune instance de base de données.

Demande

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

    Nom du groupe de paramètres de base de données.

    Contraintes :

    • Doit être le nom d'un groupe de paramètres de base de données existant.

    • Vous ne pouvez pas supprimer un groupe de paramètres de base de données par défaut

    • Ne peut être associé à aucune instance de base de données

Réponse

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

Erreurs

DeleteDBClusterParameterGroup (action)

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

Supprime un groupe de paramètres de cluster de bases de données spécifié. Le groupe de paramètres de cluster de bases de données à supprimer ne peut être associé à aucun cluster de bases de données.

Demande

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

    Nom du groupe de paramètres de cluster de bases de données.

    Contraintes :

    • Doit être le nom d'un groupe de paramètres de cluster de bases de données existant.

    • Vous ne pouvez pas supprimer un groupe de paramètres de cluster de bases de données par défaut.

    • Ne peut être associé à aucun cluster de bases de données.

Réponse

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

Erreurs

ModifyDBParameterGroup (action)

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

Modifie les paramètres d'un groupe de paramètres de base de données. Pour modifier plusieurs paramètres, soumettez une liste des éléments suivants : ParameterName, ParameterValue et ApplyMethod. 20 paramètres maximum peuvent être modifiés dans une même demande.

Note

Les modifications apportées aux paramètres dynamiques sont appliquées immédiatement. Avant leur entrée en vigueur, les modifications apportées aux paramètres statiques exigent un redémarrage sans basculement vers l'instance de base de données associée au groupe de paramètres.

Important

Après la modification d'un groupe de paramètres DB, veuillez patienter au moins 5 minutes avant de créer votre première instance DB utilisant ce groupe comme groupe de paramètres par défaut. Cela permet à Amazon Neptune de terminer complètement l'action de modification avant que le groupe de paramètres soit utilisé par défaut pour une nouvelle instance de base de données. Cela est spécialement important pour des paramètres qui sont essentiels lors de la création de la base de données par défaut pour une instance de base de données, tels que le jeu de caractères pour la base de données par défaut définie par le paramètre character_set_database. Vous pouvez utiliser l'option Parameter Groups de la console Amazon Neptune ou la commande DescribeDBParameters pour vérifier que votre groupe de paramètres de base de données a été créé ou modifié.

Demande

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

    Nom du groupe de paramètres de base de données.

    Contraintes :

    • Si cette valeur est fournie, doit correspondre au nom d'un paramètre DBParameterGroup existant.

  • Parameters (dans la CLI : --parameters) : obligatoire : tableau d'objets Paramètre.

    Tableau des noms de paramètres, des valeurs et méthode d'application pour la mise à jour des paramètres. Au moins un nom de paramètre, une valeur et la méthode d'application doivent être fournis ; les arguments suivants sont facultatifs. 20 paramètres maximum peuvent être modifiés dans une même demande.

    Valeur valides (pour la méthode d'application) : immediate | pending-reboot

    Note

    Vous pouvez utiliser la valeur immédiate uniquement avec des paramètres dynamiques. Vous pouvez utiliser la valeur de redémarrage en attente pour les paramètres statiques et dynamiques, et les modifications sont appliquées lorsque vous redémarrez l'instance de base de données sans basculement.

Réponse

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

    Fournit le nom du groupe de paramètres de base de données.

Erreurs

ModifyDBClusterParameterGroup (action)

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

Modifie les paramètres d'un groupe de paramètres de cluster de bases de données. Pour modifier plusieurs paramètres, soumettez une liste des éléments suivants : ParameterName, ParameterValue et ApplyMethod. 20 paramètres maximum peuvent être modifiés dans une même demande.

Note

Les modifications apportées aux paramètres dynamiques sont appliquées immédiatement. Avant leur entrée en vigueur, les modifications apportées aux paramètres statiques exigent un redémarrage sans basculement vers le cluster de bases de données associée au groupe de paramètres.

Important

Après avoir créé un groupe de paramètres de cluster de bases de données, vous devez patienter au moins 5 minutes avant de créer votre premier cluster de bases de données qui utilise ce groupe de paramètres de cluster de bases de données comme groupe de paramètres par défaut. Cela permet à Amazon Neptune de terminer complètement l'action de création avant que le groupe de paramètres soit utilisé par défaut pour un nouveau cluster de bases de données. Ce point est particulièrement important pour les paramètres essentiels lors de la création de la base de données par défaut pour un cluster de bases de données, tels que le jeu de caractères pour la base de données par défaut définie par le paramètre character_set_database. Vous pouvez utiliser l'option Groupe de paramètres de la console Amazon Neptune ou de la commande DescribeDBClusterParameters (action) pour vérifier que votre groupe de paramètres de cluster de bases de données a été créé ou modifié.

Demande

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

    Nom du groupe de paramètres de cluster de bases de données à modifier.

  • Parameters (dans la CLI : --parameters) : obligatoire : tableau d'objets Paramètre.

    Liste des paramètres du groupe de paramètres de cluster de bases de données à modifier.

Réponse

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

    Nom du groupe de paramètres de cluster de bases de données.

    Contraintes :

    • Doit comporter entre 1 et 255 lettres ou chiffres.

    • Le premier caractère doit être une lettre

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

    Note

    Cette valeur est stockée sous la forme d'une chaîne en minuscules.

Erreurs

ResetDBParameterGroup (action)

        Le nom AWS CLI de cette API est : reset-db-parameter-group.

Modifie les paramètres d'un groupe de paramètres de base de données avec la valeur par défaut du moteur/système. Pour réinitialiser des paramètres spécifiques, fournissez une liste des éléments suivants : ParameterName et ApplyMethod. Pour réinitialiser entièrement le groupe de paramètres de base de données, spécifiez le nom DBParameterGroup et les paramètres ResetAllParameters. Lors de la réinitialisation du groupe entier, les paramètres dynamiques sont mis à jour immédiatement et les paramètres statiques sont définis sur pending-reboot pour entrer en vigueur lors du prochain redémarrage de l'instance de base de données ou de la demande RebootDBInstance.

Demande

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

    Nom du groupe de paramètres de base de données.

    Contraintes :

    • Doit correspondre au nom d'un paramètre DBParameterGroup existant.

  • Parameters (dans la CLI : --parameters) : tableau d'objets Paramètre.

    Pour réinitialiser entièrement le groupe de paramètres de base de données, spécifiez le nom DBParameterGroup et les paramètres ResetAllParameters. Pour réinitialiser des paramètres spécifiques, fournissez une liste des éléments suivants : ParameterName et ApplyMethod. 20 paramètres maximum peuvent être modifiés dans une même demande.

    Valeurs valides (pour méthode d'application) : pending-reboot

  • ResetAllParameters (dans la CLI : --reset-all-parameters) : valeur booléenne de type : boolean (valeur booléenne : true ou false).

    Spécifie s'il faut réinitialiser tous les paramètres du groupe de paramètres de base de données à leurs valeurs par défaut (true) ou pas (false).

    Par défaut : true

Réponse

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

    Fournit le nom du groupe de paramètres de base de données.

Erreurs

ResetDBClusterParameterGroup (action)

        Le nom AWS CLI de cette API est : reset-db-cluster-parameter-group.

Remplace les paramètres d'un groupe de paramètres de cluster de bases de données par les valeurs par défaut. Pour réinitialiser des paramètres spécifiques, envoyez une liste des éléments suivants : ParameterName et ApplyMethod. Pour réinitialiser entièrement le groupe de paramètres de cluster de bases de données, spécifiez les paramètres DBClusterParameterGroupName et ResetAllParameters.

Lors de la réinitialisation du groupe entier, les paramètres dynamiques sont mis à jour immédiatement et les paramètres statiques sont définis sur pending-reboot pour entrer en vigueur lors du prochain redémarrage de l'instance de base de données ou de la demande RebootDBInstance (action). Vous devez appeler RebootDBInstance (action) pour chaque instance de base de données de votre cluster de bases de données à laquelle vous souhaitez que la mise à jour des paramètres statiques soit appliquée.

Demande

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

    Nom du groupe de paramètres de cluster de bases de données à réinitialiser.

  • Parameters (dans la CLI : --parameters) : tableau d'objets Paramètre.

    Une liste des noms de paramètre du groupe de paramètres de cluster de bases de données à réinitialiser aux valeurs par défaut. Vous ne pouvez pas utiliser ce paramètre si le paramètre ResetAllParameters est défini sur true.

  • ResetAllParameters (dans la CLI : --reset-all-parameters) : valeur booléenne de type : boolean (valeur booléenne : true ou false).

    Valeur true pour réinitialiser tous les paramètres dans le groupe de paramètres de cluster de bases de données à leurs valeurs par défaut, et false dans le cas contraire. Vous ne pouvez pas utiliser ce paramètre si une liste des noms des paramètres spécifiés existe pour le paramètre Parameters.

Réponse

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

    Nom du groupe de paramètres de cluster de bases de données.

    Contraintes :

    • Doit comporter entre 1 et 255 lettres ou chiffres.

    • Le premier caractère doit être une lettre

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

    Note

    Cette valeur est stockée sous la forme d'une chaîne en minuscules.

Erreurs

DescribeDBParameters (action)

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

Renvoie la liste détaillée des paramètres d'un groupe de paramètres de base de données spécifique.

Demande

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

    Nom d'un groupe de paramètres de base de données spécifique pour lequel renvoyer les détails.

    Contraintes :

    • Si cette valeur est fournie, doit correspondre au nom d'un paramètre DBParameterGroup existant.

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

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

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

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

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

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

    Par défaut : 100

    Contraintes : Minimum 20, maximum 100.

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

    Types de paramètre à renvoyer.

    Par défaut : tous les types de paramètre sont renvoyés.

    Valeurs valides : user | system | engine-default

Réponse

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

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

  • Parameters : tableau d'objets Paramètre.

    Liste des valeurs Parameter (structure).

Erreurs

DescribeDBParameterGroups (action)

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

Renvoie une liste des descriptions de DBParameterGroup. Si le paramètre DBParameterGroupName est spécifié, la liste contiendra uniquement la description du groupe de paramètres de base de données spécifié.

Demande

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

    Nom d'un groupe de paramètres de base de données spécifique pour lequel renvoyer les détails.

    Contraintes :

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

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

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

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

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

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

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

    Par défaut : 100

    Contraintes : Minimum 20, maximum 100.

Réponse

  • DBParameterGroups : tableau d'objets DBParameterGroup.

    Liste des instances DBParameterGroup (structure).

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

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

Erreurs

DescribeDBClusterParameters (action)

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

Renvoie la liste détaillée des paramètres d'un groupe de paramètres de cluster de bases de données spécifique.

Demande

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

    Nom d'un groupe de paramètres de cluster de bases de données spécifique pour lequel renvoyer les détails de paramètre.

    Contraintes :

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

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

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

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

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

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

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

    Par défaut : 100

    Contraintes : Minimum 20, maximum 100.

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

    Valeur indiquée pour renvoyer uniquement les paramètres d'une source spécifique. Les sources du paramètre peuvent être engine, service ou customer.

Réponse

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

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

  • Parameters : tableau d'objets Paramètre.

    Fournit une liste des paramètres du groupe de paramètres de cluster de bases de données.

Erreurs

DescribeDBClusterParameterGroups (action)

        Le nom AWS CLI de cette API est : describe-db-cluster-parameter-groups.

Renvoie une liste des descriptions de DBClusterParameterGroup. Si le paramètre DBClusterParameterGroupName est spécifié, la liste contiendra uniquement la description du groupe de paramètres de cluster de bases de données spécifié.

Demande

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

    Nom d'un groupe de paramètres de cluster de bases de données spécifique pour lequel renvoyer les détails.

    Contraintes :

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

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

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

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

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

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

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

    Par défaut : 100

    Contraintes : Minimum 20, maximum 100.

Réponse

  • DBClusterParameterGroups : tableau d'objets DBClusterParameterGroup.

    Liste des groupes de paramètres de cluster de bases de données.

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

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

Erreurs

DescribeEngineDefaultParameters (action)

        Le nom AWS CLI de cette API est : describe-engine-default-parameters.

Renvoie les informations sur les paramètres de moteur et système par défaut du moteur de base de données spécifié.

Demande

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

    Nom de la famille de groupe de paramètres de cluster de bases de données.

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

    Cette option n'est pas prise en charge actuellement.

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

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

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

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

    Par défaut : 100

    Contraintes : Minimum 20, maximum 100.

Réponse

Contient le résultat d'une invocation réussie de l'action DescribeEngineDefaultParameters (action).

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

    Spécifie le nom de la famille de groupe de paramètres de base de données à laquelle s'appliquent les paramètres par défaut du moteur.

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

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

  • Parameters : tableau d'objets Paramètre.

    Contient une liste des paramètres par défaut du moteur.

DescribeEngineDefaultClusterParameters (action)

        Le nom AWS CLI de cette API est : describe-engine-default-cluster-parameters.

Renvoie les informations sur les paramètres de moteur et de système par défaut du moteur de base de données du cluster.

Demande

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

    Nom de la famille de groupe de paramètres de cluster de bases de données pour laquelle renvoyer les informations sur les paramètres de moteur.

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

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

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

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

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

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

    Par défaut : 100

    Contraintes : Minimum 20, maximum 100.

Réponse

Contient le résultat d'une invocation réussie de l'action DescribeEngineDefaultParameters (action).

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

    Spécifie le nom de la famille de groupe de paramètres de base de données à laquelle s'appliquent les paramètres par défaut du moteur.

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

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

  • Parameters : tableau d'objets Paramètre.

    Contient une liste des paramètres par défaut du moteur.

Structures :

Parameter (structure)

Spécifie un paramètre.

Champs

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

    Spécifie la plage de valeurs valide pour le paramètre.

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

    Indique quand appliquer les mises à jour de paramètres.

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

    Spécifie le type de paramètres propres au moteur.

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

    Spécifie le type de données valide pour le paramètre.

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

    Fournit une description du paramètre.

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

    Indique si le paramètre peut être (true) ou non (false) modifié. Certains paramètres ont des implications en terme de sécurité ou de fonctionnement qui les empêchent d'être modifiés.

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

    Première version de moteur à laquelle le paramètre peut s'appliquer.

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

    Spécifie le nom du paramètre.

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

    Spécifie la valeur du paramètre.

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

    Indique la source de la valeur du paramètre.

DBParameterGroup (structure)

Contient les détails d'un groupe de paramètres de base de données Amazon Neptune.

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

Champs

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

    Amazon Resource Name (ARN) du groupe de paramètres de base de données.

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

    Fournit le nom de la famille de groupe de paramètres de base de données avec laquelle ce groupe de paramètres de base de données est compatible.

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

    Fournit le nom du groupe de paramètres de base de données.

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

    Fournit la description spécifiée par le client de ce groupe de paramètres de base de données.

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

DBClusterParameterGroup (structure)

Contient les détails d'un groupe de paramètres de cluster de bases de données Amazon Neptune.

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

Champs

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

    Amazon Resource Name (ARN) du groupe de paramètres de cluster de bases de données.

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

    Fournit le nom du groupe de paramètres du cluster de bases de données.

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

    Fournit le nom de la famille de groupe de paramètres de base de données avec laquelle ce groupe de paramètres de cluster de bases de données est compatible.

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

    Fournit la description spécifiée par le client de ce groupe de paramètres du cluster de bases de données.

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

DBParameterGroupStatus (structure)

Statut du groupe de paramètres de base de données.

Ce type de données est utilisé comme élément de réponse dans les actions suivantes :

Champs

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

    Nom du groupe de paramètres de base de données.

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

    Statut des mises à jour de paramètres.