

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# API da sub-rede do Neptune
<a name="api-subnets"></a>

**Ações do:**
+ [CreateDBSubnetGroup (ação)](#CreateDBSubnetGroup)
+ [DeleteDBSubnetGroup (ação)](#DeleteDBSubnetGroup)
+ [ModifyDBSubnetGroup (ação)](#ModifyDBSubnetGroup)
+ [DescribeDBSubnetGroups (ação)](#DescribeDBSubnetGroups)

**Estruturas:**
+ [Sub-rede (estrutura)](#Subnet)
+ [DBSubnetGroup (estrutura)](#DBSubnetGroup)

## CreateDBSubnetGroup (ação)
<a name="CreateDBSubnetGroup"></a>

         O nome da CLI da AWS para essa API é: `create-db-subnet-group`.

Cria um novo grupo de sub-redes de banco de dados. Os grupos de sub-redes de banco de dados devem conter pelo menos uma sub-rede em pelo menos duas zonas de disponibilidade na região da Amazon.

**Solicitação**
+ **DBSubnetGroupDescription** (na CLI: `--db-subnet-group-description`): *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8).

  A descrição do grupo de sub-rede de banco de dados.
+ **DBSubnetGroupName** (na CLI: `--db-subnet-group-name`): *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8).

  O nome do grupo de sub-rede de banco de dados. Esse valor é armazenado como uma string em minúsculas.

  Restrições: deve conter não mais do que 255 letras, números, pontos, sublinhados, espaços ou hífens. Não deve ser padrão.

  Exemplo: `mySubnetgroup`
+ **SubnetIds** (na CLI: `--subnet-ids`): *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8).

  Os IDs de sub-rede do EC2 do grupo de sub-redes de banco de dados.
+ **Tags** (na CLI: `--tags`): uma matriz de objetos [Tag](api-other-apis.md#Tag).

  As tags a serem atribuídas ao novo grupo de sub-redes de banco de dados.

**Resposta**

Contém os detalhes de um grupo de sub-redes de banco de dados do Amazon Neptune.

Esse tipo de dados é usado como um elemento de resposta na ação [DescribeDBSubnetGroups (ação)](#DescribeDBSubnetGroups).
+ **DBSubnetGroupArn**: uma string, do tipo: `string` (uma string codificada em UTF-8).

  O nome de recurso da Amazon (ARN) do grupo de sub-redes de banco de dados.
+ **DBSubnetGroupDescription**: uma string, do tipo: `string` (uma string codificada em UTF-8).

  Fornece a descrição do grupo de sub-redes de banco de dados.
+ **DBSubnetGroupName**: uma string, do tipo: `string` (uma string codificada em UTF-8).

  O nome do grupo de sub-redes de banco de dados.
+ **SubnetGroupStatus**: uma string, do tipo: `string` (uma string codificada em UTF-8).

  Fornece o status do grupo de sub-redes de banco de dados.
+ **Subnets**: um array de objetos [Sub-rede](#Subnet).

   Contém uma lista de elementos [Sub-rede (estrutura)](#Subnet).
+ **VpcId**: uma string, do tipo: `string` (uma string codificada em UTF-8).

  Fornece o VpcId do grupo de sub-redes de banco de dados.

**Erros**
+ [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)

## DeleteDBSubnetGroup (ação)
<a name="DeleteDBSubnetGroup"></a>

         O nome da CLI da AWS para essa API é: `delete-db-subnet-group`.

Exclui um grupo de sub-redes de banco de dados.

**nota**  
O grupo de sub-rede de banco de dados especificado não pode estar associado a nenhuma instância DB.

**Solicitação**
+ **DBSubnetGroupName** (na CLI: `--db-subnet-group-name`): *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8).

  O nome do grupo de sub-rede de banco de dados a ser excluído.
**nota**  
Você não pode excluir o grupo de sub-rede padrão.

  Restrições:

  Restrições: deve corresponder ao nome de um DBSubnetGroup existente. Não deve ser padrão.

  Exemplo: `mySubnetgroup`

**Resposta**
+ *Nenhum parâmetro de resposta.*

**Erros**
+ [InvalidDBSubnetGroupStateFault](api-faults.md#InvalidDBSubnetGroupStateFault)
+ [InvalidDBSubnetStateFault](api-faults.md#InvalidDBSubnetStateFault)
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)

## ModifyDBSubnetGroup (ação)
<a name="ModifyDBSubnetGroup"></a>

         O nome da CLI da AWS para essa API é: `modify-db-subnet-group`.

Modifica um grupo de sub-redes de banco de dados existente. Os grupos de sub-redes de banco de dados devem conter pelo menos uma sub-rede em pelo menos duas zonas de disponibilidade na região da Amazon.

**Solicitação**
+ **DBSubnetGroupDescription** (na CLI: `--db-subnet-group-description`): uma string, do tipo: `string` (uma string codificada em UTF-8).

  A descrição do grupo de sub-rede de banco de dados.
+ **DBSubnetGroupName** (na CLI: `--db-subnet-group-name`): *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8).

  O nome do grupo de sub-rede de banco de dados. Esse valor é armazenado como uma string em minúsculas. Você não pode modificar o grupo de sub-redes padrão.

  Restrições: deve corresponder ao nome de um DBSubnetGroup existente. Não deve ser padrão.

  Exemplo: `mySubnetgroup`
+ **SubnetIds** (na CLI: `--subnet-ids`): *obrigatório:* uma string, do tipo: `string` (uma string codificada em UTF-8).

  Os IDs de sub-rede do EC2 do grupo de sub-redes de banco de dados.

**Resposta**

Contém os detalhes de um grupo de sub-redes de banco de dados do Amazon Neptune.

Esse tipo de dados é usado como um elemento de resposta na ação [DescribeDBSubnetGroups (ação)](#DescribeDBSubnetGroups).
+ **DBSubnetGroupArn**: uma string, do tipo: `string` (uma string codificada em UTF-8).

  O nome de recurso da Amazon (ARN) do grupo de sub-redes de banco de dados.
+ **DBSubnetGroupDescription**: uma string, do tipo: `string` (uma string codificada em UTF-8).

  Fornece a descrição do grupo de sub-redes de banco de dados.
+ **DBSubnetGroupName**: uma string, do tipo: `string` (uma string codificada em UTF-8).

  O nome do grupo de sub-redes de banco de dados.
+ **SubnetGroupStatus**: uma string, do tipo: `string` (uma string codificada em UTF-8).

  Fornece o status do grupo de sub-redes de banco de dados.
+ **Subnets**: um array de objetos [Sub-rede](#Subnet).

   Contém uma lista de elementos [Sub-rede (estrutura)](#Subnet).
+ **VpcId**: uma string, do tipo: `string` (uma string codificada em UTF-8).

  Fornece o VpcId do grupo de sub-redes de banco de dados.

**Erros**
+ [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)

## DescribeDBSubnetGroups (ação)
<a name="DescribeDBSubnetGroups"></a>

         O nome da CLI da AWS para essa API é: `describe-db-subnet-groups`.

Retorna uma lista de descrições de DBSubnetGroup. Se um DBSubnetGroupName for especificado, a lista conterá apenas as descrições do DBSubnetGroup especificado.

Para obter uma visão geral de intervalos CIDR, vá até o [Wikipedia Tutorial](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).

**Solicitação**
+ **DBSubnetGroupName** (na CLI: `--db-subnet-group-name`): uma string, do tipo: `string` (uma string codificada em UTF-8).

  O nome do grupo de sub-redes de banco de dados do qual retornar detalhes.
+ **Filters** (na CLI: `--filters`): uma matriz de objetos [Filtro](api-datatypes.md#Filter).

  Não há suporte para esse parâmetro atualmente.
+ **Marker** (na CLI: `--marker`): uma string, do tipo: `string` (uma string codificada em UTF-8).

   Um token de paginação opcional fornecido por uma solicitação DescribeDBSubnetGroups anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.
+ **MaxRecords** (na CLI: `--max-records`): um IntegerOptional, do tipo: `integer` (um valor inteiro assinado de 32 bits).

   O número máximo de registros a serem incluídos na resposta. Se existirem mais registros do que o valor `MaxRecords` especificado, um token de paginação chamado de marcador será incluído na resposta para que os resultados restantes possam ser recuperados.

  Padrão: 100

  Restrições: mínimo de 20, máximo de 100.

**Resposta**
+ **DBSubnetGroups**: um array de objetos [DBSubnetGroup](#DBSubnetGroup).

   Uma lista de instâncias [DBSubnetGroup (estrutura)](#DBSubnetGroup).
+ **Marker**: uma string, do tipo: `string` (uma string codificada em UTF-8).

   Um token de paginação opcional fornecido por uma solicitação anterior. Se esse parâmetro for especificado, a resposta incluirá apenas os registros além do marcador, até o valor especificado por `MaxRecords`.

**Erros**
+ [DBSubnetGroupNotFoundFault](api-faults.md#DBSubnetGroupNotFoundFault)

## *Estruturas:*
<a name="api-subnets-structures-spacer"></a>

## Sub-rede (estrutura)
<a name="Subnet"></a>

Especifica uma sub-rede.

 Esse tipo de dados é usado como um elemento de resposta na ação [DescribeDBSubnetGroups (ação)](#DescribeDBSubnetGroups).

**Campos**
+ **SubnetAvailabilityZone**: é um objeto [AvailabilityZone](api-datatypes.md#AvailabilityZone).

  Especifica a zona de disponibilidade do EC2 na qual se encontra a sub-rede.
+ **SubnetIdentifier**: é uma string, do tipo: `string` (uma string codificada em UTF-8).

  Especifica o identificador da sub-rede.
+ **SubnetStatus**: é uma string, do tipo: `string` (uma string codificada em UTF-8).

  Especifica o status da sub-rede.

## DBSubnetGroup (estrutura)
<a name="DBSubnetGroup"></a>

Contém os detalhes de um grupo de sub-redes de banco de dados do Amazon Neptune.

Esse tipo de dados é usado como um elemento de resposta na ação [DescribeDBSubnetGroups (ação)](#DescribeDBSubnetGroups).

**Campos**
+ **DBSubnetGroupArn**: é uma string, do tipo: `string` (uma string codificada em UTF-8).

  O nome de recurso da Amazon (ARN) do grupo de sub-redes de banco de dados.
+ **DBSubnetGroupDescription**: é uma string, do tipo: `string` (uma string codificada em UTF-8).

  Fornece a descrição do grupo de sub-redes de banco de dados.
+ **DBSubnetGroupName**: é uma string, do tipo: `string` (uma string codificada em UTF-8).

  O nome do grupo de sub-redes de banco de dados.
+ **SubnetGroupStatus**: é uma string, do tipo: `string` (uma string codificada em UTF-8).

  Fornece o status do grupo de sub-redes de banco de dados.
+ **Subnets**: é uma matriz de objetos [Sub-rede](#Subnet).

   Contém uma lista de elementos [Sub-rede (estrutura)](#Subnet).
+ **VpcId**: é uma string, do tipo: `string` (uma string codificada em UTF-8).

  Fornece o VpcId do grupo de sub-redes de banco de dados.

`DBSubnetGroup` é usado como o elemento de resposta para:
+ [CreateDBSubnetGroup](#CreateDBSubnetGroup)
+ [ModifyDBSubnetGroup](#ModifyDBSubnetGroup)