EFS

6 min

Sinopse

O módulo permite criar, pesquisar e destruir sistemas de arquivos do Amazon EFS

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
aws_access_key	string		AWS access key. Se não for definido, o valor da variável AWS_ACCESS_KEY_ID de ambiente AWS_ACCESS_KEY ou EC2_ACCESS_KEY será usado. Se o profile for definido, este parâmetro será ignorado.
aws_ca_bundle	path		A localização de um CA Bundle a ser usado ao validar certificados SSL.
aws_config	dictionary		Um dicionário para modificar a configuração do botocore. Os parâmetros podem ser encontrados em https://botocore.amazonaws.com. Apenas a chave 'user_agent' é usada para módulos boto. Consulte http://boto.cloudhackers.com para obter mais configurações de boto.
aws_secret_key	string		AWS secret key. Se não for definido, o valor da variável de ambiente AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY ou EC2_SECRET_KEY será usado. Se o profile for definido, este parâmetro será ignorado.
debug_botocore_endpoint_logs	boolean	Escolhas: false ← (padrão) true	Use um registrador botocore.endpoint para analisar as chamadas de API “resource:action” exclusivas (em vez de totais) feitas durante uma tarefa, enviando o conjunto para a chave resource_actions nos resultados da tarefa. Use o retorno de chamada aws_resource_action para gerar a lista total feita durante um playbook.
ec2_url	string		URL a ser usada para conectar-se ao EC2 ou à sua nuvem Eucalyptus (por padrão, o módulo usará endpoints do EC2). Ignorado para módulos onde a região é necessária. Deve ser especificado para todos os outros módulos se a região não for usada. Se não for definido, o valor da variável de ambiente EC2_URL, se houver, será usado.
encrypt	boolean	Escolhas: false ← (padrão) true	Se encrypt=true cria um sistema de arquivos criptografado. Isso não pode ser modificado após a criação do sistema de arquivos.
id	string		ID do Amazon EFS. Nome ou ID necessários para exclusão.
kms_key_id	string		A ID da CMK do AWS KMS que será usada para proteger o sistema de arquivos criptografado. Esse parâmetro só é necessário se você quiser usar uma CMK não padrão. Se esse parâmetro não for especificado, a CMK padrão do Amazon EFS será usada. O ID da chave pode ser Key ID, Key ID ARN, Key Alias ou Key Alias ARN.
name	string		Token de criação do sistema de arquivos do Amazon EFS. Necessário para criar e atualizar. Nome ou ID necessários para exclusão.
performance_mode	string	Escolhas: general_purpose ← (padrão) max_io	Modo de desempenho do sistema de arquivos a ser usado. Só tem efeito durante a criação.
profile	string		O uso do profile substituirá aws_access_key , aws_secret_key e security_token e o suporte para passá-los ao mesmo tempo em que o profile foi descontinuado.
provisioned_throughput_in_mibps	float		Se o throughput_mode for provisionado, selecione a quantidade de taxa de transferência a ser provisionada em Mibps.
purge_tags	boolean	Escolhas: false true ← (padrão)	Se sim, as tags existentes serão removidas do recurso para corresponder exatamente ao que é definido pelo parâmetro tags . Se o parâmetro tags não estiver definido, as tags não serão modificadas.
region	string		A região da AWS a ser usada. Se não for especificado, o valor da variável de ambiente AWS_REGION ou EC2_REGION, se houver, será usado. Consulte http://docs.aws.amazon.com
security_token	string		AWS STS security token. Se não for definido, o valor da variável de ambiente AWS_SECURITY_TOKEN ou EC2_SECURITY_TOKEN será usado. Se o profile for definido, este parâmetro será ignorado. A passagem das opções security_token e profile ao mesmo tempo foi preterida e as opções serão mutuamente exclusivas após 2022-06-01.
state	string	Escolhas: present ← (padrão) absent	Permite criar, pesquisar e destruir o sistema de arquivos do Amazon EFS.
Tag	dictionary		Lista de tags do Amazon EFS. Deve ser definido como dicionário Em caso de estado 'presente' com lista de tags e EFS existente (combinado com 'nome'), as tags do EFS serão substituídas pelos dados fornecidos.
targets	list / elements=string		Lista de destinos montados. Deve ser uma lista de dicionários, todo dicionário deve incluir os atributos next: Esses dados podem ser modificados para o EFS existente usando o estado 'present' e uma nova lista de destinos de montagem.
throughput_mode	string	Escolhas: bursting provisioned	O throughput_mode para o sistema de arquivos a ser criado.
transition_to_ia	string	Escolhas: None 7 14 30 60 90	Quantos dias antes que os objetos façam a transição para a classe de armazenamento EFS Infrequent Access (IA) de baixo custo. Se definido como string None, qualquer política de ciclo de vida existente será removida e os objetos não farão a transição para uma classe de armazenamento IA. Se esse parâmetro estiver ausente, nenhuma política de ciclo de vida existente será afetada.
valid_certs	boolean	Escolhas: false true ← (padrão)	Quando definido como “não”, os certificados SSL não serão validados para comunicação com as APIs da AWS.
wait	boolean	Escolhas: false ← (padrão) true	No caso de estado 'presente', deve-se aguardar o estado do ciclo de vida 'disponível' do EFS (claro, se o estado atual não for 'excluído' ou 'excluído') Em caso de estado 'ausente', deve-se aguardar o estado do ciclo de vida 'excluído' do EFS
wait_timeout	integer	Default: 0	Quanto tempo o módulo deve esperar (em segundos) pelo estado desejado antes de retornar. Zero significa esperar o tempo que for necessário.

