

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.

# Référence de l'API de gestion Amazon Neptune
<a name="api"></a>

Ce chapitre décrit les opérations d'API Neptune que vous pouvez utiliser pour gérer le cluster de bases de données Neptune.

Neptune opère sur des clusters de serveurs de base de données qui sont connectés dans une topologie de réplication. Par conséquent, la gestion de Neptune implique souvent de déployer des modifications sur plusieurs serveurs et de s'assurer que tous les réplicas Neptune suivent le rythme du serveur principal.

Étant donné que Neptune met à l'échelle le stockage sous-jacent en toute transparence à mesure que vos données augmentent, la gestion de Neptune exige relativement peu de gestion au niveau du stockage sur disque. De la même manière, étant donné que Neptune effectue automatiquement des sauvegardes continues, un cluster Neptune nécessite peu de planification ou de temps d'arrêt pour la réalisation des sauvegardes. 

**Contents**
+ [API pour clusters de bases de données Neptune](api-clusters.md)
  + [Créer DBCluster (action)](api-clusters.md#CreateDBCluster)
  + [Supprimer DBCluster (action)](api-clusters.md#DeleteDBCluster)
  + [Modifier DBCluster (action)](api-clusters.md#ModifyDBCluster)
  + [Démarrer DBCluster (action)](api-clusters.md#StartDBCluster)
  + [Arrêter DBCluster (action)](api-clusters.md#StopDBCluster)
  + [AddRoleToDBCluster (action)](api-clusters.md#AddRoleToDBCluster)
  + [RemoveRoleFromDBCluster (action)](api-clusters.md#RemoveRoleFromDBCluster)
  + [Basculement DBCluster (action)](api-clusters.md#FailoverDBCluster)
  + [PromoteReadReplicaDBCluster (action)](api-clusters.md#PromoteReadReplicaDBCluster)
  + [Décrire DBClusters (action)](api-clusters.md#DescribeDBClusters)
  + [*Structures :*](api-clusters.md#api-clusters-structures-spacer)
  + [DBCluster (structure)](api-clusters.md#DBCluster)
  + [DBClusterMembre (structure)](api-clusters.md#DBClusterMember)
  + [DBClusterRôle (structure)](api-clusters.md#DBClusterRole)
  + [CloudwatchLogsExportConfiguration (structure)](api-clusters.md#CloudwatchLogsExportConfiguration)
  + [PendingCloudwatchLogsExports (structure)](api-clusters.md#PendingCloudwatchLogsExports)
  + [ClusterPendingModifiedValues (structure)](api-clusters.md#ClusterPendingModifiedValues)
+ [API de base de données globale Neptune](api-global-dbs.md)
  + [CreateGlobalCluster (action)](api-global-dbs.md#CreateGlobalCluster)
  + [DeleteGlobalCluster (action)](api-global-dbs.md#DeleteGlobalCluster)
  + [ModifyGlobalCluster (action)](api-global-dbs.md#ModifyGlobalCluster)
  + [DescribeGlobalClusters (action)](api-global-dbs.md#DescribeGlobalClusters)
  + [FailoverGlobalCluster (action)](api-global-dbs.md#FailoverGlobalCluster)
  + [RemoveFromGlobalCluster (action)](api-global-dbs.md#RemoveFromGlobalCluster)
  + [*Structures :*](api-global-dbs.md#api-global-dbs-structures-spacer)
  + [GlobalCluster (structure)](api-global-dbs.md#GlobalCluster)
  + [GlobalClusterMember (structure)](api-global-dbs.md#GlobalClusterMember)
+ [API d'instances Neptune](api-instances.md)
  + [Créer DBInstance (action)](api-instances.md#CreateDBInstance)
  + [Supprimer DBInstance (action)](api-instances.md#DeleteDBInstance)
  + [Modifier DBInstance (action)](api-instances.md#ModifyDBInstance)
  + [Redémarrer DBInstance (action)](api-instances.md#RebootDBInstance)
  + [Décrire DBInstances (action)](api-instances.md#DescribeDBInstances)
  + [DescribeOrderableDBInstanceOptions (action)](api-instances.md#DescribeOrderableDBInstanceOptions)
  + [DescribeValidDBInstanceModifications (action)](api-instances.md#DescribeValidDBInstanceModifications)
  + [*Structures :*](api-instances.md#api-instances-structures-spacer)
  + [DBInstance (structure)](api-instances.md#DBInstance)
  + [DBInstanceStatusInfo (structure)](api-instances.md#DBInstanceStatusInfo)
  + [DBInstanceOption commandable (structure)](api-instances.md#OrderableDBInstanceOption)
  + [PendingModifiedValues (structure)](api-instances.md#PendingModifiedValues)
  + [ValidStorageOptions (structure)](api-instances.md#ValidStorageOptions)
  + [Valide DBInstance ModificationsMessage (structure)](api-instances.md#ValidDBInstanceModificationsMessage)
+ [API de paramètres Neptune](api-parameters.md)
  + [Copier DBParameter le groupe (action)](api-parameters.md#CopyDBParameterGroup)
  + [Copier DBCluster ParameterGroup (action)](api-parameters.md#CopyDBClusterParameterGroup)
  + [Créer un DBParameter groupe (action)](api-parameters.md#CreateDBParameterGroup)
  + [Créer DBCluster ParameterGroup (action)](api-parameters.md#CreateDBClusterParameterGroup)
  + [Supprimer le DBParameter groupe (action)](api-parameters.md#DeleteDBParameterGroup)
  + [Supprimer DBCluster ParameterGroup (action)](api-parameters.md#DeleteDBClusterParameterGroup)
  + [Modifier DBParameter le groupe (action)](api-parameters.md#ModifyDBParameterGroup)
  + [Modifier DBCluster ParameterGroup (action)](api-parameters.md#ModifyDBClusterParameterGroup)
  + [Réinitialiser DBParameter le groupe (action)](api-parameters.md#ResetDBParameterGroup)
  + [Réinitialiser DBCluster ParameterGroup (action)](api-parameters.md#ResetDBClusterParameterGroup)
  + [Décrire DBParameters (action)](api-parameters.md#DescribeDBParameters)
  + [Décrire DBParameter les groupes (action)](api-parameters.md#DescribeDBParameterGroups)
  + [Décrire DBCluster les paramètres (action)](api-parameters.md#DescribeDBClusterParameters)
  + [Décrire DBCluster ParameterGroups (action)](api-parameters.md#DescribeDBClusterParameterGroups)
  + [DescribeEngineDefaultParameters (action)](api-parameters.md#DescribeEngineDefaultParameters)
  + [DescribeEngineDefaultClusterParameters (action)](api-parameters.md#DescribeEngineDefaultClusterParameters)
  + [*Structures :*](api-parameters.md#api-parameters-structures-spacer)
  + [Parameter (structure)](api-parameters.md#Parameter)
  + [DBParameterGroupe (structure)](api-parameters.md#DBParameterGroup)
  + [DBClusterParameterGroup (structure)](api-parameters.md#DBClusterParameterGroup)
  + [DBParameterGroupStatus (structure)](api-parameters.md#DBParameterGroupStatus)
+ [API de sous-réseau Neptune](api-subnets.md)
  + [Créer un DBSubnet groupe (action)](api-subnets.md#CreateDBSubnetGroup)
  + [Supprimer le DBSubnet groupe (action)](api-subnets.md#DeleteDBSubnetGroup)
  + [Modifier DBSubnet le groupe (action)](api-subnets.md#ModifyDBSubnetGroup)
  + [Décrire DBSubnet les groupes (action)](api-subnets.md#DescribeDBSubnetGroups)
  + [*Structures :*](api-subnets.md#api-subnets-structures-spacer)
  + [Subnet (structure)](api-subnets.md#Subnet)
  + [DBSubnetGroupe (structure)](api-subnets.md#DBSubnetGroup)
+ [API d'instantanés Neptune](api-snapshots.md)
  + [Créer DBCluster un instantané (action)](api-snapshots.md#CreateDBClusterSnapshot)
  + [Supprimer DBCluster un instantané (action)](api-snapshots.md#DeleteDBClusterSnapshot)
  + [Copier DBCluster un instantané (action)](api-snapshots.md#CopyDBClusterSnapshot)
  + [Modifier DBCluster SnapshotAttribute (action)](api-snapshots.md#ModifyDBClusterSnapshotAttribute)
  + [Restaurer DBCluster FromSnapshot (action)](api-snapshots.md#RestoreDBClusterFromSnapshot)
  + [Restaurer DBCluster ToPointInTime (action)](api-snapshots.md#RestoreDBClusterToPointInTime)
  + [Décrire les DBCluster instantanés (action)](api-snapshots.md#DescribeDBClusterSnapshots)
  + [Décrire DBCluster SnapshotAttributes (action)](api-snapshots.md#DescribeDBClusterSnapshotAttributes)
  + [*Structures :*](api-snapshots.md#api-snapshots-structures-spacer)
  + [DBClusterInstantané (structure)](api-snapshots.md#DBClusterSnapshot)
  + [DBClusterSnapshotAttribute (structure)](api-snapshots.md#DBClusterSnapshotAttribute)
  + [DBClusterSnapshotAttributesResult (structure)](api-snapshots.md#DBClusterSnapshotAttributesResult)
+ [API d'événements Neptune](api-events.md)
  + [CreateEventSubscription (action)](api-events.md#CreateEventSubscription)
  + [DeleteEventSubscription (action)](api-events.md#DeleteEventSubscription)
  + [ModifyEventSubscription (action)](api-events.md#ModifyEventSubscription)
  + [DescribeEventSubscriptions (action)](api-events.md#DescribeEventSubscriptions)
  + [AddSourceIdentifierToSubscription (action)](api-events.md#AddSourceIdentifierToSubscription)
  + [RemoveSourceIdentifierFromSubscription (action)](api-events.md#RemoveSourceIdentifierFromSubscription)
  + [DescribeEvents (action)](api-events.md#DescribeEvents)
  + [DescribeEventCategories (action)](api-events.md#DescribeEventCategories)
  + [*Structures :*](api-events.md#api-events-structures-spacer)
  + [Event (structure)](api-events.md#Event)
  + [EventCategoriesMap (structure)](api-events.md#EventCategoriesMap)
  + [EventSubscription (structure)](api-events.md#EventSubscription)
+ [Autre Neptune APIs](api-other-apis.md)
  + [AddTagsToResource (action)](api-other-apis.md#AddTagsToResource)
  + [ListTagsForResource (action)](api-other-apis.md#ListTagsForResource)
  + [RemoveTagsFromResource (action)](api-other-apis.md#RemoveTagsFromResource)
  + [ApplyPendingMaintenanceAction (action)](api-other-apis.md#ApplyPendingMaintenanceAction)
  + [DescribePendingMaintenanceActions (action)](api-other-apis.md#DescribePendingMaintenanceActions)
  + [Décrire DBEngine les versions (action)](api-other-apis.md#DescribeDBEngineVersions)
  + [*Structures :*](api-other-apis.md#api-other-apis-structures-spacer)
  + [DBEngineVersion (structure)](api-other-apis.md#DBEngineVersion)
  + [EngineDefaults (structure)](api-other-apis.md#EngineDefaults)
  + [PendingMaintenanceAction (structure)](api-other-apis.md#PendingMaintenanceAction)
  + [ResourcePendingMaintenanceActions (structure)](api-other-apis.md#ResourcePendingMaintenanceActions)
  + [UpgradeTarget (structure)](api-other-apis.md#UpgradeTarget)
  + [Tag (structure)](api-other-apis.md#Tag)
+ [Types de données Neptune courants](api-datatypes.md)
  + [AvailabilityZone (structure)](api-datatypes.md#AvailabilityZone)
  + [DBSecurityGroupMembership (structure)](api-datatypes.md#DBSecurityGroupMembership)
  + [DomainMembership (structure)](api-datatypes.md#DomainMembership)
  + [DoubleRange (structure)](api-datatypes.md#DoubleRange)
  + [Endpoint (structure)](api-datatypes.md#Endpoint)
  + [Filter (structure)](api-datatypes.md#Filter)
  + [Range (structure)](api-datatypes.md#Range)
  + [ServerlessV2 ScalingConfiguration (structure)](api-datatypes.md#ServerlessV2ScalingConfiguration)
  + [ServerlessV2 ScalingConfigurationInfo (structure)](api-datatypes.md#ServerlessV2ScalingConfigurationInfo)
  + [Timezone (structure)](api-datatypes.md#Timezone)
  + [VpcSecurityGroupMembership (structure)](api-datatypes.md#VpcSecurityGroupMembership)
+ [Neptune : exceptions spécifiques à un individu APIs](api-faults.md)
  + [AuthorizationAlreadyExistsFault (structure)](api-faults.md#AuthorizationAlreadyExistsFault)
  + [AuthorizationNotFoundFault (structure)](api-faults.md#AuthorizationNotFoundFault)
  + [AuthorizationQuotaExceededFault (structure)](api-faults.md#AuthorizationQuotaExceededFault)
  + [CertificateNotFoundFault (structure)](api-faults.md#CertificateNotFoundFault)
  + [DBClusterAlreadyExistsFault (structure)](api-faults.md#DBClusterAlreadyExistsFault)
  + [DBClusterNotFoundFault (structure)](api-faults.md#DBClusterNotFoundFault)
  + [DBClusterParameterGroupNotFoundFault (structure)](api-faults.md#DBClusterParameterGroupNotFoundFault)
  + [DBClusterQuotaExceededFault (structure)](api-faults.md#DBClusterQuotaExceededFault)
  + [DBClusterRoleAlreadyExistsFault (structure)](api-faults.md#DBClusterRoleAlreadyExistsFault)
  + [DBClusterRoleNotFoundFault (structure)](api-faults.md#DBClusterRoleNotFoundFault)
  + [DBClusterRoleQuotaExceededFault (structure)](api-faults.md#DBClusterRoleQuotaExceededFault)
  + [DBClusterSnapshotAlreadyExistsFault (structure)](api-faults.md#DBClusterSnapshotAlreadyExistsFault)
  + [DBClusterSnapshotNotFoundFault (structure)](api-faults.md#DBClusterSnapshotNotFoundFault)
  + [DBInstanceAlreadyExistsFault (structure)](api-faults.md#DBInstanceAlreadyExistsFault)
  + [DBInstanceNotFoundFault (structure)](api-faults.md#DBInstanceNotFoundFault)
  + [DBLogFileNotFoundFault (structure)](api-faults.md#DBLogFileNotFoundFault)
  + [DBParameterGroupAlreadyExistsFault (structure)](api-faults.md#DBParameterGroupAlreadyExistsFault)
  + [DBParameterGroupNotFoundFault (structure)](api-faults.md#DBParameterGroupNotFoundFault)
  + [DBParameterGroupQuotaExceededFault (structure)](api-faults.md#DBParameterGroupQuotaExceededFault)
  + [DBSecurityGroupAlreadyExistsFault (structure)](api-faults.md#DBSecurityGroupAlreadyExistsFault)
  + [DBSecurityGroupNotFoundFault (structure)](api-faults.md#DBSecurityGroupNotFoundFault)
  + [DBSecurityGroupNotSupportedFault (structure)](api-faults.md#DBSecurityGroupNotSupportedFault)
  + [DBSecurityGroupQuotaExceededFault (structure)](api-faults.md#DBSecurityGroupQuotaExceededFault)
  + [DBSnapshotAlreadyExistsFault (structure)](api-faults.md#DBSnapshotAlreadyExistsFault)
  + [DBSnapshotNotFoundFault (structure)](api-faults.md#DBSnapshotNotFoundFault)
  + [DBSubnetGroupAlreadyExistsFault (structure)](api-faults.md#DBSubnetGroupAlreadyExistsFault)
  + [DBSubnetGroupDoesNotCoverEnoughAZs (structure)](api-faults.md#DBSubnetGroupDoesNotCoverEnoughAZs)
  + [DBSubnetGroupNotAllowedFault (structure)](api-faults.md#DBSubnetGroupNotAllowedFault)
  + [DBSubnetGroupNotFoundFault (structure)](api-faults.md#DBSubnetGroupNotFoundFault)
  + [DBSubnetGroupQuotaExceededFault (structure)](api-faults.md#DBSubnetGroupQuotaExceededFault)
  + [DBSubnetQuotaExceededFault (structure)](api-faults.md#DBSubnetQuotaExceededFault)
  + [DBUpgradeDependencyFailureFault (structure)](api-faults.md#DBUpgradeDependencyFailureFault)
  + [DomainNotFoundFault (structure)](api-faults.md#DomainNotFoundFault)
  + [EventSubscriptionQuotaExceededFault (structure)](api-faults.md#EventSubscriptionQuotaExceededFault)
  + [GlobalClusterAlreadyExistsFault (structure)](api-faults.md#GlobalClusterAlreadyExistsFault)
  + [GlobalClusterNotFoundFault (structure)](api-faults.md#GlobalClusterNotFoundFault)
  + [GlobalClusterQuotaExceededFault (structure)](api-faults.md#GlobalClusterQuotaExceededFault)
  + [InstanceQuotaExceededFault (structure)](api-faults.md#InstanceQuotaExceededFault)
  + [Insuffisant DBCluster CapacityFault (structure)](api-faults.md#InsufficientDBClusterCapacityFault)
  + [Insuffisant DBInstance CapacityFault (structure)](api-faults.md#InsufficientDBInstanceCapacityFault)
  + [InsufficientStorageClusterCapacityFault (structure)](api-faults.md#InsufficientStorageClusterCapacityFault)
  + [Non valide DBCluster EndpointStateFault (structure)](api-faults.md#InvalidDBClusterEndpointStateFault)
  + [Non valide DBCluster SnapshotStateFault (structure)](api-faults.md#InvalidDBClusterSnapshotStateFault)
  + [Non valide DBCluster StateFault (structure)](api-faults.md#InvalidDBClusterStateFault)
  + [Non valide DBInstance StateFault (structure)](api-faults.md#InvalidDBInstanceStateFault)
  + [Non valide DBParameter GroupStateFault (structure)](api-faults.md#InvalidDBParameterGroupStateFault)
  + [Non valide DBSecurity GroupStateFault (structure)](api-faults.md#InvalidDBSecurityGroupStateFault)
  + [Non valide DBSnapshot StateFault (structure)](api-faults.md#InvalidDBSnapshotStateFault)
  + [Non valide DBSubnet GroupFault (structure)](api-faults.md#InvalidDBSubnetGroupFault)
  + [Non valide DBSubnet GroupStateFault (structure)](api-faults.md#InvalidDBSubnetGroupStateFault)
  + [Non valide DBSubnet StateFault (structure)](api-faults.md#InvalidDBSubnetStateFault)
  + [InvalidEventSubscriptionStateFault (structure)](api-faults.md#InvalidEventSubscriptionStateFault)
  + [InvalidGlobalClusterStateFault (structure)](api-faults.md#InvalidGlobalClusterStateFault)
  + [InvalidOptionGroupStateFault (structure)](api-faults.md#InvalidOptionGroupStateFault)
  + [InvalidRestoreFault (structure)](api-faults.md#InvalidRestoreFault)
  + [InvalidSubnet (structure)](api-faults.md#InvalidSubnet)
  + [Non valide VPCNetwork StateFault (structure)](api-faults.md#InvalidVPCNetworkStateFault)
  + [KMSKeyNotAccessibleFault (structure)](api-faults.md#KMSKeyNotAccessibleFault)
  + [OptionGroupNotFoundFault (structure)](api-faults.md#OptionGroupNotFoundFault)
  + [PointInTimeRestoreNotEnabledFault (structure)](api-faults.md#PointInTimeRestoreNotEnabledFault)
  + [ProvisionedIopsNotAvailableInAZFault (structure)](api-faults.md#ProvisionedIopsNotAvailableInAZFault)
  + [ResourceNotFoundFault (structure)](api-faults.md#ResourceNotFoundFault)
  + [SNSInvalidTopicFault (structure)](api-faults.md#SNSInvalidTopicFault)
  + [SNSNoAuthorizationFault (structure)](api-faults.md#SNSNoAuthorizationFault)
  + [SNSTopicArnNotFoundFault (structure)](api-faults.md#SNSTopicArnNotFoundFault)
  + [SharedSnapshotQuotaExceededFault (structure)](api-faults.md#SharedSnapshotQuotaExceededFault)
  + [SnapshotQuotaExceededFault (structure)](api-faults.md#SnapshotQuotaExceededFault)
  + [SourceNotFoundFault (structure)](api-faults.md#SourceNotFoundFault)
  + [StorageQuotaExceededFault (structure)](api-faults.md#StorageQuotaExceededFault)
  + [StorageTypeNotSupportedFault (structure)](api-faults.md#StorageTypeNotSupportedFault)
  + [SubnetAlreadyInUse (structure)](api-faults.md#SubnetAlreadyInUse)
  + [SubscriptionAlreadyExistFault (structure)](api-faults.md#SubscriptionAlreadyExistFault)
  + [SubscriptionCategoryNotFoundFault (structure)](api-faults.md#SubscriptionCategoryNotFoundFault)
  + [SubscriptionNotFoundFault (structure)](api-faults.md#SubscriptionNotFoundFault)

# API pour clusters de bases de données Neptune
<a name="api-clusters"></a>

**Actions :**
+ [Créer DBCluster (action)](#CreateDBCluster)
+ [Supprimer DBCluster (action)](#DeleteDBCluster)
+ [Modifier DBCluster (action)](#ModifyDBCluster)
+ [Démarrer DBCluster (action)](#StartDBCluster)
+ [Arrêter DBCluster (action)](#StopDBCluster)
+ [AddRoleToDBCluster (action)](#AddRoleToDBCluster)
+ [RemoveRoleFromDBCluster (action)](#RemoveRoleFromDBCluster)
+ [Basculement DBCluster (action)](#FailoverDBCluster)
+ [PromoteReadReplicaDBCluster (action)](#PromoteReadReplicaDBCluster)
+ [Décrire DBClusters (action)](#DescribeDBClusters)

**Structures :**
+ [DBCluster (structure)](#DBCluster)
+ [DBClusterMembre (structure)](#DBClusterMember)
+ [DBClusterRôle (structure)](#DBClusterRole)
+ [CloudwatchLogsExportConfiguration (structure)](#CloudwatchLogsExportConfiguration)
+ [PendingCloudwatchLogsExports (structure)](#PendingCloudwatchLogsExports)
+ [ClusterPendingModifiedValues (structure)](#ClusterPendingModifiedValues)

## Créer DBCluster (action)
<a name="CreateDBCluster"></a>

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

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

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

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

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

  Liste des zones de EC2 disponibilité dans lesquelles les instances du cluster de base de données peuvent être créées.
+ **BackupRetentionPeriod**(dans la CLI :`--backup-retention-period`) — un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Nombre de jours de conservation des sauvegardes automatiques. Vous devez spécifier une valeur minimale de 1.

  Par défaut : 1

  Contraintes :
  + Doit être une valeur comprise entre 1 et 35
+ **CopyTagsToSnapshot**(dans la CLI :`--copy-tags-to-snapshot`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  *Si cette valeur est définie sur `true`, les balises sont copiées dans n'importe quel instantané du cluster de bases de données créé.*
+ **DatabaseName** (dans la CLI : `--database-name`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom de votre base de données comprenant au maximum 64 caractères alphanumériques. Si vous ne fournissez pas de nom, Amazon Neptune ne crée pas de base de données dans le cluster de base de données que vous créez.
+ **DBClusterIdentifier** (dans la CLI : `--db-cluster-identifier`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Contraintes :
  + Doit contenir entre 1 et 63 lettres, chiffres ou traits d'union.
  + Le premier caractère doit être une lettre.
  + Ne peut pas se terminer par un trait d'union ni contenir deux traits d'union consécutifs.

  Exemple : `my-cluster1`
+ **DBClusterParameterGroupName** (dans la CLI : `--db-cluster-parameter-group-name`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Contraintes :
  + S'il est fourni, il doit correspondre au nom d'un existant DBClusterParameterGroup.
+ **DBSubnetGroupName** (dans la CLI : `--db-subnet-group-name`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Contraintes : Doit correspondre au nom d'un DBSubnet groupe existant. Impossible de conserver le nom par défaut.

  Exemple : `mySubnetgroup`
+ **DeletionProtection**(dans la CLI :`--deletion-protection`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Valeur qui indique si la protection contre la suppression est activée pour le cluster de bases de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée. Par défaut, la protection contre la suppression est désactivée.
+ **EnableCloudwatchLogsExports** (dans la CLI : `--enable-cloudwatch-logs-exports`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des types de journaux que ce cluster de base de données doit exporter vers CloudWatch Logs. Les types de journaux valides sont : `audit` (pour publier les journaux d'audit) et `slowquery` (pour publier les journaux de requêtes lentes). Consultez la section [Publication des journaux Neptune sur Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).
+ **EnableIAMDatabaseAuthentication**(dans la CLI :`--enable-iam-database-authentication`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

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

  Par défaut: `false`.
+ **Engine** (dans la CLI : `--engine`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom du moteur de base de données à utiliser pour ce cluster de base de données.

  Valeurs valides : `neptune`
+ **EngineVersion** (dans la CLI : `--engine-version`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Numéro de version du moteur de base de données à utiliser pour le nouveau cluster de bases de données.

  Exemple : `1.2.1.0`
+ **GlobalClusterIdentifier**(dans la CLI :`--global-cluster-identifier`) — a GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  ID de la base de données globale Neptune dans laquelle ce nouveau cluster de bases de données doit être ajouté.
+ **KmsKeyId** (dans la CLI : `--kms-key-id`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant de clé Amazon KMS pour un cluster de bases de données chiffré.

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

  Si aucune clé de chiffrement n'est spécifiée dans `KmsKeyId` :
  + Si `ReplicationSourceIdentifier` identifie une source chiffrée, Amazon Neptune utilise la clé de chiffrement qui a servi à chiffrer la source. Sinon, Amazon Neptune utilise votre clé de chiffrement par défaut.
  + Si le paramètre `StorageEncrypted` a la valeur true et que `ReplicationSourceIdentifier` n'est pas spécifié, Amazon Neptune utilise votre clé de chiffrement par défaut.

  Amazon KMS crée la clé de chiffrement par défaut pour votre compte Amazon. Votre compte Amazon a une clé de chiffrement par défaut différente pour chaque région Amazon.

  Si vous créez un réplica en lecture d'un cluster de bases de données chiffré dans une autre région Amazon, vous devez définir `KmsKeyId` sur un ID de clé KMS qui est valide dans la région Amazon de destination. Cette clé est utilisée pour chiffrer le réplica en lecture dans cette région Amazon.
+ **Port**(dans la CLI :`--port`) — un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

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

   Par défaut : `8182`
+ **PreferredBackupWindow** (dans la CLI : `--preferred-backup-window`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Par défaut, une fenêtre de 30 minutes est sélectionnée de manière aléatoire sur un bloc horaire de 8 heures pour chaque région Amazon. Pour voir les blocs horaires disponibles, consultez [Fenêtre de maintenance de Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-maintaining.html#manage-console-maintaining-window) dans le *Guide de l'utilisateur Amazon Neptune.*

  Contraintes :
  + Doit être au format `hh24:mi-hh24:mi`.
  + Doit être exprimée en heure UTC (Universal Coordinated Time).
  + Ne doit pas être en conflit avec la fenêtre de maintenance préférée.
  + Doit être de 30 minutes minimum.
+ **PreferredMaintenanceWindow** (dans la CLI : `--preferred-maintenance-window`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

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

  Par défaut, une fenêtre de 30 minutes est sélectionnée de manière aléatoire dans un bloc de 8 heures pour chaque région Amazon, se produisant un jour choisi au hasard dans la semaine. Pour voir les blocs horaires disponibles, consultez [Fenêtre de maintenance de Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-maintaining.html#manage-console-maintaining-window) dans le *Guide de l'utilisateur Amazon Neptune.*

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

  Contraintes : fenêtre minimale de 30 minutes.
+ **PreSignedUrl** (dans la CLI : `--pre-signed-url`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Ce paramètre n'est actuellement pas pris en charge.
+ **ReplicationSourceIdentifier** (dans la CLI : `--replication-source-identifier`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de l'instance de base de données ou du cluster de base de données source, si ce cluster de base de données est créé en tant que réplica en lecture.
+ **ServerlessV2ScalingConfiguration** (dans la CLI : `--serverless-v2-scaling-configuration`) : objet [Serverless V2 ScalingConfiguration](api-datatypes.md#ServerlessV2ScalingConfiguration).

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

  Pour plus d'informations, consultez [Utilisation d'Amazon Neptune sans serveur](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) dans le *Guide de l'utilisateur Amazon Neptune*.
+ **StorageEncrypted**(dans la CLI :`--storage-encrypted`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Indique si le cluster de base de données est chiffré.
+ **StorageType** (dans la CLI : `--storage-type`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Valeurs valides :
  + **`standard`**— (*valeur par défaut*) Configure un stockage de base de données rentable pour les applications dont l' I/O utilisation est modérée à faible. Lorsqu’il est défini sur `standard`, le type de stockage n’est pas renvoyé dans la réponse.
  + **`iopt1`**— Permet un [stockage optimisé pour les E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage), conçu pour répondre aux besoins de I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O débit.

    Le stockage optimisé pour les E/S Neptune n’est disponible qu’à partir de la version 1.3.0.0 du moteur.
+ **Tags** (dans la CLI : `--tags`) : tableau d'objets [Tag](api-other-apis.md#Tag).

  Balises à affecter au nouveau cluster de base de données.
+ **VpcSecurityGroupIds** (dans la CLI : `--vpc-security-group-ids`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

**Réponse**

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

Ce type de données est utilisé comme élément de réponse dans [Décrire DBClusters (action)](#DescribeDBClusters).
+ **AllocatedStorage**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  `AllocatedStorage` renvoie toujours la valeur 1, car la taille de stockage d'un cluster de bases de données Neptune n'est pas fixe ; elle s'ajuste automatiquement en fonction des besoins.
+ **AssociatedRoles** : tableau d'objets [DBClusterRôle](#DBClusterRole).

  Fournit la liste des rôles Amazon Identity and Access Management (IAM) associés au cluster de bases de données. Les rôles IAM associés à un cluster de bases de données autorisent celui-ci à accéder aux autres services Amazon en votre nom.
+ **AutomaticRestartTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Heure à laquelle le cluster de bases de données sera automatiquement redémarré.
+ **AvailabilityZones** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit la liste des zones de EC2 disponibilité dans lesquelles les instances du cluster de base de données peuvent être créées.
+ **BacktrackConsumedChangeRecords**— a LongOptional, de type : `long` (un entier signé de 64 bits).

  Non pris en charge par Neptune.
+ **BacktrackWindow**— a LongOptional, de type : `long` (un entier signé de 64 bits).

  Non pris en charge par Neptune.
+ **BackupRetentionPeriod**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie le nombre de jours de conservation des instantanés de base de données automatiques.
+ **Capacity**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Non pris en charge par Neptune.
+ **CloneGroupId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifie le groupe de clones auquel est associé le cluster de bases de données.
+ **ClusterCreateTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure à laquelle le cluster de bases de données a été créé, en heure UTC (Universal Coordinated Time).
+ **CopyTagsToSnapshot**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  *Si cette valeur est définie sur `true`, les balises sont copiées dans n'importe quel instantané du cluster de bases de données créé.*
+ **CrossAccountClone**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Si cette valeur est définie sur `true`, le cluster de bases de données peut être cloné sur plusieurs comptes.
+ **DatabaseName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient le nom de la base de données initiale de ce cluster de bases de données qui a été fourni au moment de la création, dans la mesure où un nom a été spécifié au moment de créer le cluster de bases de données. Ce même nom est renvoyé pendant la durée de vie du cluster de bases de données.
+ **DBClusterArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) du cluster de bases de données.
+ **DBClusterIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un identifiant de cluster de bases de données fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie un cluster de bases de données.
+ **DBClusterMembers** : tableau d'objets [DBClusterMembre](#DBClusterMember).

  Fournit la liste des instances qui composent le cluster de bases de données.
+ **DBClusterParameterGroup** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le nom du groupe de paramètres de cluster de base de données pour le cluster de base de données.
+ **DbClusterResourceId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant immuable et propre à la région Amazon du cluster de bases de données. Cet identifiant se trouve dans les entrées du CloudTrail journal Amazon chaque fois que la clé Amazon KMS du cluster de base de données est consultée.
+ **DBSubnetGroup** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie les informations sur le groupe de sous-réseaux associé au cluster de bases de données, notamment le nom, la description et les sous-réseaux du groupe de sous-réseaux.
+ **DeletionProtection**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Indique si la protection contre la suppression est activée pour le cluster de bases de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée.
+ **EarliestBacktrackTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Non pris en charge par Neptune.
+ **EarliestRestorableTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure la plus proche à laquelle une base de données peut être restaurée par point-in-time restauration.
+ **EnabledCloudwatchLogsExports** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des types de journaux que ce cluster de base de données est configuré pour exporter vers CloudWatch Logs. Les types de journaux valides sont les suivants : `audit` (pour publier les journaux d'audit CloudWatch) et slowquery (pour publier les journaux de requêtes lentes). CloudWatch Consultez la section [Publication des journaux Neptune sur Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).
+ **Endpoint** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le point de terminaison de connexion pour l'instance principale du cluster de bases de données.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le nom du moteur de base de données à utiliser pour ce cluster de bases de données.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique la version du moteur de base de données.
+ **GlobalClusterIdentifier**— a GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.
+ **HostedZoneId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'ID attribué par Amazon Route 53 lorsque vous créez une zone hébergée.
+ **IAMDatabaseAuthenticationEnabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur true (vrai) si le mappage des comptes Amazon Identity and Access Management (IAM) aux comptes de base de données est activé ; sinon, valeur false (faux).
+ **IOOptimizedNextAllowedModificationTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  La prochaine fois, vous pourrez modifier le cluster de bases de données de façon à utiliser le type de stockage `iopt1`.
+ **KmsKeyId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si `StorageEncrypted` a la valeur true (vrai), identifiant de clé Amazon KMS pour le cluster de bases de données chiffré.
+ **LatestRestorableTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure limite à laquelle une base de données peut être restaurée à l'aide de la fonction de point-in-time restauration.
+ **MultiAZ** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si le cluster de bases de données possède des instances dans plusieurs zones de disponibilité.
+ **PendingModifiedValues** : objet [ClusterPendingModifiedValues](#ClusterPendingModifiedValues).

  Ce type de données est utilisé comme élément de réponse dans l'opération `ModifyDBCluster` et contient les modifications qui seront appliquées lors de la fenêtre de maintenance suivante.
+ **PercentProgress** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie la progression de l'opération sous forme de pourcentage.
+ **Port**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie le port sur lequel le moteur de base de données est à l'écoute.
+ **PreferredBackupWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété `BackupRetentionPeriod`.
+ **PreferredMaintenanceWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.
+ **ReaderEndpoint** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Si un basculement se produit et que le réplica en lecture auquel vous êtes connecté est promu en instance principale, votre connexion est supprimée. Pour continuer à envoyer votre charge de travail de lecture à d'autres réplicas en lecture du cluster, vous pouvez alors vous reconnecter au point de terminaison du lecteur.
+ **ReadReplicaIdentifiers** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un ou plusieurs identifiants des réplicas en lecture associés à ce cluster de bases de données.
+ **ReplicationSourceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge par Neptune.
+ **ReplicationType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge par Neptune.
+ **ServerlessV2ScalingConfiguration** : objet [Serverless V2 ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo).

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

  Pour plus d'informations, consultez [Utilisation d'Amazon Neptune sans serveur](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) dans le *Guide de l'utilisateur Amazon Neptune*.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'état actuel de ce cluster de base de données.
+ **StorageEncrypted** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si le cluster de base de données est chiffré.
+ **StorageType** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Valeurs valides :
  + **`standard`**— (*valeur par défaut*) Fournit un stockage de base de données économique pour les applications dont l' I/O utilisation est modérée à faible.
  + **`iopt1`**— Permet un [stockage optimisé pour les E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage), conçu pour répondre aux besoins de I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O débit.

    Le stockage optimisé pour les E/S Neptune n’est disponible qu’à partir de la version 1.3.0.0 du moteur.
+ **VpcSecurityGroups** : tableau d'objets [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

**Erreurs**
+ [DBClusterAlreadyExistsFault](api-faults.md#DBClusterAlreadyExistsFault)
+ [InsufficientStorageClusterCapacityFault](api-faults.md#InsufficientStorageClusterCapacityFault)
+ [DBClusterQuotaExceededFault](api-faults.md#DBClusterQuotaExceededFault)
+ [StorageQuotaExceededFault](api-faults.md#StorageQuotaExceededFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
+ [Non valide VPCNetwork StateFault](api-faults.md#InvalidVPCNetworkStateFault)
+ [Non valide DBCluster StateFault](api-faults.md#InvalidDBClusterStateFault)
+ [Non valide DBSubnet GroupStateFault](api-faults.md#InvalidDBSubnetGroupStateFault)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)
+ [Non valide DBInstance StateFault](api-faults.md#InvalidDBInstanceStateFault)
+ [DBClusterParameterGroupNotFoundFault](api-faults.md#DBClusterParameterGroupNotFoundFault)
+ [KMSKeyNotAccessibleFault](api-faults.md#KMSKeyNotAccessibleFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [DBSubnetGroupDoesNotCoverEnoughAZs](api-faults.md#DBSubnetGroupDoesNotCoverEnoughAZs)
+ [GlobalClusterNotFoundFault](api-faults.md#GlobalClusterNotFoundFault)
+ [InvalidGlobalClusterStateFault](api-faults.md#InvalidGlobalClusterStateFault)

## Supprimer DBCluster (action)
<a name="DeleteDBCluster"></a>

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

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

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

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

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

  Contraintes :
  + Doit correspondre à un DBCluster identifiant existant.
+ **FinalDBSnapshotIdentifier** (dans la CLI : `--final-db-snapshot-identifier`) : chaîne de type : `string` (chaîne encodée en UTF-8).

   Identifiant du nouvel instantané de cluster de base de données créé lorsque `SkipFinalSnapshot` a la valeur `false`.
**Note**  
 Le fait de spécifier ce paramètre et également de définir le paramètre `SkipFinalShapshot` sur true génère une erreur.

  Contraintes :
  + Doit comporter entre 1 et 255 lettres, chiffres ou traits d'union.
  + Le premier caractère doit être une lettre
  + Ne peut pas se terminer par un trait d'union ni contenir deux traits d'union consécutifs
+ **SkipFinalSnapshot** (dans la CLI : `--skip-final-snapshot`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

   Détermine si un instantané de cluster de base de données final est créé avant la suppression du cluster de base de données. Si `true` est spécifié, aucun instantané de cluster de base de données n'est créé. Si `false` est spécifié, un instantané de cluster de base de données est créé avant la suppression du cluster de base de données.
**Note**  
Vous devez spécifier un paramètre `FinalDBSnapshotIdentifier` si `SkipFinalSnapshot` a la valeur `false`.

  Par défaut : `false`

**Réponse**

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

Ce type de données est utilisé comme élément de réponse dans [Décrire DBClusters (action)](#DescribeDBClusters).
+ **AllocatedStorage**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  `AllocatedStorage` renvoie toujours la valeur 1, car la taille de stockage d'un cluster de bases de données Neptune n'est pas fixe ; elle s'ajuste automatiquement en fonction des besoins.
+ **AssociatedRoles** : tableau d'objets [DBClusterRôle](#DBClusterRole).

  Fournit la liste des rôles Amazon Identity and Access Management (IAM) associés au cluster de bases de données. Les rôles IAM associés à un cluster de bases de données autorisent celui-ci à accéder aux autres services Amazon en votre nom.
+ **AutomaticRestartTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Heure à laquelle le cluster de bases de données sera automatiquement redémarré.
+ **AvailabilityZones** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit la liste des zones de EC2 disponibilité dans lesquelles les instances du cluster de base de données peuvent être créées.
+ **BacktrackConsumedChangeRecords**— a LongOptional, de type : `long` (un entier signé de 64 bits).

  Non pris en charge par Neptune.
+ **BacktrackWindow**— a LongOptional, de type : `long` (un entier signé de 64 bits).

  Non pris en charge par Neptune.
+ **BackupRetentionPeriod**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie le nombre de jours de conservation des instantanés de base de données automatiques.
+ **Capacity**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Non pris en charge par Neptune.
+ **CloneGroupId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifie le groupe de clones auquel est associé le cluster de bases de données.
+ **ClusterCreateTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure à laquelle le cluster de bases de données a été créé, en heure UTC (Universal Coordinated Time).
+ **CopyTagsToSnapshot**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  *Si cette valeur est définie sur `true`, les balises sont copiées dans n'importe quel instantané du cluster de bases de données créé.*
+ **CrossAccountClone**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Si cette valeur est définie sur `true`, le cluster de bases de données peut être cloné sur plusieurs comptes.
+ **DatabaseName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient le nom de la base de données initiale de ce cluster de bases de données qui a été fourni au moment de la création, dans la mesure où un nom a été spécifié au moment de créer le cluster de bases de données. Ce même nom est renvoyé pendant la durée de vie du cluster de bases de données.
+ **DBClusterArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) du cluster de bases de données.
+ **DBClusterIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un identifiant de cluster de bases de données fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie un cluster de bases de données.
+ **DBClusterMembers** : tableau d'objets [DBClusterMembre](#DBClusterMember).

  Fournit la liste des instances qui composent le cluster de bases de données.
+ **DBClusterParameterGroup** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le nom du groupe de paramètres de cluster de base de données pour le cluster de base de données.
+ **DbClusterResourceId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant immuable et propre à la région Amazon du cluster de bases de données. Cet identifiant se trouve dans les entrées du CloudTrail journal Amazon chaque fois que la clé Amazon KMS du cluster de base de données est consultée.
+ **DBSubnetGroup** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie les informations sur le groupe de sous-réseaux associé au cluster de bases de données, notamment le nom, la description et les sous-réseaux du groupe de sous-réseaux.
+ **DeletionProtection**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Indique si la protection contre la suppression est activée pour le cluster de bases de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée.
+ **EarliestBacktrackTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Non pris en charge par Neptune.
+ **EarliestRestorableTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure la plus proche à laquelle une base de données peut être restaurée par point-in-time restauration.
+ **EnabledCloudwatchLogsExports** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des types de journaux que ce cluster de base de données est configuré pour exporter vers CloudWatch Logs. Les types de journaux valides sont les suivants : `audit` (pour publier les journaux d'audit CloudWatch) et slowquery (pour publier les journaux de requêtes lentes). CloudWatch Consultez la section [Publication des journaux Neptune sur Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).
+ **Endpoint** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le point de terminaison de connexion pour l'instance principale du cluster de bases de données.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le nom du moteur de base de données à utiliser pour ce cluster de bases de données.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique la version du moteur de base de données.
+ **GlobalClusterIdentifier**— a GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.
+ **HostedZoneId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'ID attribué par Amazon Route 53 lorsque vous créez une zone hébergée.
+ **IAMDatabaseAuthenticationEnabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur true (vrai) si le mappage des comptes Amazon Identity and Access Management (IAM) aux comptes de base de données est activé ; sinon, valeur false (faux).
+ **IOOptimizedNextAllowedModificationTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  La prochaine fois, vous pourrez modifier le cluster de bases de données de façon à utiliser le type de stockage `iopt1`.
+ **KmsKeyId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si `StorageEncrypted` a la valeur true (vrai), identifiant de clé Amazon KMS pour le cluster de bases de données chiffré.
+ **LatestRestorableTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure limite à laquelle une base de données peut être restaurée à l'aide de la fonction de point-in-time restauration.
+ **MultiAZ** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si le cluster de bases de données possède des instances dans plusieurs zones de disponibilité.
+ **PendingModifiedValues** : objet [ClusterPendingModifiedValues](#ClusterPendingModifiedValues).

  Ce type de données est utilisé comme élément de réponse dans l'opération `ModifyDBCluster` et contient les modifications qui seront appliquées lors de la fenêtre de maintenance suivante.
+ **PercentProgress** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie la progression de l'opération sous forme de pourcentage.
+ **Port**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie le port sur lequel le moteur de base de données est à l'écoute.
+ **PreferredBackupWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété `BackupRetentionPeriod`.
+ **PreferredMaintenanceWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.
+ **ReaderEndpoint** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Si un basculement se produit et que le réplica en lecture auquel vous êtes connecté est promu en instance principale, votre connexion est supprimée. Pour continuer à envoyer votre charge de travail de lecture à d'autres réplicas en lecture du cluster, vous pouvez alors vous reconnecter au point de terminaison du lecteur.
+ **ReadReplicaIdentifiers** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un ou plusieurs identifiants des réplicas en lecture associés à ce cluster de bases de données.
+ **ReplicationSourceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge par Neptune.
+ **ReplicationType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge par Neptune.
+ **ServerlessV2ScalingConfiguration** : objet [Serverless V2 ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo).

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

  Pour plus d'informations, consultez [Utilisation d'Amazon Neptune sans serveur](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) dans le *Guide de l'utilisateur Amazon Neptune*.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'état actuel de ce cluster de base de données.
+ **StorageEncrypted** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si le cluster de base de données est chiffré.
+ **StorageType** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Valeurs valides :
  + **`standard`**— (*valeur par défaut*) Fournit un stockage de base de données économique pour les applications dont l' I/O utilisation est modérée à faible.
  + **`iopt1`**— Permet un [stockage optimisé pour les E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage), conçu pour répondre aux besoins de I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O débit.

    Le stockage optimisé pour les E/S Neptune n’est disponible qu’à partir de la version 1.3.0.0 du moteur.
+ **VpcSecurityGroups** : tableau d'objets [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

**Erreurs**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [Non valide DBCluster StateFault](api-faults.md#InvalidDBClusterStateFault)
+ [DBClusterSnapshotAlreadyExistsFault](api-faults.md#DBClusterSnapshotAlreadyExistsFault)
+ [SnapshotQuotaExceededFault](api-faults.md#SnapshotQuotaExceededFault)
+ [Non valide DBCluster SnapshotStateFault](api-faults.md#InvalidDBClusterSnapshotStateFault)

## Modifier DBCluster (action)
<a name="ModifyDBCluster"></a>

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

Permet de modifier un paramètre de cluster de base de données. Vous pouvez modifier un ou plusieurs paramètres de configuration de base de données en spécifiant ces paramètres et les nouvelles valeurs dans la demande.

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

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

  Contraintes : vous devez définir l' allow-major-version-upgradeindicateur lorsque vous fournissez un `EngineVersion` paramètre qui utilise une version majeure différente de la version actuelle du cluster de bases de données.
+ **ApplyImmediately** (dans la CLI : `--apply-immediately`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

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

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

  Par défaut : `false`
+ **BackupRetentionPeriod**(dans la CLI :`--backup-retention-period`) — un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Nombre de jours de conservation des sauvegardes automatiques. Vous devez spécifier une valeur minimale de 1.

  Par défaut : 1

  Contraintes :
  + Doit être une valeur comprise entre 1 et 35
+ **CloudwatchLogsExportConfiguration** (dans la CLI : `--cloudwatch-logs-export-configuration`) : objet [CloudwatchLogsExportConfiguration](#CloudwatchLogsExportConfiguration).

  Le paramètre de configuration des types de journaux à activer pour l'exportation vers les CloudWatch journaux pour un cluster de base de données spécifique. Consultez la section [Utilisation de la CLI pour publier les journaux d'audit de Neptune dans Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html#cloudwatch-logs-cli). CloudWatch 
+ **CopyTagsToSnapshot**(dans la CLI :`--copy-tags-to-snapshot`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  *Si cette valeur est définie sur `true`, les balises sont copiées dans n'importe quel instantané du cluster de bases de données créé.*
+ **DBClusterIdentifier** (dans la CLI : `--db-cluster-identifier`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant du cluster de bases de données en cours de modification. Ce paramètre n'est pas sensible à la casse.

  Contraintes :
  + Doit correspondre à l'identifiant d'un existant DBCluster.
+ **DBClusterParameterGroupName** (dans la CLI : `--db-cluster-parameter-group-name`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom du groupe de paramètres de cluster de base de données à utiliser pour le cluster de base de données.
+ **DBInstanceParameterGroupName** (dans la CLI : `--db-instance-parameter-group-name`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Le nom du groupe de paramètres de base de données à appliquer à toutes les instances du cluster de base de données. 
**Note**  
Lorsque vous appliquez un groupe de paramètres à l'aide de `DBInstanceParameterGroupName`, les modifications de paramètres ne seront pas appliquées lors de la fenêtre de maintenance suivante. Elles sont effectives immédiatement.

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

  Contraintes :
  + Le groupe de paramètres de la base de données doit faire partie de la même famille de groupes de paramètres de la base de données que la version de ce cluster de bases de données cible.
  + Le paramètre `DBInstanceParameterGroupName` n'est valide qu'en combinaison avec le paramètre `AllowMajorVersionUpgrade`.
+ **DeletionProtection**(dans la CLI :`--deletion-protection`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Valeur qui indique si la protection contre la suppression est activée pour le cluster de bases de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée. Par défaut, la protection contre la suppression est désactivée.
+ **EnableIAMDatabaseAuthentication**(dans la CLI :`--enable-iam-database-authentication`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

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

  Par défaut : `false`
+ **EngineVersion** (dans la CLI : `--engine-version`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Numéro de version du moteur de base de données vers lequel vous souhaitez effectuer la mise à niveau. La modification de ce paramètre entraîne une interruption. La modification est appliquée pendant la fenêtre de maintenance suivante, sauf si le paramètre `ApplyImmediately` a la valeur true.

  Pour obtenir la liste des versions de moteur valides, consultez [Versions du moteur pour Amazon Neptune](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases.html), ou appelez [Décrire DBEngine les versions (action)](api-other-apis.md#DescribeDBEngineVersions).
+ **NewDBClusterIdentifier** (dans la CLI : `--new-db-cluster-identifier`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nouvel identifiant du cluster de base de données lorsque celui-ci est renommé. Cette valeur est stockée sous la forme d'une chaîne en minuscules.

  Contraintes :
  + Doit contenir entre 1 et 63 lettres, chiffres ou traits d'union
  + Le premier caractère doit être une lettre
  + Ne peut pas se terminer par un trait d'union ni contenir deux traits d'union consécutifs

  Exemple : `my-cluster2`
+ **Port**(dans la CLI :`--port`) — un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

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

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

  Valeur par défaut : port du cluster de bases de données d'origine.
+ **PreferredBackupWindow** (dans la CLI : `--preferred-backup-window`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

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

  Contraintes :
  + Doit être au format `hh24:mi-hh24:mi`.
  + Doit être exprimée en heure UTC (Universal Coordinated Time).
  + Ne doit pas être en conflit avec la fenêtre de maintenance préférée.
  + Doit être de 30 minutes minimum.
+ **PreferredMaintenanceWindow** (dans la CLI : `--preferred-maintenance-window`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

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

  Par défaut, une fenêtre de 30 minutes est sélectionnée de manière aléatoire dans un bloc de 8 heures pour chaque région Amazon, se produisant un jour choisi au hasard dans la semaine.

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

  Contraintes : fenêtre minimale de 30 minutes.
+ **ServerlessV2ScalingConfiguration** (dans la CLI : `--serverless-v2-scaling-configuration`) : objet [Serverless V2 ScalingConfiguration](api-datatypes.md#ServerlessV2ScalingConfiguration).

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

  Pour plus d'informations, consultez [Utilisation d'Amazon Neptune sans serveur](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) dans le *Guide de l'utilisateur Amazon Neptune*.
+ **StorageType** (dans la CLI : `--storage-type`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Valeurs valides :
  + **`standard`**— (*valeur par défaut*) Configure un stockage de base de données rentable pour les applications dont l' I/O utilisation est modérée à faible.
  + **`iopt1`**— Permet un [stockage optimisé pour les E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage), conçu pour répondre aux besoins de I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O débit.

    Le stockage optimisé pour les E/S Neptune n’est disponible qu’à partir de la version 1.3.0.0 du moteur.
+ **VpcSecurityGroupIds** (dans la CLI : `--vpc-security-group-ids`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

**Réponse**

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

Ce type de données est utilisé comme élément de réponse dans [Décrire DBClusters (action)](#DescribeDBClusters).
+ **AllocatedStorage**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  `AllocatedStorage` renvoie toujours la valeur 1, car la taille de stockage d'un cluster de bases de données Neptune n'est pas fixe ; elle s'ajuste automatiquement en fonction des besoins.
+ **AssociatedRoles** : tableau d'objets [DBClusterRôle](#DBClusterRole).

  Fournit la liste des rôles Amazon Identity and Access Management (IAM) associés au cluster de bases de données. Les rôles IAM associés à un cluster de bases de données autorisent celui-ci à accéder aux autres services Amazon en votre nom.
+ **AutomaticRestartTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Heure à laquelle le cluster de bases de données sera automatiquement redémarré.
+ **AvailabilityZones** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit la liste des zones de EC2 disponibilité dans lesquelles les instances du cluster de base de données peuvent être créées.
+ **BacktrackConsumedChangeRecords**— a LongOptional, de type : `long` (un entier signé de 64 bits).

  Non pris en charge par Neptune.
+ **BacktrackWindow**— a LongOptional, de type : `long` (un entier signé de 64 bits).

  Non pris en charge par Neptune.
+ **BackupRetentionPeriod**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie le nombre de jours de conservation des instantanés de base de données automatiques.
+ **Capacity**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Non pris en charge par Neptune.
+ **CloneGroupId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifie le groupe de clones auquel est associé le cluster de bases de données.
+ **ClusterCreateTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure à laquelle le cluster de bases de données a été créé, en heure UTC (Universal Coordinated Time).
+ **CopyTagsToSnapshot**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  *Si cette valeur est définie sur `true`, les balises sont copiées dans n'importe quel instantané du cluster de bases de données créé.*
+ **CrossAccountClone**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Si cette valeur est définie sur `true`, le cluster de bases de données peut être cloné sur plusieurs comptes.
+ **DatabaseName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient le nom de la base de données initiale de ce cluster de bases de données qui a été fourni au moment de la création, dans la mesure où un nom a été spécifié au moment de créer le cluster de bases de données. Ce même nom est renvoyé pendant la durée de vie du cluster de bases de données.
+ **DBClusterArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) du cluster de bases de données.
+ **DBClusterIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un identifiant de cluster de bases de données fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie un cluster de bases de données.
+ **DBClusterMembers** : tableau d'objets [DBClusterMembre](#DBClusterMember).

  Fournit la liste des instances qui composent le cluster de bases de données.
+ **DBClusterParameterGroup** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le nom du groupe de paramètres de cluster de base de données pour le cluster de base de données.
+ **DbClusterResourceId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant immuable et propre à la région Amazon du cluster de bases de données. Cet identifiant se trouve dans les entrées du CloudTrail journal Amazon chaque fois que la clé Amazon KMS du cluster de base de données est consultée.
+ **DBSubnetGroup** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie les informations sur le groupe de sous-réseaux associé au cluster de bases de données, notamment le nom, la description et les sous-réseaux du groupe de sous-réseaux.
+ **DeletionProtection**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Indique si la protection contre la suppression est activée pour le cluster de bases de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée.
+ **EarliestBacktrackTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Non pris en charge par Neptune.
+ **EarliestRestorableTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure la plus proche à laquelle une base de données peut être restaurée par point-in-time restauration.
+ **EnabledCloudwatchLogsExports** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des types de journaux que ce cluster de base de données est configuré pour exporter vers CloudWatch Logs. Les types de journaux valides sont les suivants : `audit` (pour publier les journaux d'audit CloudWatch) et slowquery (pour publier les journaux de requêtes lentes). CloudWatch Consultez la section [Publication des journaux Neptune sur Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).
+ **Endpoint** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le point de terminaison de connexion pour l'instance principale du cluster de bases de données.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le nom du moteur de base de données à utiliser pour ce cluster de bases de données.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique la version du moteur de base de données.
+ **GlobalClusterIdentifier**— a GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.
+ **HostedZoneId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'ID attribué par Amazon Route 53 lorsque vous créez une zone hébergée.
+ **IAMDatabaseAuthenticationEnabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur true (vrai) si le mappage des comptes Amazon Identity and Access Management (IAM) aux comptes de base de données est activé ; sinon, valeur false (faux).
+ **IOOptimizedNextAllowedModificationTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  La prochaine fois, vous pourrez modifier le cluster de bases de données de façon à utiliser le type de stockage `iopt1`.
+ **KmsKeyId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si `StorageEncrypted` a la valeur true (vrai), identifiant de clé Amazon KMS pour le cluster de bases de données chiffré.
+ **LatestRestorableTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure limite à laquelle une base de données peut être restaurée à l'aide de la fonction de point-in-time restauration.
+ **MultiAZ** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si le cluster de bases de données possède des instances dans plusieurs zones de disponibilité.
+ **PendingModifiedValues** : objet [ClusterPendingModifiedValues](#ClusterPendingModifiedValues).

  Ce type de données est utilisé comme élément de réponse dans l'opération `ModifyDBCluster` et contient les modifications qui seront appliquées lors de la fenêtre de maintenance suivante.
+ **PercentProgress** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie la progression de l'opération sous forme de pourcentage.
+ **Port**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie le port sur lequel le moteur de base de données est à l'écoute.
+ **PreferredBackupWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété `BackupRetentionPeriod`.
+ **PreferredMaintenanceWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.
+ **ReaderEndpoint** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Si un basculement se produit et que le réplica en lecture auquel vous êtes connecté est promu en instance principale, votre connexion est supprimée. Pour continuer à envoyer votre charge de travail de lecture à d'autres réplicas en lecture du cluster, vous pouvez alors vous reconnecter au point de terminaison du lecteur.
+ **ReadReplicaIdentifiers** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un ou plusieurs identifiants des réplicas en lecture associés à ce cluster de bases de données.
+ **ReplicationSourceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge par Neptune.
+ **ReplicationType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge par Neptune.
+ **ServerlessV2ScalingConfiguration** : objet [Serverless V2 ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo).

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

  Pour plus d'informations, consultez [Utilisation d'Amazon Neptune sans serveur](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) dans le *Guide de l'utilisateur Amazon Neptune*.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'état actuel de ce cluster de base de données.
+ **StorageEncrypted** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si le cluster de base de données est chiffré.
+ **StorageType** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Valeurs valides :
  + **`standard`**— (*valeur par défaut*) Fournit un stockage de base de données économique pour les applications dont l' I/O utilisation est modérée à faible.
  + **`iopt1`**— Permet un [stockage optimisé pour les E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage), conçu pour répondre aux besoins de I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O débit.

    Le stockage optimisé pour les E/S Neptune n’est disponible qu’à partir de la version 1.3.0.0 du moteur.
+ **VpcSecurityGroups** : tableau d'objets [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

**Erreurs**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [Non valide DBCluster StateFault](api-faults.md#InvalidDBClusterStateFault)
+ [StorageQuotaExceededFault](api-faults.md#StorageQuotaExceededFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
+ [Non valide VPCNetwork StateFault](api-faults.md#InvalidVPCNetworkStateFault)
+ [Non valide DBSubnet GroupStateFault](api-faults.md#InvalidDBSubnetGroupStateFault)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)
+ [DBClusterParameterGroupNotFoundFault](api-faults.md#DBClusterParameterGroupNotFoundFault)
+ [Non valide DBSecurity GroupStateFault](api-faults.md#InvalidDBSecurityGroupStateFault)
+ [Non valide DBInstance StateFault](api-faults.md#InvalidDBInstanceStateFault)
+ [DBClusterAlreadyExistsFault](api-faults.md#DBClusterAlreadyExistsFault)
+ [StorageTypeNotSupportedFault](api-faults.md#StorageTypeNotSupportedFault)

## Démarrer DBCluster (action)
<a name="StartDBCluster"></a>

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

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

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

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

**Réponse**

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

Ce type de données est utilisé comme élément de réponse dans [Décrire DBClusters (action)](#DescribeDBClusters).
+ **AllocatedStorage**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  `AllocatedStorage` renvoie toujours la valeur 1, car la taille de stockage d'un cluster de bases de données Neptune n'est pas fixe ; elle s'ajuste automatiquement en fonction des besoins.
+ **AssociatedRoles** : tableau d'objets [DBClusterRôle](#DBClusterRole).

  Fournit la liste des rôles Amazon Identity and Access Management (IAM) associés au cluster de bases de données. Les rôles IAM associés à un cluster de bases de données autorisent celui-ci à accéder aux autres services Amazon en votre nom.
+ **AutomaticRestartTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Heure à laquelle le cluster de bases de données sera automatiquement redémarré.
+ **AvailabilityZones** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit la liste des zones de EC2 disponibilité dans lesquelles les instances du cluster de base de données peuvent être créées.
+ **BacktrackConsumedChangeRecords**— a LongOptional, de type : `long` (un entier signé de 64 bits).

  Non pris en charge par Neptune.
+ **BacktrackWindow**— a LongOptional, de type : `long` (un entier signé de 64 bits).

  Non pris en charge par Neptune.
+ **BackupRetentionPeriod**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie le nombre de jours de conservation des instantanés de base de données automatiques.
+ **Capacity**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Non pris en charge par Neptune.
+ **CloneGroupId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifie le groupe de clones auquel est associé le cluster de bases de données.
+ **ClusterCreateTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure à laquelle le cluster de bases de données a été créé, en heure UTC (Universal Coordinated Time).
+ **CopyTagsToSnapshot**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  *Si cette valeur est définie sur `true`, les balises sont copiées dans n'importe quel instantané du cluster de bases de données créé.*
+ **CrossAccountClone**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Si cette valeur est définie sur `true`, le cluster de bases de données peut être cloné sur plusieurs comptes.
+ **DatabaseName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient le nom de la base de données initiale de ce cluster de bases de données qui a été fourni au moment de la création, dans la mesure où un nom a été spécifié au moment de créer le cluster de bases de données. Ce même nom est renvoyé pendant la durée de vie du cluster de bases de données.
+ **DBClusterArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) du cluster de bases de données.
+ **DBClusterIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un identifiant de cluster de bases de données fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie un cluster de bases de données.
+ **DBClusterMembers** : tableau d'objets [DBClusterMembre](#DBClusterMember).

  Fournit la liste des instances qui composent le cluster de bases de données.
+ **DBClusterParameterGroup** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le nom du groupe de paramètres de cluster de base de données pour le cluster de base de données.
+ **DbClusterResourceId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant immuable et propre à la région Amazon du cluster de bases de données. Cet identifiant se trouve dans les entrées du CloudTrail journal Amazon chaque fois que la clé Amazon KMS du cluster de base de données est consultée.
+ **DBSubnetGroup** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie les informations sur le groupe de sous-réseaux associé au cluster de bases de données, notamment le nom, la description et les sous-réseaux du groupe de sous-réseaux.
+ **DeletionProtection**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Indique si la protection contre la suppression est activée pour le cluster de bases de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée.
+ **EarliestBacktrackTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Non pris en charge par Neptune.
+ **EarliestRestorableTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure la plus proche à laquelle une base de données peut être restaurée par point-in-time restauration.
+ **EnabledCloudwatchLogsExports** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des types de journaux que ce cluster de base de données est configuré pour exporter vers CloudWatch Logs. Les types de journaux valides sont les suivants : `audit` (pour publier les journaux d'audit CloudWatch) et slowquery (pour publier les journaux de requêtes lentes). CloudWatch Consultez la section [Publication des journaux Neptune sur Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).
+ **Endpoint** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le point de terminaison de connexion pour l'instance principale du cluster de bases de données.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le nom du moteur de base de données à utiliser pour ce cluster de bases de données.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique la version du moteur de base de données.
+ **GlobalClusterIdentifier**— a GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.
+ **HostedZoneId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'ID attribué par Amazon Route 53 lorsque vous créez une zone hébergée.
+ **IAMDatabaseAuthenticationEnabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur true (vrai) si le mappage des comptes Amazon Identity and Access Management (IAM) aux comptes de base de données est activé ; sinon, valeur false (faux).
+ **IOOptimizedNextAllowedModificationTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  La prochaine fois, vous pourrez modifier le cluster de bases de données de façon à utiliser le type de stockage `iopt1`.
+ **KmsKeyId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si `StorageEncrypted` a la valeur true (vrai), identifiant de clé Amazon KMS pour le cluster de bases de données chiffré.
+ **LatestRestorableTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure limite à laquelle une base de données peut être restaurée à l'aide de la fonction de point-in-time restauration.
+ **MultiAZ** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si le cluster de bases de données possède des instances dans plusieurs zones de disponibilité.
+ **PendingModifiedValues** : objet [ClusterPendingModifiedValues](#ClusterPendingModifiedValues).

  Ce type de données est utilisé comme élément de réponse dans l'opération `ModifyDBCluster` et contient les modifications qui seront appliquées lors de la fenêtre de maintenance suivante.
+ **PercentProgress** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie la progression de l'opération sous forme de pourcentage.
+ **Port**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie le port sur lequel le moteur de base de données est à l'écoute.
+ **PreferredBackupWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété `BackupRetentionPeriod`.
+ **PreferredMaintenanceWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.
+ **ReaderEndpoint** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Si un basculement se produit et que le réplica en lecture auquel vous êtes connecté est promu en instance principale, votre connexion est supprimée. Pour continuer à envoyer votre charge de travail de lecture à d'autres réplicas en lecture du cluster, vous pouvez alors vous reconnecter au point de terminaison du lecteur.
+ **ReadReplicaIdentifiers** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un ou plusieurs identifiants des réplicas en lecture associés à ce cluster de bases de données.
+ **ReplicationSourceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge par Neptune.
+ **ReplicationType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge par Neptune.
+ **ServerlessV2ScalingConfiguration** : objet [Serverless V2 ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo).

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

  Pour plus d'informations, consultez [Utilisation d'Amazon Neptune sans serveur](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) dans le *Guide de l'utilisateur Amazon Neptune*.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'état actuel de ce cluster de base de données.
+ **StorageEncrypted** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si le cluster de base de données est chiffré.
+ **StorageType** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Valeurs valides :
  + **`standard`**— (*valeur par défaut*) Fournit un stockage de base de données économique pour les applications dont l' I/O utilisation est modérée à faible.
  + **`iopt1`**— Permet un [stockage optimisé pour les E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage), conçu pour répondre aux besoins de I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O débit.

    Le stockage optimisé pour les E/S Neptune n’est disponible qu’à partir de la version 1.3.0.0 du moteur.
+ **VpcSecurityGroups** : tableau d'objets [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

**Erreurs**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [Non valide DBCluster StateFault](api-faults.md#InvalidDBClusterStateFault)
+ [Non valide DBInstance StateFault](api-faults.md#InvalidDBInstanceStateFault)

## Arrêter DBCluster (action)
<a name="StopDBCluster"></a>

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

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

Neptune conserve également les journaux de transactions afin que vous puissiez effectuer une point-in-time restauration si nécessaire.

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

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

**Réponse**

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

Ce type de données est utilisé comme élément de réponse dans [Décrire DBClusters (action)](#DescribeDBClusters).
+ **AllocatedStorage**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  `AllocatedStorage` renvoie toujours la valeur 1, car la taille de stockage d'un cluster de bases de données Neptune n'est pas fixe ; elle s'ajuste automatiquement en fonction des besoins.
+ **AssociatedRoles** : tableau d'objets [DBClusterRôle](#DBClusterRole).

  Fournit la liste des rôles Amazon Identity and Access Management (IAM) associés au cluster de bases de données. Les rôles IAM associés à un cluster de bases de données autorisent celui-ci à accéder aux autres services Amazon en votre nom.
+ **AutomaticRestartTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Heure à laquelle le cluster de bases de données sera automatiquement redémarré.
+ **AvailabilityZones** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit la liste des zones de EC2 disponibilité dans lesquelles les instances du cluster de base de données peuvent être créées.
+ **BacktrackConsumedChangeRecords**— a LongOptional, de type : `long` (un entier signé de 64 bits).

  Non pris en charge par Neptune.
+ **BacktrackWindow**— a LongOptional, de type : `long` (un entier signé de 64 bits).

  Non pris en charge par Neptune.
+ **BackupRetentionPeriod**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie le nombre de jours de conservation des instantanés de base de données automatiques.
+ **Capacity**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Non pris en charge par Neptune.
+ **CloneGroupId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifie le groupe de clones auquel est associé le cluster de bases de données.
+ **ClusterCreateTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure à laquelle le cluster de bases de données a été créé, en heure UTC (Universal Coordinated Time).
+ **CopyTagsToSnapshot**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  *Si cette valeur est définie sur `true`, les balises sont copiées dans n'importe quel instantané du cluster de bases de données créé.*
+ **CrossAccountClone**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Si cette valeur est définie sur `true`, le cluster de bases de données peut être cloné sur plusieurs comptes.
+ **DatabaseName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient le nom de la base de données initiale de ce cluster de bases de données qui a été fourni au moment de la création, dans la mesure où un nom a été spécifié au moment de créer le cluster de bases de données. Ce même nom est renvoyé pendant la durée de vie du cluster de bases de données.
+ **DBClusterArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) du cluster de bases de données.
+ **DBClusterIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un identifiant de cluster de bases de données fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie un cluster de bases de données.
+ **DBClusterMembers** : tableau d'objets [DBClusterMembre](#DBClusterMember).

  Fournit la liste des instances qui composent le cluster de bases de données.
+ **DBClusterParameterGroup** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le nom du groupe de paramètres de cluster de base de données pour le cluster de base de données.
+ **DbClusterResourceId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant immuable et propre à la région Amazon du cluster de bases de données. Cet identifiant se trouve dans les entrées du CloudTrail journal Amazon chaque fois que la clé Amazon KMS du cluster de base de données est consultée.
+ **DBSubnetGroup** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie les informations sur le groupe de sous-réseaux associé au cluster de bases de données, notamment le nom, la description et les sous-réseaux du groupe de sous-réseaux.
+ **DeletionProtection**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Indique si la protection contre la suppression est activée pour le cluster de bases de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée.
+ **EarliestBacktrackTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Non pris en charge par Neptune.
+ **EarliestRestorableTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure la plus proche à laquelle une base de données peut être restaurée par point-in-time restauration.
+ **EnabledCloudwatchLogsExports** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des types de journaux que ce cluster de base de données est configuré pour exporter vers CloudWatch Logs. Les types de journaux valides sont les suivants : `audit` (pour publier les journaux d'audit CloudWatch) et slowquery (pour publier les journaux de requêtes lentes). CloudWatch Consultez la section [Publication des journaux Neptune sur Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).
+ **Endpoint** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le point de terminaison de connexion pour l'instance principale du cluster de bases de données.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le nom du moteur de base de données à utiliser pour ce cluster de bases de données.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique la version du moteur de base de données.
+ **GlobalClusterIdentifier**— a GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.
+ **HostedZoneId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'ID attribué par Amazon Route 53 lorsque vous créez une zone hébergée.
+ **IAMDatabaseAuthenticationEnabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur true (vrai) si le mappage des comptes Amazon Identity and Access Management (IAM) aux comptes de base de données est activé ; sinon, valeur false (faux).
+ **IOOptimizedNextAllowedModificationTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  La prochaine fois, vous pourrez modifier le cluster de bases de données de façon à utiliser le type de stockage `iopt1`.
+ **KmsKeyId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si `StorageEncrypted` a la valeur true (vrai), identifiant de clé Amazon KMS pour le cluster de bases de données chiffré.
+ **LatestRestorableTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure limite à laquelle une base de données peut être restaurée à l'aide de la fonction de point-in-time restauration.
+ **MultiAZ** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si le cluster de bases de données possède des instances dans plusieurs zones de disponibilité.
+ **PendingModifiedValues** : objet [ClusterPendingModifiedValues](#ClusterPendingModifiedValues).

  Ce type de données est utilisé comme élément de réponse dans l'opération `ModifyDBCluster` et contient les modifications qui seront appliquées lors de la fenêtre de maintenance suivante.
+ **PercentProgress** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie la progression de l'opération sous forme de pourcentage.
+ **Port**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie le port sur lequel le moteur de base de données est à l'écoute.
+ **PreferredBackupWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété `BackupRetentionPeriod`.
+ **PreferredMaintenanceWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.
+ **ReaderEndpoint** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Si un basculement se produit et que le réplica en lecture auquel vous êtes connecté est promu en instance principale, votre connexion est supprimée. Pour continuer à envoyer votre charge de travail de lecture à d'autres réplicas en lecture du cluster, vous pouvez alors vous reconnecter au point de terminaison du lecteur.
+ **ReadReplicaIdentifiers** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un ou plusieurs identifiants des réplicas en lecture associés à ce cluster de bases de données.
+ **ReplicationSourceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge par Neptune.
+ **ReplicationType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge par Neptune.
+ **ServerlessV2ScalingConfiguration** : objet [Serverless V2 ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo).

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

  Pour plus d'informations, consultez [Utilisation d'Amazon Neptune sans serveur](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) dans le *Guide de l'utilisateur Amazon Neptune*.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'état actuel de ce cluster de base de données.
+ **StorageEncrypted** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si le cluster de base de données est chiffré.
+ **StorageType** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Valeurs valides :
  + **`standard`**— (*valeur par défaut*) Fournit un stockage de base de données économique pour les applications dont l' I/O utilisation est modérée à faible.
  + **`iopt1`**— Permet un [stockage optimisé pour les E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage), conçu pour répondre aux besoins de I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O débit.

    Le stockage optimisé pour les E/S Neptune n’est disponible qu’à partir de la version 1.3.0.0 du moteur.
+ **VpcSecurityGroups** : tableau d'objets [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

**Erreurs**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [Non valide DBCluster StateFault](api-faults.md#InvalidDBClusterStateFault)
+ [Non valide DBInstance StateFault](api-faults.md#InvalidDBInstanceStateFault)

## AddRoleToDBCluster (action)
<a name="AddRoleToDBCluster"></a>

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

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

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

  Nom du cluster de base de données auquel associer le rôle IAM.
+ **FeatureName** (dans la CLI : `--feature-name`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom de la fonctionnalité de cluster de bases de données auquel le rôle IAM doit être associé. Pour obtenir la liste des noms de fonctions pris en charge, consultez [DBEngineVersion (structure)](api-other-apis.md#DBEngineVersion).
+ **RoleArn** (dans la CLI : `--role-arn`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

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

**Réponse**
+ *Paramètres d'absence de réponse.*

**Erreurs**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [DBClusterRoleAlreadyExistsFault](api-faults.md#DBClusterRoleAlreadyExistsFault)
+ [Non valide DBCluster StateFault](api-faults.md#InvalidDBClusterStateFault)
+ [DBClusterRoleQuotaExceededFault](api-faults.md#DBClusterRoleQuotaExceededFault)

## RemoveRoleFromDBCluster (action)
<a name="RemoveRoleFromDBCluster"></a>

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

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

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

  Nom du cluster de base de données à partir duquel le rôle IAM doit être dissocié.
+ **FeatureName** (dans la CLI : `--feature-name`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom de la fonctionnalité de cluster de bases de données dont le rôle IAM doit être dissocié. Pour obtenir la liste des noms de fonctions pris en charge, consultez [Décrire DBEngine les versions (action)](api-other-apis.md#DescribeDBEngineVersions).
+ **RoleArn** (dans la CLI : `--role-arn`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

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

**Réponse**
+ *Paramètres d'absence de réponse.*

**Erreurs**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [DBClusterRoleNotFoundFault](api-faults.md#DBClusterRoleNotFoundFault)
+ [Non valide DBCluster StateFault](api-faults.md#InvalidDBClusterStateFault)

## Basculement DBCluster (action)
<a name="FailoverDBCluster"></a>

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

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

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

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

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

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

  Contraintes :
  + Doit correspondre à l'identifiant d'un existant DBCluster.
+ **TargetDBInstanceIdentifier** (dans la CLI : `--target-db-instance-identifier`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom de l'instance à promouvoir en instance principale.

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

**Réponse**

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

Ce type de données est utilisé comme élément de réponse dans [Décrire DBClusters (action)](#DescribeDBClusters).
+ **AllocatedStorage**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  `AllocatedStorage` renvoie toujours la valeur 1, car la taille de stockage d'un cluster de bases de données Neptune n'est pas fixe ; elle s'ajuste automatiquement en fonction des besoins.
+ **AssociatedRoles** : tableau d'objets [DBClusterRôle](#DBClusterRole).

  Fournit la liste des rôles Amazon Identity and Access Management (IAM) associés au cluster de bases de données. Les rôles IAM associés à un cluster de bases de données autorisent celui-ci à accéder aux autres services Amazon en votre nom.
+ **AutomaticRestartTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Heure à laquelle le cluster de bases de données sera automatiquement redémarré.
+ **AvailabilityZones** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit la liste des zones de EC2 disponibilité dans lesquelles les instances du cluster de base de données peuvent être créées.
+ **BacktrackConsumedChangeRecords**— a LongOptional, de type : `long` (un entier signé de 64 bits).

  Non pris en charge par Neptune.
+ **BacktrackWindow**— a LongOptional, de type : `long` (un entier signé de 64 bits).

  Non pris en charge par Neptune.
+ **BackupRetentionPeriod**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie le nombre de jours de conservation des instantanés de base de données automatiques.
+ **Capacity**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Non pris en charge par Neptune.
+ **CloneGroupId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifie le groupe de clones auquel est associé le cluster de bases de données.
+ **ClusterCreateTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure à laquelle le cluster de bases de données a été créé, en heure UTC (Universal Coordinated Time).
+ **CopyTagsToSnapshot**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  *Si cette valeur est définie sur `true`, les balises sont copiées dans n'importe quel instantané du cluster de bases de données créé.*
+ **CrossAccountClone**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Si cette valeur est définie sur `true`, le cluster de bases de données peut être cloné sur plusieurs comptes.
+ **DatabaseName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient le nom de la base de données initiale de ce cluster de bases de données qui a été fourni au moment de la création, dans la mesure où un nom a été spécifié au moment de créer le cluster de bases de données. Ce même nom est renvoyé pendant la durée de vie du cluster de bases de données.
+ **DBClusterArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) du cluster de bases de données.
+ **DBClusterIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un identifiant de cluster de bases de données fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie un cluster de bases de données.
+ **DBClusterMembers** : tableau d'objets [DBClusterMembre](#DBClusterMember).

  Fournit la liste des instances qui composent le cluster de bases de données.
+ **DBClusterParameterGroup** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le nom du groupe de paramètres de cluster de base de données pour le cluster de base de données.
+ **DbClusterResourceId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant immuable et propre à la région Amazon du cluster de bases de données. Cet identifiant se trouve dans les entrées du CloudTrail journal Amazon chaque fois que la clé Amazon KMS du cluster de base de données est consultée.
+ **DBSubnetGroup** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie les informations sur le groupe de sous-réseaux associé au cluster de bases de données, notamment le nom, la description et les sous-réseaux du groupe de sous-réseaux.
+ **DeletionProtection**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Indique si la protection contre la suppression est activée pour le cluster de bases de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée.
+ **EarliestBacktrackTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Non pris en charge par Neptune.
+ **EarliestRestorableTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure la plus proche à laquelle une base de données peut être restaurée par point-in-time restauration.
+ **EnabledCloudwatchLogsExports** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des types de journaux que ce cluster de base de données est configuré pour exporter vers CloudWatch Logs. Les types de journaux valides sont les suivants : `audit` (pour publier les journaux d'audit CloudWatch) et slowquery (pour publier les journaux de requêtes lentes). CloudWatch Consultez la section [Publication des journaux Neptune sur Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).
+ **Endpoint** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le point de terminaison de connexion pour l'instance principale du cluster de bases de données.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le nom du moteur de base de données à utiliser pour ce cluster de bases de données.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique la version du moteur de base de données.
+ **GlobalClusterIdentifier**— a GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.
+ **HostedZoneId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'ID attribué par Amazon Route 53 lorsque vous créez une zone hébergée.
+ **IAMDatabaseAuthenticationEnabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur true (vrai) si le mappage des comptes Amazon Identity and Access Management (IAM) aux comptes de base de données est activé ; sinon, valeur false (faux).
+ **IOOptimizedNextAllowedModificationTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  La prochaine fois, vous pourrez modifier le cluster de bases de données de façon à utiliser le type de stockage `iopt1`.
+ **KmsKeyId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si `StorageEncrypted` a la valeur true (vrai), identifiant de clé Amazon KMS pour le cluster de bases de données chiffré.
+ **LatestRestorableTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure limite à laquelle une base de données peut être restaurée à l'aide de la fonction de point-in-time restauration.
+ **MultiAZ** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si le cluster de bases de données possède des instances dans plusieurs zones de disponibilité.
+ **PendingModifiedValues** : objet [ClusterPendingModifiedValues](#ClusterPendingModifiedValues).

  Ce type de données est utilisé comme élément de réponse dans l'opération `ModifyDBCluster` et contient les modifications qui seront appliquées lors de la fenêtre de maintenance suivante.
+ **PercentProgress** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie la progression de l'opération sous forme de pourcentage.
+ **Port**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie le port sur lequel le moteur de base de données est à l'écoute.
+ **PreferredBackupWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété `BackupRetentionPeriod`.
+ **PreferredMaintenanceWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.
+ **ReaderEndpoint** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Si un basculement se produit et que le réplica en lecture auquel vous êtes connecté est promu en instance principale, votre connexion est supprimée. Pour continuer à envoyer votre charge de travail de lecture à d'autres réplicas en lecture du cluster, vous pouvez alors vous reconnecter au point de terminaison du lecteur.
+ **ReadReplicaIdentifiers** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un ou plusieurs identifiants des réplicas en lecture associés à ce cluster de bases de données.
+ **ReplicationSourceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge par Neptune.
+ **ReplicationType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge par Neptune.
+ **ServerlessV2ScalingConfiguration** : objet [Serverless V2 ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo).

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

  Pour plus d'informations, consultez [Utilisation d'Amazon Neptune sans serveur](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) dans le *Guide de l'utilisateur Amazon Neptune*.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'état actuel de ce cluster de base de données.
+ **StorageEncrypted** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si le cluster de base de données est chiffré.
+ **StorageType** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Valeurs valides :
  + **`standard`**— (*valeur par défaut*) Fournit un stockage de base de données économique pour les applications dont l' I/O utilisation est modérée à faible.
  + **`iopt1`**— Permet un [stockage optimisé pour les E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage), conçu pour répondre aux besoins de I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O débit.

    Le stockage optimisé pour les E/S Neptune n’est disponible qu’à partir de la version 1.3.0.0 du moteur.
+ **VpcSecurityGroups** : tableau d'objets [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

**Erreurs**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [Non valide DBCluster StateFault](api-faults.md#InvalidDBClusterStateFault)
+ [Non valide DBInstance StateFault](api-faults.md#InvalidDBInstanceStateFault)

## PromoteReadReplicaDBCluster (action)
<a name="PromoteReadReplicaDBCluster"></a>

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

Non pris en charge.

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

  Non pris en charge.

**Réponse**

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

Ce type de données est utilisé comme élément de réponse dans [Décrire DBClusters (action)](#DescribeDBClusters).
+ **AllocatedStorage**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  `AllocatedStorage` renvoie toujours la valeur 1, car la taille de stockage d'un cluster de bases de données Neptune n'est pas fixe ; elle s'ajuste automatiquement en fonction des besoins.
+ **AssociatedRoles** : tableau d'objets [DBClusterRôle](#DBClusterRole).

  Fournit la liste des rôles Amazon Identity and Access Management (IAM) associés au cluster de bases de données. Les rôles IAM associés à un cluster de bases de données autorisent celui-ci à accéder aux autres services Amazon en votre nom.
+ **AutomaticRestartTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Heure à laquelle le cluster de bases de données sera automatiquement redémarré.
+ **AvailabilityZones** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit la liste des zones de EC2 disponibilité dans lesquelles les instances du cluster de base de données peuvent être créées.
+ **BacktrackConsumedChangeRecords**— a LongOptional, de type : `long` (un entier signé de 64 bits).

  Non pris en charge par Neptune.
+ **BacktrackWindow**— a LongOptional, de type : `long` (un entier signé de 64 bits).

  Non pris en charge par Neptune.
+ **BackupRetentionPeriod**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie le nombre de jours de conservation des instantanés de base de données automatiques.
+ **Capacity**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Non pris en charge par Neptune.
+ **CloneGroupId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifie le groupe de clones auquel est associé le cluster de bases de données.
+ **ClusterCreateTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure à laquelle le cluster de bases de données a été créé, en heure UTC (Universal Coordinated Time).
+ **CopyTagsToSnapshot**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  *Si cette valeur est définie sur `true`, les balises sont copiées dans n'importe quel instantané du cluster de bases de données créé.*
+ **CrossAccountClone**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Si cette valeur est définie sur `true`, le cluster de bases de données peut être cloné sur plusieurs comptes.
+ **DatabaseName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient le nom de la base de données initiale de ce cluster de bases de données qui a été fourni au moment de la création, dans la mesure où un nom a été spécifié au moment de créer le cluster de bases de données. Ce même nom est renvoyé pendant la durée de vie du cluster de bases de données.
+ **DBClusterArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) du cluster de bases de données.
+ **DBClusterIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un identifiant de cluster de bases de données fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie un cluster de bases de données.
+ **DBClusterMembers** : tableau d'objets [DBClusterMembre](#DBClusterMember).

  Fournit la liste des instances qui composent le cluster de bases de données.
+ **DBClusterParameterGroup** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le nom du groupe de paramètres de cluster de base de données pour le cluster de base de données.
+ **DbClusterResourceId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant immuable et propre à la région Amazon du cluster de bases de données. Cet identifiant se trouve dans les entrées du CloudTrail journal Amazon chaque fois que la clé Amazon KMS du cluster de base de données est consultée.
+ **DBSubnetGroup** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie les informations sur le groupe de sous-réseaux associé au cluster de bases de données, notamment le nom, la description et les sous-réseaux du groupe de sous-réseaux.
+ **DeletionProtection**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Indique si la protection contre la suppression est activée pour le cluster de bases de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée.
+ **EarliestBacktrackTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Non pris en charge par Neptune.
+ **EarliestRestorableTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure la plus proche à laquelle une base de données peut être restaurée par point-in-time restauration.
+ **EnabledCloudwatchLogsExports** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des types de journaux que ce cluster de base de données est configuré pour exporter vers CloudWatch Logs. Les types de journaux valides sont les suivants : `audit` (pour publier les journaux d'audit CloudWatch) et slowquery (pour publier les journaux de requêtes lentes). CloudWatch Consultez la section [Publication des journaux Neptune sur Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).
+ **Endpoint** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le point de terminaison de connexion pour l'instance principale du cluster de bases de données.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le nom du moteur de base de données à utiliser pour ce cluster de bases de données.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique la version du moteur de base de données.
+ **GlobalClusterIdentifier**— a GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.
+ **HostedZoneId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'ID attribué par Amazon Route 53 lorsque vous créez une zone hébergée.
+ **IAMDatabaseAuthenticationEnabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur true (vrai) si le mappage des comptes Amazon Identity and Access Management (IAM) aux comptes de base de données est activé ; sinon, valeur false (faux).
+ **IOOptimizedNextAllowedModificationTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  La prochaine fois, vous pourrez modifier le cluster de bases de données de façon à utiliser le type de stockage `iopt1`.
+ **KmsKeyId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si `StorageEncrypted` a la valeur true (vrai), identifiant de clé Amazon KMS pour le cluster de bases de données chiffré.
+ **LatestRestorableTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure limite à laquelle une base de données peut être restaurée à l'aide de la fonction de point-in-time restauration.
+ **MultiAZ** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si le cluster de bases de données possède des instances dans plusieurs zones de disponibilité.
+ **PendingModifiedValues** : objet [ClusterPendingModifiedValues](#ClusterPendingModifiedValues).

  Ce type de données est utilisé comme élément de réponse dans l'opération `ModifyDBCluster` et contient les modifications qui seront appliquées lors de la fenêtre de maintenance suivante.
+ **PercentProgress** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie la progression de l'opération sous forme de pourcentage.
+ **Port**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie le port sur lequel le moteur de base de données est à l'écoute.
+ **PreferredBackupWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété `BackupRetentionPeriod`.
+ **PreferredMaintenanceWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.
+ **ReaderEndpoint** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Si un basculement se produit et que le réplica en lecture auquel vous êtes connecté est promu en instance principale, votre connexion est supprimée. Pour continuer à envoyer votre charge de travail de lecture à d'autres réplicas en lecture du cluster, vous pouvez alors vous reconnecter au point de terminaison du lecteur.
+ **ReadReplicaIdentifiers** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un ou plusieurs identifiants des réplicas en lecture associés à ce cluster de bases de données.
+ **ReplicationSourceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge par Neptune.
+ **ReplicationType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge par Neptune.
+ **ServerlessV2ScalingConfiguration** : objet [Serverless V2 ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo).

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

  Pour plus d'informations, consultez [Utilisation d'Amazon Neptune sans serveur](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) dans le *Guide de l'utilisateur Amazon Neptune*.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'état actuel de ce cluster de base de données.
+ **StorageEncrypted** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si le cluster de base de données est chiffré.
+ **StorageType** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Valeurs valides :
  + **`standard`**— (*valeur par défaut*) Fournit un stockage de base de données économique pour les applications dont l' I/O utilisation est modérée à faible.
  + **`iopt1`**— Permet un [stockage optimisé pour les E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage), conçu pour répondre aux besoins de I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O débit.

    Le stockage optimisé pour les E/S Neptune n’est disponible qu’à partir de la version 1.3.0.0 du moteur.
+ **VpcSecurityGroups** : tableau d'objets [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

**Erreurs**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [Non valide DBCluster StateFault](api-faults.md#InvalidDBClusterStateFault)

## Décrire DBClusters (action)
<a name="DescribeDBClusters"></a>

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

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

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

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

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

  Contraintes :
  + S'il est fourni, il doit correspondre à un DBCluster identifiant existant.
+ **Filters** (dans la CLI : `--filters`) : tableau d'objets [Filtre](api-datatypes.md#Filter).

  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 (ARNs) du cluster de bases de données. La liste des résultats inclura uniquement des informations sur les clusters de base de données identifiés par ceux-ci ARNs.
  + `engine` - Accepte un nom de moteur (tel que `neptune`) et restreint la liste de résultats aux clusters de base de données créés par ce moteur.

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

  ```
  aws neptune describe-db-clusters \
              --filters  Name=engine,Values=neptune
  ```
+ **Marker** (dans la CLI : `--marker`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Jeton de pagination facultatif fourni par une demande [Décrire DBClusters (action)](#DescribeDBClusters) 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`) — un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

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

  Par défaut : 100

  Contraintes : Minimum 20, maximum 100.

**Réponse**
+ **DBClusters** : tableau d'objets [DBCluster](#DBCluster).

  Contient une liste de clusters de base de données pour l'utilisateur.
+ **Marker** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Un jeton de pagination qui peut être utilisé dans une DBClusters demande Describe ultérieure.

**Erreurs**
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)

## *Structures :*
<a name="api-clusters-structures-spacer"></a>

## DBCluster (structure)
<a name="DBCluster"></a>

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

Ce type de données est utilisé comme élément de réponse dans [Décrire DBClusters (action)](#DescribeDBClusters).

**Champs**
+ **AllocatedStorage**— Il s'agit d'un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  `AllocatedStorage` renvoie toujours la valeur 1, car la taille de stockage d'un cluster de bases de données Neptune n'est pas fixe ; elle s'ajuste automatiquement en fonction des besoins.
+ **AssociatedRoles** : tableau d'objets [DBClusterRôle](#DBClusterRole).

  Fournit la liste des rôles Amazon Identity and Access Management (IAM) associés au cluster de bases de données. Les rôles IAM associés à un cluster de bases de données autorisent celui-ci à accéder aux autres services Amazon en votre nom.
+ **AutomaticRestartTime**— Il s'agit d'un TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Heure à laquelle le cluster de bases de données sera automatiquement redémarré.
+ **AvailabilityZones** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit la liste des zones de EC2 disponibilité dans lesquelles les instances du cluster de base de données peuvent être créées.
+ **BacktrackConsumedChangeRecords**— Il s'agit d'un LongOptional, de type : `long` (un entier signé de 64 bits).

  Non pris en charge par Neptune.
+ **BacktrackWindow**— Il s'agit d'un LongOptional, de type : `long` (un entier signé de 64 bits).

  Non pris en charge par Neptune.
+ **BackupRetentionPeriod**— Il s'agit d'un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie le nombre de jours de conservation des instantanés de base de données automatiques.
+ **Capacity**— Il s'agit d'un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Non pris en charge par Neptune.
+ **CloneGroupId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifie le groupe de clones auquel est associé le cluster de bases de données.
+ **ClusterCreateTime**— Il s'agit d'un TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure à laquelle le cluster de bases de données a été créé, en heure UTC (Universal Coordinated Time).
+ **CopyTagsToSnapshot**— Il s'agit d'une BooleanOptional valeur booléenne `boolean` (vraie ou fausse) du type : (valeur booléenne).

  *Si cette valeur est définie sur `true`, les balises sont copiées dans n'importe quel instantané du cluster de bases de données créé.*
+ **CrossAccountClone**— Il s'agit d'une BooleanOptional valeur booléenne `boolean` (vraie ou fausse) du type : (valeur booléenne).

  Si cette valeur est définie sur `true`, le cluster de bases de données peut être cloné sur plusieurs comptes.
+ **DatabaseName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient le nom de la base de données initiale de ce cluster de bases de données qui a été fourni au moment de la création, dans la mesure où un nom a été spécifié au moment de créer le cluster de bases de données. Ce même nom est renvoyé pendant la durée de vie du cluster de bases de données.
+ **DBClusterArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) du cluster de bases de données.
+ **DBClusterIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un identifiant de cluster de bases de données fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie un cluster de bases de données.
+ **DBClusterMembers** : tableau d'objets [DBClusterMembre](#DBClusterMember).

  Fournit la liste des instances qui composent le cluster de bases de données.
+ **DBClusterParameterGroup** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le nom du groupe de paramètres de cluster de base de données pour le cluster de base de données.
+ **DbClusterResourceId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant immuable et propre à la région Amazon du cluster de bases de données. Cet identifiant se trouve dans les entrées du CloudTrail journal Amazon chaque fois que la clé Amazon KMS du cluster de base de données est consultée.
+ **DBSubnetGroup** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie les informations sur le groupe de sous-réseaux associé au cluster de bases de données, notamment le nom, la description et les sous-réseaux du groupe de sous-réseaux.
+ **DeletionProtection**— Il s'agit d'une BooleanOptional valeur booléenne `boolean` (vraie ou fausse) du type : (valeur booléenne).

  Indique si la protection contre la suppression est activée pour le cluster de bases de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée.
+ **EarliestBacktrackTime**— Il s'agit d'un TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Non pris en charge par Neptune.
+ **EarliestRestorableTime**— Il s'agit d'un TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure la plus proche à laquelle une base de données peut être restaurée par point-in-time restauration.
+ **EnabledCloudwatchLogsExports** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des types de journaux que ce cluster de base de données est configuré pour exporter vers CloudWatch Logs. Les types de journaux valides sont les suivants : `audit` (pour publier les journaux d'audit CloudWatch) et slowquery (pour publier les journaux de requêtes lentes). CloudWatch Consultez la section [Publication des journaux Neptune sur Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).
+ **Endpoint** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le point de terminaison de connexion pour l'instance principale du cluster de bases de données.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le nom du moteur de base de données à utiliser pour ce cluster de bases de données.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique la version du moteur de base de données.
+ **GlobalClusterIdentifier**— Il s'agit d'un GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.
+ **HostedZoneId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'ID attribué par Amazon Route 53 lorsque vous créez une zone hébergée.
+ **IAMDatabaseAuthenticationEnabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur true (vrai) si le mappage des comptes Amazon Identity and Access Management (IAM) aux comptes de base de données est activé ; sinon, valeur false (faux).
+ **IOOptimizedNextAllowedModificationTime**— Il s'agit d'un TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  La prochaine fois, vous pourrez modifier le cluster de bases de données de façon à utiliser le type de stockage `iopt1`.
+ **KmsKeyId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si `StorageEncrypted` a la valeur true (vrai), identifiant de clé Amazon KMS pour le cluster de bases de données chiffré.
+ **LatestRestorableTime**— Il s'agit d'un TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure limite à laquelle une base de données peut être restaurée à l'aide de la fonction de point-in-time restauration.
+ **MultiAZ** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si le cluster de bases de données possède des instances dans plusieurs zones de disponibilité.
+ **PendingModifiedValues** : objet [ClusterPendingModifiedValues](#ClusterPendingModifiedValues).

  Ce type de données est utilisé comme élément de réponse dans l'opération `ModifyDBCluster` et contient les modifications qui seront appliquées lors de la fenêtre de maintenance suivante.
+ **PercentProgress** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie la progression de l'opération sous forme de pourcentage.
+ **Port**— Il s'agit d'un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie le port sur lequel le moteur de base de données est à l'écoute.
+ **PreferredBackupWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété `BackupRetentionPeriod`.
+ **PreferredMaintenanceWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.
+ **ReaderEndpoint** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Si un basculement se produit et que le réplica en lecture auquel vous êtes connecté est promu en instance principale, votre connexion est supprimée. Pour continuer à envoyer votre charge de travail de lecture à d'autres réplicas en lecture du cluster, vous pouvez alors vous reconnecter au point de terminaison du lecteur.
+ **ReadReplicaIdentifiers** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un ou plusieurs identifiants des réplicas en lecture associés à ce cluster de bases de données.
+ **ReplicationSourceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge par Neptune.
+ **ReplicationType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge par Neptune.
+ **ServerlessV2ScalingConfiguration** : objet [Serverless V2 ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo).

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

  Pour plus d'informations, consultez [Utilisation d'Amazon Neptune sans serveur](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) dans le *Guide de l'utilisateur Amazon Neptune*.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'état actuel de ce cluster de base de données.
+ **StorageEncrypted** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si le cluster de base de données est chiffré.
+ **StorageType** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Valeurs valides :
  + **`standard`**— (*valeur par défaut*) Fournit un stockage de base de données économique pour les applications dont l' I/O utilisation est modérée à faible.
  + **`iopt1`**— Permet un [stockage optimisé pour les E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage), conçu pour répondre aux besoins de I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O débit.

    Le stockage optimisé pour les E/S Neptune n’est disponible qu’à partir de la version 1.3.0.0 du moteur.
+ **VpcSecurityGroups** : tableau d'objets [VpcSecurityGroupMembership](api-datatypes.md#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 :
+ [Créez DBCluster](#CreateDBCluster)
+ [Supprimer DBCluster](#DeleteDBCluster)
+ [Basculement DBCluster](#FailoverDBCluster)
+ [Modifier DBCluster](#ModifyDBCluster)
+ [PromoteReadReplicaDBCluster](#PromoteReadReplicaDBCluster)
+ [Restaurer DBCluster FromSnapshot](api-snapshots.md#RestoreDBClusterFromSnapshot)
+ [Restaurer DBCluster ToPointInTime](api-snapshots.md#RestoreDBClusterToPointInTime)
+ [Démarrer DBCluster](#StartDBCluster)
+ [Arrêtez DBCluster](#StopDBCluster)

## DBClusterMembre (structure)
<a name="DBClusterMember"></a>

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

**Champs**
+ **DBClusterParameterGroupStatus** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'état du groupe de paramètres de cluster de base de données pour ce membre du cluster de base de données.
+ **DBInstanceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'identifiant d'instance de ce membre du cluster de base de données.
+ **IsClusterWriter** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur `true` si le membre du cluster est l'instance principale du cluster de base de données ; valeur `false` dans le cas contraire.
+ **PromotionTier**— Il s'agit d'un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

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

## DBClusterRôle (structure)
<a name="DBClusterRole"></a>

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

**Champs**
+ **FeatureName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Le nom de la fonctionnalité associée au rôle Amazon Identity and Access Management (IAM). Pour obtenir la liste des noms de fonctions pris en charge, consultez [Décrire DBEngine les versions (action)](api-other-apis.md#DescribeDBEngineVersions). 
+ **RoleArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  L'Amazon Resource Name (ARN) du rôle IAM associé au cluster de base de données.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Décrit l'état de l'association entre le rôle IAM et le cluster de base de données. La propriété Status renvoie l'une des valeurs suivantes :
  + `ACTIVE` : l'ARN du rôle IAM est associé au cluster de bases de données et peut être utilisé pour accéder à d'autres services Amazon en votre nom.
  + `PENDING` : l'ARN du rôle IAM est en cours d'association au cluster de bases de données.
  + `INVALID` : l'ARN du rôle IAM est associé au cluster de bases de données, mais le cluster de bases de données n'est pas en mesure d'endosser le rôle IAM pour accéder aux autres services Amazon en votre nom.

## CloudwatchLogsExportConfiguration (structure)
<a name="CloudwatchLogsExportConfiguration"></a>

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

Les `DisableLogTypes` tableaux `EnableLogTypes` et déterminent quels journaux seront exportés (ou non exportés) vers CloudWatch Logs.

Les types de journaux valides sont : `audit` (pour publier les journaux d'audit) et `slowquery` (pour publier les journaux de requêtes lentes). Consultez la section [Publication des journaux Neptune sur Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).

**Champs**
+ **DisableLogTypes** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des types de journaux à désactiver.
+ **EnableLogTypes** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des types de journaux à activer.

## PendingCloudwatchLogsExports (structure)
<a name="PendingCloudwatchLogsExports"></a>

Liste des types de journaux dont la configuration est toujours en attente. En d'autres termes, ces types de journaux sont en cours d'activation ou de désactivation.

Les types de journaux valides sont : `audit` (pour publier les journaux d'audit) et `slowquery` (pour publier les journaux de requêtes lentes). Consultez la section [Publication des journaux Neptune sur Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).

**Champs**
+ **LogTypesToDisable** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Types de journaux en cours d'activation. Une fois activés, ces types de journaux sont exportés vers CloudWatch Logs.
+ **LogTypesToEnable** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Types de journaux en cours de désactivation. Une fois désactivés, ces types de journaux ne sont pas exportés vers CloudWatch Logs.

## ClusterPendingModifiedValues (structure)
<a name="ClusterPendingModifiedValues"></a>

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

**Champs**
+ **AllocatedStorage**— Il s'agit d'un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Taille de stockage allouée en gibioctets (Gio) pour les moteurs de bases de données. Pour Neptune, `AllocatedStorage` renvoie toujours la valeur 1, car la taille de stockage d'un cluster de bases de données Neptune n'est pas fixe. Elle s'ajuste automatiquement en fonction des besoins.
+ **BackupRetentionPeriod**— Il s'agit d'un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Nombre de jours de conservation des instantanés de base de données automatiques.
+ **DBClusterIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  La valeur de l' DBClusteridentifiant du cluster de base de données.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Version du moteur de base de données.
+ **IAMDatabaseAuthenticationEnabled**— Il s'agit d'une BooleanOptional valeur booléenne `boolean` (vraie ou fausse) du type : (valeur booléenne).

  Valeur qui indique si le mappage des comptes AWS Identity and Access Management (IAM) aux comptes de base de données est activé.
+ **Iops**— Il s'agit d'un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie la valeur des IOPS provisionnés (opérations d'E/S par seconde). Ce paramètre ne s’applique qu’aux clusters de bases de données Multi-AZ.
+ **PendingCloudwatchLogsExports** : objet [PendingCloudwatchLogsExports](#PendingCloudwatchLogsExports).

  Cette `PendingCloudwatchLogsExports` structure indique les modifications en attente concernant CloudWatch les journaux activés et ceux qui sont désactivés.
+ **StorageType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Modification en attente du type de stockage pour le cluster de bases de données.   Valeurs valides :
  + **`standard`**— (*valeur par défaut*) Configure un stockage de base de données rentable pour les applications dont l' I/O utilisation est modérée à faible.
  + **`iopt1`**— Permet un [stockage optimisé pour les E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage), conçu pour répondre aux besoins de I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O débit.

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

# API de base de données globale Neptune
<a name="api-global-dbs"></a>

**Actions :**
+ [CreateGlobalCluster (action)](#CreateGlobalCluster)
+ [DeleteGlobalCluster (action)](#DeleteGlobalCluster)
+ [ModifyGlobalCluster (action)](#ModifyGlobalCluster)
+ [DescribeGlobalClusters (action)](#DescribeGlobalClusters)
+ [FailoverGlobalCluster (action)](#FailoverGlobalCluster)
+ [RemoveFromGlobalCluster (action)](#RemoveFromGlobalCluster)

**Structures :**
+ [GlobalCluster (structure)](#GlobalCluster)
+ [GlobalClusterMember (structure)](#GlobalClusterMember)

## CreateGlobalCluster (action)
<a name="CreateGlobalCluster"></a>

         Le nom de la AWS CLI pour cette API est :`create-global-cluster`.

Crée une base de données Neptune globale répartie sur plusieurs régions Amazon. La base de données globale contient un cluster principal unique doté d'une fonctionnalité de lecture-écriture, et des clusters secondaires en lecture seule qui reçoivent des données du cluster principal via une réplication haute vitesse effectuée par le sous-système de stockage Neptune.

Vous pouvez créer une base de données globale initialement vide, puis y ajouter un cluster principal et des clusters secondaires. Vous avez aussi la possibilité de spécifier un cluster Neptune existant pendant l'opération de création pour qu'il devienne le cluster principal de la base de données globale.

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

  Nom de la nouvelle base de données globale (avec une limite maximale de 64 caractères alphanumériques).
+ **DeletionProtection**(dans la CLI :`--deletion-protection`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Paramètre de protection contre la suppression pour la nouvelle base de données globale. La base de données globale ne peut pas être supprimée tant que la protection contre la suppression est activée.
+ **Engine** (dans la CLI : `--engine`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom du moteur de base de données à utiliser dans la base de données globale.

  Valeurs valides : `neptune`
+ **EngineVersion** (dans la CLI : `--engine-version`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Version de moteur Neptune à utiliser par la base de données globale.

  Valeurs valides : `1.2.0.0` ou plus.
+ **GlobalClusterIdentifier**(dans la CLI :`--global-cluster-identifier`) — *Obligatoire :* a GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  Identifiant de cluster du nouveau cluster de bases de données globales.
+ **SourceDBClusterIdentifier** (dans la CLI : `--source-db-cluster-identifier`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  (*Facultatif*) Amazon Resource Name (ARN) d'un cluster de bases de données Neptune existant à utiliser comme cluster principal de la nouvelle base de données globale.
+ **StorageEncrypted**(dans la CLI :`--storage-encrypted`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Paramètre de chiffrement du stockage pour le nouveau cluster de bases de données globales.

**Réponse**

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

Ce type de données est utilisé comme élément de réponse pour les actions [CreateGlobalCluster (action)](#CreateGlobalCluster), [DescribeGlobalClusters (action)](#DescribeGlobalClusters), [ModifyGlobalCluster (action)](#ModifyGlobalCluster), [DeleteGlobalCluster (action)](#DeleteGlobalCluster), [FailoverGlobalCluster (action)](#FailoverGlobalCluster) et [RemoveFromGlobalCluster (action)](#RemoveFromGlobalCluster).
+ **DeletionProtection**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Paramètre de protection contre la suppression pour la base de données globale.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Moteur de base de données Neptune utilisé par la base de données globale (`"neptune"`).
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Version de moteur Neptune utilisée par la base de données globale.
+ **GlobalClusterArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de la base de données globale.
+ **GlobalClusterIdentifier**— a GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.
+ **GlobalClusterMembers** : tableau d'objets [GlobalClusterMember](#GlobalClusterMember).

  Une liste de clusters ARNs et d'instances ARNs pour tous les clusters de base de données qui font partie de la base de données globale.
+ **GlobalClusterResourceId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant immuable de la base de données globale, unique dans toutes les régions. Cet identifiant se trouve dans les entrées du CloudTrail journal chaque fois que l'on accède à la clé KMS du cluster de base de données.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique l'état actuel de cette base de données globale.
+ **StorageEncrypted**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Paramètre de chiffrement du stockage pour la base de données globale.

**Erreurs**
+ [GlobalClusterAlreadyExistsFault](api-faults.md#GlobalClusterAlreadyExistsFault)
+ [GlobalClusterQuotaExceededFault](api-faults.md#GlobalClusterQuotaExceededFault)
+ [Non valide DBCluster StateFault](api-faults.md#InvalidDBClusterStateFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)

## DeleteGlobalCluster (action)
<a name="DeleteGlobalCluster"></a>

         Le nom de la AWS CLI pour cette API est :`delete-global-cluster`.

Supprime une base de données globale. Le cluster principal et tous les clusters secondaires doivent d'abord être dissociés ou supprimés.

**Demande**
+ **GlobalClusterIdentifier**(dans la CLI :`--global-cluster-identifier`) — *Obligatoire :* a GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  Identifiant du cluster de bases de données global qui est en cours de suppression.

**Réponse**

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

Ce type de données est utilisé comme élément de réponse pour les actions [CreateGlobalCluster (action)](#CreateGlobalCluster), [DescribeGlobalClusters (action)](#DescribeGlobalClusters), [ModifyGlobalCluster (action)](#ModifyGlobalCluster), [DeleteGlobalCluster (action)](#DeleteGlobalCluster), [FailoverGlobalCluster (action)](#FailoverGlobalCluster) et [RemoveFromGlobalCluster (action)](#RemoveFromGlobalCluster).
+ **DeletionProtection**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Paramètre de protection contre la suppression pour la base de données globale.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Moteur de base de données Neptune utilisé par la base de données globale (`"neptune"`).
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Version de moteur Neptune utilisée par la base de données globale.
+ **GlobalClusterArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de la base de données globale.
+ **GlobalClusterIdentifier**— a GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.
+ **GlobalClusterMembers** : tableau d'objets [GlobalClusterMember](#GlobalClusterMember).

  Une liste de clusters ARNs et d'instances ARNs pour tous les clusters de base de données qui font partie de la base de données globale.
+ **GlobalClusterResourceId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant immuable de la base de données globale, unique dans toutes les régions. Cet identifiant se trouve dans les entrées du CloudTrail journal chaque fois que l'on accède à la clé KMS du cluster de base de données.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique l'état actuel de cette base de données globale.
+ **StorageEncrypted**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Paramètre de chiffrement du stockage pour la base de données globale.

**Erreurs**
+ [GlobalClusterNotFoundFault](api-faults.md#GlobalClusterNotFoundFault)
+ [InvalidGlobalClusterStateFault](api-faults.md#InvalidGlobalClusterStateFault)

## ModifyGlobalCluster (action)
<a name="ModifyGlobalCluster"></a>

         Le nom de la AWS CLI pour cette API est :`modify-global-cluster`.

Modifie un paramètre pour un cluster global Amazon Neptune. Vous pouvez modifier un ou plusieurs paramètres de configuration de base de données en spécifiant ces paramètres et leurs nouvelles valeurs dans la demande.

**Demande**
+ **AllowMajorVersionUpgrade**(dans la CLI :`--allow-major-version-upgrade`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Une valeur qui indique que les mises à niveau de version majeures sont autorisées.

  Contraintes : vous devez autoriser les mises à niveau de versions majeures si vous spécifiez une valeur pour le paramètre `EngineVersion` correspondant à une version majeure différente de la version actuelle du cluster de bases de données.

  Si vous mettez à niveau la version majeure d'une base de données globale, les groupes de paramètres du cluster de bases de données et de l'instance de base de données sont définis sur les groupes de paramètres par défaut de la nouvelle version. Vous devrez donc appliquer tous les groupes de paramètres personnalisés une fois la mise à niveau terminée.
+ **DeletionProtection**(dans la CLI :`--deletion-protection`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Indique si la protection contre la suppression a été activée pour la base de données globale. La base de données globale ne peut pas être supprimée tant que la protection contre la suppression est activée.
+ **EngineVersion** (dans la CLI : `--engine-version`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Numéro de version du moteur de base de données vers lequel vous souhaitez effectuer la mise à niveau. La modification de ce paramètre entraîne une interruption. La modification sera appliquée pendant la fenêtre de maintenance suivante, sauf si `ApplyImmediately` est activé.

  Pour répertorier toutes les versions disponibles du moteur Neptune, utilisez la commande suivante :  
**Example**  

  ```
  aws neptune describe-db-engine-versions \
            --engine neptune \
            --query '*[]|[?SupportsGlobalDatabases == 'true'].[EngineVersion]'
  ```
+ **GlobalClusterIdentifier**(dans la CLI :`--global-cluster-identifier`) — *Obligatoire :* a GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  Identifiant du cluster global de bases de données en cours de modification. Ce paramètre n'est pas sensible à la casse.

  Contraintes : doit correspondre à l'identifiant d'un cluster de bases de données global existant.
+ **NewGlobalClusterIdentifier**(dans la CLI :`--new-global-cluster-identifier`) — a GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  Nouvel identifiant de cluster à attribuer à la base de données globale. 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.
  + Il ne peut pas se terminer par un trait d'union ou contenir deux traits d'union consécutifs.

  Exemple : `my-cluster2`

**Réponse**

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

Ce type de données est utilisé comme élément de réponse pour les actions [CreateGlobalCluster (action)](#CreateGlobalCluster), [DescribeGlobalClusters (action)](#DescribeGlobalClusters), [ModifyGlobalCluster (action)](#ModifyGlobalCluster), [DeleteGlobalCluster (action)](#DeleteGlobalCluster), [FailoverGlobalCluster (action)](#FailoverGlobalCluster) et [RemoveFromGlobalCluster (action)](#RemoveFromGlobalCluster).
+ **DeletionProtection**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Paramètre de protection contre la suppression pour la base de données globale.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Moteur de base de données Neptune utilisé par la base de données globale (`"neptune"`).
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Version de moteur Neptune utilisée par la base de données globale.
+ **GlobalClusterArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de la base de données globale.
+ **GlobalClusterIdentifier**— a GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.
+ **GlobalClusterMembers** : tableau d'objets [GlobalClusterMember](#GlobalClusterMember).

  Une liste de clusters ARNs et d'instances ARNs pour tous les clusters de base de données qui font partie de la base de données globale.
+ **GlobalClusterResourceId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant immuable de la base de données globale, unique dans toutes les régions. Cet identifiant se trouve dans les entrées du CloudTrail journal chaque fois que l'on accède à la clé KMS du cluster de base de données.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique l'état actuel de cette base de données globale.
+ **StorageEncrypted**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Paramètre de chiffrement du stockage pour la base de données globale.

**Erreurs**
+ [GlobalClusterNotFoundFault](api-faults.md#GlobalClusterNotFoundFault)
+ [InvalidGlobalClusterStateFault](api-faults.md#InvalidGlobalClusterStateFault)

## DescribeGlobalClusters (action)
<a name="DescribeGlobalClusters"></a>

         Le nom de la AWS CLI pour cette API est :`describe-global-clusters`.

Renvoie des informations sur les clusters de bases de données Neptune globales. Cette API prend en charge la pagination.

**Demande**
+ **GlobalClusterIdentifier**(dans la CLI :`--global-cluster-identifier`) — a GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  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 bases de données en question sont renvoyées. Ce paramètre n'est pas sensible à la casse.

  Contraintes : si cette valeur est fournie, elle doit correspondre à l'identifiant d'un cluster de bases de données existant.
+ **Marker** (dans la CLI : `--marker`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  (*Facultatif*) Jeton de pagination renvoyé par un appel précédent à `DescribeGlobalClusters`. Si ce paramètre est spécifié, la réponse inclut uniquement les enregistrements supérieurs au marqueur, jusqu'au nombre spécifié par `MaxRecords`.
+ **MaxRecords**(dans la CLI :`--max-records`) — un IntegerOptional, de type : `integer` (un 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 marqueur de pagination est inclus dans la réponse. Vous pouvez l'utiliser pour récupérer les résultats restants.

  Par défaut : `100`

  Contraintes : Minimum 20, maximum 100.

**Réponse**
+ **GlobalClusters** : tableau d'objets [GlobalCluster](#GlobalCluster).

  Liste des instances et des clusters globaux renvoyés par cette demande.
+ **Marker** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Jeton de pagination. Si ce paramètre est renvoyé dans la réponse, d'autres enregistrements sont disponibles. Ils peuvent être récupérés par un ou plusieurs appels supplémentaires à `DescribeGlobalClusters`.

**Erreurs**
+ [GlobalClusterNotFoundFault](api-faults.md#GlobalClusterNotFoundFault)

## FailoverGlobalCluster (action)
<a name="FailoverGlobalCluster"></a>

         Le nom de la AWS CLI pour cette API est :`failover-global-cluster`.

Démarre le processus de basculement pour une base de données Neptune globale.

Un basculement d'une base de données globale Neptune promeut l'un des clusters de bases de données secondaires en lecture seule en cluster de bases de données principal et rétrograde le cluster de bases de données principal en cluster de bases de données secondaire (en lecture seule). En d'autres termes, le rôle du cluster de bases de données principal actuel et du cluster de bases de données secondaire cible sélectionné sont interchangés. Le cluster de base de données secondaire sélectionné suppose toutes read/write les fonctionnalités de la base de données globale Neptune.

**Note**  
Cette action s'applique **uniquement** aux bases de données globales Neptune. Cette action vise uniquement à être utilisée sur les bases de données globales Neptune saines dotées de clusters de bases de données Neptune en bon état et sans interruption de service à l'échelle de la région. Elle permet de tester des scénarios de reprise après sinistre ou de reconfigurer la topologie de la base de données globale.

**Demande**
+ **GlobalClusterIdentifier**(dans la CLI :`--global-cluster-identifier`) — *Obligatoire :* a GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  Identifiant de la base de données globale Neptune qui doit être basculée. L'identifiant est la clé unique attribuée par l'utilisateur lors de la création de la base de données globale Neptune. En d'autres termes, il s'agit du nom de la base de données globale pour laquelle vous souhaitez effectuer le basculement.

  Contraintes : doit correspondre à l'identifiant d'une base de données Neptune globale existante.
+ **TargetDbClusterIdentifier** (dans la CLI : `--target-db-cluster-identifier`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) du cluster de bases de données Neptune secondaire que vous souhaitez promouvoir comme cluster principal pour la base de données globale.

**Réponse**

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

Ce type de données est utilisé comme élément de réponse pour les actions [CreateGlobalCluster (action)](#CreateGlobalCluster), [DescribeGlobalClusters (action)](#DescribeGlobalClusters), [ModifyGlobalCluster (action)](#ModifyGlobalCluster), [DeleteGlobalCluster (action)](#DeleteGlobalCluster), [FailoverGlobalCluster (action)](#FailoverGlobalCluster) et [RemoveFromGlobalCluster (action)](#RemoveFromGlobalCluster).
+ **DeletionProtection**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Paramètre de protection contre la suppression pour la base de données globale.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Moteur de base de données Neptune utilisé par la base de données globale (`"neptune"`).
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Version de moteur Neptune utilisée par la base de données globale.
+ **GlobalClusterArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de la base de données globale.
+ **GlobalClusterIdentifier**— a GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.
+ **GlobalClusterMembers** : tableau d'objets [GlobalClusterMember](#GlobalClusterMember).

  Une liste de clusters ARNs et d'instances ARNs pour tous les clusters de base de données qui font partie de la base de données globale.
+ **GlobalClusterResourceId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant immuable de la base de données globale, unique dans toutes les régions. Cet identifiant se trouve dans les entrées du CloudTrail journal chaque fois que l'on accède à la clé KMS du cluster de base de données.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique l'état actuel de cette base de données globale.
+ **StorageEncrypted**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Paramètre de chiffrement du stockage pour la base de données globale.

**Erreurs**
+ [GlobalClusterNotFoundFault](api-faults.md#GlobalClusterNotFoundFault)
+ [InvalidGlobalClusterStateFault](api-faults.md#InvalidGlobalClusterStateFault)
+ [Non valide DBCluster StateFault](api-faults.md#InvalidDBClusterStateFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)

## RemoveFromGlobalCluster (action)
<a name="RemoveFromGlobalCluster"></a>

         Le nom de la AWS CLI pour cette API est :`remove-from-global-cluster`.

Dissocie un cluster de bases de données Neptune d'une base de données globale Neptune. Un cluster secondaire devient un cluster autonome normal doté d'une fonctionnalité de lecture-écriture au lieu d'être en lecture seule, et ne reçoit plus de données d'un cluster principal.

**Demande**
+ **DbClusterIdentifier** (dans la CLI : `--db-cluster-identifier`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) qui identifie le cluster à détacher du cluster de bases de données Neptune global.
+ **GlobalClusterIdentifier**(dans la CLI :`--global-cluster-identifier`) — *Obligatoire :* a GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  Identifiant de la base de données globale Neptune à partir de laquelle détacher le cluster de bases de données Neptune spécifié.

**Réponse**

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

Ce type de données est utilisé comme élément de réponse pour les actions [CreateGlobalCluster (action)](#CreateGlobalCluster), [DescribeGlobalClusters (action)](#DescribeGlobalClusters), [ModifyGlobalCluster (action)](#ModifyGlobalCluster), [DeleteGlobalCluster (action)](#DeleteGlobalCluster), [FailoverGlobalCluster (action)](#FailoverGlobalCluster) et [RemoveFromGlobalCluster (action)](#RemoveFromGlobalCluster).
+ **DeletionProtection**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Paramètre de protection contre la suppression pour la base de données globale.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Moteur de base de données Neptune utilisé par la base de données globale (`"neptune"`).
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Version de moteur Neptune utilisée par la base de données globale.
+ **GlobalClusterArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de la base de données globale.
+ **GlobalClusterIdentifier**— a GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.
+ **GlobalClusterMembers** : tableau d'objets [GlobalClusterMember](#GlobalClusterMember).

  Une liste de clusters ARNs et d'instances ARNs pour tous les clusters de base de données qui font partie de la base de données globale.
+ **GlobalClusterResourceId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant immuable de la base de données globale, unique dans toutes les régions. Cet identifiant se trouve dans les entrées du CloudTrail journal chaque fois que l'on accède à la clé KMS du cluster de base de données.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique l'état actuel de cette base de données globale.
+ **StorageEncrypted**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Paramètre de chiffrement du stockage pour la base de données globale.

**Erreurs**
+ [GlobalClusterNotFoundFault](api-faults.md#GlobalClusterNotFoundFault)
+ [InvalidGlobalClusterStateFault](api-faults.md#InvalidGlobalClusterStateFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)

## *Structures :*
<a name="api-global-dbs-structures-spacer"></a>

## GlobalCluster (structure)
<a name="GlobalCluster"></a>

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

Ce type de données est utilisé comme élément de réponse pour les actions [CreateGlobalCluster (action)](#CreateGlobalCluster), [DescribeGlobalClusters (action)](#DescribeGlobalClusters), [ModifyGlobalCluster (action)](#ModifyGlobalCluster), [DeleteGlobalCluster (action)](#DeleteGlobalCluster), [FailoverGlobalCluster (action)](#FailoverGlobalCluster) et [RemoveFromGlobalCluster (action)](#RemoveFromGlobalCluster).

**Champs**
+ **DeletionProtection**— Il s'agit d'une BooleanOptional valeur booléenne `boolean` (vraie ou fausse) du type : (valeur booléenne).

  Paramètre de protection contre la suppression pour la base de données globale.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Moteur de base de données Neptune utilisé par la base de données globale (`"neptune"`).
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Version de moteur Neptune utilisée par la base de données globale.
+ **GlobalClusterArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de la base de données globale.
+ **GlobalClusterIdentifier**— Il s'agit d'un GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.
+ **GlobalClusterMembers** : tableau d'objets [GlobalClusterMember](#GlobalClusterMember).

  Une liste de clusters ARNs et d'instances ARNs pour tous les clusters de base de données qui font partie de la base de données globale.
+ **GlobalClusterResourceId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant immuable de la base de données globale, unique dans toutes les régions. Cet identifiant se trouve dans les entrées du CloudTrail journal chaque fois que l'on accède à la clé KMS du cluster de base de données.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique l'état actuel de cette base de données globale.
+ **StorageEncrypted**— Il s'agit d'une BooleanOptional valeur booléenne `boolean` (vraie ou fausse) du type : (valeur booléenne).

  Paramètre de chiffrement du stockage pour la base de données globale.

`GlobalCluster` est utilisé comme élément de réponse pour :
+ [CreateGlobalCluster](#CreateGlobalCluster)
+ [ModifyGlobalCluster](#ModifyGlobalCluster)
+ [DeleteGlobalCluster](#DeleteGlobalCluster)
+ [RemoveFromGlobalCluster](#RemoveFromGlobalCluster)
+ [FailoverGlobalCluster](#FailoverGlobalCluster)

## GlobalClusterMember (structure)
<a name="GlobalClusterMember"></a>

 Structure de données contenant des informations sur les clusters principaux et secondaires associés à une base de données globale Neptune. 

**Champs**
+ **DBClusterArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

   Amazon Resource Name (ARN) du cluster de bases de données. 
+ **IsWriter** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

   Spécifie si le cluster Neptune est le cluster principal (c'est-à-dire s'il possède une fonctionnalité de lecture-écriture) de la base de données globale Neptune à laquelle il est associé. 
+ **Readers** : chaîne de type : `string` (chaîne encodée en UTF-8).

   Amazon Resource Name (ARN) de chaque cluster secondaire en lecture seule associé à la base de données Neptune globale. 

# API d'instances Neptune
<a name="api-instances"></a>

**Actions :**
+ [Créer DBInstance (action)](#CreateDBInstance)
+ [Supprimer DBInstance (action)](#DeleteDBInstance)
+ [Modifier DBInstance (action)](#ModifyDBInstance)
+ [Redémarrer DBInstance (action)](#RebootDBInstance)
+ [Décrire DBInstances (action)](#DescribeDBInstances)
+ [DescribeOrderableDBInstanceOptions (action)](#DescribeOrderableDBInstanceOptions)
+ [DescribeValidDBInstanceModifications (action)](#DescribeValidDBInstanceModifications)

**Structures :**
+ [DBInstance (structure)](#DBInstance)
+ [DBInstanceStatusInfo (structure)](#DBInstanceStatusInfo)
+ [DBInstanceOption commandable (structure)](#OrderableDBInstanceOption)
+ [PendingModifiedValues (structure)](#PendingModifiedValues)
+ [ValidStorageOptions (structure)](#ValidStorageOptions)
+ [Valide DBInstance ModificationsMessage (structure)](#ValidDBInstanceModificationsMessage)

## Créer DBInstance (action)
<a name="CreateDBInstance"></a>

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

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

**Demande**
+ **AutoMinorVersionUpgrade**(dans la CLI :`--auto-minor-version-upgrade`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

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

  Par défaut : `true`
+ **AvailabilityZone** (dans la CLI : `--availability-zone`) : chaîne de type : `string` (chaîne encodée en UTF-8).

   La zone de EC2 disponibilité dans laquelle l'instance de base de données est créée

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

   Exemple : `us-east-1d`

   Contrainte : le AvailabilityZone paramètre ne peut pas être spécifié si le paramètre MultiAZ est défini sur. `true` La zone de disponibilité spécifiée doit se trouver dans la même région Amazon que le point de terminaison actuel.
+ **BackupRetentionPeriod**(dans la CLI :`--backup-retention-period`) — un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Nombre de jours de conservation des sauvegardes automatiques.

  Non applicable. La période de rétention des sauvegardes automatisées est gérée par le cluster de bases de données. Pour de plus amples informations, veuillez consulter [Créer DBCluster (action)](api-clusters.md#CreateDBCluster).

  Par défaut : 1

  Contraintes :
  + Doit être compris entre 0 et 35
  + Ne peut pas être défini sur 0 si l'instance de base de données est une source des réplicas en lecture
+ **CopyTagsToSnapshot**(dans la CLI :`--copy-tags-to-snapshot`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Valeur true pour copier toutes les balises de l'instance de base de données vers les instantanés de l'instance de base de données, et false dans le cas contraire. La valeur par défaut est false.
+ **DBClusterIdentifier** (dans la CLI : `--db-cluster-identifier`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Pour plus d'informations sur la création d'un cluster de base de données , consultez [Créer DBCluster (action)](api-clusters.md#CreateDBCluster).

  Type : String
+ **DBInstanceClass** (dans la CLI : `--db-instance-class`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Capacité de calcul et de mémoire de l'instance de base de données, par exemple `db.m4.large`. Toutes les classes d'instances de base de données ne sont pas disponibles dans toutes les régions Amazon.
+ **DBInstanceIdentifier** (dans la CLI : `--db-instance-identifier`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Contraintes :
  + Doit contenir entre 1 et 63 lettres, chiffres ou traits d'union.
  + Le premier caractère doit être une lettre.
  + Ne peut pas se terminer par un trait d'union ni contenir deux traits d'union consécutifs.

  Exemple : `mydbinstance`
+ **DBName** (dans la CLI : `--db-name`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge.
+ **DBParameterGroupName** (dans la CLI : `--db-parameter-group-name`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Contraintes :
  + Doit comporter entre 1 et 255 lettres, chiffres ou traits d'union.
  + Le premier caractère doit être une lettre
  + Ne peut pas se terminer par un trait d'union ni contenir deux traits d'union consécutifs
+ **DBSecurityGroups** (dans la CLI : `--db-security-groups`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Par défaut : le Security Group DB par défaut pour le moteur de base de données.
+ **DBSubnetGroupName** (dans la CLI : `--db-subnet-group-name`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  S'il n'existe aucun groupe de sous-réseaux de base de données, il s'agit d'une instance de base de données non VPC.
+ **DeletionProtection**(dans la CLI :`--deletion-protection`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Une valeur qui indique si la protection contre la suppression a été activée pour l'instance de base de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée. Par défaut, la protection contre la suppression est désactivée. Consultez [Suppression d'une instance de base de données](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html).

  Les instances de base de données dans un cluster de base de données peuvent être supprimées même lorsque la protection contre la suppression est activée dans le cluster de base de données parent.
+ **Domain** (dans la CLI : `--domain`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifiez le domaine Active Directory dans lequel créer l'instance.
+ **DomainIAMRoleName** (dans la CLI : `--domain-iam-role-name`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifiez le nom du rôle IAM à utiliser pour effectuer des appels d'API à Directory Service.
+ **EnableCloudwatchLogsExports** (dans la CLI : `--enable-cloudwatch-logs-exports`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des types de journaux qui doivent être activés pour être exportés vers CloudWatch Logs.
+ **EnableIAMDatabaseAuthentication**(dans la CLI :`--enable-iam-database-authentication`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Non prise en charge par Neptune (ignorée).
+ **Engine** (dans la CLI : `--engine`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Valeurs valides : `neptune`
+ **EngineVersion** (dans la CLI : `--engine-version`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Numéro de version du moteur de base de données à utiliser. Actuellement, la définition de ce paramètre n'a aucun effet.
+ **Iops**(dans la CLI :`--iops`) — un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Quantité d'IOPS provisionnés (opérations d'E/S par seconde) à allouer initialement pour l'instance de base de données.
+ **KmsKeyId** (dans la CLI : `--kms-key-id`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

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

  Non applicable. L'identifiant de clé KMS est géré par le cluster de bases de données. Pour de plus amples informations, veuillez consulter [Créer DBCluster (action)](api-clusters.md#CreateDBCluster).

  Si le paramètre `StorageEncrypted` est true, et que vous ne spécifiez pas de valeur pour le paramètre `KmsKeyId`, Amazon Neptune utilisera votre clé de chiffrement par défaut. Amazon KMS crée la clé de chiffrement par défaut pour votre compte Amazon. Votre compte Amazon a une clé de chiffrement par défaut différente pour chaque région Amazon.
+ **LicenseModel** (dans la CLI : `--license-model`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

   Valeurs valides : `license-included` \$1 `bring-your-own-license` \$1 `general-public-license`
+ **MonitoringInterval**(dans la CLI :`--monitoring-interval`) — un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

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

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

  Valeurs valides : `0, 1, 5, 10, 15, 30, 60`
+ **MonitoringRoleArn** (dans la CLI : `--monitoring-role-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  L'ARN du rôle IAM qui permet à Neptune d'envoyer des métriques de surveillance améliorées à Amazon CloudWatch Logs. Par exemple, `arn:aws:iam:123456789012:role/emaccess`.

  Si `MonitoringInterval` est défini sur une valeur différente de 0, vous devez fournir une valeur `MonitoringRoleArn`.
+ **MultiAZ**(dans la CLI :`--multi-az`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Indique si l'instance de base de données est un déploiement multi-AZ. Vous ne pouvez pas définir le AvailabilityZone paramètre si le paramètre MultiAZ est défini sur true.
+ **Port**(dans la CLI :`--port`) — un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

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

  Non applicable. Le port est géré par le cluster de bases de données. Pour de plus amples informations, veuillez consulter [Créer DBCluster (action)](api-clusters.md#CreateDBCluster).

   Par défaut: `8182`

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

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

  Non applicable. L'intervalle de temps quotidien pour la création des sauvegardes automatisées est géré par le cluster de bases de données. Pour de plus amples informations, veuillez consulter [Créer DBCluster (action)](api-clusters.md#CreateDBCluster).
+ **PreferredMaintenanceWindow** (dans la CLI : `--preferred-maintenance-window`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

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

  Par défaut, une fenêtre de 30 minutes est sélectionnée de manière aléatoire dans un bloc de 8 heures pour chaque région Amazon, se produisant un jour choisi au hasard dans la semaine.

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

  Contraintes : fenêtre minimale de 30 minutes.
+ **PromotionTier**(dans la CLI :`--promotion-tier`) — un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

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

  Valeur par défaut : 1

  Valeurs valides : 0 - 15
+ **PubliclyAccessible**(dans la CLI :`--publicly-accessible`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Cet indicateur ne doit plus être utilisé.
+ **StorageEncrypted**(dans la CLI :`--storage-encrypted`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

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

  Non applicable. Le chiffrement des instances de base de données est géré par le cluster de bases de données. Pour de plus amples informations, veuillez consulter [Créer DBCluster (action)](api-clusters.md#CreateDBCluster).

  Valeur par défaut : false
+ **StorageType** (dans la CLI : `--storage-type`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non applicable. Dans Neptune, le type de stockage est géré au niveau du cluster de bases de données.
+ **Tags** (dans la CLI : `--tags`) : tableau d'objets [Tag](api-other-apis.md#Tag).

  Balises à attribuer à la nouvelle instance.
+ **TdeCredentialArn** (dans la CLI : `--tde-credential-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  ARN du magasin de clés auquel associer l'instance pour le chiffrement TDE.
+ **TdeCredentialPassword**(dans la CLI :`--tde-credential-password`) — a SensitiveString, de type : `string` (une chaîne codée en UTF-8).

  Mot de passe de l'ARN donnée du magasin de clés pour accéder à l'appareil.
+ **Timezone** (dans la CLI : `--timezone`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fuseau horaire de l'instance de base de données.
+ **VpcSecurityGroupIds** (dans la CLI : `--vpc-security-group-ids`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Non applicable. La liste associée des groupes de sécurité EC2 VPC est gérée par le cluster de base de données. Pour de plus amples informations, veuillez consulter [Créer DBCluster (action)](api-clusters.md#CreateDBCluster).

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

**Réponse**

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

Ce type de données est utilisé comme élément de réponse dans l'action [Décrire DBInstances (action)](#DescribeDBInstances).
+ **AutoMinorVersionUpgrade** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique que des correctifs de versions mineures sont appliquées automatiquement.
+ **AvailabilityZone** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le nom de la zone de disponibilité dans laquelle l'instance DB se trouve.
+ **BackupRetentionPeriod** : entier de type : `integer` (entier signé de 32 bits).

  Spécifie le nombre de jours de conservation des instantanés de base de données automatiques.
+ **CACertificateIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant du certificat CA de cette instance de base de données.
+ **CopyTagsToSnapshot** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si des balises sont copiées de l'instance de base de données vers des instantanés de l'instance de base de données.
+ **DBClusterIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si l'instance de base de données est membre d'un cluster de bases de données, elle contient le nom du cluster de bases de données dont elle est membre.
+ **DBInstanceArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de l'instance de base de données.
+ **DBInstanceClass** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient le nom de la classe de capacité de calcul et de mémoire de l'instance de base de données.
+ **DBInstanceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un identifiant de base de données fourni par l'utilisateur. Ce dernier est la clé unique qui identifie une instance de base de données.
+ **DbInstancePort** : entier de type : `integer` (entier signé de 32 bits).

  Spécifie le port sur lequel l'instance de base de données écoute. Si l'instance de base de données fait partie d'un cluster de bases de données, le port peut être différent du port de cluster de bases de données.
+ **DBInstanceStatus** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique l'état actuel de cette base de données.
+ **DbiResourceId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant immuable et propre à chaque région Amazon pour l'instance de base de données. Cet identifiant se trouve dans les entrées du CloudTrail journal Amazon chaque fois que la clé Amazon KMS de l'instance de base de données est consultée.
+ **DBName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom de la base de données.
+ **DBParameterGroups** : tableau d'objets [DBParameterGroupStatus](api-parameters.md#DBParameterGroupStatus).

  Fournit la liste des groupes de paramètres de base de données appliqués à cette instance de base de données.
+ **DBSecurityGroups** : tableau d'objets [DBSecurityGroupMembership](api-datatypes.md#DBSecurityGroupMembership).

   Fournit la liste des éléments du Security Group DB contenant uniquement des sous-éléments `DBSecurityGroup.Name` et `DBSecurityGroup.Status`.
+ **DBSubnetGroup** : objet [DBSubnetGroupe](api-subnets.md#DBSubnetGroup).

  Spécifie des informations sur le groupe de sous-réseaux associé à l'instance de base de données, dont le nom, la description et les sous-réseaux du groupe de sous-réseaux.
+ **DeletionProtection**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Indique si la protection contre la suppression a été activée pour l'instance de base de données. L’instance ne peut pas être supprimée tant que la protection contre la suppression est activée. Consultez [Suppression d'une instance de base de données](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html).
+ **DomainMemberships** : tableau d'objets [DomainMembership](api-datatypes.md#DomainMembership).

  Non pris en charge
+ **EnabledCloudwatchLogsExports** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des types de journaux que cette instance de base de données est configurée pour exporter vers CloudWatch Logs.
+ **Endpoint** : objet [Point de terminaison](api-datatypes.md#Endpoint).

  Spécifie le point de terminaison de la connexion.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le nom du moteur de base de données à utiliser pour cette instance de base de données.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique la version du moteur de base de données.
+ **EnhancedMonitoringResourceArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Le nom de ressource Amazon (ARN) du flux de journal Amazon CloudWatch Logs qui reçoit les données de métriques de surveillance améliorée pour l'instance de base de données.
+ **IAMDatabaseAuthenticationEnabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur true si l'authentification Amazon Identity and Access Management (IAM) est activée, et false dans le cas contraire.
+ **InstanceCreateTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Indique la date et l'heure de création de l'instance de base de données.
+ **Iops**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie la valeur des IOPS provisionnés (opérations d'E/S par seconde).
+ **KmsKeyId** : chaîne de type : `string` (chaîne encodée en UTF-8).

   Non pris en charge : Le chiffrement des instances de base de données est géré par le cluster de bases de données.
+ **LatestRestorableTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure limite à laquelle une base de données peut être restaurée par point-in-time restauration.
+ **LicenseModel** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Informations sur le modèle de licence de cette instance de base de données.
+ **MonitoringInterval**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Intervalle, en secondes, entre les points lorsque des métriques de surveillance améliorée sont collectées pour l'instance de base de données.
+ **MonitoringRoleArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  L'ARN du rôle IAM qui permet à Neptune d'envoyer des métriques de surveillance améliorée à Amazon CloudWatch Logs.
+ **MultiAZ** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si l'instance de base de données est un déploiement multi-AZ.
+ **PendingModifiedValues** : objet [PendingModifiedValues](#PendingModifiedValues).

  Spécifie que les modifications apportées à l'instance de base de données sont en attente. Cet élément est inclus uniquement lorsque des modifications sont en attente. Des modifications spécifiques sont identifiées par sous-éléments.
+ **PreferredBackupWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

   Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété `BackupRetentionPeriod`.
+ **PreferredMaintenanceWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.
+ **PromotionTier**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Valeur qui spécifie l'ordre dans lequel un réplica en lecture est promu en instance principale après un échec de l'instance principale existante. 
+ **PubliclyAccessible** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Cet indicateur ne doit plus être utilisé.
+ **ReadReplicaDBClusterIdentifiers** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un ou plusieurs identifiants des clusters de bases de données qui sont des réplicas en lecture de cette instance de base de données.
+ **ReadReplicaDBInstanceIdentifiers** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un ou plusieurs identifiants des réplicas en lecture associés à cette instance de base de données.
+ **ReadReplicaSourceDBInstanceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient l'identifiant de l'instance de base de données source si cette dernière est un réplica en lecture.
+ **SecondaryAvailabilityZone** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si cette valeur est présente, spécifie le nom de la zone de disponibilité secondaire d'une instance de base de données avec prise en charge multi-AZ.
+ **StatusInfos** : tableau d'objets [DBInstanceStatusInfo](#DBInstanceStatusInfo).

  Statut d'un réplica en lecture. Si l'instance n'est pas un réplica en lecture, ce champ est vide.
+ **StorageEncrypted** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Non pris en charge : Le chiffrement des instances de base de données est géré par le cluster de bases de données.
+ **StorageType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le type de stockage associé à l’instance de base de données.
+ **TdeCredentialArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  ARN du magasin de clés associé à l'instance pour le chiffrement TDE.
+ **Timezone** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge.
+ **VpcSecurityGroups** : tableau d'objets [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

**Erreurs**
+ [DBInstanceAlreadyExistsFault](api-faults.md#DBInstanceAlreadyExistsFault)
+ [Insuffisant DBInstance CapacityFault](api-faults.md#InsufficientDBInstanceCapacityFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [DBSecurityGroupNotFoundFault](api-faults.md#DBSecurityGroupNotFoundFault)
+ [InstanceQuotaExceededFault](api-faults.md#InstanceQuotaExceededFault)
+ [StorageQuotaExceededFault](api-faults.md#StorageQuotaExceededFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
+ [DBSubnetGroupDoesNotCoverEnoughAZs](api-faults.md#DBSubnetGroupDoesNotCoverEnoughAZs)
+ [Non valide DBCluster StateFault](api-faults.md#InvalidDBClusterStateFault)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)
+ [Non valide VPCNetwork StateFault](api-faults.md#InvalidVPCNetworkStateFault)
+ [ProvisionedIopsNotAvailableInAZFault](api-faults.md#ProvisionedIopsNotAvailableInAZFault)
+ [OptionGroupNotFoundFault](api-faults.md#OptionGroupNotFoundFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [StorageTypeNotSupportedFault](api-faults.md#StorageTypeNotSupportedFault)
+ [AuthorizationNotFoundFault](api-faults.md#AuthorizationNotFoundFault)
+ [KMSKeyNotAccessibleFault](api-faults.md#KMSKeyNotAccessibleFault)
+ [DomainNotFoundFault](api-faults.md#DomainNotFoundFault)

## Supprimer DBInstance (action)
<a name="DeleteDBInstance"></a>

         Le nom de la AWS CLI pour cette API est :`delete-db-instance`.

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

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

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

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

**Demande**
+ **DBInstanceIdentifier** (dans la CLI : `--db-instance-identifier`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Contraintes :
  + Doit correspondre au nom d'une instance de bases de données existante.
+ **FinalDBSnapshotIdentifier** (dans la CLI : `--final-db-snapshot-identifier`) : chaîne de type : `string` (chaîne encodée en UTF-8).

   L' DBSnapshotidentifiant de la nouvelle date DBSnapshot créée SkipFinalSnapshot est défini sur`false`.
**Note**  
Le fait de spécifier ce paramètre et de le SkipFinalShapshot définir également sur true entraîne une erreur.

  Contraintes :
  + Doit comporter entre 1 et 255 lettres ou chiffres.
  + Le premier caractère doit être une lettre
  + Ne peut pas se terminer par un trait d'union ni contenir deux traits d'union consécutifs
  + Ne peut pas être spécifié lors de la suppression d'un réplica en lecture.
+ **SkipFinalSnapshot** (dans la CLI : `--skip-final-snapshot`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

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

  Notez que lorsqu'une instance de base de données est en état de défaillance et a le statut « failed », « incompatible-restore » ou « incompatible-network », elle ne peut être supprimée que lorsque le SkipFinalSnapshot paramètre est défini sur « true ».

  Spécifiez `true` lors de la suppression d'un réplica en lecture.
**Note**  
Le paramètre Final DBSnapshot Identifier doit être spécifié si tel SkipFinalSnapshot est le cas`false`.

  Par défaut : `false`

**Réponse**

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

Ce type de données est utilisé comme élément de réponse dans l'action [Décrire DBInstances (action)](#DescribeDBInstances).
+ **AutoMinorVersionUpgrade** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique que des correctifs de versions mineures sont appliquées automatiquement.
+ **AvailabilityZone** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le nom de la zone de disponibilité dans laquelle l'instance DB se trouve.
+ **BackupRetentionPeriod** : entier de type : `integer` (entier signé de 32 bits).

  Spécifie le nombre de jours de conservation des instantanés de base de données automatiques.
+ **CACertificateIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant du certificat CA de cette instance de base de données.
+ **CopyTagsToSnapshot** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si des balises sont copiées de l'instance de base de données vers des instantanés de l'instance de base de données.
+ **DBClusterIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si l'instance de base de données est membre d'un cluster de bases de données, elle contient le nom du cluster de bases de données dont elle est membre.
+ **DBInstanceArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de l'instance de base de données.
+ **DBInstanceClass** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient le nom de la classe de capacité de calcul et de mémoire de l'instance de base de données.
+ **DBInstanceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un identifiant de base de données fourni par l'utilisateur. Ce dernier est la clé unique qui identifie une instance de base de données.
+ **DbInstancePort** : entier de type : `integer` (entier signé de 32 bits).

  Spécifie le port sur lequel l'instance de base de données écoute. Si l'instance de base de données fait partie d'un cluster de bases de données, le port peut être différent du port de cluster de bases de données.
+ **DBInstanceStatus** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique l'état actuel de cette base de données.
+ **DbiResourceId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant immuable et propre à chaque région Amazon pour l'instance de base de données. Cet identifiant se trouve dans les entrées du CloudTrail journal Amazon chaque fois que la clé Amazon KMS de l'instance de base de données est consultée.
+ **DBName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom de la base de données.
+ **DBParameterGroups** : tableau d'objets [DBParameterGroupStatus](api-parameters.md#DBParameterGroupStatus).

  Fournit la liste des groupes de paramètres de base de données appliqués à cette instance de base de données.
+ **DBSecurityGroups** : tableau d'objets [DBSecurityGroupMembership](api-datatypes.md#DBSecurityGroupMembership).

   Fournit la liste des éléments du Security Group DB contenant uniquement des sous-éléments `DBSecurityGroup.Name` et `DBSecurityGroup.Status`.
+ **DBSubnetGroup** : objet [DBSubnetGroupe](api-subnets.md#DBSubnetGroup).

  Spécifie des informations sur le groupe de sous-réseaux associé à l'instance de base de données, dont le nom, la description et les sous-réseaux du groupe de sous-réseaux.
+ **DeletionProtection**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Indique si la protection contre la suppression a été activée pour l'instance de base de données. L’instance ne peut pas être supprimée tant que la protection contre la suppression est activée. Consultez [Suppression d'une instance de base de données](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html).
+ **DomainMemberships** : tableau d'objets [DomainMembership](api-datatypes.md#DomainMembership).

  Non pris en charge
+ **EnabledCloudwatchLogsExports** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des types de journaux que cette instance de base de données est configurée pour exporter vers CloudWatch Logs.
+ **Endpoint** : objet [Point de terminaison](api-datatypes.md#Endpoint).

  Spécifie le point de terminaison de la connexion.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le nom du moteur de base de données à utiliser pour cette instance de base de données.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique la version du moteur de base de données.
+ **EnhancedMonitoringResourceArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Le nom de ressource Amazon (ARN) du flux de journal Amazon CloudWatch Logs qui reçoit les données de métriques de surveillance améliorée pour l'instance de base de données.
+ **IAMDatabaseAuthenticationEnabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur true si l'authentification Amazon Identity and Access Management (IAM) est activée, et false dans le cas contraire.
+ **InstanceCreateTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Indique la date et l'heure de création de l'instance de base de données.
+ **Iops**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie la valeur des IOPS provisionnés (opérations d'E/S par seconde).
+ **KmsKeyId** : chaîne de type : `string` (chaîne encodée en UTF-8).

   Non pris en charge : Le chiffrement des instances de base de données est géré par le cluster de bases de données.
+ **LatestRestorableTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure limite à laquelle une base de données peut être restaurée par point-in-time restauration.
+ **LicenseModel** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Informations sur le modèle de licence de cette instance de base de données.
+ **MonitoringInterval**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Intervalle, en secondes, entre les points lorsque des métriques de surveillance améliorée sont collectées pour l'instance de base de données.
+ **MonitoringRoleArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  L'ARN du rôle IAM qui permet à Neptune d'envoyer des métriques de surveillance améliorée à Amazon CloudWatch Logs.
+ **MultiAZ** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si l'instance de base de données est un déploiement multi-AZ.
+ **PendingModifiedValues** : objet [PendingModifiedValues](#PendingModifiedValues).

  Spécifie que les modifications apportées à l'instance de base de données sont en attente. Cet élément est inclus uniquement lorsque des modifications sont en attente. Des modifications spécifiques sont identifiées par sous-éléments.
+ **PreferredBackupWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

   Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété `BackupRetentionPeriod`.
+ **PreferredMaintenanceWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.
+ **PromotionTier**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Valeur qui spécifie l'ordre dans lequel un réplica en lecture est promu en instance principale après un échec de l'instance principale existante. 
+ **PubliclyAccessible** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Cet indicateur ne doit plus être utilisé.
+ **ReadReplicaDBClusterIdentifiers** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un ou plusieurs identifiants des clusters de bases de données qui sont des réplicas en lecture de cette instance de base de données.
+ **ReadReplicaDBInstanceIdentifiers** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un ou plusieurs identifiants des réplicas en lecture associés à cette instance de base de données.
+ **ReadReplicaSourceDBInstanceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient l'identifiant de l'instance de base de données source si cette dernière est un réplica en lecture.
+ **SecondaryAvailabilityZone** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si cette valeur est présente, spécifie le nom de la zone de disponibilité secondaire d'une instance de base de données avec prise en charge multi-AZ.
+ **StatusInfos** : tableau d'objets [DBInstanceStatusInfo](#DBInstanceStatusInfo).

  Statut d'un réplica en lecture. Si l'instance n'est pas un réplica en lecture, ce champ est vide.
+ **StorageEncrypted** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Non pris en charge : Le chiffrement des instances de base de données est géré par le cluster de bases de données.
+ **StorageType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le type de stockage associé à l’instance de base de données.
+ **TdeCredentialArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  ARN du magasin de clés associé à l'instance pour le chiffrement TDE.
+ **Timezone** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge.
+ **VpcSecurityGroups** : tableau d'objets [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

**Erreurs**
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [Non valide DBInstance StateFault](api-faults.md#InvalidDBInstanceStateFault)
+ [DBSnapshotAlreadyExistsFault](api-faults.md#DBSnapshotAlreadyExistsFault)
+ [SnapshotQuotaExceededFault](api-faults.md#SnapshotQuotaExceededFault)
+ [Non valide DBCluster StateFault](api-faults.md#InvalidDBClusterStateFault)

## Modifier DBInstance (action)
<a name="ModifyDBInstance"></a>

         Le nom de la AWS CLI pour cette API est :`modify-db-instance`.

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

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

  Indique que des mises à niveau de version majeure sont autorisées. La modification de ce paramètre n'entraîne pas d'interruption et est appliquée de manière asynchrone dès que possible.
+ **ApplyImmediately** (dans la CLI : `--apply-immediately`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

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

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

  Par défaut : `false`
+ **AutoMinorVersionUpgrade**(dans la CLI :`--auto-minor-version-upgrade`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

   Indique que des mises à niveau de version mineure sont appliquées automatiquement à l'instance de base de données pendant la fenêtre de maintenance. La modification de ce paramètre n'entraîne pas d'interruption, sauf dans le cas suivant, et est appliquée de manière asynchrone dès que possible. Une interruption se produit si ce paramètre est défini sur `true` pendant la fenêtre de maintenance, si une version mineure plus récente est disponible et si Neptune active les correctifs automatiques pour cette version de moteur.
+ **BackupRetentionPeriod**(dans la CLI :`--backup-retention-period`) — un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Non applicable. La période de rétention des sauvegardes automatisées est gérée par le cluster de bases de données. Pour de plus amples informations, veuillez consulter [Modifier DBCluster (action)](api-clusters.md#ModifyDBCluster).

  Par défaut : utilise le paramètre existant
+ **CACertificateIdentifier** (dans la CLI : `--ca-certificate-identifier`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique le certificat qui doit être associé à l'instance.
+ **CloudwatchLogsExportConfiguration** (dans la CLI : `--cloudwatch-logs-export-configuration`) : objet [CloudwatchLogsExportConfiguration](api-clusters.md#CloudwatchLogsExportConfiguration).

  Paramètre de configuration des types de journaux à activer pour l'exportation vers les CloudWatch journaux pour une instance de base de données ou un cluster de base de données spécifique.
+ **CopyTagsToSnapshot**(dans la CLI :`--copy-tags-to-snapshot`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Valeur true pour copier toutes les balises de l'instance de base de données vers les instantanés de l'instance de base de données, et false dans le cas contraire. La valeur par défaut est false.
+ **DBInstanceClass** (dans la CLI : `--db-instance-class`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

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

  Par défaut : utilise le paramètre existant
+ **DBInstanceIdentifier** (dans la CLI : `--db-instance-identifier`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Contraintes :
  + Doit correspondre à l'identifiant d'un existant DBInstance.
+ **DBParameterGroupName** (dans la CLI : `--db-parameter-group-name`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Par défaut : utilise le paramètre existant

  Contraintes : le groupe de paramètres de base de données doit être dans la même famille de groupe de paramètres de base de données que cette instance de base de données.
+ **DBPortNumber**(dans la CLI :`--db-port-number`) — un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

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

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

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

   Par défaut : `8182`
+ **DBSecurityGroups** (dans la CLI : `--db-security-groups`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Contraintes :
  + S'il est fourni, il doit correspondre aux DBSecurity groupes existants.
+ **DBSubnetGroupName** (dans la CLI : `--db-subnet-group-name`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

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

  Contraintes : s'il est fourni, il doit correspondre au nom d'un DBSubnet groupe existant.

  Exemple : `mySubnetGroup`
+ **DeletionProtection**(dans la CLI :`--deletion-protection`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Une valeur qui indique si la protection contre la suppression a été activée pour l'instance de base de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée. Par défaut, la protection contre la suppression est désactivée. Consultez [Suppression d'une instance de base de données](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html).
+ **Domain** (dans la CLI : `--domain`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge.
+ **DomainIAMRoleName** (dans la CLI : `--domain-iam-role-name`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge
+ **EnableIAMDatabaseAuthentication**(dans la CLI :`--enable-iam-database-authentication`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

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

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

  Non applicable. Le mappage des comptes Amazon IAM avec des comptes de base de données est géré par le cluster de bases de données. Pour de plus amples informations, veuillez consulter [Modifier DBCluster (action)](api-clusters.md#ModifyDBCluster).

  Par défaut: `false`
+ **EngineVersion** (dans la CLI : `--engine-version`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Numéro de version du moteur de base de données vers lequel effectuer la mise à niveau. Actuellement, la définition de ce paramètre n'a aucun effet. Pour mettre à niveau votre moteur de base de données vers la version la plus récente, utilisez l'API [ApplyPendingMaintenanceAction (action)](api-other-apis.md#ApplyPendingMaintenanceAction).
+ **Iops**(dans la CLI :`--iops`) — un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

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

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

  Par défaut : utilise le paramètre existant
+ **MonitoringInterval**(dans la CLI :`--monitoring-interval`) — un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

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

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

  Valeurs valides : `0, 1, 5, 10, 15, 30, 60`
+ **MonitoringRoleArn** (dans la CLI : `--monitoring-role-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  L'ARN du rôle IAM qui permet à Neptune d'envoyer des métriques de surveillance améliorées à Amazon CloudWatch Logs. Par exemple, `arn:aws:iam:123456789012:role/emaccess`.

  Si `MonitoringInterval` est défini sur une valeur différente de 0, vous devez fournir une valeur `MonitoringRoleArn`.
+ **MultiAZ**(dans la CLI :`--multi-az`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Indique si l'instance de base de données est un déploiement multi-AZ. La modification de ce paramètre n'entraîne pas d'interruption et la modification est appliquée pendant la fenêtre de maintenance suivante, sauf si le paramètre `ApplyImmediately` est défini sur `true` pour cette demande.
+ **NewDBInstanceIdentifier** (dans la CLI : `--new-db-instance-identifier`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Contraintes :
  + Doit contenir entre 1 et 63 lettres, chiffres ou traits d'union.
  + Le premier caractère doit être une lettre.
  + Ne peut pas se terminer par un trait d'union ni contenir deux traits d'union consécutifs.

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

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

  Non applicable. L'intervalle de temps quotidien pour la création des sauvegardes automatisées est géré par le cluster de bases de données. Pour de plus amples informations, veuillez consulter [Modifier DBCluster (action)](api-clusters.md#ModifyDBCluster).

  Contraintes :
  + Doit être au format hh24:mi-hh24:mi
  + Doit être dans le fuseau UTC (temps universel)
  + Ne doit pas être en conflit avec la fenêtre de maintenance préférée
  + Doit être de 30 minutes minimum.
+ **PreferredMaintenanceWindow** (dans la CLI : `--preferred-maintenance-window`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Par défaut : utilise le paramètre existant

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

  Jours valides : Mon \$1 Tue \$1 Wed \$1 Thu \$1 Fri \$1 Sat \$1 Sun

  Contraintes : doit être de 30 minutes minimum.
+ **PromotionTier**(dans la CLI :`--promotion-tier`) — un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

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

  Valeur par défaut : 1

  Valeurs valides : 0 - 15
+ **PubliclyAccessible**(dans la CLI :`--publicly-accessible`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Cet indicateur ne doit plus être utilisé.
+ **StorageType** (dans la CLI : `--storage-type`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non applicable. Dans Neptune, le type de stockage est géré au niveau du cluster de bases de données.
+ **TdeCredentialArn** (dans la CLI : `--tde-credential-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  ARN du magasin de clés auquel associer l'instance pour le chiffrement TDE.
+ **TdeCredentialPassword**(dans la CLI :`--tde-credential-password`) — a SensitiveString, de type : `string` (une chaîne codée en UTF-8).

  Mot de passe de l'ARN donnée du magasin de clés pour accéder à l'appareil.
+ **VpcSecurityGroupIds** (dans la CLI : `--vpc-security-group-ids`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Non applicable. La liste associée des groupes de sécurité EC2 VPC est gérée par le cluster de base de données. Pour de plus amples informations, veuillez consulter [Modifier DBCluster (action)](api-clusters.md#ModifyDBCluster).

  Contraintes :
  + S'il est fourni, il doit correspondre à l'existant VpcSecurityGroupIds.

**Réponse**

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

Ce type de données est utilisé comme élément de réponse dans l'action [Décrire DBInstances (action)](#DescribeDBInstances).
+ **AutoMinorVersionUpgrade** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique que des correctifs de versions mineures sont appliquées automatiquement.
+ **AvailabilityZone** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le nom de la zone de disponibilité dans laquelle l'instance DB se trouve.
+ **BackupRetentionPeriod** : entier de type : `integer` (entier signé de 32 bits).

  Spécifie le nombre de jours de conservation des instantanés de base de données automatiques.
+ **CACertificateIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant du certificat CA de cette instance de base de données.
+ **CopyTagsToSnapshot** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si des balises sont copiées de l'instance de base de données vers des instantanés de l'instance de base de données.
+ **DBClusterIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si l'instance de base de données est membre d'un cluster de bases de données, elle contient le nom du cluster de bases de données dont elle est membre.
+ **DBInstanceArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de l'instance de base de données.
+ **DBInstanceClass** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient le nom de la classe de capacité de calcul et de mémoire de l'instance de base de données.
+ **DBInstanceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un identifiant de base de données fourni par l'utilisateur. Ce dernier est la clé unique qui identifie une instance de base de données.
+ **DbInstancePort** : entier de type : `integer` (entier signé de 32 bits).

  Spécifie le port sur lequel l'instance de base de données écoute. Si l'instance de base de données fait partie d'un cluster de bases de données, le port peut être différent du port de cluster de bases de données.
+ **DBInstanceStatus** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique l'état actuel de cette base de données.
+ **DbiResourceId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant immuable et propre à chaque région Amazon pour l'instance de base de données. Cet identifiant se trouve dans les entrées du CloudTrail journal Amazon chaque fois que la clé Amazon KMS de l'instance de base de données est consultée.
+ **DBName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom de la base de données.
+ **DBParameterGroups** : tableau d'objets [DBParameterGroupStatus](api-parameters.md#DBParameterGroupStatus).

  Fournit la liste des groupes de paramètres de base de données appliqués à cette instance de base de données.
+ **DBSecurityGroups** : tableau d'objets [DBSecurityGroupMembership](api-datatypes.md#DBSecurityGroupMembership).

   Fournit la liste des éléments du Security Group DB contenant uniquement des sous-éléments `DBSecurityGroup.Name` et `DBSecurityGroup.Status`.
+ **DBSubnetGroup** : objet [DBSubnetGroupe](api-subnets.md#DBSubnetGroup).

  Spécifie des informations sur le groupe de sous-réseaux associé à l'instance de base de données, dont le nom, la description et les sous-réseaux du groupe de sous-réseaux.
+ **DeletionProtection**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Indique si la protection contre la suppression a été activée pour l'instance de base de données. L’instance ne peut pas être supprimée tant que la protection contre la suppression est activée. Consultez [Suppression d'une instance de base de données](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html).
+ **DomainMemberships** : tableau d'objets [DomainMembership](api-datatypes.md#DomainMembership).

  Non pris en charge
+ **EnabledCloudwatchLogsExports** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des types de journaux que cette instance de base de données est configurée pour exporter vers CloudWatch Logs.
+ **Endpoint** : objet [Point de terminaison](api-datatypes.md#Endpoint).

  Spécifie le point de terminaison de la connexion.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le nom du moteur de base de données à utiliser pour cette instance de base de données.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique la version du moteur de base de données.
+ **EnhancedMonitoringResourceArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Le nom de ressource Amazon (ARN) du flux de journal Amazon CloudWatch Logs qui reçoit les données de métriques de surveillance améliorée pour l'instance de base de données.
+ **IAMDatabaseAuthenticationEnabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur true si l'authentification Amazon Identity and Access Management (IAM) est activée, et false dans le cas contraire.
+ **InstanceCreateTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Indique la date et l'heure de création de l'instance de base de données.
+ **Iops**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie la valeur des IOPS provisionnés (opérations d'E/S par seconde).
+ **KmsKeyId** : chaîne de type : `string` (chaîne encodée en UTF-8).

   Non pris en charge : Le chiffrement des instances de base de données est géré par le cluster de bases de données.
+ **LatestRestorableTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure limite à laquelle une base de données peut être restaurée par point-in-time restauration.
+ **LicenseModel** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Informations sur le modèle de licence de cette instance de base de données.
+ **MonitoringInterval**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Intervalle, en secondes, entre les points lorsque des métriques de surveillance améliorée sont collectées pour l'instance de base de données.
+ **MonitoringRoleArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  L'ARN du rôle IAM qui permet à Neptune d'envoyer des métriques de surveillance améliorée à Amazon CloudWatch Logs.
+ **MultiAZ** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si l'instance de base de données est un déploiement multi-AZ.
+ **PendingModifiedValues** : objet [PendingModifiedValues](#PendingModifiedValues).

  Spécifie que les modifications apportées à l'instance de base de données sont en attente. Cet élément est inclus uniquement lorsque des modifications sont en attente. Des modifications spécifiques sont identifiées par sous-éléments.
+ **PreferredBackupWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

   Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété `BackupRetentionPeriod`.
+ **PreferredMaintenanceWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.
+ **PromotionTier**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Valeur qui spécifie l'ordre dans lequel un réplica en lecture est promu en instance principale après un échec de l'instance principale existante. 
+ **PubliclyAccessible** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Cet indicateur ne doit plus être utilisé.
+ **ReadReplicaDBClusterIdentifiers** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un ou plusieurs identifiants des clusters de bases de données qui sont des réplicas en lecture de cette instance de base de données.
+ **ReadReplicaDBInstanceIdentifiers** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un ou plusieurs identifiants des réplicas en lecture associés à cette instance de base de données.
+ **ReadReplicaSourceDBInstanceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient l'identifiant de l'instance de base de données source si cette dernière est un réplica en lecture.
+ **SecondaryAvailabilityZone** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si cette valeur est présente, spécifie le nom de la zone de disponibilité secondaire d'une instance de base de données avec prise en charge multi-AZ.
+ **StatusInfos** : tableau d'objets [DBInstanceStatusInfo](#DBInstanceStatusInfo).

  Statut d'un réplica en lecture. Si l'instance n'est pas un réplica en lecture, ce champ est vide.
+ **StorageEncrypted** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Non pris en charge : Le chiffrement des instances de base de données est géré par le cluster de bases de données.
+ **StorageType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le type de stockage associé à l’instance de base de données.
+ **TdeCredentialArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  ARN du magasin de clés associé à l'instance pour le chiffrement TDE.
+ **Timezone** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge.
+ **VpcSecurityGroups** : tableau d'objets [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

**Erreurs**
+ [Non valide DBInstance StateFault](api-faults.md#InvalidDBInstanceStateFault)
+ [Non valide DBSecurity GroupStateFault](api-faults.md#InvalidDBSecurityGroupStateFault)
+ [DBInstanceAlreadyExistsFault](api-faults.md#DBInstanceAlreadyExistsFault)
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [DBSecurityGroupNotFoundFault](api-faults.md#DBSecurityGroupNotFoundFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [Insuffisant DBInstance CapacityFault](api-faults.md#InsufficientDBInstanceCapacityFault)
+ [StorageQuotaExceededFault](api-faults.md#StorageQuotaExceededFault)
+ [Non valide VPCNetwork StateFault](api-faults.md#InvalidVPCNetworkStateFault)
+ [ProvisionedIopsNotAvailableInAZFault](api-faults.md#ProvisionedIopsNotAvailableInAZFault)
+ [OptionGroupNotFoundFault](api-faults.md#OptionGroupNotFoundFault)
+ [DBUpgradeDependencyFailureFault](api-faults.md#DBUpgradeDependencyFailureFault)
+ [StorageTypeNotSupportedFault](api-faults.md#StorageTypeNotSupportedFault)
+ [AuthorizationNotFoundFault](api-faults.md#AuthorizationNotFoundFault)
+ [CertificateNotFoundFault](api-faults.md#CertificateNotFoundFault)
+ [DomainNotFoundFault](api-faults.md#DomainNotFoundFault)

## Redémarrer DBInstance (action)
<a name="RebootDBInstance"></a>

         Le nom de la AWS CLI pour cette API est :`reboot-db-instance`.

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

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

**Demande**
+ **DBInstanceIdentifier** (dans la CLI : `--db-instance-identifier`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Contraintes :
  + Doit correspondre à l'identifiant d'un existant DBInstance.
+ **ForceFailover**(dans la CLI :`--force-failover`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

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

  Contrainte : vous ne pouvez pas spécifier `true` si l'instance n'est pas configurée pour MultiAZ.

**Réponse**

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

Ce type de données est utilisé comme élément de réponse dans l'action [Décrire DBInstances (action)](#DescribeDBInstances).
+ **AutoMinorVersionUpgrade** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique que des correctifs de versions mineures sont appliquées automatiquement.
+ **AvailabilityZone** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le nom de la zone de disponibilité dans laquelle l'instance DB se trouve.
+ **BackupRetentionPeriod** : entier de type : `integer` (entier signé de 32 bits).

  Spécifie le nombre de jours de conservation des instantanés de base de données automatiques.
+ **CACertificateIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant du certificat CA de cette instance de base de données.
+ **CopyTagsToSnapshot** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si des balises sont copiées de l'instance de base de données vers des instantanés de l'instance de base de données.
+ **DBClusterIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si l'instance de base de données est membre d'un cluster de bases de données, elle contient le nom du cluster de bases de données dont elle est membre.
+ **DBInstanceArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de l'instance de base de données.
+ **DBInstanceClass** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient le nom de la classe de capacité de calcul et de mémoire de l'instance de base de données.
+ **DBInstanceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un identifiant de base de données fourni par l'utilisateur. Ce dernier est la clé unique qui identifie une instance de base de données.
+ **DbInstancePort** : entier de type : `integer` (entier signé de 32 bits).

  Spécifie le port sur lequel l'instance de base de données écoute. Si l'instance de base de données fait partie d'un cluster de bases de données, le port peut être différent du port de cluster de bases de données.
+ **DBInstanceStatus** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique l'état actuel de cette base de données.
+ **DbiResourceId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant immuable et propre à chaque région Amazon pour l'instance de base de données. Cet identifiant se trouve dans les entrées du CloudTrail journal Amazon chaque fois que la clé Amazon KMS de l'instance de base de données est consultée.
+ **DBName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom de la base de données.
+ **DBParameterGroups** : tableau d'objets [DBParameterGroupStatus](api-parameters.md#DBParameterGroupStatus).

  Fournit la liste des groupes de paramètres de base de données appliqués à cette instance de base de données.
+ **DBSecurityGroups** : tableau d'objets [DBSecurityGroupMembership](api-datatypes.md#DBSecurityGroupMembership).

   Fournit la liste des éléments du Security Group DB contenant uniquement des sous-éléments `DBSecurityGroup.Name` et `DBSecurityGroup.Status`.
+ **DBSubnetGroup** : objet [DBSubnetGroupe](api-subnets.md#DBSubnetGroup).

  Spécifie des informations sur le groupe de sous-réseaux associé à l'instance de base de données, dont le nom, la description et les sous-réseaux du groupe de sous-réseaux.
+ **DeletionProtection**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Indique si la protection contre la suppression a été activée pour l'instance de base de données. L’instance ne peut pas être supprimée tant que la protection contre la suppression est activée. Consultez [Suppression d'une instance de base de données](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html).
+ **DomainMemberships** : tableau d'objets [DomainMembership](api-datatypes.md#DomainMembership).

  Non pris en charge
+ **EnabledCloudwatchLogsExports** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des types de journaux que cette instance de base de données est configurée pour exporter vers CloudWatch Logs.
+ **Endpoint** : objet [Point de terminaison](api-datatypes.md#Endpoint).

  Spécifie le point de terminaison de la connexion.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le nom du moteur de base de données à utiliser pour cette instance de base de données.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique la version du moteur de base de données.
+ **EnhancedMonitoringResourceArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Le nom de ressource Amazon (ARN) du flux de journal Amazon CloudWatch Logs qui reçoit les données de métriques de surveillance améliorée pour l'instance de base de données.
+ **IAMDatabaseAuthenticationEnabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur true si l'authentification Amazon Identity and Access Management (IAM) est activée, et false dans le cas contraire.
+ **InstanceCreateTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Indique la date et l'heure de création de l'instance de base de données.
+ **Iops**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie la valeur des IOPS provisionnés (opérations d'E/S par seconde).
+ **KmsKeyId** : chaîne de type : `string` (chaîne encodée en UTF-8).

   Non pris en charge : Le chiffrement des instances de base de données est géré par le cluster de bases de données.
+ **LatestRestorableTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure limite à laquelle une base de données peut être restaurée par point-in-time restauration.
+ **LicenseModel** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Informations sur le modèle de licence de cette instance de base de données.
+ **MonitoringInterval**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Intervalle, en secondes, entre les points lorsque des métriques de surveillance améliorée sont collectées pour l'instance de base de données.
+ **MonitoringRoleArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  L'ARN du rôle IAM qui permet à Neptune d'envoyer des métriques de surveillance améliorée à Amazon CloudWatch Logs.
+ **MultiAZ** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si l'instance de base de données est un déploiement multi-AZ.
+ **PendingModifiedValues** : objet [PendingModifiedValues](#PendingModifiedValues).

  Spécifie que les modifications apportées à l'instance de base de données sont en attente. Cet élément est inclus uniquement lorsque des modifications sont en attente. Des modifications spécifiques sont identifiées par sous-éléments.
+ **PreferredBackupWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

   Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété `BackupRetentionPeriod`.
+ **PreferredMaintenanceWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.
+ **PromotionTier**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Valeur qui spécifie l'ordre dans lequel un réplica en lecture est promu en instance principale après un échec de l'instance principale existante. 
+ **PubliclyAccessible** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Cet indicateur ne doit plus être utilisé.
+ **ReadReplicaDBClusterIdentifiers** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un ou plusieurs identifiants des clusters de bases de données qui sont des réplicas en lecture de cette instance de base de données.
+ **ReadReplicaDBInstanceIdentifiers** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un ou plusieurs identifiants des réplicas en lecture associés à cette instance de base de données.
+ **ReadReplicaSourceDBInstanceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient l'identifiant de l'instance de base de données source si cette dernière est un réplica en lecture.
+ **SecondaryAvailabilityZone** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si cette valeur est présente, spécifie le nom de la zone de disponibilité secondaire d'une instance de base de données avec prise en charge multi-AZ.
+ **StatusInfos** : tableau d'objets [DBInstanceStatusInfo](#DBInstanceStatusInfo).

  Statut d'un réplica en lecture. Si l'instance n'est pas un réplica en lecture, ce champ est vide.
+ **StorageEncrypted** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Non pris en charge : Le chiffrement des instances de base de données est géré par le cluster de bases de données.
+ **StorageType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le type de stockage associé à l’instance de base de données.
+ **TdeCredentialArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  ARN du magasin de clés associé à l'instance pour le chiffrement TDE.
+ **Timezone** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge.
+ **VpcSecurityGroups** : tableau d'objets [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

**Erreurs**
+ [Non valide DBInstance StateFault](api-faults.md#InvalidDBInstanceStateFault)
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)

## Décrire DBInstances (action)
<a name="DescribeDBInstances"></a>

         Le nom de la AWS CLI pour cette API est :`describe-db-instances`.

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

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

**Demande**
+ **DBInstanceIdentifier** (dans la CLI : `--db-instance-identifier`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Contraintes :
  + S'il est fourni, il doit correspondre à l'identifiant d'un existant DBInstance.
+ **Filters** (dans la CLI : `--filters`) : tableau d'objets [Filtre](api-datatypes.md#Filter).

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

  Filtres pris en charge :
  +  `db-cluster-id`- Accepte les identifiants de cluster de base de données et les Amazon Resource Names (ARNs) du cluster de bases de données. La liste des résultats inclura uniquement des informations sur les instances de base de données associées aux clusters de base de données identifiés par celles-ci ARNs.
  + `engine` - Accepte un nom de moteur (tel que `neptune`) et restreint la liste de résultats aux instances de base de données créées par ce moteur.

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

  ```
  aws neptune describe-db-instances \
              --filters  Name=engine,Values=neptune
  ```
+ **Marker** (dans la CLI : `--marker`) : chaîne de type : `string` (chaîne encodée en UTF-8).

   Jeton de pagination facultatif fourni par une demande `DescribeDBInstances` précédente. Si ce paramètre est spécifié, la réponse inclut uniquement des enregistrements supérieurs au marqueur, jusqu'à la valeur spécifiée par `MaxRecords`.
+ **MaxRecords**(dans la CLI :`--max-records`) — un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

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

  Par défaut : 100

  Contraintes : Minimum 20, maximum 100.

**Réponse**
+ **DBInstances** : tableau d'objets [DBInstance](#DBInstance).

   Liste des instances [DBInstance (structure)](#DBInstance).
+ **Marker** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

**Erreurs**
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)

## DescribeOrderableDBInstanceOptions (action)
<a name="DescribeOrderableDBInstanceOptions"></a>

         Le nom de la AWS CLI pour cette API est :`describe-orderable-db-instance-options`.

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

**Demande**
+ **DBInstanceClass** (dans la CLI : `--db-instance-class`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Valeur de filtre de la classe d'instance de base de données. Spécifiez ce paramètre pour afficher uniquement les offres disponibles correspondant à la classe d'instance de base de données.
+ **Engine** (dans la CLI : `--engine`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom du moteur pour lequel récupérer les options d'instance de base de données.
+ **EngineVersion** (dans la CLI : `--engine-version`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Valeur de filtre de la version de moteur. Spécifiez ce paramètre pour afficher uniquement les offres disponibles correspondant à la version de moteur spécifiée.
+ **Filters** (dans la CLI : `--filters`) : tableau d'objets [Filtre](api-datatypes.md#Filter).

  Ce paramètre n'est actuellement pas pris en charge.
+ **LicenseModel** (dans la CLI : `--license-model`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Valeur de filtre du modèle de licence. Spécifiez ce paramètre pour afficher uniquement les offres disponibles correspondant au modèle de licence spécifié.
+ **Marker** (dans la CLI : `--marker`) : chaîne de type : `string` (chaîne encodée en UTF-8).

   Un jeton de pagination facultatif fourni par une demande d' DescribeOrderableDBInstanceoptions précédente. Si ce paramètre est spécifié, la réponse inclut uniquement des enregistrements supérieurs au marqueur, jusqu'à la valeur spécifiée par `MaxRecords`.
+ **MaxRecords**(dans la CLI :`--max-records`) — un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

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

  Par défaut : 100

  Contraintes : Minimum 20, maximum 100.
+ **Vpc**(dans la CLI :`--vpc`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

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

**Réponse**
+ **Marker** : chaîne de type : `string` (chaîne encodée en UTF-8).

   Un jeton de pagination facultatif fourni par une précédente demande d'DBInstanceoptions commandables. Si ce paramètre est spécifié, la réponse inclut uniquement des enregistrements supérieurs au marqueur, jusqu'à la valeur spécifiée par `MaxRecords`.
+ **OrderableDBInstanceOptions** : tableau d'objets [Option commandable DBInstance](#OrderableDBInstanceOption).

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

## DescribeValidDBInstanceModifications (action)
<a name="DescribeValidDBInstanceModifications"></a>

         Le nom de la AWS CLI pour cette API est :`describe-valid-db-instance-modifications`.

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

**Demande**
+ **DBInstanceIdentifier** (dans la CLI : `--db-instance-identifier`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

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

**Réponse**

Informations sur les modifications valides que vous pouvez apporter à votre instance de base de données. Contient le résultat d'un appel réussi à l'action [DescribeValidDBInstanceModifications (action)](#DescribeValidDBInstanceModifications). Vous pouvez utiliser ces informations lorsque vous appelez [Modifier DBInstance (action)](#ModifyDBInstance). 
+ **Storage** : tableau d'objets [ValidStorageOptions](#ValidStorageOptions).

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

**Erreurs**
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [Non valide DBInstance StateFault](api-faults.md#InvalidDBInstanceStateFault)

## *Structures :*
<a name="api-instances-structures-spacer"></a>

## DBInstance (structure)
<a name="DBInstance"></a>

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

Ce type de données est utilisé comme élément de réponse dans l'action [Décrire DBInstances (action)](#DescribeDBInstances).

**Champs**
+ **AutoMinorVersionUpgrade** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique que des correctifs de versions mineures sont appliquées automatiquement.
+ **AvailabilityZone** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le nom de la zone de disponibilité dans laquelle l'instance DB se trouve.
+ **BackupRetentionPeriod** : entier de type : `integer` (entier signé de 32 bits).

  Spécifie le nombre de jours de conservation des instantanés de base de données automatiques.
+ **CACertificateIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant du certificat CA de cette instance de base de données.
+ **CopyTagsToSnapshot** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si des balises sont copiées de l'instance de base de données vers des instantanés de l'instance de base de données.
+ **DBClusterIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si l'instance de base de données est membre d'un cluster de bases de données, elle contient le nom du cluster de bases de données dont elle est membre.
+ **DBInstanceArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de l'instance de base de données.
+ **DBInstanceClass** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient le nom de la classe de capacité de calcul et de mémoire de l'instance de base de données.
+ **DBInstanceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un identifiant de base de données fourni par l'utilisateur. Ce dernier est la clé unique qui identifie une instance de base de données.
+ **DbInstancePort** : entier de type : `integer` (entier signé de 32 bits).

  Spécifie le port sur lequel l'instance de base de données écoute. Si l'instance de base de données fait partie d'un cluster de bases de données, le port peut être différent du port de cluster de bases de données.
+ **DBInstanceStatus** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique l'état actuel de cette base de données.
+ **DbiResourceId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant immuable et propre à chaque région Amazon pour l'instance de base de données. Cet identifiant se trouve dans les entrées du CloudTrail journal Amazon chaque fois que la clé Amazon KMS de l'instance de base de données est consultée.
+ **DBName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom de la base de données.
+ **DBParameterGroups** : tableau d'objets [DBParameterGroupStatus](api-parameters.md#DBParameterGroupStatus).

  Fournit la liste des groupes de paramètres de base de données appliqués à cette instance de base de données.
+ **DBSecurityGroups** : tableau d'objets [DBSecurityGroupMembership](api-datatypes.md#DBSecurityGroupMembership).

   Fournit la liste des éléments du Security Group DB contenant uniquement des sous-éléments `DBSecurityGroup.Name` et `DBSecurityGroup.Status`.
+ **DBSubnetGroup** : objet [DBSubnetGroupe](api-subnets.md#DBSubnetGroup).

  Spécifie des informations sur le groupe de sous-réseaux associé à l'instance de base de données, dont le nom, la description et les sous-réseaux du groupe de sous-réseaux.
+ **DeletionProtection**— Il s'agit d'une BooleanOptional valeur booléenne `boolean` (vraie ou fausse) du type : (valeur booléenne).

  Indique si la protection contre la suppression a été activée pour l'instance de base de données. L’instance ne peut pas être supprimée tant que la protection contre la suppression est activée. Consultez [Suppression d'une instance de base de données](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html).
+ **DomainMemberships** : tableau d'objets [DomainMembership](api-datatypes.md#DomainMembership).

  Non pris en charge
+ **EnabledCloudwatchLogsExports** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des types de journaux que cette instance de base de données est configurée pour exporter vers CloudWatch Logs.
+ **Endpoint** : objet [Point de terminaison](api-datatypes.md#Endpoint).

  Spécifie le point de terminaison de la connexion.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le nom du moteur de base de données à utiliser pour cette instance de base de données.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique la version du moteur de base de données.
+ **EnhancedMonitoringResourceArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Le nom de ressource Amazon (ARN) du flux de journal Amazon CloudWatch Logs qui reçoit les données de métriques de surveillance améliorée pour l'instance de base de données.
+ **IAMDatabaseAuthenticationEnabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur true si l'authentification Amazon Identity and Access Management (IAM) est activée, et false dans le cas contraire.
+ **InstanceCreateTime**— Il s'agit d'un TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Indique la date et l'heure de création de l'instance de base de données.
+ **Iops**— Il s'agit d'un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie la valeur des IOPS provisionnés (opérations d'E/S par seconde).
+ **KmsKeyId** : chaîne de type : `string` (chaîne encodée en UTF-8).

   Non pris en charge : Le chiffrement des instances de base de données est géré par le cluster de bases de données.
+ **LatestRestorableTime**— Il s'agit d'un TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure limite à laquelle une base de données peut être restaurée par point-in-time restauration.
+ **LicenseModel** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Informations sur le modèle de licence de cette instance de base de données.
+ **MonitoringInterval**— Il s'agit d'un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Intervalle, en secondes, entre les points lorsque des métriques de surveillance améliorée sont collectées pour l'instance de base de données.
+ **MonitoringRoleArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  L'ARN du rôle IAM qui permet à Neptune d'envoyer des métriques de surveillance améliorée à Amazon CloudWatch Logs.
+ **MultiAZ** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si l'instance de base de données est un déploiement multi-AZ.
+ **PendingModifiedValues** : objet [PendingModifiedValues](#PendingModifiedValues).

  Spécifie que les modifications apportées à l'instance de base de données sont en attente. Cet élément est inclus uniquement lorsque des modifications sont en attente. Des modifications spécifiques sont identifiées par sous-éléments.
+ **PreferredBackupWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

   Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété `BackupRetentionPeriod`.
+ **PreferredMaintenanceWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.
+ **PromotionTier**— Il s'agit d'un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Valeur qui spécifie l'ordre dans lequel un réplica en lecture est promu en instance principale après un échec de l'instance principale existante. 
+ **PubliclyAccessible** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Cet indicateur ne doit plus être utilisé.
+ **ReadReplicaDBClusterIdentifiers** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un ou plusieurs identifiants des clusters de bases de données qui sont des réplicas en lecture de cette instance de base de données.
+ **ReadReplicaDBInstanceIdentifiers** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un ou plusieurs identifiants des réplicas en lecture associés à cette instance de base de données.
+ **ReadReplicaSourceDBInstanceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient l'identifiant de l'instance de base de données source si cette dernière est un réplica en lecture.
+ **SecondaryAvailabilityZone** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si cette valeur est présente, spécifie le nom de la zone de disponibilité secondaire d'une instance de base de données avec prise en charge multi-AZ.
+ **StatusInfos** : tableau d'objets [DBInstanceStatusInfo](#DBInstanceStatusInfo).

  Statut d'un réplica en lecture. Si l'instance n'est pas un réplica en lecture, ce champ est vide.
+ **StorageEncrypted** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Non pris en charge : Le chiffrement des instances de base de données est géré par le cluster de bases de données.
+ **StorageType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le type de stockage associé à l’instance de base de données.
+ **TdeCredentialArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  ARN du magasin de clés associé à l'instance pour le chiffrement TDE.
+ **Timezone** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge.
+ **VpcSecurityGroups** : tableau d'objets [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

`DBInstance` est utilisé comme élément de réponse pour :
+ [Créez DBInstance](#CreateDBInstance)
+ [Supprimer DBInstance](#DeleteDBInstance)
+ [Modifier DBInstance](#ModifyDBInstance)
+ [Redémarrer DBInstance](#RebootDBInstance)

## DBInstanceStatusInfo (structure)
<a name="DBInstanceStatusInfo"></a>

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

**Champs**
+ **Message** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Détails de l'erreur en cas d'erreur de l'instance. Si l'instance n'est pas dans un état d'erreur, cette valeur est vide.
+ **Normal** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur booléenne true si l'instance fonctionne normalement, et false si l'instance est dans un état d'erreur.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Statut de l'instance de base de données. Pour une StatusType réplique en lecture, les valeurs peuvent être répliquées, erronées, arrêtées ou terminées.
+ **StatusType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Cette valeur est actuellement « read replication ».

## DBInstanceOption commandable (structure)
<a name="OrderableDBInstanceOption"></a>

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

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

**Champs**
+ **AvailabilityZones** : tableau d'objets [AvailabilityZone](api-datatypes.md#AvailabilityZone).

  Une liste des zones de disponibilité pour une instance de base de données.
+ **DBInstanceClass** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Classe d'instance de base de données d'une instance de base de données.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Type de moteur d'une instance de base de données.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Version du moteur d'une instance de base de données.
+ **LicenseModel** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Modèle de licence d'une instance de base de données.
+ **MaxIopsPerDbInstance**— Il s'agit d'un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Nombre total maximum des IOPS provisionnés pour une instance de base de données.
+ **MaxIopsPerGib**— Il s'agit d'un DoubleOptional, de type : `double` (un nombre à virgule flottante IEEE 754 à double précision).

  Nombre total maximum des IOPS provisionnés par Gio pour une instance de base de données.
+ **MaxStorageSize**— Il s'agit d'un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Taille de stockage maximum d'une instance de base de données.
+ **MinIopsPerDbInstance**— Il s'agit d'un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Nombre total minimum des IOPS provisionnés pour une instance de base de données.
+ **MinIopsPerGib**— Il s'agit d'un DoubleOptional, de type : `double` (un nombre à virgule flottante IEEE 754 à double précision).

  Nombre total minimum des IOPS provisionnés par Gio pour une instance de base de données.
+ **MinStorageSize**— Il s'agit d'un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Taille de stockage minimum d'une instance de base de données.
+ **MultiAZCapable** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si une instance de base de données peut gérer le mode Multi-AZ.
+ **ReadReplicaCapable** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si une instance de base de données peut disposer d'un réplica en lecture.
+ **StorageType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non applicable. Dans Neptune, le type de stockage est géré au niveau du cluster de bases de données.
+ **SupportsEnhancedMonitoring** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si une instance de base de données prend en charge la surveillance améliorée à des intervalles de 1 à 60 secondes.
+ **SupportsGlobalDatabases** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur qui indique si vous pouvez utiliser les bases de données globales Neptune avec une combinaison spécifique d'autres attributs du moteur de base de données.
+ **SupportsIAMDatabaseAuthentication** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si une instance de base de données prend en charge l'authentification de base de données IAM.
+ **SupportsIops** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si une instance de base de données prend en charge les IOPS provisionnés.
+ **SupportsStorageEncryption** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si une instance de base de données prend en charge le stockage chiffré.
+ **Vpc** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

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

## PendingModifiedValues (structure)
<a name="PendingModifiedValues"></a>

Ce type de données est utilisé comme élément de réponse dans l'action [Modifier DBInstance (action)](#ModifyDBInstance).

**Champs**
+ **AllocatedStorage**— Il s'agit d'un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

   Contient la nouvelle taille `AllocatedStorage` pour l'instance de base de données qui sera appliquée ou est actuellement appliquée.
+ **BackupRetentionPeriod**— Il s'agit d'un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie le nombre de jours en attente pour lesquels des sauvegardes automatiques sont conservées.
+ **CACertificateIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'identifiant du certificat CA pour l'instance de base de données.
+ **DBInstanceClass** : chaîne de type : `string` (chaîne encodée en UTF-8).

   Contient le nouveau paramètre `DBInstanceClass` pour l'instance de base de données qui sera appliqué ou est actuellement appliqué.
+ **DBInstanceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

   Contient le nouveau paramètre `DBInstanceIdentifier` pour l'instance de base de données qui sera appliqué ou est actuellement appliqué.
+ **DBSubnetGroupName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nouveau groupe de sous-réseaux de l'instance de base de données.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique la version du moteur de base de données.
+ **Iops**— Il s'agit d'un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie la nouvelle valeur d'IOPS provisionnés pour l'instance de base de données qui sera appliquée ou est actuellement appliquée.
+ **MultiAZ**— Il s'agit d'une BooleanOptional valeur booléenne `boolean` (vraie ou fausse) du type : (valeur booléenne).

  Indique que l'instance de base de données mono-AZ doit être remplacée par un déploiement multi-AZ.
+ **PendingCloudwatchLogsExports** : objet [PendingCloudwatchLogsExports](api-clusters.md#PendingCloudwatchLogsExports).

  Cette `PendingCloudwatchLogsExports` structure indique les modifications en attente concernant CloudWatch les journaux activés et ceux qui sont désactivés.
+ **Port**— Il s'agit d'un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie le port en attente pour l'instance de base de données.
+ **StorageType** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

## ValidStorageOptions (structure)
<a name="ValidStorageOptions"></a>

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

**Champs**
+ **IopsToStorageRatio** : tableau d'objets [DoubleRange](api-datatypes.md#DoubleRange).

  Non applicable. Dans Neptune, le type de stockage est géré au niveau du cluster de bases de données.
+ **ProvisionedIops** : tableau d'objets [Range](api-datatypes.md#Range).

  Non applicable. Dans Neptune, le type de stockage est géré au niveau du cluster de bases de données.
+ **StorageSize** : tableau d'objets [Range](api-datatypes.md#Range).

  Non applicable. Dans Neptune, le type de stockage est géré au niveau du cluster de bases de données.
+ **StorageType** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

## Valide DBInstance ModificationsMessage (structure)
<a name="ValidDBInstanceModificationsMessage"></a>

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

**Champs**
+ **Storage** : tableau d'objets [ValidStorageOptions](#ValidStorageOptions).

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

`ValidDBInstanceModificationsMessage` est utilisé comme élément de réponse pour :
+ [DescribeValidDBInstanceModifications](#DescribeValidDBInstanceModifications)

# API de paramètres Neptune
<a name="api-parameters"></a>

**Actions :**
+ [Copier DBParameter le groupe (action)](#CopyDBParameterGroup)
+ [Copier DBCluster ParameterGroup (action)](#CopyDBClusterParameterGroup)
+ [Créer un DBParameter groupe (action)](#CreateDBParameterGroup)
+ [Créer DBCluster ParameterGroup (action)](#CreateDBClusterParameterGroup)
+ [Supprimer le DBParameter groupe (action)](#DeleteDBParameterGroup)
+ [Supprimer DBCluster ParameterGroup (action)](#DeleteDBClusterParameterGroup)
+ [Modifier DBParameter le groupe (action)](#ModifyDBParameterGroup)
+ [Modifier DBCluster ParameterGroup (action)](#ModifyDBClusterParameterGroup)
+ [Réinitialiser DBParameter le groupe (action)](#ResetDBParameterGroup)
+ [Réinitialiser DBCluster ParameterGroup (action)](#ResetDBClusterParameterGroup)
+ [Décrire DBParameters (action)](#DescribeDBParameters)
+ [Décrire DBParameter les groupes (action)](#DescribeDBParameterGroups)
+ [Décrire DBCluster les paramètres (action)](#DescribeDBClusterParameters)
+ [Décrire DBCluster ParameterGroups (action)](#DescribeDBClusterParameterGroups)
+ [DescribeEngineDefaultParameters (action)](#DescribeEngineDefaultParameters)
+ [DescribeEngineDefaultClusterParameters (action)](#DescribeEngineDefaultClusterParameters)

**Structures :**
+ [Parameter (structure)](#Parameter)
+ [DBParameterGroupe (structure)](#DBParameterGroup)
+ [DBClusterParameterGroup (structure)](#DBClusterParameterGroup)
+ [DBParameterGroupStatus (structure)](#DBParameterGroupStatus)

## Copier DBParameter le groupe (action)
<a name="CopyDBParameterGroup"></a>

         Le nom de la AWS CLI pour 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)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing).

  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](api-other-apis.md#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 [Décrire DBParameter les groupes (action)](#DescribeDBParameterGroups).
+ **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**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [DBParameterGroupAlreadyExistsFault](api-faults.md#DBParameterGroupAlreadyExistsFault)
+ [DBParameterGroupQuotaExceededFault](api-faults.md#DBParameterGroupQuotaExceededFault)

## Copier DBCluster ParameterGroup (action)
<a name="CopyDBClusterParameterGroup"></a>

         Le nom de la AWS CLI pour 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)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing).

  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](api-other-apis.md#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 [Décrire DBCluster ParameterGroups (action)](#DescribeDBClusterParameterGroups).
+ **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 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 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**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [DBParameterGroupQuotaExceededFault](api-faults.md#DBParameterGroupQuotaExceededFault)
+ [DBParameterGroupAlreadyExistsFault](api-faults.md#DBParameterGroupAlreadyExistsFault)

## Créer un DBParameter groupe (action)
<a name="CreateDBParameterGroup"></a>

         Le nom de la AWS CLI pour 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 pour l'un des paramètres, vous devez modifier le groupe après l'avoir créé à l'aide de l'option *Modifier le DBParameter groupe*. Une fois que vous avez 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 *Modify DBInstance*. 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 *Groupes de paramètres* de la console Amazon Neptune ou la DBParameters commande *Describe* 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](api-other-apis.md#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 [Décrire DBParameter les groupes (action)](#DescribeDBParameterGroups).
+ **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**
+ [DBParameterGroupQuotaExceededFault](api-faults.md#DBParameterGroupQuotaExceededFault)
+ [DBParameterGroupAlreadyExistsFault](api-faults.md#DBParameterGroupAlreadyExistsFault)

## Créer DBCluster ParameterGroup (action)
<a name="CreateDBClusterParameterGroup"></a>

         Le nom de la AWS CLI pour 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 [Modifier DBCluster ParameterGroup (action)](#ModifyDBClusterParameterGroup). 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 [Modifier DBCluster (action)](api-clusters.md#ModifyDBCluster). 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](https://console.aws.amazon.com/rds/) ou de la commande [Décrire DBCluster les paramètres (action)](#DescribeDBClusterParameters) 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 existant DBClusterParameterGroup.
**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](api-other-apis.md#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 [Décrire DBCluster ParameterGroups (action)](#DescribeDBClusterParameterGroups).
+ **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 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 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**
+ [DBParameterGroupQuotaExceededFault](api-faults.md#DBParameterGroupQuotaExceededFault)
+ [DBParameterGroupAlreadyExistsFault](api-faults.md#DBParameterGroupAlreadyExistsFault)

## Supprimer le DBParameter groupe (action)
<a name="DeleteDBParameterGroup"></a>

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

Supprime un DBParameter groupe spécifié. Le DBParameter groupe à 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**
+ [Non valide DBParameter GroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)

## Supprimer DBCluster ParameterGroup (action)
<a name="DeleteDBClusterParameterGroup"></a>

         Le nom de la AWS CLI pour 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**
+ [Non valide DBParameter GroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)

## Modifier DBParameter le groupe (action)
<a name="ModifyDBParameterGroup"></a>

         Le nom de la AWS CLI pour 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 *Groupes de paramètres* de la console Amazon Neptune ou la DBParameters commande *Describe* 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 :
  + S'il est fourni, il doit correspondre au nom d'un DBParameter groupe existant.
+ **Parameters** (dans la CLI : `--parameters`) : *obligatoire :* tableau d'objets [Paramètre](#Parameter).

  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**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [Non valide DBParameter GroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)

## Modifier DBCluster ParameterGroup (action)
<a name="ModifyDBClusterParameterGroup"></a>

         Le nom de la AWS CLI pour 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 [Décrire DBCluster les paramètres (action)](#DescribeDBClusterParameters) 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](#Parameter).

  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**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)
+ [Non valide DBParameter GroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)

## Réinitialiser DBParameter le groupe (action)
<a name="ResetDBParameterGroup"></a>

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

Modifie les paramètres d'un groupe de paramètres de base de données à la valeur engine/system par défaut. 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 DBParameter groupe existant.
+ **Parameters** (dans la CLI : `--parameters`) : tableau d'objets [Paramètre](#Parameter).

  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**
+ [Non valide DBParameter GroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)

## Réinitialiser DBCluster ParameterGroup (action)
<a name="ResetDBClusterParameterGroup"></a>

         Le nom de la AWS CLI pour 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 [Redémarrer DBInstance (action)](api-instances.md#RebootDBInstance). Vous devez appeler [Redémarrer DBInstance (action)](api-instances.md#RebootDBInstance) 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](#Parameter).

  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**
+ [Non valide DBParameter GroupStateFault](api-faults.md#InvalidDBParameterGroupStateFault)
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)

## Décrire DBParameters (action)
<a name="DescribeDBParameters"></a>

         Le nom de la AWS CLI pour 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 :
  + S'il est fourni, il doit correspondre au nom d'un DBParameter groupe existant.
+ **Filters** (dans la CLI : `--filters`) : tableau d'objets [Filtre](api-datatypes.md#Filter).

  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`) — un IntegerOptional, de type : `integer` (un 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](#Parameter).

  Liste des valeurs [Parameter (structure)](#Parameter).

**Erreurs**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)

## Décrire DBParameter les groupes (action)
<a name="DescribeDBParameterGroups"></a>

         Le nom de la AWS CLI pour 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, il doit correspondre au nom d'un existant DBClusterParameterGroup.
+ **Filters** (dans la CLI : `--filters`) : tableau d'objets [Filtre](api-datatypes.md#Filter).

  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`) — un IntegerOptional, de type : `integer` (un 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 [DBParameterGroupe](#DBParameterGroup).

  Liste des instances [DBParameterGroupe (structure)](#DBParameterGroup).
+ **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**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)

## Décrire DBCluster les paramètres (action)
<a name="DescribeDBClusterParameters"></a>

         Le nom de la AWS CLI pour 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, il doit correspondre au nom d'un existant DBClusterParameterGroup.
+ **Filters** (dans la CLI : `--filters`) : tableau d'objets [Filtre](api-datatypes.md#Filter).

  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`) — un IntegerOptional, de type : `integer` (un 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).

   Un jeton de pagination facultatif fourni par une précédente demande de description DBCluster des paramètres. 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](#Parameter).

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

**Erreurs**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)

## Décrire DBCluster ParameterGroups (action)
<a name="DescribeDBClusterParameterGroups"></a>

         Le nom de la AWS CLI pour 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, il doit correspondre au nom d'un existant DBClusterParameterGroup.
+ **Filters** (dans la CLI : `--filters`) : tableau d'objets [Filtre](api-datatypes.md#Filter).

  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`) — un IntegerOptional, de type : `integer` (un 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](#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**
+ [DBParameterGroupNotFoundFault](api-faults.md#DBParameterGroupNotFoundFault)

## DescribeEngineDefaultParameters (action)
<a name="DescribeEngineDefaultParameters"></a>

         Le nom de la AWS CLI pour 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](api-datatypes.md#Filter).

  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`) — un IntegerOptional, de type : `integer` (un 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)](#DescribeEngineDefaultParameters).
+ **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).

   Un jeton de pagination facultatif fourni par une EngineDefaults 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](#Parameter).

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

## DescribeEngineDefaultClusterParameters (action)
<a name="DescribeEngineDefaultClusterParameters"></a>

         Le nom de la AWS CLI pour 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](api-datatypes.md#Filter).

  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`) — un IntegerOptional, de type : `integer` (un 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)](#DescribeEngineDefaultParameters).
+ **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).

   Un jeton de pagination facultatif fourni par une EngineDefaults 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](#Parameter).

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

## *Structures :*
<a name="api-parameters-structures-spacer"></a>

## Parameter (structure)
<a name="Parameter"></a>

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**— Il s'agit d'un ApplyMethod, de type : `string` (une chaîne codé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.

## DBParameterGroupe (structure)
<a name="DBParameterGroup"></a>

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 [Décrire DBParameter les groupes (action)](#DescribeDBParameterGroups).

**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 :
+ [DBParameterGroupe de copies](#CopyDBParameterGroup)
+ [Créer un DBParameter groupe](#CreateDBParameterGroup)

## DBClusterParameterGroup (structure)
<a name="DBClusterParameterGroup"></a>

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 [Décrire DBCluster ParameterGroups (action)](#DescribeDBClusterParameterGroups).

**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 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 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 :
+ [Copier DBCluster ParameterGroup](#CopyDBClusterParameterGroup)
+ [Créez DBCluster ParameterGroup](#CreateDBClusterParameterGroup)

## DBParameterGroupStatus (structure)
<a name="DBParameterGroupStatus"></a>

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 :
+ [Créer DBInstance (action)](api-instances.md#CreateDBInstance)
+ [Supprimer DBInstance (action)](api-instances.md#DeleteDBInstance)
+ [Modifier DBInstance (action)](api-instances.md#ModifyDBInstance)
+ [Redémarrer DBInstance (action)](api-instances.md#RebootDBInstance)

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

# API de sous-réseau Neptune
<a name="api-subnets"></a>

**Actions :**
+ [Créer un DBSubnet groupe (action)](#CreateDBSubnetGroup)
+ [Supprimer le DBSubnet groupe (action)](#DeleteDBSubnetGroup)
+ [Modifier DBSubnet le groupe (action)](#ModifyDBSubnetGroup)
+ [Décrire DBSubnet les groupes (action)](#DescribeDBSubnetGroups)

**Structures :**
+ [Subnet (structure)](#Subnet)
+ [DBSubnetGroupe (structure)](#DBSubnetGroup)

## Créer un DBSubnet groupe (action)
<a name="CreateDBSubnetGroup"></a>

         Le nom de la AWS CLI pour cette API est :`create-db-subnet-group`.

Crée un groupe de sous-réseaux de base de données. Les groupes de sous-réseaux de base de données doivent contenir au moins un sous-réseau sur au moins deux AZs dans la région Amazon.

**Demande**
+ **DBSubnetGroupDescription** (dans la CLI : `--db-subnet-group-description`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Description du groupe de sous-réseaux de base de données.
+ **DBSubnetGroupName** (dans la CLI : `--db-subnet-group-name`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom du groupe de sous-réseaux de base de données. Cette valeur est stockée sous la forme d'une chaîne en minuscules.

  Contraintes : doit comporter au maximum 255 lettres, chiffres, points, traits de soulignement, espaces ou tirets. Impossible de conserver le nom par défaut.

  Exemple : `mySubnetgroup`
+ **SubnetIds** (dans la CLI : `--subnet-ids`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

   EC2 Sous-réseau du groupe IDs de sous-réseaux de base de données.
+ **Tags** (dans la CLI : `--tags`) : tableau d'objets [Tag](api-other-apis.md#Tag).

  Balises à attribuer au nouveau groupe de sous-réseaux de base de données.

**Réponse**

Contient les détails d'un groupe de sous-réseaux de base de données Amazon Neptune.

Ce type de données est utilisé comme élément de réponse dans l'action [Décrire DBSubnet les groupes (action)](#DescribeDBSubnetGroups).
+ **DBSubnetGroupArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) du groupe de sous-réseaux de base de données.
+ **DBSubnetGroupDescription** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit la description du groupe de sous-réseaux de base de données.
+ **DBSubnetGroupName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Le nom du groupe de sous-réseaux DB.
+ **SubnetGroupStatus** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le statut du groupe de sous-réseaux de base de données.
+ **Subnets** : tableau d'objets [Sous-réseau](#Subnet).

   Contient une liste des éléments [Subnet (structure)](#Subnet).
+ **VpcId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le nom VpcId du groupe de sous-réseaux de base de données.

**Erreurs**
+ [DBSubnetGroupAlreadyExistsFault](api-faults.md#DBSubnetGroupAlreadyExistsFault)
+ [DBSubnetGroupQuotaExceededFault](api-faults.md#DBSubnetGroupQuotaExceededFault)
+ [DBSubnetQuotaExceededFault](api-faults.md#DBSubnetQuotaExceededFault)
+ [DBSubnetGroupDoesNotCoverEnoughAZs](api-faults.md#DBSubnetGroupDoesNotCoverEnoughAZs)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)

## Supprimer le DBSubnet groupe (action)
<a name="DeleteDBSubnetGroup"></a>

         Le nom de la AWS CLI pour cette API est :`delete-db-subnet-group`.

Supprime un groupe de sous-réseaux de base de données.

**Note**  
Le groupe de sous-réseaux de base de données spécifié ne doit pas être associé à des instances de base de données.

**Demande**
+ **DBSubnetGroupName** (dans la CLI : `--db-subnet-group-name`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom du groupe de sous-réseaux de base de données à supprimer.
**Note**  
Vous ne pouvez pas supprimer le groupe de sous-réseaux par défaut.

  Contraintes :

  Contraintes : Doit correspondre au nom d'un DBSubnet groupe existant. Impossible de conserver le nom par défaut.

  Exemple : `mySubnetgroup`

**Réponse**
+ *Paramètres d'absence de réponse.*

**Erreurs**
+ [Non valide DBSubnet GroupStateFault](api-faults.md#InvalidDBSubnetGroupStateFault)
+ [Non valide DBSubnet StateFault](api-faults.md#InvalidDBSubnetStateFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)

## Modifier DBSubnet le groupe (action)
<a name="ModifyDBSubnetGroup"></a>

         Le nom de la AWS CLI pour cette API est :`modify-db-subnet-group`.

Modifie un groupe de sous-réseaux de base de données existant. Les groupes de sous-réseaux de base de données doivent contenir au moins un sous-réseau sur au moins deux AZs dans la région Amazon.

**Demande**
+ **DBSubnetGroupDescription** (dans la CLI : `--db-subnet-group-description`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Description du groupe de sous-réseaux de base de données.
+ **DBSubnetGroupName** (dans la CLI : `--db-subnet-group-name`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom du groupe de sous-réseaux de base de données. Cette valeur est stockée sous la forme d'une chaîne en minuscules. Vous ne pouvez pas modifier le groupe de sous-réseaux par défaut.

  Contraintes : Doit correspondre au nom d'un DBSubnet groupe existant. Impossible de conserver le nom par défaut.

  Exemple : `mySubnetgroup`
+ **SubnetIds** (dans la CLI : `--subnet-ids`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Le EC2 sous-réseau du groupe IDs de sous-réseaux de base de données.

**Réponse**

Contient les détails d'un groupe de sous-réseaux de base de données Amazon Neptune.

Ce type de données est utilisé comme élément de réponse dans l'action [Décrire DBSubnet les groupes (action)](#DescribeDBSubnetGroups).
+ **DBSubnetGroupArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) du groupe de sous-réseaux de base de données.
+ **DBSubnetGroupDescription** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit la description du groupe de sous-réseaux de base de données.
+ **DBSubnetGroupName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Le nom du groupe de sous-réseaux DB.
+ **SubnetGroupStatus** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le statut du groupe de sous-réseaux de base de données.
+ **Subnets** : tableau d'objets [Sous-réseau](#Subnet).

   Contient une liste des éléments [Subnet (structure)](#Subnet).
+ **VpcId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le nom VpcId du groupe de sous-réseaux de base de données.

**Erreurs**
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
+ [DBSubnetQuotaExceededFault](api-faults.md#DBSubnetQuotaExceededFault)
+ [SubnetAlreadyInUse](api-faults.md#SubnetAlreadyInUse)
+ [DBSubnetGroupDoesNotCoverEnoughAZs](api-faults.md#DBSubnetGroupDoesNotCoverEnoughAZs)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)

## Décrire DBSubnet les groupes (action)
<a name="DescribeDBSubnetGroups"></a>

         Le nom de la AWS CLI pour cette API est :`describe-db-subnet-groups`.

Renvoie une liste de descriptions de DBSubnet groupes. Si a DBSubnet GroupName est spécifié, la liste contiendra uniquement les descriptions du DBSubnet groupe spécifié.

Pour obtenir une vue d'ensemble des plages d'adresses CIDR, consultez le [didacticiel Wikipedia](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).

**Demande**
+ **DBSubnetGroupName** (dans la CLI : `--db-subnet-group-name`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom du groupe de sous-réseaux de base de données pour lequel renvoyer les détails.
+ **Filters** (dans la CLI : `--filters`) : tableau d'objets [Filtre](api-datatypes.md#Filter).

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

   Un jeton de pagination facultatif fourni par une précédente demande Describe DBSubnet Groups. 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`) — un IntegerOptional, de type : `integer` (un 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**
+ **DBSubnetGroups** : tableau d'objets [DBSubnetGroupe](#DBSubnetGroup).

   Liste des instances [DBSubnetGroupe (structure)](#DBSubnetGroup).
+ **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**
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)

## *Structures :*
<a name="api-subnets-structures-spacer"></a>

## Subnet (structure)
<a name="Subnet"></a>

Spécifie un sous-réseau.

 Ce type de données est utilisé comme élément de réponse dans l'action [Décrire DBSubnet les groupes (action)](#DescribeDBSubnetGroups).

**Champs**
+ **SubnetAvailabilityZone** : objet [AvailabilityZone](api-datatypes.md#AvailabilityZone).

  Spécifie la zone de EC2 disponibilité dans laquelle se trouve le sous-réseau.
+ **SubnetIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'identifiant du sous-réseau.
+ **SubnetStatus** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le statut du sous-réseau.

## DBSubnetGroupe (structure)
<a name="DBSubnetGroup"></a>

Contient les détails d'un groupe de sous-réseaux de base de données Amazon Neptune.

Ce type de données est utilisé comme élément de réponse dans l'action [Décrire DBSubnet les groupes (action)](#DescribeDBSubnetGroups).

**Champs**
+ **DBSubnetGroupArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) du groupe de sous-réseaux de base de données.
+ **DBSubnetGroupDescription** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit la description du groupe de sous-réseaux de base de données.
+ **DBSubnetGroupName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Le nom du groupe de sous-réseaux DB.
+ **SubnetGroupStatus** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le statut du groupe de sous-réseaux de base de données.
+ **Subnets** : tableau d'objets [Sous-réseau](#Subnet).

   Contient une liste des éléments [Subnet (structure)](#Subnet).
+ **VpcId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le nom VpcId du groupe de sous-réseaux de base de données.

`DBSubnetGroup` est utilisé comme élément de réponse pour :
+ [Créer un DBSubnet groupe](#CreateDBSubnetGroup)
+ [Modifier le DBSubnet groupe](#ModifyDBSubnetGroup)

# API d'instantanés Neptune
<a name="api-snapshots"></a>

**Actions :**
+ [Créer DBCluster un instantané (action)](#CreateDBClusterSnapshot)
+ [Supprimer DBCluster un instantané (action)](#DeleteDBClusterSnapshot)
+ [Copier DBCluster un instantané (action)](#CopyDBClusterSnapshot)
+ [Modifier DBCluster SnapshotAttribute (action)](#ModifyDBClusterSnapshotAttribute)
+ [Restaurer DBCluster FromSnapshot (action)](#RestoreDBClusterFromSnapshot)
+ [Restaurer DBCluster ToPointInTime (action)](#RestoreDBClusterToPointInTime)
+ [Décrire les DBCluster instantanés (action)](#DescribeDBClusterSnapshots)
+ [Décrire DBCluster SnapshotAttributes (action)](#DescribeDBClusterSnapshotAttributes)

**Structures :**
+ [DBClusterInstantané (structure)](#DBClusterSnapshot)
+ [DBClusterSnapshotAttribute (structure)](#DBClusterSnapshotAttribute)
+ [DBClusterSnapshotAttributesResult (structure)](#DBClusterSnapshotAttributesResult)

## Créer DBCluster un instantané (action)
<a name="CreateDBClusterSnapshot"></a>

         Le nom de la AWS CLI pour cette API est :`create-db-cluster-snapshot`.

Crée un instantané d'un cluster de bases de données.

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

  Identifiant du cluster de bases de données pour lequel créer un instantané. Ce paramètre n'est pas sensible à la casse.

  Contraintes :
  + Doit correspondre à l'identifiant d'un existant DBCluster.

  Exemple : `my-cluster1`
+ **DBClusterSnapshotIdentifier** (dans la CLI : `--db-cluster-snapshot-identifier`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant de l'instantané de 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-snapshot1`
+ **Tags** (dans la CLI : `--tags`) : tableau d'objets [Tag](api-other-apis.md#Tag).

  Balises à attribuer à l'instantané de cluster de bases de données.

**Réponse**

Contient les détails d'un instantané 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 [Décrire les DBCluster instantanés (action)](#DescribeDBClusterSnapshots).
+ **AllocatedStorage** : entier de type : `integer` (entier signé de 32 bits).

  Spécifie la taille de stockage allouée en gigaoctets (Gio).
+ **AvailabilityZones** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit la liste des zones de EC2 disponibilité dans lesquelles les instances du snapshot du cluster de base de données peuvent être restaurées.
+ **ClusterCreateTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure à laquelle le cluster de bases de données a été créé, en heure UTC (Universal Coordinated Time).
+ **DBClusterIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'identifiant du cluster de bases de données à partir duquel cet instantané de cluster de bases de données a été créé.
+ **DBClusterSnapshotArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de l'instantané de cluster de bases de données.
+ **DBClusterSnapshotIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'identifiant d'un instantané de cluster de bases de données. Doit correspondre à l'identifiant d'un instantané existant.

  Après avoir restauré un cluster de bases de données à l'aide d'un `DBClusterSnapshotIdentifier`, vous devez spécifier le même `DBClusterSnapshotIdentifier` pour toute mise à jour ultérieure de ce cluster. Lorsque vous spécifiez cette propriété pour une mise à jour, le cluster de bases de données n'est pas restauré de nouveau à partir de l'instantané, et les données de la base de données ne sont pas modifiées.

  Toutefois, si vous ne spécifiez pas le `DBClusterSnapshotIdentifier`, un cluster de bases de données vide est créé et le cluster de bases de données d'origine est supprimé. Si vous spécifiez une propriété différente de la propriété précédente de restauration d'instantané, le cluster de bases de données est restauré à partir de l'instantané spécifié par le `DBClusterSnapshotIdentifier`, et le cluster de bases de données d'origine est supprimé.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le nom du moteur de base de données.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit la version du moteur de base de données à utiliser pour cet instantané de cluster de bases de données.
+ **IAMDatabaseAuthenticationEnabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur true (vrai) si le mappage des comptes Amazon Identity and Access Management (IAM) aux comptes de base de données est activé ; sinon, valeur false (faux).
+ **KmsKeyId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si `StorageEncrypted` a la valeur true (vrai), il s'agit de l'identifiant de clé Amazon KMS pour le cluster de bases de données chiffré.
+ **LicenseModel** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit les informations sur le modèle de licence pour cet instantané de cluster de bases de données.
+ **PercentProgress** : entier de type : `integer` (entier signé de 32 bits).

  Spécifie une estimation du pourcentage de données transférées.
+ **Port** : entier de type : `integer` (entier signé de 32 bits).

  Spécifie le port écouté par le cluster de bases de données au moment de l'instantané.
+ **SnapshotCreateTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure à laquelle l'instantané a été pris, au format UTC (temps universel).
+ **SnapshotType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le type de l'instantané de cluster de bases de données.
+ **SourceDBClusterSnapshotArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si l'instantané de cluster de bases de données a été copié à partir d'un instantané de cluster de bases de données source, l'Amazon Resource Name (ARN) de l'instantané de cluster de bases de données source, une valeur null dans le cas contraire.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le statut de cet instantané de cluster de bases de données.
+ **StorageEncrypted** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si l'instantané de cluster de bases de données est chiffré.
+ **StorageType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Type de stockage associé à l’instantané de cluster de bases de données.
+ **VpcId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit l'ID de VPC associé à l'instantané de cluster de bases de données.

**Erreurs**
+ [DBClusterSnapshotAlreadyExistsFault](api-faults.md#DBClusterSnapshotAlreadyExistsFault)
+ [Non valide DBCluster StateFault](api-faults.md#InvalidDBClusterStateFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [SnapshotQuotaExceededFault](api-faults.md#SnapshotQuotaExceededFault)
+ [Non valide DBCluster SnapshotStateFault](api-faults.md#InvalidDBClusterSnapshotStateFault)

## Supprimer DBCluster un instantané (action)
<a name="DeleteDBClusterSnapshot"></a>

         Le nom de la AWS CLI pour cette API est :`delete-db-cluster-snapshot`.

Supprime un instantané de cluster de bases de données. Si l'instantané est en cours de copie, l'opération est arrêtée.

**Note**  
L'instantané de cluster de bases de données doit être dans l'état `available` pour être supprimé.

**Demande**
+ **DBClusterSnapshotIdentifier** (dans la CLI : `--db-cluster-snapshot-identifier`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant de l'instantané de cluster de bases de données à supprimer.

  Contraintes : doit être le nom d'un instantané de cluster de bases de données existant dans l'état `available`.

**Réponse**

Contient les détails d'un instantané 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 [Décrire les DBCluster instantanés (action)](#DescribeDBClusterSnapshots).
+ **AllocatedStorage** : entier de type : `integer` (entier signé de 32 bits).

  Spécifie la taille de stockage allouée en gigaoctets (Gio).
+ **AvailabilityZones** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit la liste des zones de EC2 disponibilité dans lesquelles les instances du snapshot du cluster de base de données peuvent être restaurées.
+ **ClusterCreateTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure à laquelle le cluster de bases de données a été créé, en heure UTC (Universal Coordinated Time).
+ **DBClusterIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'identifiant du cluster de bases de données à partir duquel cet instantané de cluster de bases de données a été créé.
+ **DBClusterSnapshotArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de l'instantané de cluster de bases de données.
+ **DBClusterSnapshotIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'identifiant d'un instantané de cluster de bases de données. Doit correspondre à l'identifiant d'un instantané existant.

  Après avoir restauré un cluster de bases de données à l'aide d'un `DBClusterSnapshotIdentifier`, vous devez spécifier le même `DBClusterSnapshotIdentifier` pour toute mise à jour ultérieure de ce cluster. Lorsque vous spécifiez cette propriété pour une mise à jour, le cluster de bases de données n'est pas restauré de nouveau à partir de l'instantané, et les données de la base de données ne sont pas modifiées.

  Toutefois, si vous ne spécifiez pas le `DBClusterSnapshotIdentifier`, un cluster de bases de données vide est créé et le cluster de bases de données d'origine est supprimé. Si vous spécifiez une propriété différente de la propriété précédente de restauration d'instantané, le cluster de bases de données est restauré à partir de l'instantané spécifié par le `DBClusterSnapshotIdentifier`, et le cluster de bases de données d'origine est supprimé.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le nom du moteur de base de données.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit la version du moteur de base de données à utiliser pour cet instantané de cluster de bases de données.
+ **IAMDatabaseAuthenticationEnabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur true (vrai) si le mappage des comptes Amazon Identity and Access Management (IAM) aux comptes de base de données est activé ; sinon, valeur false (faux).
+ **KmsKeyId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si `StorageEncrypted` a la valeur true (vrai), il s'agit de l'identifiant de clé Amazon KMS pour le cluster de bases de données chiffré.
+ **LicenseModel** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit les informations sur le modèle de licence pour cet instantané de cluster de bases de données.
+ **PercentProgress** : entier de type : `integer` (entier signé de 32 bits).

  Spécifie une estimation du pourcentage de données transférées.
+ **Port** : entier de type : `integer` (entier signé de 32 bits).

  Spécifie le port écouté par le cluster de bases de données au moment de l'instantané.
+ **SnapshotCreateTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure à laquelle l'instantané a été pris, au format UTC (temps universel).
+ **SnapshotType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le type de l'instantané de cluster de bases de données.
+ **SourceDBClusterSnapshotArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si l'instantané de cluster de bases de données a été copié à partir d'un instantané de cluster de bases de données source, l'Amazon Resource Name (ARN) de l'instantané de cluster de bases de données source, une valeur null dans le cas contraire.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le statut de cet instantané de cluster de bases de données.
+ **StorageEncrypted** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si l'instantané de cluster de bases de données est chiffré.
+ **StorageType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Type de stockage associé à l’instantané de cluster de bases de données.
+ **VpcId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit l'ID de VPC associé à l'instantané de cluster de bases de données.

**Erreurs**
+ [Non valide DBCluster SnapshotStateFault](api-faults.md#InvalidDBClusterSnapshotStateFault)
+ [DBClusterSnapshotNotFoundFault](api-faults.md#DBClusterSnapshotNotFoundFault)

## Copier DBCluster un instantané (action)
<a name="CopyDBClusterSnapshot"></a>

         Le nom de la AWS CLI pour cette API est :`copy-db-cluster-snapshot`.

Copie un instantané d'un cluster de bases de données.

Pour copier un instantané de cluster de bases de données à partir d'un instantané de cluster de bases de données manuel partagé, `SourceDBClusterSnapshotIdentifier` doit être l'ARN (Amazon Resource Name) de l'instantané de cluster de bases de données partagé.

**Demande**
+ **CopyTags**(dans la CLI :`--copy-tags`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  La valeur est true pour copier toutes les balises de l'instantané de cluster de bases de données source vers l'instantané de cluster de bases de données cible, et false dans le cas contraire. La valeur par défaut est false.
+ **KmsKeyId** (dans la CLI : `--kms-key-id`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  ID de clé Amazon KMS pour un instantané de cluster de bases de données chiffré. L'ID de clé KMS est l'Amazon Resource Name (ARN), l'identifiant de clé KMS ou l'alias de clé KMS pour la clé de chiffrement KMS.

  Si vous copiez un instantané de cluster de bases de données chiffré à partir de votre compte Amazon, vous pouvez spécifier une valeur pour `KmsKeyId` afin de chiffrer la copie avec une nouvelle clé de chiffrement KMS. Si vous ne spécifiez pas de valeur pour `KmsKeyId`, la copie de l'instantané de cluster de bases de données est chiffrée avec la même clé KMS que l'instantané de cluster de bases de données source.

  Si vous copiez un instantané de cluster de bases de données chiffré partagé à partir d'un autre compte Amazon, vous devez spécifier une valeur pour `KmsKeyId`.

   Les clés de chiffrement KMS sont spécifiques à la région Amazon dans laquelle elles sont créées, et vous ne pouvez pas utiliser de clés de chiffrement issues d'une région Amazon dans une autre région Amazon.

  Vous ne pouvez pas chiffrer un instantané de cluster de bases de données non chiffré lorsque vous le copiez. Si vous essayez de copier un instantané de cluster de base de données non chiffré et que vous spécifiez une valeur pour le KmsKeyId paramètre, une erreur est renvoyée.
+ **PreSignedUrl** (dans la CLI : `--pre-signed-url`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Cette option n'est pas prise en charge actuellement.
+ **SourceDBClusterSnapshotIdentifier** (dans la CLI : `--source-db-cluster-snapshot-identifier`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant de l'instantané de cluster de bases de données à copier. Ce paramètre n'est pas sensible à la casse.

  Contraintes :
  + Vous devez spécifier un instantané système valide dans l'état « available ».
  + Spécifiez un identifiant de l'instantané de base de données valide.

  Exemple : `my-cluster-snapshot1`
+ **Tags** (dans la CLI : `--tags`) : tableau d'objets [Tag](api-other-apis.md#Tag).

  Balises à attribuer à la nouvelle copie de l'instantané de cluster de bases de données.
+ **TargetDBClusterSnapshotIdentifier** (dans la CLI : `--target-db-cluster-snapshot-identifier`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant du nouvel instantané de cluster de bases de données à créer à partir de l'instantané de cluster de bases de données source. Ce paramètre n'est pas sensible à la casse.

  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-cluster-snapshot2`

**Réponse**

Contient les détails d'un instantané 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 [Décrire les DBCluster instantanés (action)](#DescribeDBClusterSnapshots).
+ **AllocatedStorage** : entier de type : `integer` (entier signé de 32 bits).

  Spécifie la taille de stockage allouée en gigaoctets (Gio).
+ **AvailabilityZones** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit la liste des zones de EC2 disponibilité dans lesquelles les instances du snapshot du cluster de base de données peuvent être restaurées.
+ **ClusterCreateTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure à laquelle le cluster de bases de données a été créé, en heure UTC (Universal Coordinated Time).
+ **DBClusterIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'identifiant du cluster de bases de données à partir duquel cet instantané de cluster de bases de données a été créé.
+ **DBClusterSnapshotArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de l'instantané de cluster de bases de données.
+ **DBClusterSnapshotIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'identifiant d'un instantané de cluster de bases de données. Doit correspondre à l'identifiant d'un instantané existant.

  Après avoir restauré un cluster de bases de données à l'aide d'un `DBClusterSnapshotIdentifier`, vous devez spécifier le même `DBClusterSnapshotIdentifier` pour toute mise à jour ultérieure de ce cluster. Lorsque vous spécifiez cette propriété pour une mise à jour, le cluster de bases de données n'est pas restauré de nouveau à partir de l'instantané, et les données de la base de données ne sont pas modifiées.

  Toutefois, si vous ne spécifiez pas le `DBClusterSnapshotIdentifier`, un cluster de bases de données vide est créé et le cluster de bases de données d'origine est supprimé. Si vous spécifiez une propriété différente de la propriété précédente de restauration d'instantané, le cluster de bases de données est restauré à partir de l'instantané spécifié par le `DBClusterSnapshotIdentifier`, et le cluster de bases de données d'origine est supprimé.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le nom du moteur de base de données.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit la version du moteur de base de données à utiliser pour cet instantané de cluster de bases de données.
+ **IAMDatabaseAuthenticationEnabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur true (vrai) si le mappage des comptes Amazon Identity and Access Management (IAM) aux comptes de base de données est activé ; sinon, valeur false (faux).
+ **KmsKeyId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si `StorageEncrypted` a la valeur true (vrai), il s'agit de l'identifiant de clé Amazon KMS pour le cluster de bases de données chiffré.
+ **LicenseModel** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit les informations sur le modèle de licence pour cet instantané de cluster de bases de données.
+ **PercentProgress** : entier de type : `integer` (entier signé de 32 bits).

  Spécifie une estimation du pourcentage de données transférées.
+ **Port** : entier de type : `integer` (entier signé de 32 bits).

  Spécifie le port écouté par le cluster de bases de données au moment de l'instantané.
+ **SnapshotCreateTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure à laquelle l'instantané a été pris, au format UTC (temps universel).
+ **SnapshotType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le type de l'instantané de cluster de bases de données.
+ **SourceDBClusterSnapshotArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si l'instantané de cluster de bases de données a été copié à partir d'un instantané de cluster de bases de données source, l'Amazon Resource Name (ARN) de l'instantané de cluster de bases de données source, une valeur null dans le cas contraire.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le statut de cet instantané de cluster de bases de données.
+ **StorageEncrypted** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si l'instantané de cluster de bases de données est chiffré.
+ **StorageType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Type de stockage associé à l’instantané de cluster de bases de données.
+ **VpcId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit l'ID de VPC associé à l'instantané de cluster de bases de données.

**Erreurs**
+ [DBClusterSnapshotAlreadyExistsFault](api-faults.md#DBClusterSnapshotAlreadyExistsFault)
+ [DBClusterSnapshotNotFoundFault](api-faults.md#DBClusterSnapshotNotFoundFault)
+ [Non valide DBCluster StateFault](api-faults.md#InvalidDBClusterStateFault)
+ [Non valide DBCluster SnapshotStateFault](api-faults.md#InvalidDBClusterSnapshotStateFault)
+ [SnapshotQuotaExceededFault](api-faults.md#SnapshotQuotaExceededFault)
+ [KMSKeyNotAccessibleFault](api-faults.md#KMSKeyNotAccessibleFault)

## Modifier DBCluster SnapshotAttribute (action)
<a name="ModifyDBClusterSnapshotAttribute"></a>

         Le nom de la AWS CLI pour cette API est :`modify-db-cluster-snapshot-attribute`.

Ajoute un attribut et des valeurs à un instantané de cluster de bases de données manuel, ou en supprime.

Pour partager un instantané de cluster de base de données manuel avec d'autres comptes Amazon, spécifiez `restore` comme `ValuesToAdd` paramètre `AttributeName` et utilisez le paramètre pour ajouter une liste IDs des comptes Amazon autorisés à restaurer l'instantané de cluster de base de données manuel. Utilisez la valeur `all` pour rendre l'instantané de cluster de bases de données manuel public, ce qui signifie qu'il pourra être copié ou restauré par tous les comptes Amazon. N'ajoutez pas la valeur `all` pour tous les instantanés de cluster de bases de données manuels contenant des informations privées que vous ne souhaitez pas mettre à la disposition de tous les comptes Amazon. Si un instantané de cluster de base de données manuel est chiffré, il peut être partagé, mais uniquement en spécifiant une liste de comptes Amazon autorisés IDs pour le `ValuesToAdd` paramètre. Dans ce cas, vous ne pouvez pas utiliser `all` comme une valeur pour ce paramètre.

Pour afficher les comptes Amazon autorisés à copier ou restaurer un instantané de cluster de bases de données manuel, ou pour voir si un instantané de cluster de bases de données manuel est public ou privé, utilisez l'action d'API [Décrire DBCluster SnapshotAttributes (action)](#DescribeDBClusterSnapshotAttributes).

**Demande**
+ **AttributeName** (dans la CLI : `--attribute-name`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom de l'attribut d'instantané de cluster de bases de données à modifier.

  Pour gérer l'autorisation des autres comptes Amazon à copier ou restaurer un instantané de cluster de bases de données manuel, définissez cette valeur sur `restore`.
+ **DBClusterSnapshotIdentifier** (dans la CLI : `--db-cluster-snapshot-identifier`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant de l'instantané de cluster de bases de données pour lequel modifier les attributs.
+ **ValuesToAdd** (dans la CLI : `--values-to-add`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des attributs d'instantané de cluster de bases de données à ajouter à l'attribut spécifié par `AttributeName`.

  Pour autoriser d'autres comptes Amazon à copier ou à restaurer un instantané de cluster de base de données manuel, configurez cette liste pour inclure un ou plusieurs comptes Amazon IDs, ou `all` pour que l'instantané de cluster de base de données manuel puisse être restauré par n'importe quel compte Amazon. N'ajoutez pas la valeur `all` pour tous les instantanés de cluster de bases de données manuels contenant des informations privées que vous ne souhaitez pas mettre à la disposition de tous les comptes Amazon.
+ **ValuesToRemove** (dans la CLI : `--values-to-remove`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des attributs d'instantané de cluster de bases de données à supprimer de l'attribut spécifié par `AttributeName`.

  Pour supprimer l'autorisation d'autres comptes Amazon à copier ou restaurer un instantané de cluster de bases de données manuel, définissez cette liste afin d'inclure un ou plusieurs identifiants de compte Amazon, ou définissez `all` pour interdire à tous les comptes Amazon de copier ou restaurer l'instantané de cluster de bases de données. Si vous spécifiez `all`, un compte Amazon dont l'ID de compte est explicitement ajouté à l'attribut `restore` peut toujours copier ou restaurer un instantané de cluster de bases de données manuel.

**Réponse**

Contient les résultats d'appel réussi à l'action d'API [Décrire DBCluster SnapshotAttributes (action)](#DescribeDBClusterSnapshotAttributes).

Les attributs d'instantané de cluster de bases de données manuel sont utilisés pour autoriser d'autres comptes Amazon à copier ou restaurer un instantané de cluster de bases de données manuel. Pour plus d'informations, consultez l'action d'API [Modifier DBCluster SnapshotAttribute (action)](#ModifyDBClusterSnapshotAttribute).
+ **DBClusterSnapshotAttributes** : tableau d'objets [DBClusterSnapshotAttribute](#DBClusterSnapshotAttribute).

  Liste des attributs et des valeurs de l'instantané de cluster de bases de données manuel.
+ **DBClusterSnapshotIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant de l'instantané de cluster de bases de données manuel sur lequel s'appliquent les attributs.

**Erreurs**
+ [DBClusterSnapshotNotFoundFault](api-faults.md#DBClusterSnapshotNotFoundFault)
+ [Non valide DBCluster SnapshotStateFault](api-faults.md#InvalidDBClusterSnapshotStateFault)
+ [SharedSnapshotQuotaExceededFault](api-faults.md#SharedSnapshotQuotaExceededFault)

## Restaurer DBCluster FromSnapshot (action)
<a name="RestoreDBClusterFromSnapshot"></a>

         Le nom de la AWS CLI pour cette API est :`restore-db-cluster-from-snapshot`.

Crée un nouveau cluster de bases de données à partir d'un instantané de base de données ou d'un instantané de cluster de bases de données.

Si un instantané de base de données est spécifié, le cluster de bases de données cible est créé à partir de l'instantané de base de données source avec une configuration par défaut et un groupe de sécurité par défaut.

Si un instantané de cluster de bases de données est spécifié, le cluster de bases de données cible est créé à partir du point de restauration du cluster de bases de données source avec la même configuration que le cluster de bases de données source original, sauf que le nouveau cluster de bases de données est créé avec le groupe de sécurité par défaut.

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

  Fournit la liste des zones de EC2 disponibilité dans lesquelles les instances du cluster de base de données restauré peuvent être créées.
+ **CopyTagsToSnapshot**(dans la CLI :`--copy-tags-to-snapshot`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  *Si cette valeur est `true`, les balises sont copiées dans n'importe quel instantané du cluster de bases de données restauré qui est créé.*
+ **DatabaseName** (dans la CLI : `--database-name`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge.
+ **DBClusterIdentifier** (dans la CLI : `--db-cluster-identifier`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom du cluster de bases de données à créer à partir de l'instantané de base de données ou de l'instantané de cluster de bases de données. Ce paramètre n'est pas sensible à la casse.

  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-snapshot-id`
+ **DBClusterParameterGroupName** (dans la CLI : `--db-cluster-parameter-group-name`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom du groupe de paramètres de cluster de base de données à associer au nouveau cluster de base de données.

  Contraintes :
  + S'il est fourni, il doit correspondre au nom d'un existant DBClusterParameterGroup.
+ **DBSubnetGroupName** (dans la CLI : `--db-subnet-group-name`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom du groupe de sous-réseaux de base de données à utiliser pour le nouveau cluster de bases de données.

  Contraintes : s'il est indiqué, il doit correspondre au nom d'un DBSubnet groupe existant.

  Exemple : `mySubnetgroup`
+ **DeletionProtection**(dans la CLI :`--deletion-protection`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Valeur qui indique si la protection contre la suppression est activée pour le cluster de bases de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée. Par défaut, la protection contre la suppression est désactivée. 
+ **EnableCloudwatchLogsExports** (dans la CLI : `--enable-cloudwatch-logs-exports`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des journaux que le cluster de base de données restauré doit exporter vers Amazon CloudWatch Logs.
+ **EnableIAMDatabaseAuthentication**(dans la CLI :`--enable-iam-database-authentication`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

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

  Par défaut : `false`
+ **Engine** (dans la CLI : `--engine`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Moteur de base de données à utiliser pour le nouveau cluster de base de données.

  Par défaut : identique à la source

  Contrainte : doit être compatible avec le moteur de la source
+ **EngineVersion** (dans la CLI : `--engine-version`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Version du moteur de base de données à utiliser pour le nouveau cluster de bases de données.
+ **KmsKeyId** (dans la CLI : `--kms-key-id`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant de clé Amazon KMS à utiliser lors de la restauration d'un cluster de bases de données chiffré à partir d'un instantané de base de données ou d'un instantané de cluster de bases de données.

  L'identifiant de clé KMS est l'Amazon Resource Name (ARN) de la clé de chiffrement KMS. Si vous restaurez 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 vous ne spécifiez pas de valeur pour le paramètre `KmsKeyId` :
  + Si l'instantané de base de données ou l'instantané de cluster de bases de données dans `SnapshotIdentifier` est chiffré, le cluster de bases de données restauré est chiffré à l'aide de la clé KMS utilisée pour chiffrer l'instantané de base de données ou l'instantané de cluster de bases de données.
  + Si l'instantané de base de données ou l'instantané de cluster de bases de données dans `SnapshotIdentifier` n'est pas chiffré, le cluster de base de données restauré n'est pas chiffré.
+ **Port**(dans la CLI :`--port`) — un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Le numéro de port sur lequel le nouveau cluster de bases de données accepte des connexions.

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

  Valeur par défaut : port du cluster de bases de données d'origine.
+ **ServerlessV2ScalingConfiguration** (dans la CLI : `--serverless-v2-scaling-configuration`) : objet [Serverless V2 ScalingConfiguration](api-datatypes.md#ServerlessV2ScalingConfiguration).

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

  Pour plus d'informations, consultez [Utilisation d'Amazon Neptune sans serveur](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) dans le *Guide de l'utilisateur Amazon Neptune*.
+ **SnapshotIdentifier** (dans la CLI : `--snapshot-identifier`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant de l'instantané de base de données ou de l'instantané de cluster de bases de données à partir duquel restaurer.

  Vous pouvez utiliser le nom ou l'Amazon Resource Name (ARN) pour spécifier un instantané de cluster de bases de données. Cependant, vous pouvez utiliser uniquement l'ARN pour spécifier un instantané de base de données.

  Contraintes :
  + Doit correspondre à l'identifiant d'un instantané existant.
+ **StorageType** (dans la CLI : `--storage-type`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le type de stockage à associer au cluster de base de données.

  Valeurs valides : `standard`, `iopt1`

  Par défaut : `standard`
+ **Tags** (dans la CLI : `--tags`) : tableau d'objets [Tag](api-other-apis.md#Tag).

  Balises à attribuer au cluster de bases de données restauré.
+ **VpcSecurityGroupIds** (dans la CLI : `--vpc-security-group-ids`) : chaîne de type : `string` (chaîne encodée en UTF-8).

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

**Réponse**

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

Ce type de données est utilisé comme élément de réponse dans [Décrire DBClusters (action)](api-clusters.md#DescribeDBClusters).
+ **AllocatedStorage**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  `AllocatedStorage` renvoie toujours la valeur 1, car la taille de stockage d'un cluster de bases de données Neptune n'est pas fixe ; elle s'ajuste automatiquement en fonction des besoins.
+ **AssociatedRoles** : tableau d'objets [DBClusterRôle](api-clusters.md#DBClusterRole).

  Fournit la liste des rôles Amazon Identity and Access Management (IAM) associés au cluster de bases de données. Les rôles IAM associés à un cluster de bases de données autorisent celui-ci à accéder aux autres services Amazon en votre nom.
+ **AutomaticRestartTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Heure à laquelle le cluster de bases de données sera automatiquement redémarré.
+ **AvailabilityZones** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit la liste des zones de EC2 disponibilité dans lesquelles les instances du cluster de base de données peuvent être créées.
+ **BacktrackConsumedChangeRecords**— a LongOptional, de type : `long` (un entier signé de 64 bits).

  Non pris en charge par Neptune.
+ **BacktrackWindow**— a LongOptional, de type : `long` (un entier signé de 64 bits).

  Non pris en charge par Neptune.
+ **BackupRetentionPeriod**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie le nombre de jours de conservation des instantanés de base de données automatiques.
+ **Capacity**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Non pris en charge par Neptune.
+ **CloneGroupId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifie le groupe de clones auquel est associé le cluster de bases de données.
+ **ClusterCreateTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure à laquelle le cluster de bases de données a été créé, en heure UTC (Universal Coordinated Time).
+ **CopyTagsToSnapshot**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  *Si cette valeur est définie sur `true`, les balises sont copiées dans n'importe quel instantané du cluster de bases de données créé.*
+ **CrossAccountClone**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Si cette valeur est définie sur `true`, le cluster de bases de données peut être cloné sur plusieurs comptes.
+ **DatabaseName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient le nom de la base de données initiale de ce cluster de bases de données qui a été fourni au moment de la création, dans la mesure où un nom a été spécifié au moment de créer le cluster de bases de données. Ce même nom est renvoyé pendant la durée de vie du cluster de bases de données.
+ **DBClusterArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) du cluster de bases de données.
+ **DBClusterIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un identifiant de cluster de bases de données fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie un cluster de bases de données.
+ **DBClusterMembers** : tableau d'objets [DBClusterMembre](api-clusters.md#DBClusterMember).

  Fournit la liste des instances qui composent le cluster de bases de données.
+ **DBClusterParameterGroup** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le nom du groupe de paramètres de cluster de base de données pour le cluster de base de données.
+ **DbClusterResourceId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant immuable et propre à la région Amazon du cluster de bases de données. Cet identifiant se trouve dans les entrées du CloudTrail journal Amazon chaque fois que la clé Amazon KMS du cluster de base de données est consultée.
+ **DBSubnetGroup** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie les informations sur le groupe de sous-réseaux associé au cluster de bases de données, notamment le nom, la description et les sous-réseaux du groupe de sous-réseaux.
+ **DeletionProtection**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Indique si la protection contre la suppression est activée pour le cluster de bases de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée.
+ **EarliestBacktrackTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Non pris en charge par Neptune.
+ **EarliestRestorableTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie la première heure à laquelle une base de données peut être restaurée par point-in-time restauration.
+ **EnabledCloudwatchLogsExports** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des types de journaux que ce cluster de base de données est configuré pour exporter vers CloudWatch Logs. Les types de journaux valides sont les suivants : `audit` (pour publier les journaux d'audit CloudWatch) et slowquery (pour publier les journaux de requêtes lentes). CloudWatch Consultez la section [Publication des journaux Neptune sur Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).
+ **Endpoint** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le point de terminaison de connexion pour l'instance principale du cluster de bases de données.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le nom du moteur de base de données à utiliser pour ce cluster de bases de données.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique la version du moteur de base de données.
+ **GlobalClusterIdentifier**— a GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.
+ **HostedZoneId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'ID attribué par Amazon Route 53 lorsque vous créez une zone hébergée.
+ **IAMDatabaseAuthenticationEnabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur true (vrai) si le mappage des comptes Amazon Identity and Access Management (IAM) aux comptes de base de données est activé ; sinon, valeur false (faux).
+ **IOOptimizedNextAllowedModificationTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  La prochaine fois, vous pourrez modifier le cluster de bases de données de façon à utiliser le type de stockage `iopt1`.
+ **KmsKeyId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si `StorageEncrypted` a la valeur true (vrai), identifiant de clé Amazon KMS pour le cluster de bases de données chiffré.
+ **LatestRestorableTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure limite à laquelle une base de données peut être restaurée par point-in-time restauration.
+ **MultiAZ** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si le cluster de bases de données possède des instances dans plusieurs zones de disponibilité.
+ **PendingModifiedValues** : objet [ClusterPendingModifiedValues](api-clusters.md#ClusterPendingModifiedValues).

  Ce type de données est utilisé comme élément de réponse dans l'opération `ModifyDBCluster` et contient les modifications qui seront appliquées lors de la fenêtre de maintenance suivante.
+ **PercentProgress** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie la progression de l'opération sous forme de pourcentage.
+ **Port**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie le port sur lequel le moteur de base de données est à l'écoute.
+ **PreferredBackupWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété `BackupRetentionPeriod`.
+ **PreferredMaintenanceWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.
+ **ReaderEndpoint** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Si un basculement se produit et que le réplica en lecture auquel vous êtes connecté est promu en instance principale, votre connexion est supprimée. Pour continuer à envoyer votre charge de travail de lecture à d'autres réplicas en lecture du cluster, vous pouvez alors vous reconnecter au point de terminaison du lecteur.
+ **ReadReplicaIdentifiers** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un ou plusieurs identifiants des réplicas en lecture associés à ce cluster de bases de données.
+ **ReplicationSourceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge par Neptune.
+ **ReplicationType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge par Neptune.
+ **ServerlessV2ScalingConfiguration** : objet [Serverless V2 ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo).

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

  Pour plus d'informations, consultez [Utilisation d'Amazon Neptune sans serveur](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) dans le *Guide de l'utilisateur Amazon Neptune*.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'état actuel de ce cluster de base de données.
+ **StorageEncrypted** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si le cluster de base de données est chiffré.
+ **StorageType** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Valeurs valides :
  + **`standard`**— (*valeur par défaut*) Fournit un stockage de base de données économique pour les applications dont l' I/O utilisation est modérée à faible.
  + **`iopt1`**— Permet un [stockage optimisé pour les E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage), conçu pour répondre aux besoins de I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O débit.

    Le stockage optimisé pour les E/S Neptune n’est disponible qu’à partir de la version 1.3.0.0 du moteur.
+ **VpcSecurityGroups** : tableau d'objets [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

**Erreurs**
+ [DBClusterAlreadyExistsFault](api-faults.md#DBClusterAlreadyExistsFault)
+ [DBClusterQuotaExceededFault](api-faults.md#DBClusterQuotaExceededFault)
+ [StorageQuotaExceededFault](api-faults.md#StorageQuotaExceededFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
+ [DBSnapshotNotFoundFault](api-faults.md#DBSnapshotNotFoundFault)
+ [DBClusterSnapshotNotFoundFault](api-faults.md#DBClusterSnapshotNotFoundFault)
+ [Insuffisant DBCluster CapacityFault](api-faults.md#InsufficientDBClusterCapacityFault)
+ [InsufficientStorageClusterCapacityFault](api-faults.md#InsufficientStorageClusterCapacityFault)
+ [Non valide DBSnapshot StateFault](api-faults.md#InvalidDBSnapshotStateFault)
+ [Non valide DBCluster SnapshotStateFault](api-faults.md#InvalidDBClusterSnapshotStateFault)
+ [StorageQuotaExceededFault](api-faults.md#StorageQuotaExceededFault)
+ [Non valide VPCNetwork StateFault](api-faults.md#InvalidVPCNetworkStateFault)
+ [InvalidRestoreFault](api-faults.md#InvalidRestoreFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)
+ [OptionGroupNotFoundFault](api-faults.md#OptionGroupNotFoundFault)
+ [KMSKeyNotAccessibleFault](api-faults.md#KMSKeyNotAccessibleFault)
+ [DBClusterParameterGroupNotFoundFault](api-faults.md#DBClusterParameterGroupNotFoundFault)

## Restaurer DBCluster ToPointInTime (action)
<a name="RestoreDBClusterToPointInTime"></a>

         Le nom de la AWS CLI pour cette API est :`restore-db-cluster-to-point-in-time`.

Restaure un cluster de bases de données à un moment donné arbitraire. Les utilisateurs peuvent restaurer à tout moment avant `LatestRestorableTime` pendant `BackupRetentionPeriod` jours. Le cluster de bases de données cible est créé à partir du cluster de bases de données source avec la même configuration que le cluster de bases de données original, sauf que le nouveau cluster de bases de données est créé avec le groupe de sécurité de base de données par défaut.

**Note**  
Cette action restaure uniquement le cluster de bases de données, mais pas les instances de base de données de ce cluster de bases de données. Vous devez invoquer l'action [Créer DBInstance (action)](api-instances.md#CreateDBInstance) pour créer des instances de bases de données pour le cluster de bases de données restauré, en spécifiant l'identifiant du cluster de bases de données restauré dans `DBClusterIdentifier`. Vous pouvez créer des instances de base de données uniquement après la fin de l'action `RestoreDBClusterToPointInTime` et lorsque le cluster de bases de données est disponible.

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

  Nom du nouveau cluster de bases de données à créer.

  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
+ **DBClusterParameterGroupName** (dans la CLI : `--db-cluster-parameter-group-name`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom du groupe de paramètres de cluster de base de données à associer au nouveau cluster de base de données.

  Contraintes :
  + S'il est fourni, il doit correspondre au nom d'un existant DBClusterParameterGroup.
+ **DBSubnetGroupName** (dans la CLI : `--db-subnet-group-name`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom du groupe de sous-réseaux de base de données à utiliser pour le nouveau cluster de bases de données.

  Contraintes : s'il est indiqué, il doit correspondre au nom d'un DBSubnet groupe existant.

  Exemple : `mySubnetgroup`
+ **DeletionProtection**(dans la CLI :`--deletion-protection`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Valeur qui indique si la protection contre la suppression est activée pour le cluster de bases de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée. Par défaut, la protection contre la suppression est désactivée. 
+ **EnableCloudwatchLogsExports** (dans la CLI : `--enable-cloudwatch-logs-exports`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  La liste des journaux que le cluster de base de données restauré doit exporter vers CloudWatch Logs.
+ **EnableIAMDatabaseAuthentication**(dans la CLI :`--enable-iam-database-authentication`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

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

  Par défaut : `false`
+ **KmsKeyId** (dans la CLI : `--kms-key-id`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant de clé Amazon KMS à utiliser lors de la restauration d'un cluster de bases de données chiffré à partir d'un cluster de bases de données chiffré.

  L'identifiant de clé KMS est l'Amazon Resource Name (ARN) de la clé de chiffrement KMS. Si vous restaurez 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.

  Vous pouvez restaurer vers un nouveau cluster de bases de données et chiffrer le nouveau cluster de bases de données avec une clé KMS différente de la clé KMS utilisée pour chiffrer le cluster de bases de données source. Le nouveau cluster de bases de données est chiffré avec la clé KMS identifiée par le paramètre `KmsKeyId`.

  Si vous ne spécifiez pas de valeur pour le paramètre `KmsKeyId` :
  + Si le cluster de bases de données est chiffré, le cluster de bases de données restauré est chiffré à l'aide de la clé KMS utilisée pour chiffrer le cluster de bases de données source.
  + Si le cluster de bases de données n'est pas chiffré, le cluster de bases de données restauré n'est pas chiffré.

  Si `DBClusterIdentifier` fait référence à un cluster de base de données non chiffré, la demande de restauration est rejetée.
+ **Port**(dans la CLI :`--port`) — un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Le numéro de port sur lequel le nouveau cluster de bases de données accepte des connexions.

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

  Valeur par défaut : port du cluster de bases de données d'origine.
+ **RestoreToTime**(dans la CLI :`--restore-to-time`) — a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Date et heure auxquelles restaurer le cluster de bases de données.

  Valeurs Valides : doit être une heure au format UTC (temps universel)

  Contraintes :
  + Doit se situer avant l'heure de restauration la plus récente pour l'instance de base de données.
  + Doit être indiqué si le paramètre `UseLatestRestorableTime` n'est pas fourni.
  + Ne peut pas être spécifié si le paramètre `UseLatestRestorableTime` est true.
  + Ne peut pas être spécifié si le paramètre `RestoreType` est `copy-on-write`.

  Exemple : `2015-03-07T23:45:00Z`
+ **RestoreType** (dans la CLI : `--restore-type`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Type de restauration à exécuter. Vous pouvez spécifier l’une des valeurs suivantes :
  +  `full-copy` - Le nouveau cluster de base de données est restauré sous la forme d'une copie intégrale du cluster de base de données source.
  +  `copy-on-write` - Le nouveau cluster de base de données est restauré sous la forme d'un clone du cluster de base de données source.

  Si vous ne spécifiez pas de valeur pour `RestoreType`, le nouveau cluster de base de données est restauré sous la forme d'une copie intégrale du cluster de base de données source.
+ **ServerlessV2ScalingConfiguration** (dans la CLI : `--serverless-v2-scaling-configuration`) : objet [Serverless V2 ScalingConfiguration](api-datatypes.md#ServerlessV2ScalingConfiguration).

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

  Pour plus d'informations, consultez [Utilisation d'Amazon Neptune sans serveur](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) dans le *Guide de l'utilisateur Amazon Neptune*.
+ **SourceDBClusterIdentifier** (dans la CLI : `--source-db-cluster-identifier`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant du cluster de base de données source à partir duquel effectuer la restauration.

  Contraintes :
  + Doit correspondre à l'identifiant d'un existant DBCluster.
+ **StorageType** (dans la CLI : `--storage-type`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le type de stockage à associer au cluster de base de données.

  Valeurs valides : `standard`, `iopt1`

  Par défaut : `standard`
+ **Tags** (dans la CLI : `--tags`) : tableau d'objets [Tag](api-other-apis.md#Tag).

  Balises à appliquer au cluster de bases de données restauré.
+ **UseLatestRestorableTime** (dans la CLI : `--use-latest-restorable-time`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur défini sur `true` pour restaurer le cluster de bases de données à l'heure de sauvegarde de restauration la plus récente, et `false` dans le cas contraire.

  Par défaut : `false`

  Contraintes : ne doit pas être spécifié si le paramètre `RestoreToTime` est fourni.
+ **VpcSecurityGroupIds** (dans la CLI : `--vpc-security-group-ids`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des groupes de sécurité VPC auxquels appartient le nouveau cluster de bases de données.

**Réponse**

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

Ce type de données est utilisé comme élément de réponse dans [Décrire DBClusters (action)](api-clusters.md#DescribeDBClusters).
+ **AllocatedStorage**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  `AllocatedStorage` renvoie toujours la valeur 1, car la taille de stockage d'un cluster de bases de données Neptune n'est pas fixe ; elle s'ajuste automatiquement en fonction des besoins.
+ **AssociatedRoles** : tableau d'objets [DBClusterRôle](api-clusters.md#DBClusterRole).

  Fournit la liste des rôles Amazon Identity and Access Management (IAM) associés au cluster de bases de données. Les rôles IAM associés à un cluster de bases de données autorisent celui-ci à accéder aux autres services Amazon en votre nom.
+ **AutomaticRestartTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Heure à laquelle le cluster de bases de données sera automatiquement redémarré.
+ **AvailabilityZones** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit la liste des zones de EC2 disponibilité dans lesquelles les instances du cluster de base de données peuvent être créées.
+ **BacktrackConsumedChangeRecords**— a LongOptional, de type : `long` (un entier signé de 64 bits).

  Non pris en charge par Neptune.
+ **BacktrackWindow**— a LongOptional, de type : `long` (un entier signé de 64 bits).

  Non pris en charge par Neptune.
+ **BackupRetentionPeriod**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie le nombre de jours de conservation des instantanés de base de données automatiques.
+ **Capacity**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Non pris en charge par Neptune.
+ **CloneGroupId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifie le groupe de clones auquel est associé le cluster de bases de données.
+ **ClusterCreateTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure à laquelle le cluster de bases de données a été créé, en heure UTC (Universal Coordinated Time).
+ **CopyTagsToSnapshot**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  *Si cette valeur est définie sur `true`, les balises sont copiées dans n'importe quel instantané du cluster de bases de données créé.*
+ **CrossAccountClone**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Si cette valeur est définie sur `true`, le cluster de bases de données peut être cloné sur plusieurs comptes.
+ **DatabaseName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient le nom de la base de données initiale de ce cluster de bases de données qui a été fourni au moment de la création, dans la mesure où un nom a été spécifié au moment de créer le cluster de bases de données. Ce même nom est renvoyé pendant la durée de vie du cluster de bases de données.
+ **DBClusterArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) du cluster de bases de données.
+ **DBClusterIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un identifiant de cluster de bases de données fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie un cluster de bases de données.
+ **DBClusterMembers** : tableau d'objets [DBClusterMembre](api-clusters.md#DBClusterMember).

  Fournit la liste des instances qui composent le cluster de bases de données.
+ **DBClusterParameterGroup** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le nom du groupe de paramètres de cluster de base de données pour le cluster de base de données.
+ **DbClusterResourceId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant immuable et propre à la région Amazon du cluster de bases de données. Cet identifiant se trouve dans les entrées du CloudTrail journal Amazon chaque fois que la clé Amazon KMS du cluster de base de données est consultée.
+ **DBSubnetGroup** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie les informations sur le groupe de sous-réseaux associé au cluster de bases de données, notamment le nom, la description et les sous-réseaux du groupe de sous-réseaux.
+ **DeletionProtection**— a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Indique si la protection contre la suppression est activée pour le cluster de bases de données. La base de données ne peut pas être supprimée lorsque la protection contre la suppression est activée.
+ **EarliestBacktrackTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Non pris en charge par Neptune.
+ **EarliestRestorableTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie la première heure à laquelle une base de données peut être restaurée par point-in-time restauration.
+ **EnabledCloudwatchLogsExports** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des types de journaux que ce cluster de base de données est configuré pour exporter vers CloudWatch Logs. Les types de journaux valides sont les suivants : `audit` (pour publier les journaux d'audit CloudWatch) et slowquery (pour publier les journaux de requêtes lentes). CloudWatch Consultez la section [Publication des journaux Neptune sur Amazon CloudWatch Logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html).
+ **Endpoint** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le point de terminaison de connexion pour l'instance principale du cluster de bases de données.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le nom du moteur de base de données à utiliser pour ce cluster de bases de données.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique la version du moteur de base de données.
+ **GlobalClusterIdentifier**— a GlobalClusterIdentifier, de type : `string` (une chaîne codée en UTF-8), pas moins de 1 ou plus de 255 ? 1er ? s, correspondant à cette expression régulière :`[A-Za-z][0-9A-Za-z-:._]*`.

  Contient un identifiant de cluster de bases de données globale fourni par l'utilisateur. Cet identifiant est la clé unique qui identifie une base de données globale.
+ **HostedZoneId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'ID attribué par Amazon Route 53 lorsque vous créez une zone hébergée.
+ **IAMDatabaseAuthenticationEnabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur true (vrai) si le mappage des comptes Amazon Identity and Access Management (IAM) aux comptes de base de données est activé ; sinon, valeur false (faux).
+ **IOOptimizedNextAllowedModificationTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  La prochaine fois, vous pourrez modifier le cluster de bases de données de façon à utiliser le type de stockage `iopt1`.
+ **KmsKeyId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si `StorageEncrypted` a la valeur true (vrai), identifiant de clé Amazon KMS pour le cluster de bases de données chiffré.
+ **LatestRestorableTime**— a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure limite à laquelle une base de données peut être restaurée par point-in-time restauration.
+ **MultiAZ** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si le cluster de bases de données possède des instances dans plusieurs zones de disponibilité.
+ **PendingModifiedValues** : objet [ClusterPendingModifiedValues](api-clusters.md#ClusterPendingModifiedValues).

  Ce type de données est utilisé comme élément de réponse dans l'opération `ModifyDBCluster` et contient les modifications qui seront appliquées lors de la fenêtre de maintenance suivante.
+ **PercentProgress** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie la progression de l'opération sous forme de pourcentage.
+ **Port**— an IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Spécifie le port sur lequel le moteur de base de données est à l'écoute.
+ **PreferredBackupWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie la plage de temps quotidienne au cours de laquelle des sauvegardes automatiques sont créées si cette fonctionnalité est activée, comme déterminé par la propriété `BackupRetentionPeriod`.
+ **PreferredMaintenanceWindow** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'intervalle de temps hebdomadaire, au format Universal Coordinated Time (UTC), pendant lequel a lieu la maintenance du système.
+ **ReaderEndpoint** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Si un basculement se produit et que le réplica en lecture auquel vous êtes connecté est promu en instance principale, votre connexion est supprimée. Pour continuer à envoyer votre charge de travail de lecture à d'autres réplicas en lecture du cluster, vous pouvez alors vous reconnecter au point de terminaison du lecteur.
+ **ReadReplicaIdentifiers** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Contient un ou plusieurs identifiants des réplicas en lecture associés à ce cluster de bases de données.
+ **ReplicationSourceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge par Neptune.
+ **ReplicationType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Non pris en charge par Neptune.
+ **ServerlessV2ScalingConfiguration** : objet [Serverless V2 ScalingConfigurationInfo](api-datatypes.md#ServerlessV2ScalingConfigurationInfo).

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

  Pour plus d'informations, consultez [Utilisation d'Amazon Neptune sans serveur](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) dans le *Guide de l'utilisateur Amazon Neptune*.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'état actuel de ce cluster de base de données.
+ **StorageEncrypted** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si le cluster de base de données est chiffré.
+ **StorageType** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

  Valeurs valides :
  + **`standard`**— (*valeur par défaut*) Fournit un stockage de base de données économique pour les applications dont l' I/O utilisation est modérée à faible.
  + **`iopt1`**— Permet un [stockage optimisé pour les E/S](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage), conçu pour répondre aux besoins de I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O débit.

    Le stockage optimisé pour les E/S Neptune n’est disponible qu’à partir de la version 1.3.0.0 du moteur.
+ **VpcSecurityGroups** : tableau d'objets [VpcSecurityGroupMembership](api-datatypes.md#VpcSecurityGroupMembership).

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

**Erreurs**
+ [DBClusterAlreadyExistsFault](api-faults.md#DBClusterAlreadyExistsFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)
+ [DBClusterQuotaExceededFault](api-faults.md#DBClusterQuotaExceededFault)
+ [DBClusterSnapshotNotFoundFault](api-faults.md#DBClusterSnapshotNotFoundFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)
+ [Insuffisant DBCluster CapacityFault](api-faults.md#InsufficientDBClusterCapacityFault)
+ [InsufficientStorageClusterCapacityFault](api-faults.md#InsufficientStorageClusterCapacityFault)
+ [Non valide DBCluster SnapshotStateFault](api-faults.md#InvalidDBClusterSnapshotStateFault)
+ [Non valide DBCluster StateFault](api-faults.md#InvalidDBClusterStateFault)
+ [Non valide DBSnapshot StateFault](api-faults.md#InvalidDBSnapshotStateFault)
+ [InvalidRestoreFault](api-faults.md#InvalidRestoreFault)
+ [InvalidSubnet](api-faults.md#InvalidSubnet)
+ [Non valide VPCNetwork StateFault](api-faults.md#InvalidVPCNetworkStateFault)
+ [KMSKeyNotAccessibleFault](api-faults.md#KMSKeyNotAccessibleFault)
+ [OptionGroupNotFoundFault](api-faults.md#OptionGroupNotFoundFault)
+ [StorageQuotaExceededFault](api-faults.md#StorageQuotaExceededFault)
+ [DBClusterParameterGroupNotFoundFault](api-faults.md#DBClusterParameterGroupNotFoundFault)

## Décrire les DBCluster instantanés (action)
<a name="DescribeDBClusterSnapshots"></a>

         Le nom de la AWS CLI pour cette API est :`describe-db-cluster-snapshots`.

Renvoie des informations sur des instantanés de cluster de bases de données. Cette action d'API prend en charge la pagination.

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

  ID du cluster de bases de données auprès duquel récupérer la liste des instantanés de cluster de bases de données. Ce paramètre ne peut pas être utilisé avec le paramètre `DBClusterSnapshotIdentifier`. Ce paramètre n'est pas sensible à la casse.

  Contraintes :
  + S'il est fourni, il doit correspondre à l'identifiant d'un existant DBCluster.
+ **DBClusterSnapshotIdentifier** (dans la CLI : `--db-cluster-snapshot-identifier`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant d'instantané de cluster de bases de données spécifique à décrire. Ce paramètre ne peut pas être utilisé avec le paramètre `DBClusterIdentifier`. Cette valeur est stockée sous la forme d'une chaîne en minuscules.

  Contraintes :
  + S'il est fourni, il doit correspondre à l'identifiant d'un DBCluster instantané existant.
  + Si cet identifiant est destinée à un instantané automatisé, le paramètre `SnapshotType` doit également être spécifié.
+ **Filters** (dans la CLI : `--filters`) : tableau d'objets [Filtre](api-datatypes.md#Filter).

  Ce paramètre n'est actuellement pas pris en charge.
+ **IncludePublic** (dans la CLI : `--include-public`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur true pour inclure les instantanés de cluster de bases de données manuels publics et qui peuvent être copiés ou restaurés par tous les comptes Amazon, et false dans le cas contraire. L’argument par défaut est `false`. La valeur par défaut est false.

  Vous pouvez partager un instantané de cluster de bases de données manuel comme public à l'aide de l'action d'API [Modifier DBCluster SnapshotAttribute (action)](#ModifyDBClusterSnapshotAttribute).
+ **IncludeShared** (dans la CLI : `--include-shared`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur true pour inclure les instantanés de cluster de bases de données manuels partagés à partir d'autres comptes Amazon attestant que ce compte Amazon a reçu l'autorisation de copier ou restaurer, et false dans le cas contraire. L’argument par défaut est `false`.

  Vous pouvez autoriser un compte Amazon à restaurer un instantané de cluster de bases de données manuel à partir d'un autre compte Amazon par l'action d'API [Modifier DBCluster SnapshotAttribute (action)](#ModifyDBClusterSnapshotAttribute).
+ **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 `DescribeDBClusterSnapshots` 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`) — un IntegerOptional, de type : `integer` (un 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.
+ **SnapshotType** (dans la CLI : `--snapshot-type`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Type d'instantanés de cluster de bases de données à renvoyer. Vous pouvez spécifier l’une des valeurs suivantes :
  +  `automated` : renvoie tous les instantanés de cluster de bases de données automatiquement créés par Amazon Neptune pour mon compte Amazon.
  +  `manual` : renvoie tous les instantanés de cluster de bases de données créés par mon compte Amazon.
  +  `shared` : renvoie tous les instantanés de cluster de bases de données manuels partagés avec mon compte AWS.
  +  `public` - Renvoie tous les instantanés de cluster de bases de données marqués comme publics.

  Si vous ne spécifiez pas de valeur `SnapshotType`, les deux instantanés de cluster de bases de données manuels et automatiques sont renvoyés. Vous pouvez inclure des instantanés de cluster de bases de données partagés avec ces résultats en définissant le paramètre `IncludeShared` sur `true`. Vous pouvez inclure des instantanés de cluster de bases de données publics avec ces résultats en définissant le paramètre `IncludePublic` sur `true`.

  Les paramètres `IncludeShared` et `IncludePublic` ne s'appliquent pas pour les valeurs `SnapshotType` de `manual` ou `automated`. Le paramètre `IncludePublic` ne s'applique pas lorsque `SnapshotType` est défini sur `shared`. Le paramètre `IncludeShared` ne s'applique pas lorsque `SnapshotType` est défini sur `public`.

**Réponse**
+ **DBClusterSnapshots** : tableau d'objets [DBClusterInstantané](#DBClusterSnapshot).

  Fournit une liste des instantanés de cluster de bases de données pour l'utilisateur.
+ **Marker** : chaîne de type : `string` (chaîne encodée en UTF-8).

   Jeton de pagination facultatif fourni par une demande [Décrire les DBCluster instantanés (action)](#DescribeDBClusterSnapshots) 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**
+ [DBClusterSnapshotNotFoundFault](api-faults.md#DBClusterSnapshotNotFoundFault)

## Décrire DBCluster SnapshotAttributes (action)
<a name="DescribeDBClusterSnapshotAttributes"></a>

         Le nom de la AWS CLI pour cette API est :`describe-db-cluster-snapshot-attributes`.

Renvoie une liste de noms et de valeurs d'attributs d'instantané de cluster de bases de données pour un instantané de cluster de bases de données manuel.

Lorsque vous partagez des instantanés avec d'autres comptes Amazon, `DescribeDBClusterSnapshotAttributes` renvoie l'`restore`attribut et une liste IDs des comptes Amazon autorisés à copier ou à restaurer l'instantané manuel du cluster de base de données. Si le paramètre `all` est inclus dans la liste des valeurs pour l'attribut `restore`, l'instantané de cluster de bases de données manuel est public et peut être copié ou restauré par tous les comptes Amazon.

Pour ajouter ou supprimer l'accès d'un compte Amazon afin de copier ou de restaurer un instantané de cluster de bases de données manuel, ou de rendre l'instantané de cluster de bases de données manuel public ou privé, utilisez l'action d'API [Modifier DBCluster SnapshotAttribute (action)](#ModifyDBClusterSnapshotAttribute).

**Demande**
+ **DBClusterSnapshotIdentifier** (dans la CLI : `--db-cluster-snapshot-identifier`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant de l'instantané de cluster de bases de données pour lequel décrire les attributs.

**Réponse**

Contient les résultats d'appel réussi à l'action d'API [Décrire DBCluster SnapshotAttributes (action)](#DescribeDBClusterSnapshotAttributes).

Les attributs d'instantané de cluster de bases de données manuel sont utilisés pour autoriser d'autres comptes Amazon à copier ou restaurer un instantané de cluster de bases de données manuel. Pour plus d'informations, consultez l'action d'API [Modifier DBCluster SnapshotAttribute (action)](#ModifyDBClusterSnapshotAttribute).
+ **DBClusterSnapshotAttributes** : tableau d'objets [DBClusterSnapshotAttribute](#DBClusterSnapshotAttribute).

  Liste des attributs et des valeurs de l'instantané de cluster de bases de données manuel.
+ **DBClusterSnapshotIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant de l'instantané de cluster de bases de données manuel sur lequel s'appliquent les attributs.

**Erreurs**
+ [DBClusterSnapshotNotFoundFault](api-faults.md#DBClusterSnapshotNotFoundFault)

## *Structures :*
<a name="api-snapshots-structures-spacer"></a>

## DBClusterInstantané (structure)
<a name="DBClusterSnapshot"></a>

Contient les détails d'un instantané 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 [Décrire les DBCluster instantanés (action)](#DescribeDBClusterSnapshots).

**Champs**
+ **AllocatedStorage** : entier de type : `integer` (entier signé de 32 bits).

  Spécifie la taille de stockage allouée en gigaoctets (Gio).
+ **AvailabilityZones** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit la liste des zones de EC2 disponibilité dans lesquelles les instances du snapshot du cluster de base de données peuvent être restaurées.
+ **ClusterCreateTime**— Il s'agit d'un TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure à laquelle le cluster de bases de données a été créé, en heure UTC (Universal Coordinated Time).
+ **DBClusterIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'identifiant du cluster de bases de données à partir duquel cet instantané de cluster de bases de données a été créé.
+ **DBClusterSnapshotArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de l'instantané de cluster de bases de données.
+ **DBClusterSnapshotIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'identifiant d'un instantané de cluster de bases de données. Doit correspondre à l'identifiant d'un instantané existant.

  Après avoir restauré un cluster de bases de données à l'aide d'un `DBClusterSnapshotIdentifier`, vous devez spécifier le même `DBClusterSnapshotIdentifier` pour toute mise à jour ultérieure de ce cluster. Lorsque vous spécifiez cette propriété pour une mise à jour, le cluster de bases de données n'est pas restauré de nouveau à partir de l'instantané, et les données de la base de données ne sont pas modifiées.

  Toutefois, si vous ne spécifiez pas le `DBClusterSnapshotIdentifier`, un cluster de bases de données vide est créé et le cluster de bases de données d'origine est supprimé. Si vous spécifiez une propriété différente de la propriété précédente de restauration d'instantané, le cluster de bases de données est restauré à partir de l'instantané spécifié par le `DBClusterSnapshotIdentifier`, et le cluster de bases de données d'origine est supprimé.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le nom du moteur de base de données.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit la version du moteur de base de données à utiliser pour cet instantané de cluster de bases de données.
+ **IAMDatabaseAuthenticationEnabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur true (vrai) si le mappage des comptes Amazon Identity and Access Management (IAM) aux comptes de base de données est activé ; sinon, valeur false (faux).
+ **KmsKeyId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si `StorageEncrypted` a la valeur true (vrai), il s'agit de l'identifiant de clé Amazon KMS pour le cluster de bases de données chiffré.
+ **LicenseModel** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit les informations sur le modèle de licence pour cet instantané de cluster de bases de données.
+ **PercentProgress** : entier de type : `integer` (entier signé de 32 bits).

  Spécifie une estimation du pourcentage de données transférées.
+ **Port** : entier de type : `integer` (entier signé de 32 bits).

  Spécifie le port écouté par le cluster de bases de données au moment de l'instantané.
+ **SnapshotCreateTime**— Il s'agit d'un TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie l'heure à laquelle l'instantané a été pris, au format UTC (temps universel).
+ **SnapshotType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le type de l'instantané de cluster de bases de données.
+ **SourceDBClusterSnapshotArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Si l'instantané de cluster de bases de données a été copié à partir d'un instantané de cluster de bases de données source, l'Amazon Resource Name (ARN) de l'instantané de cluster de bases de données source, une valeur null dans le cas contraire.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie le statut de cet instantané de cluster de bases de données.
+ **StorageEncrypted** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si l'instantané de cluster de bases de données est chiffré.
+ **StorageType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Type de stockage associé à l’instantané de cluster de bases de données.
+ **VpcId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit l'ID de VPC associé à l'instantané de cluster de bases de données.

`DBClusterSnapshot` est utilisé comme élément de réponse pour :
+ [Créer un DBCluster instantané](#CreateDBClusterSnapshot)
+ [Copier DBCluster un instantané](#CopyDBClusterSnapshot)
+ [Supprimer DBCluster un instantané](#DeleteDBClusterSnapshot)

## DBClusterSnapshotAttribute (structure)
<a name="DBClusterSnapshotAttribute"></a>

Contient le nom et les valeurs d'un attribut d'instantané de cluster de bases de données manuel.

Les attributs d'instantané de cluster de bases de données manuel sont utilisés pour autoriser d'autres comptes Amazon à restaurer un instantané de cluster de bases de données manuel. Pour plus d'informations, consultez l'action d'API [Modifier DBCluster SnapshotAttribute (action)](#ModifyDBClusterSnapshotAttribute).

**Champs**
+ **AttributeName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom de l'attribut d'instantané de cluster de bases de données manuel.

  L'attribut nommé `restore` fait référence à la liste des comptes Amazon autorisés à copier ou restaurer l'instantané de cluster de bases de données manuel. Pour plus d'informations, consultez l'action d'API [Modifier DBCluster SnapshotAttribute (action)](#ModifyDBClusterSnapshotAttribute).
+ **AttributeValues** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Valeur(s) de l'attribut d'instantané de cluster de bases de données manuel.

  Si le `AttributeName` champ est défini sur`restore`, cet élément renvoie une liste IDs des comptes Amazon autorisés à copier ou à restaurer l'instantané manuel du cluster de base de données. Si une valeur `all` se trouve dans la liste, l'instantané de cluster de bases de données manuel est public et disponible pour la copie ou la restauration des comptes Amazon.

## DBClusterSnapshotAttributesResult (structure)
<a name="DBClusterSnapshotAttributesResult"></a>

Contient les résultats d'appel réussi à l'action d'API [Décrire DBCluster SnapshotAttributes (action)](#DescribeDBClusterSnapshotAttributes).

Les attributs d'instantané de cluster de bases de données manuel sont utilisés pour autoriser d'autres comptes Amazon à copier ou restaurer un instantané de cluster de bases de données manuel. Pour plus d'informations, consultez l'action d'API [Modifier DBCluster SnapshotAttribute (action)](#ModifyDBClusterSnapshotAttribute).

**Champs**
+ **DBClusterSnapshotAttributes** : tableau d'objets [DBClusterSnapshotAttribute](#DBClusterSnapshotAttribute).

  Liste des attributs et des valeurs de l'instantané de cluster de bases de données manuel.
+ **DBClusterSnapshotIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant de l'instantané de cluster de bases de données manuel sur lequel s'appliquent les attributs.

`DBClusterSnapshotAttributesResult` est utilisé comme élément de réponse pour :
+ [Décrivez DBCluster SnapshotAttributes](#DescribeDBClusterSnapshotAttributes)
+ [Modifier DBCluster SnapshotAttribute](#ModifyDBClusterSnapshotAttribute)

# API d'événements Neptune
<a name="api-events"></a>

**Actions :**
+ [CreateEventSubscription (action)](#CreateEventSubscription)
+ [DeleteEventSubscription (action)](#DeleteEventSubscription)
+ [ModifyEventSubscription (action)](#ModifyEventSubscription)
+ [DescribeEventSubscriptions (action)](#DescribeEventSubscriptions)
+ [AddSourceIdentifierToSubscription (action)](#AddSourceIdentifierToSubscription)
+ [RemoveSourceIdentifierFromSubscription (action)](#RemoveSourceIdentifierFromSubscription)
+ [DescribeEvents (action)](#DescribeEvents)
+ [DescribeEventCategories (action)](#DescribeEventCategories)

**Structures :**
+ [Event (structure)](#Event)
+ [EventCategoriesMap (structure)](#EventCategoriesMap)
+ [EventSubscription (structure)](#EventSubscription)

## CreateEventSubscription (action)
<a name="CreateEventSubscription"></a>

         Le nom de la AWS CLI pour cette API est :`create-event-subscription`.

Crée un abonnement à la notification d'événements. Cette action nécessite un ARN (Amazon Resource Name) de rubrique créé par la console Neptune, la console SNS ou l'API SNS. Pour obtenir un ARN avec SNS, vous devez créer une rubrique dans Amazon SNS et vous y abonner. L'ARN s'affiche dans la console SNS.

Vous pouvez spécifier le type de source (SourceType) dont vous souhaitez être informé, fournir une liste des sources Neptune (SourceIds) qui déclenchent les événements et fournir une liste de catégories d'événements (EventCategories) pour les événements dont vous souhaitez être informé. Par exemple, vous pouvez spécifier SourceType = db-instance, = mydbinstance1, mydbinstance2 et SourceIds = Availability, Backup. EventCategories 

Si vous spécifiez à la fois le SourceType et SourceIds, par exemple SourceType = db-instance et SourceIdentifier = myDBInstance1, vous êtes informé de tous les événements db-instance pour la source spécifiée. Si vous spécifiez a SourceType mais pas a SourceIdentifier, vous êtes informé des événements liés à ce type de source pour toutes vos sources Neptune. Si vous ne spécifiez ni le SourceType ni le SourceIdentifier, vous êtes informé des événements générés par toutes les sources Neptune associées à votre compte client.

**Demande**
+ **Enabled**(dans la CLI :`--enabled`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

   Valeur booléenne définie sur **true** pour activer l'abonnement, et définie sur **false** pour créer l'abonnement sans l'activer.
+ **EventCategories** (dans la CLI : `--event-categories`) : chaîne de type : `string` (chaîne encodée en UTF-8).

   Liste des catégories d'événements SourceType auxquels vous souhaitez vous abonner. Vous pouvez voir la liste des catégories correspondant à une donnée SourceType en utilisant l'**DescribeEventCategories**action.
+ **SnsTopicArn** (dans la CLI : `--sns-topic-arn`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de la rubrique SNS créé pour la notification d'événements. L'ARN est créé par Amazon SNS lorsque vous créez une rubrique et vous y abonnez.
+ **SourceIds** (dans la CLI : `--source-ids`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des identifiants des sources d'événements pour lesquels des événements sont renvoyés. Si la valeur n'est pas spécifiée, toutes les sources sont incluses dans la réponse. Un identifiant doit commencer par une lettre et contenir uniquement des lettres ASCII, des chiffres et des tirets. Il ne doit pas se terminer par un tiret ou contenir deux tirets consécutifs.

  Contraintes :
  + S' SourceIds ils sont fournis, ils SourceType doivent également être fournis.
  + Si le type de source est une instance de base de données, un paramètre `DBInstanceIdentifier` doit être fourni.
  + Si le type de source est un groupe de sécurité de base de données, un paramètre `DBSecurityGroupName` doit être fourni.
  + Si le type de source est un groupe de paramètres de base de données, un paramètre `DBParameterGroupName` doit être fourni.
  + Si le type de source est un instantané de base de données, un paramètre `DBSnapshotIdentifier` doit être fourni.
+ **SourceType** (dans la CLI : `--source-type`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Type de source qui génère les événements. Par exemple, si vous souhaitez être informé des événements générés par une instance de base de données, vous devez définir ce paramètre sur db-instance. Si cette valeur n'est pas spécifiée, tous les événements sont renvoyés.

  Valeurs valides: `db-instance` \$1 `db-cluster` \$1 `db-parameter-group` \$1 `db-security-group` \$1 `db-snapshot` \$1 `db-cluster-snapshot`
+ **SubscriptionName** (dans la CLI : `--subscription-name`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom de l'abonnement.

  Contraintes : le nom doit être composé de 255 caractères maximum.
+ **Tags** (dans la CLI : `--tags`) : tableau d'objets [Tag](api-other-apis.md#Tag).

  Balises à appliquer au nouvel abonnement d'événements.

**Réponse**

Contient les résultats d'une invocation réussie de l'action [DescribeEventSubscriptions (action)](#DescribeEventSubscriptions).
+ **CustomerAwsId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Compte client Amazon associé à l'abonnement aux notifications d'événements.
+ **CustSubscriptionId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  ID d'abonnement à la notification d'événements.
+ **Enabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur booléenne indiquant si l'abonnement est activé. La valeur true indique que l'abonnement est activé.
+ **EventCategoriesList** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des catégories d'événements pour l'abonnement à la notification d'événements.
+ **EventSubscriptionArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de l'abonnement aux événements.
+ **SnsTopicArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  ARN de la rubrique de l'abonnement à la notification d'événements.
+ **SourceIdsList** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des sources IDs pour l'abonnement aux notifications d'événements.
+ **SourceType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Type de source pour l'abonnement à la notification d'événements.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  L'état de l'abonnement à la notification d'événements .

  Contraintes :

  Il peut s'agir de l'une des options suivantes : création \$1 modification \$1 suppression \$1 active \$1 sans autorisation \$1 topic-not-exist

  Le statut « pas de permission » indique que Neptune n'a plus l'autorisation de publier sur la rubrique SNS. Le statut « topic-not-exist » indique que le sujet a été supprimé après la création de l'abonnement.
+ **SubscriptionCreationTime** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Heure de création de l'abonnement à la notification d'événements.

**Erreurs**
+ [EventSubscriptionQuotaExceededFault](api-faults.md#EventSubscriptionQuotaExceededFault)
+ [SubscriptionAlreadyExistFault](api-faults.md#SubscriptionAlreadyExistFault)
+ [SNSInvalidTopicFault](api-faults.md#SNSInvalidTopicFault)
+ [SNSNoAuthorizationFault](api-faults.md#SNSNoAuthorizationFault)
+ [SNSTopicArnNotFoundFault](api-faults.md#SNSTopicArnNotFoundFault)
+ [SubscriptionCategoryNotFoundFault](api-faults.md#SubscriptionCategoryNotFoundFault)
+ [SourceNotFoundFault](api-faults.md#SourceNotFoundFault)

## DeleteEventSubscription (action)
<a name="DeleteEventSubscription"></a>

         Le nom de la AWS CLI pour cette API est :`delete-event-subscription`.

Supprime un abonnement à la notifications d'événements.

**Demande**
+ **SubscriptionName** (dans la CLI : `--subscription-name`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom de l'abonnement à la notification d'événements que vous souhaitez supprimer.

**Réponse**

Contient les résultats d'une invocation réussie de l'action [DescribeEventSubscriptions (action)](#DescribeEventSubscriptions).
+ **CustomerAwsId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Compte client Amazon associé à l'abonnement aux notifications d'événements.
+ **CustSubscriptionId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  ID d'abonnement à la notification d'événements.
+ **Enabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur booléenne indiquant si l'abonnement est activé. La valeur true indique que l'abonnement est activé.
+ **EventCategoriesList** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des catégories d'événements pour l'abonnement à la notification d'événements.
+ **EventSubscriptionArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de l'abonnement aux événements.
+ **SnsTopicArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  ARN de la rubrique de l'abonnement à la notification d'événements.
+ **SourceIdsList** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des sources IDs pour l'abonnement aux notifications d'événements.
+ **SourceType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Type de source pour l'abonnement à la notification d'événements.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  L'état de l'abonnement à la notification d'événements .

  Contraintes :

  Il peut s'agir de l'une des options suivantes : création \$1 modification \$1 suppression \$1 active \$1 sans autorisation \$1 topic-not-exist

  Le statut « pas de permission » indique que Neptune n'a plus l'autorisation de publier sur la rubrique SNS. Le statut « topic-not-exist » indique que le sujet a été supprimé après la création de l'abonnement.
+ **SubscriptionCreationTime** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Heure de création de l'abonnement à la notification d'événements.

**Erreurs**
+ [SubscriptionNotFoundFault](api-faults.md#SubscriptionNotFoundFault)
+ [InvalidEventSubscriptionStateFault](api-faults.md#InvalidEventSubscriptionStateFault)

## ModifyEventSubscription (action)
<a name="ModifyEventSubscription"></a>

         Le nom de la AWS CLI pour cette API est :`modify-event-subscription`.

Modifie un abonnement à la notification d'événements existant. Notez que vous ne pouvez pas modifier les identifiants source à l'aide de cet appel. Pour modifier les identifiants source d'un abonnement, utilisez les appels commande [AddSourceIdentifierToSubscription (action)](#AddSourceIdentifierToSubscription) et [RemoveSourceIdentifierFromSubscription (action)](#RemoveSourceIdentifierFromSubscription).

Vous pouvez voir la liste des catégories d'événements pour un événement donné SourceType en utilisant l'**DescribeEventCategories**action.

**Demande**
+ **Enabled**(dans la CLI :`--enabled`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

   Valeur booléenne définie sur **true** pour activer l'abonnement.
+ **EventCategories** (dans la CLI : `--event-categories`) : chaîne de type : `string` (chaîne encodée en UTF-8).

   Liste des catégories d'événements SourceType auxquels vous souhaitez vous abonner. Vous pouvez voir la liste des catégories correspondant à une donnée SourceType en utilisant l'**DescribeEventCategories**action.
+ **SnsTopicArn** (dans la CLI : `--sns-topic-arn`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de la rubrique SNS créé pour la notification d'événements. L'ARN est créé par Amazon SNS lorsque vous créez une rubrique et vous y abonnez.
+ **SourceType** (dans la CLI : `--source-type`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Type de source qui génère les événements. Par exemple, si vous souhaitez être informé des événements générés par une instance de base de données, vous devez définir ce paramètre sur db-instance. Si cette valeur n'est pas spécifiée, tous les événements sont renvoyés.

  Valeurs valides : db-instance \$1 \$1 db-parameter-group \$1 db-security-group db-snapshot
+ **SubscriptionName** (dans la CLI : `--subscription-name`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Le nom de l'abonnement à la notification d'événements .

**Réponse**

Contient les résultats d'une invocation réussie de l'action [DescribeEventSubscriptions (action)](#DescribeEventSubscriptions).
+ **CustomerAwsId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Compte client Amazon associé à l'abonnement aux notifications d'événements.
+ **CustSubscriptionId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  ID d'abonnement à la notification d'événements.
+ **Enabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur booléenne indiquant si l'abonnement est activé. La valeur true indique que l'abonnement est activé.
+ **EventCategoriesList** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des catégories d'événements pour l'abonnement à la notification d'événements.
+ **EventSubscriptionArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de l'abonnement aux événements.
+ **SnsTopicArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  ARN de la rubrique de l'abonnement à la notification d'événements.
+ **SourceIdsList** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des sources IDs pour l'abonnement aux notifications d'événements.
+ **SourceType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Type de source pour l'abonnement à la notification d'événements.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  L'état de l'abonnement à la notification d'événements .

  Contraintes :

  Il peut s'agir de l'une des options suivantes : création \$1 modification \$1 suppression \$1 active \$1 sans autorisation \$1 topic-not-exist

  Le statut « pas de permission » indique que Neptune n'a plus l'autorisation de publier sur la rubrique SNS. Le statut « topic-not-exist » indique que le sujet a été supprimé après la création de l'abonnement.
+ **SubscriptionCreationTime** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Heure de création de l'abonnement à la notification d'événements.

**Erreurs**
+ [EventSubscriptionQuotaExceededFault](api-faults.md#EventSubscriptionQuotaExceededFault)
+ [SubscriptionNotFoundFault](api-faults.md#SubscriptionNotFoundFault)
+ [SNSInvalidTopicFault](api-faults.md#SNSInvalidTopicFault)
+ [SNSNoAuthorizationFault](api-faults.md#SNSNoAuthorizationFault)
+ [SNSTopicArnNotFoundFault](api-faults.md#SNSTopicArnNotFoundFault)
+ [SubscriptionCategoryNotFoundFault](api-faults.md#SubscriptionCategoryNotFoundFault)

## DescribeEventSubscriptions (action)
<a name="DescribeEventSubscriptions"></a>

         Le nom de la AWS CLI pour cette API est :`describe-event-subscriptions`.

Répertorie toutes les descriptions d'abonnements d'un compte client. La description d'un abonnement inclut l' SNSTopicARN SubscriptionName, le CustomerID, le SourceID SourceType et le Status. CreationTime

Si vous spécifiez un SubscriptionName, répertorie la description de cet abonnement.

**Demande**
+ **Filters** (dans la CLI : `--filters`) : tableau d'objets [Filtre](api-datatypes.md#Filter).

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

   Un jeton de pagination facultatif fourni par une demande d' DescribeOrderableDBInstanceoptions précédente. Si ce paramètre est spécifié, la réponse inclut uniquement des enregistrements supérieurs au marqueur, jusqu'à la valeur spécifiée par `MaxRecords`.
+ **MaxRecords**(dans la CLI :`--max-records`) — un IntegerOptional, de type : `integer` (un 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.
+ **SubscriptionName** (dans la CLI : `--subscription-name`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom de l'abonnement à la notification d'événements que vous souhaitez décrire.

**Réponse**
+ **EventSubscriptionsList** : tableau d'objets [EventSubscription](#EventSubscription).

  Liste des types de EventSubscriptions données.
+ **Marker** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

**Erreurs**
+ [SubscriptionNotFoundFault](api-faults.md#SubscriptionNotFoundFault)

## AddSourceIdentifierToSubscription (action)
<a name="AddSourceIdentifierToSubscription"></a>

         Le nom de la AWS CLI pour cette API est :`add-source-identifier-to-subscription`.

Ajoute un identifiant source à un abonnement à la notification d'événements existant.

**Demande**
+ **SourceIdentifier** (dans la CLI : `--source-identifier`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant de la source de l'événement à ajouter.

  Contraintes :
  + Si le type de source est une instance de base de données, un paramètre `DBInstanceIdentifier` doit être fourni.
  + Si le type de source est un groupe de sécurité de base de données, un paramètre `DBSecurityGroupName` doit être fourni.
  + Si le type de source est un groupe de paramètres de base de données, un paramètre `DBParameterGroupName` doit être fourni.
  + Si le type de source est un instantané de base de données, un paramètre `DBSnapshotIdentifier` doit être fourni.
+ **SubscriptionName** (dans la CLI : `--subscription-name`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom de l'abonnement à la notification d'événements auquel vous souhaitez ajouter un identifiant source.

**Réponse**

Contient les résultats d'une invocation réussie de l'action [DescribeEventSubscriptions (action)](#DescribeEventSubscriptions).
+ **CustomerAwsId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Compte client Amazon associé à l'abonnement aux notifications d'événements.
+ **CustSubscriptionId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  ID d'abonnement à la notification d'événements.
+ **Enabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur booléenne indiquant si l'abonnement est activé. La valeur true indique que l'abonnement est activé.
+ **EventCategoriesList** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des catégories d'événements pour l'abonnement à la notification d'événements.
+ **EventSubscriptionArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de l'abonnement aux événements.
+ **SnsTopicArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  ARN de la rubrique de l'abonnement à la notification d'événements.
+ **SourceIdsList** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des sources IDs pour l'abonnement aux notifications d'événements.
+ **SourceType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Type de source pour l'abonnement à la notification d'événements.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  L'état de l'abonnement à la notification d'événements .

  Contraintes :

  Il peut s'agir de l'une des options suivantes : création \$1 modification \$1 suppression \$1 active \$1 sans autorisation \$1 topic-not-exist

  Le statut « pas de permission » indique que Neptune n'a plus l'autorisation de publier sur la rubrique SNS. Le statut « topic-not-exist » indique que le sujet a été supprimé après la création de l'abonnement.
+ **SubscriptionCreationTime** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Heure de création de l'abonnement à la notification d'événements.

**Erreurs**
+ [SubscriptionNotFoundFault](api-faults.md#SubscriptionNotFoundFault)
+ [SourceNotFoundFault](api-faults.md#SourceNotFoundFault)

## RemoveSourceIdentifierFromSubscription (action)
<a name="RemoveSourceIdentifierFromSubscription"></a>

         Le nom de la AWS CLI pour cette API est :`remove-source-identifier-from-subscription`.

Supprime un identifiant source d'un abonnement à la notification d'événements existant

**Demande**
+ **SourceIdentifier** (dans la CLI : `--source-identifier`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

   Identifiant source à supprimer de l'abonnement, tel que l'**identifiant d'instance DB** pour une instance de base de données ou le nom d'un groupe de sécurité.
+ **SubscriptionName** (dans la CLI : `--subscription-name`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom de l'abonnement à la notification d'événements duquel vous souhaitez supprimer un identifiant source.

**Réponse**

Contient les résultats d'une invocation réussie de l'action [DescribeEventSubscriptions (action)](#DescribeEventSubscriptions).
+ **CustomerAwsId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Compte client Amazon associé à l'abonnement aux notifications d'événements.
+ **CustSubscriptionId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  ID d'abonnement à la notification d'événements.
+ **Enabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur booléenne indiquant si l'abonnement est activé. La valeur true indique que l'abonnement est activé.
+ **EventCategoriesList** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des catégories d'événements pour l'abonnement à la notification d'événements.
+ **EventSubscriptionArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de l'abonnement aux événements.
+ **SnsTopicArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  ARN de la rubrique de l'abonnement à la notification d'événements.
+ **SourceIdsList** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des sources IDs pour l'abonnement aux notifications d'événements.
+ **SourceType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Type de source pour l'abonnement à la notification d'événements.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  L'état de l'abonnement à la notification d'événements .

  Contraintes :

  Il peut s'agir de l'une des options suivantes : création \$1 modification \$1 suppression \$1 active \$1 sans autorisation \$1 topic-not-exist

  Le statut « pas de permission » indique que Neptune n'a plus l'autorisation de publier sur la rubrique SNS. Le statut « topic-not-exist » indique que le sujet a été supprimé après la création de l'abonnement.
+ **SubscriptionCreationTime** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Heure de création de l'abonnement à la notification d'événements.

**Erreurs**
+ [SubscriptionNotFoundFault](api-faults.md#SubscriptionNotFoundFault)
+ [SourceNotFoundFault](api-faults.md#SourceNotFoundFault)

## DescribeEvents (action)
<a name="DescribeEvents"></a>

         Le nom de la AWS CLI pour cette API est :`describe-events`.

Renvoie des événements associés aux instances de base de données, aux Security Groups DB, aux instantanés de base de données et aux groupes de paramètres de base de données des 14 derniers jours. Des événements propres à une instance de base de données, un Security Group DB, un instantané de base de données ou un groupe de paramètres de base de données en particulier peuvent être obtenus en fournissant le nom en tant que paramètre. Par défaut, la dernière heure d'événements est renvoyée.

**Demande**
+ **Duration**(dans la CLI :`--duration`) — un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Nombre de minutes pour lesquelles récupérer les événements.

  Par défaut : 60
+ **EndTime**(dans la CLI :`--end-time`) — a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

   Fin de l'intervalle de temps pour lequel récupérer les événements au format ISO 8601. Pour plus d'informations sur la norme ISO 8601, rendez-vous sur la [page Wikipédia ISO86 01](http://en.wikipedia.org/wiki/ISO_8601).

  Exemple : 2009-07-08T18:00Z
+ **EventCategories** (dans la CLI : `--event-categories`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des catégories d'événements qui déclenchent des notifications pour un abonnement à la notification d'événements.
+ **Filters** (dans la CLI : `--filters`) : tableau d'objets [Filtre](api-datatypes.md#Filter).

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

   Un jeton de pagination facultatif fourni par une DescribeEvents 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`.
+ **MaxRecords**(dans la CLI :`--max-records`) — un IntegerOptional, de type : `integer` (un 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.
+ **SourceIdentifier** (dans la CLI : `--source-identifier`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant de la source de l'événement pour laquelle les événements sont renvoyés. Si la valeur n'est pas spécifiée, toutes les sources sont incluses dans la réponse.

  Contraintes :
  + S'il SourceIdentifier est fourni, SourceType il doit également être fourni.
  + Si le type de source est `DBInstance`, un paramètre `DBInstanceIdentifier` doit être fourni.
  + Si le type de source est `DBSecurityGroup`, un paramètre `DBSecurityGroupName` doit être fourni.
  + Si le type de source est `DBParameterGroup`, un paramètre `DBParameterGroupName` doit être fourni.
  + Si le type de source est `DBSnapshot`, un paramètre `DBSnapshotIdentifier` doit être fourni.
  + Ne peut pas se terminer par un trait d'union ni contenir deux traits d'union consécutifs.
+ **SourceType**(dans la CLI :`--source-type`) — a SourceType, de type : `string` (une chaîne codée en UTF-8).

  Source de l'événement pour laquelle récupérer les événements. Si aucune valeur n'est spécifiée, tous les événements sont renvoyés.
+ **StartTime**(dans la CLI :`--start-time`) — a TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

   Début de l'intervalle de temps pour lequel récupérer les événements au format ISO 8601. Pour plus d'informations sur la norme ISO 8601, rendez-vous sur la [page Wikipédia ISO86 01](http://en.wikipedia.org/wiki/ISO_8601).

  Exemple : 2009-07-08T18:00Z

**Réponse**
+ **Events** : tableau d'objets [Événement](#Event).

   Liste des instances [Event (structure)](#Event).
+ **Marker** : chaîne de type : `string` (chaîne encodée en UTF-8).

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

## DescribeEventCategories (action)
<a name="DescribeEventCategories"></a>

         Le nom de la AWS CLI pour cette API est :`describe-event-categories`.

Affiche une liste des catégories de tous les types de sources de l'événement ou, si la valeur est spécifiée, d'un type de source donné.

**Demande**
+ **Filters** (dans la CLI : `--filters`) : tableau d'objets [Filtre](api-datatypes.md#Filter).

  Ce paramètre n'est actuellement pas pris en charge.
+ **SourceType** (dans la CLI : `--source-type`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Type de source qui génère les événements.

  Valeurs valides : db-instance \$1 \$1 db-parameter-group \$1 db-security-group db-snapshot

**Réponse**
+ **EventCategoriesMapList** : tableau d'objets [EventCategoriesMap](#EventCategoriesMap).

  Liste des types de EventCategoriesMap données.

## *Structures :*
<a name="api-events-structures-spacer"></a>

## Event (structure)
<a name="Event"></a>

 Ce type de données est utilisé comme élément de réponse dans l'action [DescribeEvents (action)](#DescribeEvents).

**Champs**
+ **Date**— Il s'agit d'un TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Spécifie la date et l'heure de l'événement.
+ **EventCategories** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie la catégorie pour l'événement.
+ **Message** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit le texte de cet événement.
+ **SourceArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  ARN (Amazon Resource Name) de l'événement.
+ **SourceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Fournit l'identifiant de la source de l'événement.
+ **SourceType**— Il s'agit d'une SourceType, de type : `string` (une chaîne codée en UTF-8).

  Spécifie le type de source pour cet événement.

## EventCategoriesMap (structure)
<a name="EventCategoriesMap"></a>

Contient les résultats d'une invocation réussie de l'action [DescribeEventCategories (action)](#DescribeEventCategories).

**Champs**
+ **EventCategories** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Catégories d'événements pour le type de source spécifié
+ **SourceType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Type de source auquel appartiennent les catégories retournés

## EventSubscription (structure)
<a name="EventSubscription"></a>

Contient les résultats d'une invocation réussie de l'action [DescribeEventSubscriptions (action)](#DescribeEventSubscriptions).

**Champs**
+ **CustomerAwsId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Compte client Amazon associé à l'abonnement aux notifications d'événements.
+ **CustSubscriptionId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  ID d'abonnement à la notification d'événements.
+ **Enabled** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur booléenne indiquant si l'abonnement est activé. La valeur true indique que l'abonnement est activé.
+ **EventCategoriesList** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des catégories d'événements pour l'abonnement à la notification d'événements.
+ **EventSubscriptionArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Amazon Resource Name (ARN) de l'abonnement aux événements.
+ **SnsTopicArn** : chaîne de type : `string` (chaîne encodée en UTF-8).

  ARN de la rubrique de l'abonnement à la notification d'événements.
+ **SourceIdsList** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Liste des sources IDs pour l'abonnement aux notifications d'événements.
+ **SourceType** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Type de source pour l'abonnement à la notification d'événements.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  L'état de l'abonnement à la notification d'événements .

  Contraintes :

  Il peut s'agir de l'une des options suivantes : création \$1 modification \$1 suppression \$1 active \$1 sans autorisation \$1 topic-not-exist

  Le statut « pas de permission » indique que Neptune n'a plus l'autorisation de publier sur la rubrique SNS. Le statut « topic-not-exist » indique que le sujet a été supprimé après la création de l'abonnement.
+ **SubscriptionCreationTime** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Heure de création de l'abonnement à la notification d'événements.

`EventSubscription` est utilisé comme élément de réponse pour :
+ [CreateEventSubscription](#CreateEventSubscription)
+ [ModifyEventSubscription](#ModifyEventSubscription)
+ [AddSourceIdentifierToSubscription](#AddSourceIdentifierToSubscription)
+ [RemoveSourceIdentifierFromSubscription](#RemoveSourceIdentifierFromSubscription)
+ [DeleteEventSubscription](#DeleteEventSubscription)

# Autre Neptune APIs
<a name="api-other-apis"></a>

**Actions :**
+ [AddTagsToResource (action)](#AddTagsToResource)
+ [ListTagsForResource (action)](#ListTagsForResource)
+ [RemoveTagsFromResource (action)](#RemoveTagsFromResource)
+ [ApplyPendingMaintenanceAction (action)](#ApplyPendingMaintenanceAction)
+ [DescribePendingMaintenanceActions (action)](#DescribePendingMaintenanceActions)
+ [Décrire DBEngine les versions (action)](#DescribeDBEngineVersions)

**Structures :**
+ [DBEngineVersion (structure)](#DBEngineVersion)
+ [EngineDefaults (structure)](#EngineDefaults)
+ [PendingMaintenanceAction (structure)](#PendingMaintenanceAction)
+ [ResourcePendingMaintenanceActions (structure)](#ResourcePendingMaintenanceActions)
+ [UpgradeTarget (structure)](#UpgradeTarget)
+ [Tag (structure)](#Tag)

## AddTagsToResource (action)
<a name="AddTagsToResource"></a>

         Le nom de la AWS CLI pour cette API est :`add-tags-to-resource`.

Ajoute des balises de métadonnées à une ressource Amazon Neptune. Ces balises peuvent être utilisées avec des rapports de répartition des coûts pour suivre les coûts associés aux ressources Amazon Neptune, ou dans une instruction de condition d'une stratégie IAM pour Amazon Neptune.

**Demande**
+ **ResourceName** (dans la CLI : `--resource-name`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Ressource Amazon Neptune à laquelle les balises sont ajoutées. Cette valeur est un Amazon Resource Name (ARN). Pour plus d'informations sur la création d'un ARN, consultez [ Création d'un Amazon Resource Name (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing).
+ **Tags** (dans la CLI : `--tags`) : *obligatoire :* tableau d'objets [Tag](#Tag).

  Balises à attribuer à la ressource Amazon Neptune.

**Réponse**
+ *Paramètres d'absence de réponse.*

**Erreurs**
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [DBSnapshotNotFoundFault](api-faults.md#DBSnapshotNotFoundFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)

## ListTagsForResource (action)
<a name="ListTagsForResource"></a>

         Le nom de la AWS CLI pour cette API est :`list-tags-for-resource`.

Répertorie toutes les balises sur une ressource Amazon Neptune.

**Demande**
+ **Filters** (dans la CLI : `--filters`) : tableau d'objets [Filtre](api-datatypes.md#Filter).

  Ce paramètre n'est actuellement pas pris en charge.
+ **ResourceName** (dans la CLI : `--resource-name`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Ressource Amazon Neptune avec balises à répertorier. Cette valeur est un Amazon Resource Name (ARN). Pour plus d'informations sur la création d'un ARN, consultez [ Création d'un Amazon Resource Name (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing).

**Réponse**
+ **TagList** : tableau d'objets [Tag](#Tag).

  Liste des balises renvoyées par l' ListTagsForResource opération.

**Erreurs**
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [DBSnapshotNotFoundFault](api-faults.md#DBSnapshotNotFoundFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)

## RemoveTagsFromResource (action)
<a name="RemoveTagsFromResource"></a>

         Le nom de la AWS CLI pour cette API est :`remove-tags-from-resource`.

Supprime des balises de métadonnées d'une ressource Amazon Neptune.

**Demande**
+ **ResourceName** (dans la CLI : `--resource-name`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Ressource Amazon Neptune de laquelle les balises sont supprimées. Cette valeur est un Amazon Resource Name (ARN). Pour plus d'informations sur la création d'un ARN, consultez [ Création d'un Amazon Resource Name (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing).
+ **TagKeys** (dans la CLI : `--tag-keys`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Clé de balise (nom) de la balise à supprimer.

**Réponse**
+ *Paramètres d'absence de réponse.*

**Erreurs**
+ [DBInstanceNotFoundFault](api-faults.md#DBInstanceNotFoundFault)
+ [DBSnapshotNotFoundFault](api-faults.md#DBSnapshotNotFoundFault)
+ [DBClusterNotFoundFault](api-faults.md#DBClusterNotFoundFault)

## ApplyPendingMaintenanceAction (action)
<a name="ApplyPendingMaintenanceAction"></a>

         Le nom de la AWS CLI pour cette API est :`apply-pending-maintenance-action`.

Applique une action de maintenance en attente à une ressource (par exemple, à une instance de base de données).

**Demande**
+ **ApplyAction** (dans la CLI : `--apply-action`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Action de maintenance en attente à appliquer à cette ressource.

  Valeurs valides : `system-update`, `db-upgrade`
+ **OptInType** (dans la CLI : `--opt-in-type`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Valeur qui spécifie le type de demande de confirmation de l'acceptation ou annule cette dernière. Un type demande de confirmation de l'acceptation de type `immediate` ne peut pas être annulée.

  Valeurs valides :
  + `immediate` - Appliquer immédiatement l'action de maintenance.
  + `next-maintenance` - Appliquer l'action de maintenance pendant le créneau de maintenance suivant pour la ressource.
  + `undo-opt-in` - Annuler toute demande de confirmation de l'acceptation `next-maintenance` existante.
+ **ResourceIdentifier** (dans la CLI : `--resource-identifier`) : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  ARN (Amazon Resource Name) de la ressource à laquelle s'applique l'action de maintenance en attente. Pour plus d'informations sur la création d'un ARN, consultez [ Création d'un Amazon Resource Name (ARN)](https://docs.aws.amazon.com/neptune/latest/UserGuide/tagging.ARN.html#tagging.ARN.Constructing).

**Réponse**

Décrit les actions de maintenance en attente pour une ressource.
+ **PendingMaintenanceActionDetails** : tableau d'objets [PendingMaintenanceAction](#PendingMaintenanceAction).

  Liste qui fournit des détails sur les actions de maintenance en attente pour la ressource.
+ **ResourceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  ARN de la ressource qui possède les actions de maintenance en attente.

**Erreurs**
+ [ResourceNotFoundFault](api-faults.md#ResourceNotFoundFault)

## DescribePendingMaintenanceActions (action)
<a name="DescribePendingMaintenanceActions"></a>

         Le nom de la AWS CLI pour cette API est :`describe-pending-maintenance-actions`.

Renvoie une liste des ressources (par exemple, des instances de base de données) ayant au moins une action de maintenance en attente.

**Demande**
+ **Filters** (dans la CLI : `--filters`) : tableau d'objets [Filtre](api-datatypes.md#Filter).

  Filtre qui spécifie une ou plusieurs ressources pour lesquelles renvoyer des actions de maintenance en attente.

  Filtres pris en charge :
  +  `db-cluster-id`- Accepte les identifiants de cluster de base de données et les Amazon Resource Names (ARNs) du cluster de bases de données. La liste des résultats inclura uniquement les actions de maintenance en attente pour les clusters de base de données identifiés par ceux-ci ARNs.
  +  `db-instance-id`- Accepte les identifiants d'instance de base de données et les instances ARNs de base de données. La liste des résultats inclura uniquement les actions de maintenance en attente pour les instances de base de données identifiées par celles-ci ARNs.
+ **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 `DescribePendingMaintenanceActions` précédente. Si ce paramètre est spécifié, la réponse inclut uniquement des enregistrements supérieurs au marqueur, jusqu'à un nombre d'enregistrements spécifié par `MaxRecords`.
+ **MaxRecords**(dans la CLI :`--max-records`) — un IntegerOptional, de type : `integer` (un 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.
+ **ResourceIdentifier** (dans la CLI : `--resource-identifier`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  ARN d'une ressource pour laquelle renvoyer des actions de maintenance en attente.

**Réponse**
+ **Marker** : chaîne de type : `string` (chaîne encodée en UTF-8).

   Jeton de pagination facultatif fourni par une demande `DescribePendingMaintenanceActions` précédente. Si ce paramètre est spécifié, la réponse inclut uniquement des enregistrements supérieurs au marqueur, jusqu'à un nombre d'enregistrements spécifié par `MaxRecords`.
+ **PendingMaintenanceActions** : tableau d'objets [ResourcePendingMaintenanceActions](#ResourcePendingMaintenanceActions).

  Liste des actions de maintenance en attente pour la ressource.

**Erreurs**
+ [ResourceNotFoundFault](api-faults.md#ResourceNotFoundFault)

## Décrire DBEngine les versions (action)
<a name="DescribeDBEngineVersions"></a>

         Le nom de la AWS CLI pour cette API est :`describe-db-engine-versions`.

Renvoie une liste des moteurs de base de données disponibles.

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

  Nom d'une famille de groupe de paramètres de base de données spécifique pour laquelle renvoyer les détails.

  Contraintes :
  + S'il est fourni, il doit correspondre à un existant DBParameterGroupFamily.
+ **DefaultOnly** (dans la CLI : `--default-only`) : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique que seule la version par défaut du moteur spécifié ou de l'association moteur et version majeure est renvoyée.
+ **Engine** (dans la CLI : `--engine`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Moteur de base de données à renvoyer.
+ **EngineVersion** (dans la CLI : `--engine-version`) : chaîne de type : `string` (chaîne encodée en UTF-8).

  Version du moteur de base de données à renvoyer.

  Exemple : `5.1.49`
+ **Filters** (dans la CLI : `--filters`) : tableau d'objets [Filtre](api-datatypes.md#Filter).

  Cette option n'est pas prise en charge actuellement.
+ **ListSupportedCharacterSets**(dans la CLI :`--list-supported-character-sets`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Si ce paramètre est spécifié et que le moteur demandé prend en charge le paramètre `CharacterSetName` pour `CreateDBInstance`, la réponse inclut une liste des jeux de caractères pris en charge pour chaque version de moteur.
+ **ListSupportedTimezones**(dans la CLI :`--list-supported-timezones`) — a BooleanOptional, de type : `boolean` (une valeur booléenne (vraie ou fausse)).

  Si ce paramètre est spécifié et que le moteur demandé prend en charge le paramètre `TimeZone` pour `CreateDBInstance`, la réponse inclut une liste des fuseaux horaires pris en charge pour chaque version de moteur.
+ **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 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`) — un IntegerOptional, de type : `integer` (un 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`, un jeton de pagination appelé marqueur est inclus dans la réponse pour permettre la récupération des résultats suivants.

  Par défaut : 100

  Contraintes : Minimum 20, maximum 100.

**Réponse**
+ **DBEngineVersions** : tableau d'objets [DBEngineVersion](#DBEngineVersion).

   Une liste des éléments `DBEngineVersion`.
+ **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`.

## *Structures :*
<a name="api-other-apis-structures-spacer"></a>

## DBEngineVersion (structure)
<a name="DBEngineVersion"></a>

 Ce type de données est utilisé comme élément de réponse dans l'action [Décrire DBEngine les versions (action)](#DescribeDBEngineVersions).

**Champs**
+ **DBEngineDescription** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Description du moteur de base de données.
+ **DBEngineVersionDescription** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Description de la version du moteur de base de données.
+ **DBParameterGroupFamily** : 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 pour le moteur de base de données.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom du moteur de base de données.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Le numéro de version du moteur de base de données.
+ **ExportableLogTypes** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Types de journaux disponibles pour exportation vers CloudWatch Logs par le moteur de base de données.
+ **SupportedTimezones** : tableau d'objets [Fuseau horaire](api-datatypes.md#Timezone).

  Liste des fuseaux horaires pris en charge par ce moteur pour le paramètre `Timezone` de l'action `CreateDBInstance`.
+ **SupportsGlobalDatabases** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur qui indique si vous pouvez utiliser les bases de données globales Neptune avec une version de moteur de base de données spécifique.
+ **SupportsLogExportsToCloudwatchLogs** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Une valeur qui indique si la version du moteur prend en charge l'exportation des types de journaux spécifiés par ExportableLogTypes to CloudWatch Logs.
+ **SupportsReadReplica** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Indique si la version du moteur de base de données prend en charge les réplicas en lecture.
+ **ValidUpgradeTarget** : tableau d'objets [UpgradeTarget](#UpgradeTarget).

  Liste des versions de moteur vers lesquelles cette version du moteur de base de données peut être mise à niveau.

## EngineDefaults (structure)
<a name="EngineDefaults"></a>

 Contient le résultat d'une invocation réussie de l'action [DescribeEngineDefaultParameters (action)](api-parameters.md#DescribeEngineDefaultParameters).

**Champs**
+ **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).

   Un jeton de pagination facultatif fourni par une EngineDefaults 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](api-parameters.md#Parameter).

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

`EngineDefaults` est utilisé comme élément de réponse pour :
+ [DescribeEngineDefaultParameters](api-parameters.md#DescribeEngineDefaultParameters)
+ [DescribeEngineDefaultClusterParameters](api-parameters.md#DescribeEngineDefaultClusterParameters)

## PendingMaintenanceAction (structure)
<a name="PendingMaintenanceAction"></a>

Fournit des informations sur une action de maintenance en attente pour une ressource.

**Champs**
+ **Action** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Type d'action de maintenance en attente disponible pour la ressource.
+ **AutoAppliedAfterDate**— Il s'agit d'un TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Date de la fenêtre de maintenance lorsque l'action est appliquée. L'action de maintenance est appliquée à la ressource lors de sa première fenêtre de maintenance après cette date. Si cette date est spécifiée, toutes les demandes de confirmation de l'acceptation `next-maintenance` sont ignorées.
+ **CurrentApplyDate**— Il s'agit d'un TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Date effective d'application de l'action de maintenance en attente à la ressource. Cette date tient compte des demandes de confirmation de l'acceptation de compte reçues à partir de l'API [ApplyPendingMaintenanceAction (action)](#ApplyPendingMaintenanceAction), le paramètre `AutoAppliedAfterDate` et le paramètre `ForcedApplyDate`. Ce champ est vide si une demande de confirmation de l'acceptation n'a pas été reçue et rien n'a été spécifié comme `AutoAppliedAfterDate` ou `ForcedApplyDate`.
+ **Description** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Description fournissant plus de détails sur l'action de maintenance.
+ **ForcedApplyDate**— Il s'agit d'un TStamp, de type : `timestamp` (un point dans le temps, généralement défini comme un décalage par rapport à minuit le 01/01/1970).

  Date à laquelle l'action de maintenance est automatiquement appliquée. L'action de maintenance est appliquée à la ressource à cette date indépendamment de la fenêtre de maintenance de la ressource. Si cette date est spécifiée, toutes les demandes de confirmation de l'acceptation `immediate` sont ignorées.
+ **OptInStatus** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Indique le type de demande de confirmation de l'acceptation reçue pour la ressource.

## ResourcePendingMaintenanceActions (structure)
<a name="ResourcePendingMaintenanceActions"></a>

Décrit les actions de maintenance en attente pour une ressource.

**Champs**
+ **PendingMaintenanceActionDetails** : tableau d'objets [PendingMaintenanceAction](#PendingMaintenanceAction).

  Liste qui fournit des détails sur les actions de maintenance en attente pour la ressource.
+ **ResourceIdentifier** : chaîne de type : `string` (chaîne encodée en UTF-8).

  ARN de la ressource qui possède les actions de maintenance en attente.

`ResourcePendingMaintenanceActions` est utilisé comme élément de réponse pour :
+ [ApplyPendingMaintenanceAction](#ApplyPendingMaintenanceAction)

## UpgradeTarget (structure)
<a name="UpgradeTarget"></a>

Version du moteur de base de données vers laquelle une instance de base de données peut être mise à niveau.

**Champs**
+ **AutoUpgrade** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Une valeur qui indique si la version cible est appliquée à toutes les instances de base de données source AutoMinorVersionUpgrade définies sur true.
+ **Description** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Version du moteur de base de données vers laquelle une instance de base de données peut être mise à niveau.
+ **Engine** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom du moteur de base de données cible mis à niveau.
+ **EngineVersion** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Numéro de version du moteur de base de données cible mis à niveau.
+ **IsMajorVersionUpgrade** : valeur booléenne de type : `boolean` (valeur booléenne : true ou false).

  Valeur qui indique si un moteur de base de données est mis à niveau vers une version majeure.
+ **SupportsGlobalDatabases**— Il s'agit d'une BooleanOptional valeur booléenne `boolean` (vraie ou fausse) du type : (valeur booléenne).

  Valeur qui indique si vous pouvez utiliser les bases de données globales Neptune avec la version de moteur cible.

## Tag (structure)
<a name="Tag"></a>

Métadonnée attribuée à une ressource Amazon Neptune composée d'une paire clé-valeur.

**Champs**
+ **Key** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Une clé est le nom obligatoire de la balise. La valeur de la chaîne peut comporter de 1 à 128 caractères Unicode et elle ne peut pas être précédée de la mention `aws:` ou `rds:`. La chaîne peut uniquement contenir l'ensemble de lettres, de chiffres et d'espaces Unicode, '\$1', '.', '/', '=', '\$1', '-' (regex Java : "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").
+ **Value** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Une valeur est la valeur facultative de la balise. La valeur de la chaîne peut comporter de 1 à 256 caractères Unicode et elle ne peut pas être précédée de la mention `aws:` ou `rds:`. La chaîne peut uniquement contenir l'ensemble de lettres, de chiffres et d'espaces Unicode, '\$1', '.', '/', '=', '\$1', '-' (regex Java : "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").

# Types de données Neptune courants
<a name="api-datatypes"></a>

**Structures :**
+ [AvailabilityZone (structure)](#AvailabilityZone)
+ [DBSecurityGroupMembership (structure)](#DBSecurityGroupMembership)
+ [DomainMembership (structure)](#DomainMembership)
+ [DoubleRange (structure)](#DoubleRange)
+ [Endpoint (structure)](#Endpoint)
+ [Filter (structure)](#Filter)
+ [Range (structure)](#Range)
+ [ServerlessV2 ScalingConfiguration (structure)](#ServerlessV2ScalingConfiguration)
+ [ServerlessV2 ScalingConfigurationInfo (structure)](#ServerlessV2ScalingConfigurationInfo)
+ [Timezone (structure)](#Timezone)
+ [VpcSecurityGroupMembership (structure)](#VpcSecurityGroupMembership)

## AvailabilityZone (structure)
<a name="AvailabilityZone"></a>

Spécifie une zone de disponibilité.

**Champs**
+ **Name** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom de la zone de disponibilité.

## DBSecurityGroupMembership (structure)
<a name="DBSecurityGroupMembership"></a>

Spécifie l'appartenance à un Security Group DB désigné.

**Champs**
+ **DBSecurityGroupName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom du Security Group DB.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Statut du Security Group DB.

## DomainMembership (structure)
<a name="DomainMembership"></a>

Enregistrement de l'appartenance au domaine Active Directory associé à une instance de base de données.

**Champs**
+ **Domain** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Identifiant du domaine Active Directory.
+ **FQDN** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom de domaine complet du domaine Active Directory.
+ **IAMRoleName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom du rôle IAM à utiliser pour effectuer des appels d'API à Directory Service.
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Statut de l'instance de l'appartenance au domaine Active Directory de l'instance de base de données, tel que joint, en attente, échec, etc.).

## DoubleRange (structure)
<a name="DoubleRange"></a>

Plage de valeurs doubles.

**Champs**
+ **From** : double de type : `double` (nombre à virgule flottante IEEE 754 à double précision).

  Valeur minimum de la plage.
+ **To** : double de type : `double` (nombre à virgule flottante IEEE 754 à double précision).

  Valeur maximum de la plage.

## Endpoint (structure)
<a name="Endpoint"></a>

Spécifie un point de terminaison de connexion.

Pour la structure de données qui représente les points de terminaison du cluster de bases de données Amazon Neptune, consultez `DBClusterEndpoint`.

**Champs**
+ **Address** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'adresse DNS de l'instance de base de données.
+ **HostedZoneId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Spécifie l'ID attribué par Amazon Route 53 lorsque vous créez une zone hébergée.
+ **Port** : entier de type : `integer` (entier signé de 32 bits).

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

## Filter (structure)
<a name="Filter"></a>

Ce type n'est actuellement pas pris en charge.

**Champs**
+ **Name** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

  Ce paramètre n'est actuellement pas pris en charge.
+ **Values** : *obligatoire :* chaîne de type : `string` (chaîne encodée en UTF-8).

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

## Range (structure)
<a name="Range"></a>

Plage de valeurs entières.

**Champs**
+ **From** : entier de type : `integer` (entier signé de 32 bits).

  Valeur minimum de la plage.
+ **Step**— Il s'agit d'un IntegerOptional, de type : `integer` (un entier signé de 32 bits).

  Valeur de pas de la plage. Par exemple, si vous avez une plage de 5 000 à 10 000, avec une valeur de pas de 1 000, les valeurs valides commencent à 5 000 et augmentent de 1 000. Même si 7 500 se trouve dans la plage, ce n'est pas une valeur valide. Les valeurs valides sont 5 000, 6 000, 7 000 et 8 000...
+ **To** : entier de type : `integer` (entier signé de 32 bits).

  Valeur maximum de la plage.

## ServerlessV2 ScalingConfiguration (structure)
<a name="ServerlessV2ScalingConfiguration"></a>

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

Pour plus d'informations, consultez [Utilisation d'Amazon Neptune sans serveur](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) dans le *Guide de l'utilisateur Amazon Neptune*.

**Champs**
+ **MaxCapacity**— Il s'agit d'un DoubleOptional, de type : `double` (un nombre à virgule flottante IEEE 754 à double précision).

  Nombre maximal d'unités de capacité Neptune (NCUs) pour une instance de base de données dans un cluster Neptune Serverless. Vous pouvez spécifier les valeurs NCU par paliers de 0,5, par exemple 40, 40,5, 41, etc.
+ **MinCapacity**— Il s'agit d'un DoubleOptional, de type : `double` (un nombre à virgule flottante IEEE 754 à double précision).

  Le nombre minimum d'unités de capacité Neptune (NCUs) pour une instance de base de données dans un cluster Neptune Serverless. Vous pouvez spécifier les valeurs NCU par paliers de 0,5, par exemple 8, 8,5, 9, etc.

## ServerlessV2 ScalingConfigurationInfo (structure)
<a name="ServerlessV2ScalingConfigurationInfo"></a>

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

Pour plus d'informations, consultez [Utilisation d'Amazon Neptune sans serveur](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) dans le *Guide de l'utilisateur Amazon Neptune*.

**Champs**
+ **MaxCapacity**— Il s'agit d'un DoubleOptional, de type : `double` (un nombre à virgule flottante IEEE 754 à double précision).

  Nombre maximal d'unités de capacité Neptune (NCUs) pour une instance de base de données dans un cluster Neptune Serverless. Vous pouvez spécifier les valeurs NCU par paliers de 0,5, par exemple 40, 40,5, 41, etc.
+ **MinCapacity**— Il s'agit d'un DoubleOptional, de type : `double` (un nombre à virgule flottante IEEE 754 à double précision).

  Le nombre minimum d'unités de capacité Neptune (NCUs) pour une instance de base de données dans un cluster Neptune Serverless. Vous pouvez spécifier les valeurs NCU par paliers de 0,5, par exemple 8, 8,5, 9, etc.

## Timezone (structure)
<a name="Timezone"></a>

Un fuseau horaire associé à une [DBInstance (structure)](api-instances.md#DBInstance).

**Champs**
+ **TimezoneName** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom du fuseau horaire.

## VpcSecurityGroupMembership (structure)
<a name="VpcSecurityGroupMembership"></a>

Type de données utilisé comme un élément de réponse pour les requêtes sur l'appartenance de groupe de sécurité VPC.

**Champs**
+ **Status** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Statut du groupe de sécurité VPC.
+ **VpcSecurityGroupId** : chaîne de type : `string` (chaîne encodée en UTF-8).

  Nom du groupe de sécurité VPC.

# Neptune : exceptions spécifiques à un individu APIs
<a name="api-faults"></a>

**Exceptions :**
+ [AuthorizationAlreadyExistsFault (structure)](#AuthorizationAlreadyExistsFault)
+ [AuthorizationNotFoundFault (structure)](#AuthorizationNotFoundFault)
+ [AuthorizationQuotaExceededFault (structure)](#AuthorizationQuotaExceededFault)
+ [CertificateNotFoundFault (structure)](#CertificateNotFoundFault)
+ [DBClusterAlreadyExistsFault (structure)](#DBClusterAlreadyExistsFault)
+ [DBClusterNotFoundFault (structure)](#DBClusterNotFoundFault)
+ [DBClusterParameterGroupNotFoundFault (structure)](#DBClusterParameterGroupNotFoundFault)
+ [DBClusterQuotaExceededFault (structure)](#DBClusterQuotaExceededFault)
+ [DBClusterRoleAlreadyExistsFault (structure)](#DBClusterRoleAlreadyExistsFault)
+ [DBClusterRoleNotFoundFault (structure)](#DBClusterRoleNotFoundFault)
+ [DBClusterRoleQuotaExceededFault (structure)](#DBClusterRoleQuotaExceededFault)
+ [DBClusterSnapshotAlreadyExistsFault (structure)](#DBClusterSnapshotAlreadyExistsFault)
+ [DBClusterSnapshotNotFoundFault (structure)](#DBClusterSnapshotNotFoundFault)
+ [DBInstanceAlreadyExistsFault (structure)](#DBInstanceAlreadyExistsFault)
+ [DBInstanceNotFoundFault (structure)](#DBInstanceNotFoundFault)
+ [DBLogFileNotFoundFault (structure)](#DBLogFileNotFoundFault)
+ [DBParameterGroupAlreadyExistsFault (structure)](#DBParameterGroupAlreadyExistsFault)
+ [DBParameterGroupNotFoundFault (structure)](#DBParameterGroupNotFoundFault)
+ [DBParameterGroupQuotaExceededFault (structure)](#DBParameterGroupQuotaExceededFault)
+ [DBSecurityGroupAlreadyExistsFault (structure)](#DBSecurityGroupAlreadyExistsFault)
+ [DBSecurityGroupNotFoundFault (structure)](#DBSecurityGroupNotFoundFault)
+ [DBSecurityGroupNotSupportedFault (structure)](#DBSecurityGroupNotSupportedFault)
+ [DBSecurityGroupQuotaExceededFault (structure)](#DBSecurityGroupQuotaExceededFault)
+ [DBSnapshotAlreadyExistsFault (structure)](#DBSnapshotAlreadyExistsFault)
+ [DBSnapshotNotFoundFault (structure)](#DBSnapshotNotFoundFault)
+ [DBSubnetGroupAlreadyExistsFault (structure)](#DBSubnetGroupAlreadyExistsFault)
+ [DBSubnetGroupDoesNotCoverEnoughAZs (structure)](#DBSubnetGroupDoesNotCoverEnoughAZs)
+ [DBSubnetGroupNotAllowedFault (structure)](#DBSubnetGroupNotAllowedFault)
+ [DBSubnetGroupNotFoundFault (structure)](#DBSubnetGroupNotFoundFault)
+ [DBSubnetGroupQuotaExceededFault (structure)](#DBSubnetGroupQuotaExceededFault)
+ [DBSubnetQuotaExceededFault (structure)](#DBSubnetQuotaExceededFault)
+ [DBUpgradeDependencyFailureFault (structure)](#DBUpgradeDependencyFailureFault)
+ [DomainNotFoundFault (structure)](#DomainNotFoundFault)
+ [EventSubscriptionQuotaExceededFault (structure)](#EventSubscriptionQuotaExceededFault)
+ [GlobalClusterAlreadyExistsFault (structure)](#GlobalClusterAlreadyExistsFault)
+ [GlobalClusterNotFoundFault (structure)](#GlobalClusterNotFoundFault)
+ [GlobalClusterQuotaExceededFault (structure)](#GlobalClusterQuotaExceededFault)
+ [InstanceQuotaExceededFault (structure)](#InstanceQuotaExceededFault)
+ [Insuffisant DBCluster CapacityFault (structure)](#InsufficientDBClusterCapacityFault)
+ [Insuffisant DBInstance CapacityFault (structure)](#InsufficientDBInstanceCapacityFault)
+ [InsufficientStorageClusterCapacityFault (structure)](#InsufficientStorageClusterCapacityFault)
+ [Non valide DBCluster EndpointStateFault (structure)](#InvalidDBClusterEndpointStateFault)
+ [Non valide DBCluster SnapshotStateFault (structure)](#InvalidDBClusterSnapshotStateFault)
+ [Non valide DBCluster StateFault (structure)](#InvalidDBClusterStateFault)
+ [Non valide DBInstance StateFault (structure)](#InvalidDBInstanceStateFault)
+ [Non valide DBParameter GroupStateFault (structure)](#InvalidDBParameterGroupStateFault)
+ [Non valide DBSecurity GroupStateFault (structure)](#InvalidDBSecurityGroupStateFault)
+ [Non valide DBSnapshot StateFault (structure)](#InvalidDBSnapshotStateFault)
+ [Non valide DBSubnet GroupFault (structure)](#InvalidDBSubnetGroupFault)
+ [Non valide DBSubnet GroupStateFault (structure)](#InvalidDBSubnetGroupStateFault)
+ [Non valide DBSubnet StateFault (structure)](#InvalidDBSubnetStateFault)
+ [InvalidEventSubscriptionStateFault (structure)](#InvalidEventSubscriptionStateFault)
+ [InvalidGlobalClusterStateFault (structure)](#InvalidGlobalClusterStateFault)
+ [InvalidOptionGroupStateFault (structure)](#InvalidOptionGroupStateFault)
+ [InvalidRestoreFault (structure)](#InvalidRestoreFault)
+ [InvalidSubnet (structure)](#InvalidSubnet)
+ [Non valide VPCNetwork StateFault (structure)](#InvalidVPCNetworkStateFault)
+ [KMSKeyNotAccessibleFault (structure)](#KMSKeyNotAccessibleFault)
+ [OptionGroupNotFoundFault (structure)](#OptionGroupNotFoundFault)
+ [PointInTimeRestoreNotEnabledFault (structure)](#PointInTimeRestoreNotEnabledFault)
+ [ProvisionedIopsNotAvailableInAZFault (structure)](#ProvisionedIopsNotAvailableInAZFault)
+ [ResourceNotFoundFault (structure)](#ResourceNotFoundFault)
+ [SNSInvalidTopicFault (structure)](#SNSInvalidTopicFault)
+ [SNSNoAuthorizationFault (structure)](#SNSNoAuthorizationFault)
+ [SNSTopicArnNotFoundFault (structure)](#SNSTopicArnNotFoundFault)
+ [SharedSnapshotQuotaExceededFault (structure)](#SharedSnapshotQuotaExceededFault)
+ [SnapshotQuotaExceededFault (structure)](#SnapshotQuotaExceededFault)
+ [SourceNotFoundFault (structure)](#SourceNotFoundFault)
+ [StorageQuotaExceededFault (structure)](#StorageQuotaExceededFault)
+ [StorageTypeNotSupportedFault (structure)](#StorageTypeNotSupportedFault)
+ [SubnetAlreadyInUse (structure)](#SubnetAlreadyInUse)
+ [SubscriptionAlreadyExistFault (structure)](#SubscriptionAlreadyExistFault)
+ [SubscriptionCategoryNotFoundFault (structure)](#SubscriptionCategoryNotFoundFault)
+ [SubscriptionNotFoundFault (structure)](#SubscriptionNotFoundFault)

## AuthorizationAlreadyExistsFault (structure)
<a name="AuthorizationAlreadyExistsFault"></a>

**Code de statut HTTP retourné : ** 400.

Le CIDRIP ou le groupe de EC2 sécurité spécifié est déjà autorisé pour le groupe de sécurité de base de données spécifié.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## AuthorizationNotFoundFault (structure)
<a name="AuthorizationNotFoundFault"></a>

**Code de statut HTTP retourné :** 404.

Le CIDRIP ou le groupe EC2 de sécurité spécifié n'est pas autorisé pour le groupe de sécurité de base de données spécifié.

Neptune peut également ne pas être autorisé via IAM pour exécuter les actions nécessaires en votre nom.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## AuthorizationQuotaExceededFault (structure)
<a name="AuthorizationQuotaExceededFault"></a>

**Code de statut HTTP retourné : ** 400.

Un quota d'autorisation du Security Group DB a été atteint.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## CertificateNotFoundFault (structure)
<a name="CertificateNotFoundFault"></a>

**Code de statut HTTP retourné :** 404.

*CertificateIdentifier*ne fait pas référence à un certificat existant.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBClusterAlreadyExistsFault (structure)
<a name="DBClusterAlreadyExistsFault"></a>

**Code de statut HTTP retourné : ** 400.

Un utilisateur possède déjà un cluster de bases de données avec l'identifiant donné.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBClusterNotFoundFault (structure)
<a name="DBClusterNotFoundFault"></a>

**Code de statut HTTP retourné :** 404.

*DBClusterL'identifiant* ne fait pas référence à un cluster de base de données existant.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBClusterParameterGroupNotFoundFault (structure)
<a name="DBClusterParameterGroupNotFoundFault"></a>

**Code de statut HTTP retourné :** 404.

*DBClusterParameterGroupName*ne fait pas référence à un groupe de paramètres de cluster de base de données existant.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBClusterQuotaExceededFault (structure)
<a name="DBClusterQuotaExceededFault"></a>

**Code de statut HTTP retourné :** 403.

Un utilisateur a tenté de créer un nouveau cluster de bases de données et il a déjà atteint le quota maximum de cluster de bases de données autorisé.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBClusterRoleAlreadyExistsFault (structure)
<a name="DBClusterRoleAlreadyExistsFault"></a>

**Code de statut HTTP retourné : ** 400.

L'ARN (Amazon Resource Name) du rôle IAM spécifié est déjà associé au cluster de bases de données spécifié.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBClusterRoleNotFoundFault (structure)
<a name="DBClusterRoleNotFoundFault"></a>

**Code de statut HTTP retourné :** 404.

L'ARN (Amazon Resource Name) du rôle IAM spécifié n'est pas associé au cluster de bases de données spécifié.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBClusterRoleQuotaExceededFault (structure)
<a name="DBClusterRoleQuotaExceededFault"></a>

**Code de statut HTTP retourné : ** 400.

Vous avez dépassé le nombre maximal de rôles IAM pouvant être associés au cluster de bases de données spécifié.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBClusterSnapshotAlreadyExistsFault (structure)
<a name="DBClusterSnapshotAlreadyExistsFault"></a>

**Code de statut HTTP retourné : ** 400.

Un utilisateur possède déjà un instantané de cluster de bases de données avec l'identifiant donné.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBClusterSnapshotNotFoundFault (structure)
<a name="DBClusterSnapshotNotFoundFault"></a>

**Code de statut HTTP retourné :** 404.

*DBClusterSnapshotIdentifier*ne fait pas référence à un instantané de cluster de base de données existant.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBInstanceAlreadyExistsFault (structure)
<a name="DBInstanceAlreadyExistsFault"></a>

**Code de statut HTTP retourné : ** 400.

Un utilisateur possède déjà une instance de base de données avec l'identifiant donné.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBInstanceNotFoundFault (structure)
<a name="DBInstanceNotFoundFault"></a>

**Code de statut HTTP retourné :** 404.

*DBInstanceL'identifiant* ne fait pas référence à une instance de base de données existante.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBLogFileNotFoundFault (structure)
<a name="DBLogFileNotFoundFault"></a>

**Code de statut HTTP retourné :** 404.

 *LogFileName*ne fait pas référence à un fichier journal de base de données existant.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBParameterGroupAlreadyExistsFault (structure)
<a name="DBParameterGroupAlreadyExistsFault"></a>

**Code de statut HTTP retourné : ** 400.

Un groupe de paramètres de base de données avec le même nom existe.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBParameterGroupNotFoundFault (structure)
<a name="DBParameterGroupNotFoundFault"></a>

**Code de statut HTTP retourné :** 404.

*DBParameterGroupName*ne fait pas référence à un groupe de paramètres de base de données existant.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBParameterGroupQuotaExceededFault (structure)
<a name="DBParameterGroupQuotaExceededFault"></a>

**Code de statut HTTP retourné : ** 400.

Une demande entraînerait le dépassement par l'utilisateur du nombre de groupes de paramètres de base de données.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBSecurityGroupAlreadyExistsFault (structure)
<a name="DBSecurityGroupAlreadyExistsFault"></a>

**Code de statut HTTP retourné : ** 400.

Un groupe de sécurité de base de données dont le nom est spécifié dans existe *DBSecurityGroupName*déjà.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBSecurityGroupNotFoundFault (structure)
<a name="DBSecurityGroupNotFoundFault"></a>

**Code de statut HTTP retourné :** 404.

*DBSecurityGroupName*ne fait pas référence à un groupe de sécurité de base de données existant.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBSecurityGroupNotSupportedFault (structure)
<a name="DBSecurityGroupNotSupportedFault"></a>

**Code de statut HTTP retourné : ** 400.

Un Security Group DB n'est pas autorisé pour cette action.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBSecurityGroupQuotaExceededFault (structure)
<a name="DBSecurityGroupQuotaExceededFault"></a>

**Code de statut HTTP retourné : ** 400.

Une demande entraînerait le dépassement par l'utilisateur du nombre de Security Groups DB.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBSnapshotAlreadyExistsFault (structure)
<a name="DBSnapshotAlreadyExistsFault"></a>

**Code de statut HTTP retourné : ** 400.

*DBSnapshotL'identifiant* est déjà utilisé par un instantané existant.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBSnapshotNotFoundFault (structure)
<a name="DBSnapshotNotFoundFault"></a>

**Code de statut HTTP retourné :** 404.

*DBSnapshotL'identifiant* ne fait pas référence à un instantané de base de données existant.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBSubnetGroupAlreadyExistsFault (structure)
<a name="DBSubnetGroupAlreadyExistsFault"></a>

**Code de statut HTTP retourné : ** 400.

*DBSubnetGroupName*est déjà utilisé par un groupe de sous-réseaux de base de données existant.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBSubnetGroupDoesNotCoverEnoughAZs (structure)
<a name="DBSubnetGroupDoesNotCoverEnoughAZs"></a>

**Code de statut HTTP retourné : ** 400.

Des sous-réseaux du groupe de sous-réseaux de base de données doivent couvrir au moins deux zones de disponibilité, sauf s'il n'y en a qu'une seule.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBSubnetGroupNotAllowedFault (structure)
<a name="DBSubnetGroupNotAllowedFault"></a>

**Code de statut HTTP retourné : ** 400.

Indique que le DBSubnet groupe ne doit pas être spécifié lors de la création de répliques de lecture situées dans la même région que l'instance source.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBSubnetGroupNotFoundFault (structure)
<a name="DBSubnetGroupNotFoundFault"></a>

**Code de statut HTTP retourné :** 404.

*DBSubnetGroupName*ne fait pas référence à un groupe de sous-réseaux de base de données existant.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBSubnetGroupQuotaExceededFault (structure)
<a name="DBSubnetGroupQuotaExceededFault"></a>

**Code de statut HTTP retourné : ** 400.

Une demande entraînerait le dépassement par l'utilisateur du nombre de groupes de sous-réseaux de base de données.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBSubnetQuotaExceededFault (structure)
<a name="DBSubnetQuotaExceededFault"></a>

**Code de statut HTTP retourné : ** 400.

Une demande entraînerait le dépassement par l'utilisateur du nombre de sous-réseaux dans un groupe de base de données.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DBUpgradeDependencyFailureFault (structure)
<a name="DBUpgradeDependencyFailureFault"></a>

**Code de statut HTTP retourné : ** 400.

La mise à niveau de base de données a échoué, car une ressource dont dépendait la base de données n'a pas pu être modifiée.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## DomainNotFoundFault (structure)
<a name="DomainNotFoundFault"></a>

**Code de statut HTTP retourné :** 404.

*Domain* ne fait pas référence à un domaine Active Directory existant.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## EventSubscriptionQuotaExceededFault (structure)
<a name="EventSubscriptionQuotaExceededFault"></a>

**Code de statut HTTP retourné : ** 400.

Vous avez dépassé le nombre d'événements auxquels vous pouvez vous abonner.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## GlobalClusterAlreadyExistsFault (structure)
<a name="GlobalClusterAlreadyExistsFault"></a>

**Code de statut HTTP retourné : ** 400.

`GlobalClusterIdentifier` existe déjà. Choisissez un nouvel identifiant de base de données global (nom unique) pour créer un cluster de bases de données global.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## GlobalClusterNotFoundFault (structure)
<a name="GlobalClusterNotFoundFault"></a>

**Code de statut HTTP retourné :** 404.

`GlobalClusterIdentifier` ne fait pas référence à un cluster de bases de données global existant. 

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## GlobalClusterQuotaExceededFault (structure)
<a name="GlobalClusterQuotaExceededFault"></a>

**Code de statut HTTP retourné : ** 400.

Le nombre de clusters de bases de données globaux pour ce compte est déjà au maximum autorisé.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## InstanceQuotaExceededFault (structure)
<a name="InstanceQuotaExceededFault"></a>

**Code de statut HTTP retourné : ** 400.

Une demande entraînerait le dépassement par l'utilisateur du nombre d'instances de base de données.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## Insuffisant DBCluster CapacityFault (structure)
<a name="InsufficientDBClusterCapacityFault"></a>

**Code de statut HTTP retourné :** 403.

Le cluster de bases de données ne possède pas la capacité suffisante pour l'opération en cours.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## Insuffisant DBInstance CapacityFault (structure)
<a name="InsufficientDBInstanceCapacityFault"></a>

**Code de statut HTTP retourné : ** 400.

La classe d'instance de base de données spécifiée n'est pas disponible dans la zone de disponibilité spécifiée.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## InsufficientStorageClusterCapacityFault (structure)
<a name="InsufficientStorageClusterCapacityFault"></a>

**Code de statut HTTP retourné : ** 400.

Il n'y a pas suffisamment de stockage disponible pour l'action en cours. Vous pouvez résoudre cette erreur en mettant à jour votre groupe de sous-réseaux, afin d'utiliser différentes zones de disponibilité avec davantage d'espace de stockage disponible.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## Non valide DBCluster EndpointStateFault (structure)
<a name="InvalidDBClusterEndpointStateFault"></a>

**Code de statut HTTP retourné : ** 400.

L'opération demandée ne peut pas être effectuée sur le point de terminaison tant qu'il est dans cet état.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## Non valide DBCluster SnapshotStateFault (structure)
<a name="InvalidDBClusterSnapshotStateFault"></a>

**Code de statut HTTP retourné : ** 400.

La valeur fournie n'est pas un état d'instantané de cluster de bases de données valide.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## Non valide DBCluster StateFault (structure)
<a name="InvalidDBClusterStateFault"></a>

**Code de statut HTTP retourné : ** 400.

Le cluster de bases de données n'est pas dans un état valide.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## Non valide DBInstance StateFault (structure)
<a name="InvalidDBInstanceStateFault"></a>

**Code de statut HTTP retourné : ** 400.

L'instance de base de données spécifiée n'est pas dans l'état *available*.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## Non valide DBParameter GroupStateFault (structure)
<a name="InvalidDBParameterGroupStateFault"></a>

**Code de statut HTTP retourné : ** 400.

Le groupe de paramètres de base de données est en cours d'utilisation ou se trouve dans un état non valide. Si vous essayez de supprimer le groupe de paramètres, vous ne pouvez pas le supprimer lorsqu'il est dans cet état.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## Non valide DBSecurity GroupStateFault (structure)
<a name="InvalidDBSecurityGroupStateFault"></a>

**Code de statut HTTP retourné : ** 400.

L'état du Security Group DB n'autorise pas la suppression.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## Non valide DBSnapshot StateFault (structure)
<a name="InvalidDBSnapshotStateFault"></a>

**Code de statut HTTP retourné : ** 400.

L'état de l'instantané de base de données n'autorise pas la suppression.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## Non valide DBSubnet GroupFault (structure)
<a name="InvalidDBSubnetGroupFault"></a>

**Code de statut HTTP retourné : ** 400.

Indique que le DBSubnet groupe n'appartient pas au même VPC que celui d'une réplique de lecture interrégionale existante de la même instance source.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## Non valide DBSubnet GroupStateFault (structure)
<a name="InvalidDBSubnetGroupStateFault"></a>

**Code de statut HTTP retourné : ** 400.

Le groupe de sous-réseaux de base de données ne peut pas être supprimé car il est en cours d'utilisation.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## Non valide DBSubnet StateFault (structure)
<a name="InvalidDBSubnetStateFault"></a>

**Code de statut HTTP retourné : ** 400.

Le sous-réseaux de base de données n'est pas dans l'état *available*.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## InvalidEventSubscriptionStateFault (structure)
<a name="InvalidEventSubscriptionStateFault"></a>

**Code de statut HTTP retourné : ** 400.

L'abonnement aux événements est dans un état non valide.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## InvalidGlobalClusterStateFault (structure)
<a name="InvalidGlobalClusterStateFault"></a>

**Code de statut HTTP retourné : ** 400.

Le cluster global est dans un état non valide et ne peut pas effectuer l'opération demandée. 

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## InvalidOptionGroupStateFault (structure)
<a name="InvalidOptionGroupStateFault"></a>

**Code de statut HTTP retourné : ** 400.

Le groupe d'options n'est pas dans l'état *available*.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## InvalidRestoreFault (structure)
<a name="InvalidRestoreFault"></a>

**Code de statut HTTP retourné : ** 400.

Impossible de restaurer d'une sauvegarde vpc à une instance de base de données non vpc.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## InvalidSubnet (structure)
<a name="InvalidSubnet"></a>

**Code de statut HTTP retourné : ** 400.

Le sous-réseau demandé n'est pas valide ou plusieurs sous-réseaux qui ne sont pas dans un VPC commun ont été demandés.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## Non valide VPCNetwork StateFault (structure)
<a name="InvalidVPCNetworkStateFault"></a>

**Code de statut HTTP retourné : ** 400.

Un groupe de sous-réseaux de base de données ne couvre pas toutes les zones de disponibilité après sa création, en raison du changement d'utilisateur.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## KMSKeyNotAccessibleFault (structure)
<a name="KMSKeyNotAccessibleFault"></a>

**Code de statut HTTP retourné : ** 400.

Erreur lors de l'accès à la clé KMS.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## OptionGroupNotFoundFault (structure)
<a name="OptionGroupNotFoundFault"></a>

**Code de statut HTTP retourné :** 404.

Le groupe d'options désigné est introuvable.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## PointInTimeRestoreNotEnabledFault (structure)
<a name="PointInTimeRestoreNotEnabledFault"></a>

**Code de statut HTTP retourné : ** 400.

*DBInstanceL'identifiant de source* fait référence à une instance de base de données dont la *BackupRetentionPeriod*valeur est égale à 0.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## ProvisionedIopsNotAvailableInAZFault (structure)
<a name="ProvisionedIopsNotAvailableInAZFault"></a>

**Code de statut HTTP retourné : ** 400.

IOPS provisionnés indisponibles dans la zone de disponibilité spécifiée.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## ResourceNotFoundFault (structure)
<a name="ResourceNotFoundFault"></a>

**Code de statut HTTP retourné :** 404.

L'ID de ressource spécifiée est introuvable.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## SNSInvalidTopicFault (structure)
<a name="SNSInvalidTopicFault"></a>

**Code de statut HTTP retourné : ** 400.

La rubrique SNS n'est pas valide.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## SNSNoAuthorizationFault (structure)
<a name="SNSNoAuthorizationFault"></a>

**Code de statut HTTP retourné : ** 400.

Il n'y a aucune autorisation SNS.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## SNSTopicArnNotFoundFault (structure)
<a name="SNSTopicArnNotFoundFault"></a>

**Code de statut HTTP retourné :** 404.

L'ARN de la rubrique SNS est introuvable.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## SharedSnapshotQuotaExceededFault (structure)
<a name="SharedSnapshotQuotaExceededFault"></a>

**Code de statut HTTP retourné : ** 400.

Vous avez dépassé le nombre maximal de comptes avec lesquels vous pouvez partager un instantané de base de données manuel.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## SnapshotQuotaExceededFault (structure)
<a name="SnapshotQuotaExceededFault"></a>

**Code de statut HTTP retourné : ** 400.

Une demande entraînerait le dépassement par l'utilisateur du nombre d'instantanés de base de données.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## SourceNotFoundFault (structure)
<a name="SourceNotFoundFault"></a>

**Code de statut HTTP retourné :** 404.

La source est introuvable.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## StorageQuotaExceededFault (structure)
<a name="StorageQuotaExceededFault"></a>

**Code de statut HTTP retourné : ** 400.

Une demande entraînerait le dépassement par l'utilisateur du volume autorisé de stockage disponible sur toutes les instances de base de données.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## StorageTypeNotSupportedFault (structure)
<a name="StorageTypeNotSupportedFault"></a>

**Code de statut HTTP retourné : ** 400.

*StorageType*spécifiée ne peut pas être associée à l'instance de base de données.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## SubnetAlreadyInUse (structure)
<a name="SubnetAlreadyInUse"></a>

**Code de statut HTTP retourné : ** 400.

Le sous-réseau de base de données est déjà en cours d'utilisation dans la zone de disponibilité.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## SubscriptionAlreadyExistFault (structure)
<a name="SubscriptionAlreadyExistFault"></a>

**Code de statut HTTP retourné : ** 400.

Cet abonnement existe déjà.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## SubscriptionCategoryNotFoundFault (structure)
<a name="SubscriptionCategoryNotFoundFault"></a>

**Code de statut HTTP retourné :** 404.

La catégorie d'abonnement désigné est introuvable.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.

## SubscriptionNotFoundFault (structure)
<a name="SubscriptionNotFoundFault"></a>

**Code de statut HTTP retourné :** 404.

L'abonnement désigné est introuvable.

**Champs**
+ **message**— Il s'agit d'un ExceptionMessage, de type : `string` (une chaîne codée en UTF-8).

  Message décrivant les détails du problème.