DynamoDB Table
Resumo
- Crie ou exclua tabelas do AWS Dynamo DB.
Parâmetros
Parâmetro | Tipo | Escolhas | Valor Padrão | Comentários |
|---|---|---|---|
state | string | Escolhas: - present (default) - absent | Crie ou exclua a tabela. Se escolhido como present a tabela será criada, caso escolhido como absent a mesma será deletada. |
name - required | string | | Nome da tabela. |
hash_key_name | string | | Nome da chave de hash. Necessário quando (state=present) e a tabela não existir. |
hash_key_type | string | Escolhas: - 'STRING' - 'NUMBER' - 'BINARY' | Tipo da chave de hash. O padrão é ('STRING') ao criar uma nova tabela. |
range_key_name | string | | Nome da chave de intervalo. |
range_key_type | string | Escolhas: - 'STRING' - 'NUMBER' - 'BINARY' | Tipo da chave de intervalo. O padrão é ('STRING') ao criar uma nova chave de intervalo. |
billing_mode | string | Escolhas: - 'PROVISIONED' - 'PAY_PER_REQUEST' | Controla se as tabelas provisionadas ou sob demanda são criadas. |
read_capacity | integer | | Capacidade de taxa de transferência de leitura (unidades) para provisionar. O padrão é (1) ao criar uma nova tabela. |
write_capacity | integer | | Gravar a capacidade de taxa de transferência (unidades) para provisionar. O padrão é (1) ao criar uma nova tabela. |
indexes (Possíveis valores) | list / elements=dictionary | - [] (default) | Lista de dicionários que descrevem índices para adicionar à tabela. índices globais podem ser atualizados. índices locais não oferecem suporte a atualizações ou taxa de transferência. Opções necessárias: ['nome', 'tipo', 'hash_key_name']" Outras opções: ['hash_key_type', 'range_key_name', 'range_key_type', 'includes', 'read_capacity', 'write_capacity']" |
table_class | string | Escolhas: - 'STANDARD' - 'STANDARD_INFREQUENT_ACCESS' | A classe da tabela. |
tags | dictionary | | Um hash/dicionário de tags para adicionar à nova instância ou para iniciar/parar instância por tag. |
purge_tags | boolean | Escolhas: - false - true (default) | Remova as tags não listadas no parâmetro (tags). |
wait_timeout aliases: [wait_for_active_timeout] | integer | 300 (default) | Quanto tempo (em segundos) aguardar a conclusão da criação/atualização/exclusão. |
wait | boolean | Escolhas: - false - true (default) | Quando (wait=True) o módulo irá esperar o tempo especificado no parâmetro (wait_timeout) para que a criação ou exclusão da tabela seja concluída. |
Subcampos da opção indexes
Parâmetro | Tipo | Escolhas | Valor Padrão | Comentários |
|---|---|---|---|
name - required | string | | Nome do índice. |
type - required | string | Escolhas: - 'all' - 'global_all' - 'global_include' - 'global_keys_only' - 'include' - 'keys_only' | Tipo de índice. |
hash_key_name | string | | Nome da chave baseada em hash. Obrigatório se o índice ainda não existir. Não pode ser modificado após a criação do índice. |
hash_key_type | string | Escolhas: - 'STRING' - 'NUMBER' - 'BINARY' | Tipo da chave baseada em hash. O padrão é ('STRING') ao criar um novo índice. Não pode ser modificado após a criação do índice. |
range_key_name | string | | Nome da chave baseada em intervalo. Não pode ser modificado após a criação do índice. |
range_key_type | string | Escolhas: - 'STRING' - 'NUMBER' - 'BINARY' | Tipo da chave baseada em intervalo. O padrão é ('STRING') ao criar um novo índice. Não pode ser modificado após a criação do índice. |
includes | list / elements=string | | Uma lista de campos a serem incluídos ao usar índices (global_include) ou C(include). |
read_capacity | integer | | Capacidade de taxa de transferência de leitura (unidades) para provisionar o índice. |
write_capacity | integer | | Capacidade de taxa de transferência de gravação (unidades) para provisionar o índice. |
Exemplos
# Exemplo: Criar tabela dynamodb com chave primária de hash e intervalo
- dynamodb_table:
name: my-table
region: us-east-1
hash_key_name: id
hash_key_type: STRING
range_key_name: create_time
range_key_type: NUMBER
read_capacity: 2
write_capacity: 2
tags:
tag_name: tag_value
# Exemplo: Atualizar capacidade na tabela dynamodb existente
- dynamodb_table:
name: my-table
region: us-east-1
read_capacity: 10
write_capacity: 10
# Exemplo: Criar tabela de pagamento por solicitação
- dynamodb_table:
name: my-table
region: us-east-1
hash_key_name: id
hash_key_type: STRING
billing_mode: PAY_PER_REQUEST
# Exemplo: Definir índice na tabela dynamodb existente
- dynamodb_table:
name: my-table
region: us-east-1
indexes:
- name: NamedIndex
type: global_include
hash_key_name: id
range_key_name: create_time
includes:
- other_field
- other_field2
read_capacity: 10
write_capacity: 10
# Exemplo: Excluir tabela dynamodb
- dynamodb_table:
name: my-table
region: us-east-1
state: absent
Valores retornados
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
table | complex | Sucesso | Os parâmetros de tabela retornados da chamada de API de descrição. |
table_status | string | Sucesso | O status atual da tabela. |