API de sous-réseau Neptune

Actions :

• CreateDBSubnetGroup (action)

• DeleteDBSubnetGroup (action)

• ModifyDBSubnetGroup (action)

• DescribeDBSubnetGroups (action)

Structures :

• Subnet (structure)

• DBSubnetGroup (structure)

CreateDBSubnetGroup (action)

        Le nom AWS CLI de 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 dans deux zones de disponibilité minimum de 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).

  ID de sous-réseau EC2 du groupe de sous-réseaux de base de données.

• Tags (dans la CLI : --tags) : tableau d'objets 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 DescribeDBSubnetGroups (action).

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

  Contient une liste des éléments Subnet (structure).

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

  Fournit l'ID de VPC du groupe de sous-réseaux de base de données.

Erreurs

• DBSubnetGroupAlreadyExistsFault

• DBSubnetGroupQuotaExceededFault

• DBSubnetQuotaExceededFault

• DBSubnetGroupDoesNotCoverEnoughAZs

• InvalidSubnet

DeleteDBSubnetGroup (action)

        Le nom AWS CLI de 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 DBSubnetGroup existant. Impossible de conserver le nom par défaut.

  Exemple : mySubnetgroup

Réponse

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

Erreurs

• InvalidDBSubnetGroupStateFault

• InvalidDBSubnetStateFault

• DBSubnetGroupNotFoundFault

ModifyDBSubnetGroup (action)

        Le nom AWS CLI de 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 dans deux zones de disponibilité minimum de 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 DBSubnetGroup 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).

  ID de sous-réseau EC2 du 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 DescribeDBSubnetGroups (action).

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

  Contient une liste des éléments Subnet (structure).

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

  Fournit l'ID de VPC du groupe de sous-réseaux de base de données.

Erreurs

• DBSubnetGroupNotFoundFault

• DBSubnetQuotaExceededFault

• SubnetAlreadyInUse

• DBSubnetGroupDoesNotCoverEnoughAZs

• InvalidSubnet

DescribeDBSubnetGroups (action)

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

Renvoie une liste de descriptions DBSubnetGroup. Si le paramètre DBSubnetGroupName est spécifié, la liste contiendra uniquement les descriptions correspondantes au DBSubnetGroup spécifié.

Pour obtenir une vue d'ensemble des plages d'adresses CIDR, consultez le didacticiel Wikipedia.

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.

  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 DescribeDBSubnetGroups précédente. Si ce paramètre est spécifié, la réponse inclut uniquement des enregistrements supérieurs au marqueur, jusqu'à la valeur spécifiée par MaxRecords.

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

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

  Par défaut : 100

  Contraintes : Minimum 20, maximum 100.

Réponse

• DBSubnetGroups : tableau d'objets DBSubnetGroup.

  Liste des instances DBSubnetGroup (structure).

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

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

Erreurs

• DBSubnetGroupNotFoundFault

Structures :

Subnet (structure)

Spécifie un sous-réseau.

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

Champs

• SubnetAvailabilityZone : objet AvailabilityZone.

  Spécifie la zone de disponibilité EC2 contenant 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.

DBSubnetGroup (structure)

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 DescribeDBSubnetGroups (action).

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.

  Contient une liste des éléments Subnet (structure).

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

  Fournit l'ID de VPC du groupe de sous-réseaux de base de données.

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

• CreateDBSubnetGroup

• ModifyDBSubnetGroup