S3 Website

12 min

Resumo

Configurar um bucket s3 como um site.

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.
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.
error_key			O nome da chave do objeto a ser usado quando ocorrer um erro de classe 4XX. Para remover uma chave de erro, defina como Nenhum.
name - required			Nome do bucket s3
profile			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 perfil foi descontinuado.
redirect_all_requests			Descreve o comportamento de redirecionamento de cada solicitação para este endpoint do site do bucket s3
region			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			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 - required		Escolhas: - present(default) - absent	Crie ou remova a regra de ciclo de vida.
suffix		Default: - "index.html"	Sufixo que é anexado a uma solicitação que é para um diretório no endpoint do site (por exemplo, se o sufixo for index.html e você fizer uma solicitação para samplebucket/images/ os dados retornados serão para o objeto com o nome da chave images /index.html). O sufixo não deve incluir um caractere de barra.
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 ec2 e aws.

Notas

Exemplos

# Observação: esses exemplos não definem detalhes de autenticação, consulte o AWS Guide para obter detalhes.

- name: Configure um bucket s3 para redirecionar todas as solicitações para example.com
  s3_website:
    name: mybucket.com
    redirect_all_requests: example.com
    state: present

- name: Remover a configuração do site de um bucket s3
  s3_website:
    name: mybucket.com
    state: absent

- name: Configure um bucket s3 como um site com páginas de índice e erro
  s3_website:
    name: mybucket.com
    suffix: home.htm
    error_key: errors/404.htm
    state: present

Valores retornados

Chave	Tipo	Retornado quando	Descrição
error_document	complex	Sempre	documento de erro
index_document	complex	Sempre	documento de índice
redirect_all_requests_to	complex	Sempre	para onde redirecionar solicitações
routing_rules	list / elements=string	Sempre	regras de roteamento

Subcampos da chave de retorno error_document

Chave	Tipo	Retornado quando	Descrição
key	string	quando o parâmetro error_document é definido	nome da chave do objeto a ser usado quando ocorrer um erro de classe 4XX

Subcampos da chave de retorno index_document

Chave	Tipo	Retornado quando	Descrição
suffix	string	sucesso	sufixo que é anexado a uma solicitação que é para um diretório no endpoint do site

Subcampos da chave de retorno redirect_all_requests_to

Chave	Tipo	Retornado quando	Descrição
host_name	string	ao redirecionar todos os conjuntos de parâmetros de solicitações	nome do host para onde as solicitações serão redirecionadas.
protocol	string	ao redirecionar todos os conjuntos de parâmetros de solicitações	protocolo a ser usado ao redirecionar solicitações.

Subcampos da chave de retorno routing_rules

Chave	Tipo	Retornado quando	Descrição
condition	complex	Sucesso	Um contêiner para descrever uma condição que deve ser atendida para que o redirecionamento especificado seja aplicado.
redirect	complex	Sempre	Recipiente para informações de redirecionamento.

Subcampos da chave de retorno condition

Chave	Tipo	Retornado quando	Descrição
http_error_code_returned_equals	string	sempre	O código de erro HTTP quando o redirecionamento é aplicado.
key_prefix_equals	string	quando a regra de roteamento estiver presente	prefixo do nome da chave do objeto quando o redirecionamento é aplicado. Por exemplo, para redirecionar solicitações para ExamplePage.html, o prefixo de chave será ExamplePage.html

Subcampos da chave de retorno redirect

Chave	Tipo	Retornado quando	Descrição
host_name	string	quando o nome do host é definido como parte da regra de redirecionamento	nome do host para onde as solicitações serão redirecionadas.
http_redirect_code	string	quando a regra de roteamento estiver presente	O código de redirecionamento HTTP a ser usado na resposta.
protocol	string	quando a regra de roteamento estiver presente	Protocolo a ser usado ao redirecionar solicitações.
replace_key_prefix_with	string	quando a regra de roteamento estiver presente	prefixo de chave de objeto a ser usado na solicitação de redirecionamento
replace_key_with	string	quando a regra de roteamento estiver presente	prefixo de chave de objeto a ser usado na solicitação de redirecionamento