Subcampos do parâmetro targets

Parâmetro	Tipo	Comentários
endereço de IP	string	Um endereço IPv4 válido dentro do intervalo de endereços da sub-rede especificada.
security_groups	list / elements=string	Lista de IDs de grupos de segurança, no formato 'sg-xxxxxxxx'. Eles devem ser para a mesma VPC que a sub-rede especificada
subnet_id	string	O ID da sub-rede na qual adicionar o destino de montagem.

Notas

Observação

Se os parâmetros não forem definidos no módulo, as seguintes variáveis de ambiente podem ser usadas em ordem decrescente de precedência
- AWS_URL ou EC2_URL,
- AWS_PROFILE ou AWS_DEFAULT_PROFILE,
- AWS_ACCESS_KEY_ID ou AWS_ACCESS_KEY ou EC2_ACCESS_KEY,
- AWS_SECRET_ACCESS_KEY ou AWS_SECRET_KEY ou EC2_SECRET_KEY,
- AWS_SECURITY_TOKEN ou EC2_SECURITY_TOKEN,
- AWS_REGION ou EC2_REGION,
- AWS_CA_BUNDLE
Quando nenhuma credencial é fornecida explicitamente, o AWS SDK (boto3) que o Ansible usa retornará aos seus arquivos de configuração (normalmente ~/.aws/credentials). Consulte https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html para obter mais informações.
Módulos baseados no AWS SDK original (boto) podem ler sua configuração padrão de arquivos diferentes. Consulte https://boto.readthedocs.io/en/latest/boto_config_tut.html para obter mais informações.
AWS_REGION ou EC2_REGION pode ser normalmente usado para especificar a região da AWS, quando necessário, mas isso também pode ser definido nos arquivos de configuração.

Exemplos

- name: EFS provisioning
  efs:
    state: present
    name: myTestEFS
    tags:
        Name: myTestNameTag
        purpose: file-storage
    targets:
        - subnet_id: subnet-748c5d03
          security_groups: [ "sg-1a2b3c4d" ]

- name: Modifying EFS data
  efs:
    state: present
    name: myTestEFS
    tags:
        name: myAnotherTestTag
    targets:
        - subnet_id: subnet-7654fdca
          security_groups: [ "sg-4c5d6f7a" ]

- name: Set a lifecycle policy
  efs:
    state: present
    name: myTestEFS
    transition_to_ia: 7
    targets:
        - subnet_id: subnet-7654fdca
          security_groups: [ "sg-4c5d6f7a" ]

- name: Remove a lifecycle policy
  efs:
    state: present
    name: myTestEFS
    transition_to_ia: None
    targets:
        - subnet_id: subnet-7654fdca
          security_groups: [ "sg-4c5d6f7a" ]

- name: Deleting EFS
  efs:
    state: absent
    name: myTestEFS

Valores de retorno

Chave	Tipo	Escolhas \| Valor Padrão	Comentários
creation_time	string	sempre	timestamp da data de criação
creation_token	string	sempre	Token de criação do EFS
file_system_id	string	sempre	ID do sistema de arquivos
filesystem_address	string	sempre	url do sistema de arquivos válido para uso com montagem
life_cycle_state	string	sempre	estado do sistema de arquivos EFS
mount_point	string	sempre	URL do sistema de arquivos com ponto inicial do momento em que o AWS EFS exigiu adicionar um sufixo de região ao endereço
mount_targets	list / elements=dictionary	sempre	lista de destinos de montagem
name	string	sempre	nome do sistema de arquivos
number_of_mount_targets	integer	sempre	o número de alvos montados
owner_id	string	sempre	ID da conta da AWS do proprietário do EFS
performance_mode	string	sempre	modo de desempenho do sistema de arquivos
size_in_bytes	dictionary	sempre	tamanho do sistema de arquivos em bytes a partir de um carimbo de data/hora
tags	dictionary	sempre	tags na instância efs