S3 Bucket Notification

6 min

Resumo

Este módulo permite o gerenciamento de mapeamentos de eventos de buckets de funções do AWS Lambda por meio da estrutura do Atmosphere.

Requisitos

Os requisitos abaixo são necessários no host que executa este módulo.

bot3 >= 1.15.0
botocore >= 1.18.0

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. Não usado por módulos baseados em boto 2. Observação: o CA Bundle é lido no lado do 'módulo' e pode precisar ser copiado explicitamente do controlador se não for executado localmente.
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 perfil for definido, este parâmetro será ignorado.
bucket_name	string		Nome do bucket do S3.
debug_botocore_endpoint_logs	boolean	Escolhas: - false - 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. A variável de ambiente ANSIBLE_DEBUG_BOTOCORE_LOGS também pode ser usada.
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.
event_name - required	string		Nome exclusivo para notificação de eventos no bucket.
events	list / elements=string	Escolhas: s3:ObjectCreated:* s3:ObjectCreated:Put s3:ObjectCreated:Post s3:ObjectCreated:Copy s3:ObjectCreated:CompleteMultipartUpload s3:ObjectRemoved:* s3:ObjectRemoved:Delete s3:ObjectRemoved:DeleteMarkerCreated s3:ObjectRestore:Post s3:ObjectRestore:Completed s3:ReducedRedundancyLostObject	Eventos que você deseja que acionem notificações. Você pode selecionar vários eventos para enviar para o mesmo destino, configurar eventos diferentes para enviar para destinos diferentes e configurar um prefixo ou sufixo para um evento. No entanto, para cada bucket, os eventos individuais não podem ter várias configurações com prefixos ou sufixos sobrepostos que possam corresponder à mesma chave de objeto. Necessário quando state=present .
lambda_alias	string		Nome do alias da função Lambda. Mutuamente exclusivo com lambda_version .
lambda_function_arn	string		O ARN da função lambda.
lambda_version	integer		Versão da função Lambda. Mutuamente exclusivo com lambda_alias .
prefix	string		Prefixo opcional para limitar as notificações a objetos com chaves que começam com caracteres correspondentes.
profile	string		O uso do perfil 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.
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 perfil for definido, este parâmetro será ignorado.
state	string	Escolhas: - present(default) - absent	Descreve o estado desejado.
suffix	string		Sufixo opcional para limitar as notificações a objetos com chaves que terminam com caracteres correspondentes.
validate_certs	boolean	Escolhas: - false - true(default)	Quando definido como "false", os certificados SSL não serão validados para comunicação com as APIs da AWS.

Extende fragmentos da documentação do módulo aws e ec2.

Notas

Este módulo depende muito de community.aws.lambda_policy , pois você precisa permitir lambda:InvokeFunctionpermissão para sua função lambda.
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_REGIONpode 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

# Exemplos adicionando configurações de destino de notificação a um bucket do S3
- name: Configurar notificação de evento de bucket para uma função do Lambda
  s3_bucket_notification:
    state: present
    event_name: on_file_add_or_remove
    bucket_name: test-bucket
    lambda_function_arn: arn:aws:lambda:us-east-2:526810320200:function:test-lambda
    events: ["s3:ObjectCreated:*", "s3:ObjectRemoved:*"]
    prefix: images/
    suffix: .jpg

- name: Configurar notificação de evento de bucket para SQS
  s3_bucket_notification:
    state: present
    event_name: on_file_add_or_remove
    bucket_name: test-bucket
    queue_arn: arn:aws:sqs:us-east-2:526810320200:test-queue
    events: ["s3:ObjectCreated:*", "s3:ObjectRemoved:*"]
    prefix: images/
    suffix: .jpg

# Exemplo de remoção de uma notificação de evento
- name: Remover notificação de evento
  s3_bucket_notification:
    state: absent
    event_name: on_file_add_or_remove
    bucket_name: test-bucket

Valores retornados

Chave	Tipo	Retornado quando	Descrição
notification_configuration	list / elements=string	sempre	lista de notificações aplicadas atualmente