EC2 Instance

27 min

Resumo

Crie e gerencie instâncias do AWS EC2.
Nota: Este módulo não suporta a criação de instâncias EC2 Spot. O módulo amazon.aws.ec2 pode criar e gerenciar instâncias pontuais.

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
availability_zone	string		Especifique uma zona de disponibilidade para usar a sub-rede padrão. Útil se não estiver especificando o parâmetro vpc_subnet_id. Se nenhuma sub-rede, ENI ou zona de disponibilidade for fornecida, a sub-rede padrão no VPC padrão será usada no primeiro AZ (classifique alfabeticamente).
aws_access_key aliases: ec2_access_key, access_key	string		Chave de acesso AWS. Se não for definido, o valor da variável de ambiente AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY ou EC2_ACCESS_KEY será usado.
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 'module' 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. Apenas a chave 'user_agent' é usada para módulos boto.
aws_secret_key aliases: ec2_secret_key, secret_key	string		Chave secreta da AWS. 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.
cpu_credit_specification	string	Escolhas: - unlimited - standard	Para instâncias da série T, escolha se deseja permitir cobranças maiores para comprar créditos de CPU se o pool padrão estiver esgotado. Escolha unlimited para permitir a compra de créditos de CPU adicionais.
cpu_options	dictionary		Reduza o número de vCPU expostas à instância. Esses parâmetros só podem ser definidos na inicialização da instância. As duas subopções threads_per_core e core_count são obrigatórias.
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.
detailed_monitoring	boolean	Escolhas: - false - true	Se permitir que métricas detalhadas do cloudwatch sejam coletadas, permitindo alertas mais detalhados.
ebs_optimized	boolean	Escolhas: - false - true	Se a instância deve usar volumes EBS otimizados.
ec2_url aliases: aws_endpoint_url, endpoint_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.
filters	dictionary		Um ditado de filtros a serem aplicados ao decidir se as instâncias existentes correspondem e devem ser alteradas. Cada item dict consiste em uma chave de filtro e um valor de filtro. Os nomes e valores dos filtros diferenciam maiúsculas de minúsculas. Por padrão, as instâncias são filtradas para contagem por sua tag "Nome", AMI base, estado (em execução, por padrão) e ID de sub-rede. Qualquer filtro consultável pode ser usado. Bons candidatos são tags específicas, chaves SSH ou grupos de segurança.
image	dictionary		Uma imagem a ser usada para a instância.
image_id	string		ami ID a ser usado para a instância. Um de image ou image_id é necessário quando a instância ainda não está presente. Este é um alias para image.id.
instance_ids list / elements=string	list / elements=string		Se você especificar um ou mais IDs de instância, somente as instâncias que possuem os IDs especificados serão retornadas.
instance_initiated_shutdown_behavior	string	Escolhas: - stop - terminate	Se deve parar ou encerrar uma instância após o desligamento.
instance_role	string		O ARN ou o nome de uma função de instância habilitada para EC2 a ser usada. Se um nome não for fornecido no formato arn, a permissão ListInstanceProfiles também deverá ser concedida.
instance_type	string	Default - "t2.micro"	Tipo de instância a ser usado para a instância. Necessário apenas quando a instância ainda não estiver presente.
key_name	string		Nome da chave de acesso SSH a ser atribuída à instância - deve existir na região em que a instância foi criada.
launch_template	dictionary		O modelo de execução do EC2 para basear a configuração da instância.
metadata_options	dictionary		Modifique as opções de metadados para a instância. As duas subopções http_endpoint e http_tokens são suportadas.
name	string		A tag Name para a instância.
network	dictionary		Ou um dicionário contendo as chaves 'interfaces' correspondentes a uma lista de IDs de interface de rede ou contendo especificações para uma única interface de rede.
placement_group	string		O grupo de veiculações que precisa ser atribuído à instância.
profile aliases: aws_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.
purge_tags	boolean	Escolhas: - false - true	Exclua todas as tags não especificadas na tarefa que estão na instância. Isso significa que você precisa especificar todas as tags desejadas em cada tarefa que afeta uma instância.
region aliases: aws_region, ec2_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.
security_group	string		Um ID ou nome de grupo de segurança. Mutuamente exclusivo com security_groups.
security_groups	list / elements=string		Uma lista de IDs ou nomes de grupos de segurança (strings). Mutuamente exclusivo com security_group.
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 - terminated - running - started - stopped - restarted - rebooted - absent	Estado da meta para as instâncias. state=present: garante que as instâncias existam, mas não garante nenhum estado (por exemplo, em execução). As instâncias recém-iniciadas serão executadas pelo EC2. state=running: state=present + garante que as instâncias estejam em execução state=started: state=running + espera que as verificações de status do EC2 relatem OK se wait=true state=stopped: garante que uma instância existente seja interrompida. state=rebooted: alias de conveniência para state=stopped imediatamente seguido por state=running state=restarted: alias de conveniência para state=stopped imediatamente seguido por state=started state=terminated: garante que uma instância existente seja encerrada. state=absent: alias para state=terminated
tags	dictionary		Um hash/dicionário de tags para adicionar à nova instância ou adicionar/remover de uma existente.
tenancy	string	Escolhas: - dedicated - default	Que tipo de locação permitir que uma instância use. O padrão é locação compartilhada. A locação dedicada incorrerá em custos adicionais.
termination_protection	boolean	Escolhas: - false - true	Se deve habilitar a proteção contra rescisão. Este módulo não encerrará uma instância com proteção de encerramento ativa, ele deve ser desligado primeiro.
tower_callback	dictionary		Dados do usuário pré-configurados para permitir que uma instância execute um retorno de chamada da Torre (somente Linux). Mutuamente exclusivo com user_data. Para instâncias do Windows, para habilitar o acesso remoto por meio do Atmosphere, defina tower_callback.windows como true e, opcionalmente, defina uma senha de administrador. Se estiver usando 'windows' e 'set_password', o retorno de chamada para Tower não será executado, mas a instância estará pronta para receber conexões winrm do Atmosphere.
user_data	string		Blob opaco de dados que é disponibilizado para a instância ec2.
validate_certs	boolean	Escolhas: - false - true	Quando definido como "false", os certificados SSL não serão validados para comunicação com as APIs da AWS.
volumes	list / elements=dictionary		Uma lista de mapeamentos de dispositivos de bloco, por padrão, isso sempre usará o dispositivo raiz da AMI, portanto, a opção de volumes é principalmente para adicionar mais armazenamento. Um mapeamento contém as chaves (opcionais) device_name, virtual_name, ebs.volume_type, ebs.volume_size, ebs.kms_key_id, ebs.iops e ebs.delete_on_termination. Definir o valor de ebs.throughput requer botocore>=1.19.27.
vpc_subnet_id aliases: subnet_id	string		A ID de sub-rede na qual iniciar a instância (VPC) Se nenhuma for fornecida, amazon.aws.ec2_instance escolherá a zona padrão da VPC padrão.
wait	boolean	Escolhas: - false - true	Se deve ou não aguardar o estado desejado (use wait_timeout para personalizar isso).
wait_timeout	integer	Default: - 600	Quanto tempo esperar (em segundos) para que a instância termine de inicializar/terminar.

Subcampos da opção cpu_options

Parâmetros	Tipo	Escolhas \| Valor Padrão	Comentários
core_count - required	string		Defina o número de núcleos a serem ativados.
threads_per_core - required	string	Escolhas: - 1 - 2	Select the number of threads per core to enable. Disable or Enable Intel HT.

Subcampos da opção image

Parâmetros	Tipo	Comentários
id	string	O ID da AMI.
kernel	string	Uma string AKI para substituir o kernel da AMI.
ramdisk	string	Substitui o ID de disco ram padrão da AMI.

Subcampos da opção launch_template

Parâmetros	Tipo	Comentários
id	string	o ID do modelo de execução (opcional se o nome for especificado).
name	string	o nome bonito do modelo de execução (opcional se id for especificado).
version	string	a versão específica do modelo de execução a ser usado. Se não especificado, o padrão do modelo é escolhido.

Subcampos da opção metadata_options

Parâmetros	Tipo	Escolhas \| Valor Padrão	Comentários
http_endpoint	string	Escolhas: - Enable - Disable	Habilita ou desabilita o endpoint de metadados HTTP em instâncias. Se for especificado um valor de disabled, os metadados da instância não estarão acessíveis.
http_tokens	string	Escolhas: - optional - required	Defina o estado de uso do token para solicitações de metadados de instância. Se o estado for opcional (v1 e v2), os metadados da instância poderão ser recuperados com ou sem um cabeçalho de token assinado mediante solicitação. Se o estado for obrigatório (v2), um cabeçalho de token assinado deverá ser enviado com todas as solicitações de recuperação de metadados da instância.

Subcampos da opção network

Parâmetros	Tipo	Escolhas \| Valor Padrão	Comentários
assign_public_ip	boolean	Escolhas: - true - false	quando true, atribui um endereço IP público à interface.
delete_on_termination	boolean	Escolhas: - true - false	Exclua a interface quando a instância à qual ela está anexada for encerrada.
description	string		uma descrição para a interface de rede
device_index	integer		O índice da interface para modificar
groups	list / elements=string		uma lista de IDs de grupos de segurança para anexar à interface
interfaces	list / elements=string		uma lista de IDs ENI (strings) ou uma lista de objetos contendo o ID da chave.
ipv6_addresses	list / elements=string		uma lista de endereços IPv6 para atribuir à interface de rede
private_ip_address	string		um endereço IPv4 para atribuir à interface
private_ip_addresses	list / elements=string		uma lista de endereços IPv4 para atribuir à interface de rede
source_dest_check	boolean	Escolhas: - true - false	controla se a verificação de origem/destino está habilitada na interface
subnet_id	string		a sub-rede para conectar a interface de rede

Subcampos da opção tower_callback

Parâmetros	Tipo	Comentários
host_config_key	string	Chave secreta de configuração do host gerada pelo modelo de trabalho da Torre.
job_template_id	string	O ID inteiro do modelo de trabalho de torre ou o nome (nome suportado apenas para torre 3.2+).
tower_address	string	Endereço IP ou nome DNS do servidor Torre. Deve ser acessível por meio desse endereço da VPC na qual esta instância será executada.

Notas

Se os parâmetros não forem definidos dentro do 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_SECURITY_TOKEN ou EC2_SECURITY_TOKEN

Quando nenhuma credencial é fornecida explicitamente, o AWS SDK (boto3) que o Atmosphere 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 geralmente podem ser usados para especificar a região da AWS, quando necessário, mas isso também pode ser definido nos arquivos de configuração.

Exemplos

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

- name: Encerre todas as instâncias em execução em uma região. Use com EXTREMA cautela.
  ec2_instance:
    state: absent
    filters:
      instance-state-name: running

- name: reinicie uma instância específica por seu ID
  ec2_instance:
    state: restarted
    instance_ids:
      - i-12345678

- name: iniciar uma instância com um endereço IP público
  ec2_instance:
    name: "public-compute-instance"
    key_name: "prod-ssh-key"
    vpc_subnet_id: subnet-5ca1ab1e
    instance_type: c5.large
    security_group: default
    network:
      assign_public_ip: true
    image_id: ami-123456
    tags:
      Environment: Testing

- name: inicie uma instância e adicione o EBS
  ec2_instance:
    name: "public-withebs-instance"
    vpc_subnet_id: subnet-5ca1ab1e
    instance_type: t2.micro
    key_name: "prod-ssh-key"
    security_group: default
    volumes:
      - device_name: /dev/sda1
        ebs:
          volume_size: 16
          delete_on_termination: true

- name: iniciar uma instância com um cpu_options
  ec2_instance:
    name: "public-cpuoption-instance"
    vpc_subnet_id: subnet-5ca1ab1e
    tags:
      Environment: Testing
    instance_type: c4.large
    volumes:
    - device_name: /dev/sda1
      ebs:
        delete_on_termination: true
    cpu_options:
        core_count: 1
        threads_per_core: 1

- name: inicie uma instância e faça com que ela inicie um retorno de chamada da Torre na inicialização
  ec2_instance:
    name: "tower-callback-test"
    key_name: "prod-ssh-key"
    vpc_subnet_id: subnet-5ca1ab1e
    security_group: default
    tower_callback:
      # IP or hostname of tower server
      tower_address: 1.2.3.4
      job_template_id: 876
      host_config_key: '[secret config key goes here]'
    network:
      assign_public_ip: true
    image_id: ami-123456
    cpu_credit_specification: unlimited
    tags:
      SomeThing: "A value"

- name: iniciar uma instância com ENI (é necessário um ID ENI existente)
  ec2_instance:
    name: "public-eni-instance"
    key_name: "prod-ssh-key"
    vpc_subnet_id: subnet-5ca1ab1e
    network:
      interfaces:
        - id: "eni-12345"
    tags:
      Env: "eni_on"
    volumes:
    - device_name: /dev/sda1
      ebs:
        delete_on_termination: true
    instance_type: t2.micro
    image_id: ami-123456

- name: adicionar segunda interface ENI
  ec2_instance:
    name: "public-eni-instance"
    network:
      interfaces:
        - id: "eni-12345"
        - id: "eni-67890"
    image_id: ami-123456
    tags:
      Env: "eni_on"
    instance_type: t2.micro
- name: iniciar uma instância com opções de metadados
  ec2_instance:
    name: "public-metadataoptions-instance"
    vpc_subnet_id: subnet-5calable
    instance_type: t3.small
    image_id: ami-123456
    tags:
      Environment: Testing
    metadata_options:
      http_endpoint: enabled
      http_tokens: optional

Valores retornados

Chave	Tipo	Retornado quando	Descrição
instances	complex	Quando wait == true	uma lista de instâncias ec2

Subcampos do valor de retorno instances

Parâmetro	Tipo	Retornado quando	Comentários
ami_launch_index	integer	Sempre	O índice de execução da AMI, que pode ser usado para localizar essa instância no grupo de execução.
architecture	string	Sempre	A arquitetura da imagem
block_device_mappings	complex	Sempre	Qualquer entrada de mapeamento de dispositivo de bloco para a instância.
client_token	string	Sempre	O token de idempotência fornecido ao executar a instância, se aplicável.
ebs_optimized	boolean	Sempre	Indica se a instância está otimizada para E/S do EBS.
hypervisor	string	Sempre	O tipo de hipervisor da instância.
iam_instance_profile	complex	Sempre	O perfil de instância do IAM associado à instância, se aplicável.
image_id	string	Sempre	O ID da AMI usado para iniciar a instância.
instance_id	string	Sempre	O ID da instância.
instance_type	string	Sempre	O tamanho do tipo de instância da instância em execução.
key_name	string	Sempre	O nome do par de chaves, se esta instância foi iniciada com um par de chaves associado.
launch_time	string	Sempre	A hora em que a instância foi iniciada.
monitoring	string	Sempre	O monitoramento para a instância.
network_interfaces	complex	Sempre	One or more network interfaces for the instance.
placement	complex	Sempre	O local em que a instância foi iniciada, se aplicável.
private_dns_name	string	Sempre	O nome DNS privado.
private_ip_address	string	Sempre	O endereço IPv4 da interface de rede na sub-rede.
product_codes	list / elements=dictionary	Sempre	Um ou mais códigos de produto.
public_dns_name	string	Sempre	O nome DNS público atribuído à instância.
public_ip_address	string	Sempre	O endereço IPv4 público atribuído à instância
root_device_name	string	Sempre	O nome do dispositivo do dispositivo raiz
root_device_type	string	Sempre	O tipo de dispositivo raiz usado pela AMI.
security_groups	list / elements=dictionary	Sempre	Um ou mais grupos de segurança para a instância.
state	complex	Sempre	O estado atual da instância.
state_transition_reason	string	Sempre	A razão para a transição de estado mais recente.
subnet_id	string	Sempre	O ID da sub-rede na qual a instância está em execução.
tags	dictionary	Sempre	Quaisquer tags atribuídas à instância.
virtualization_type	string	Sempre	O tipo de virtualização da AMI.
vpc_id	dictionary	Sempre	O ID da VPC em que a instância está.

Subcampos do valor de retorno block_device_mappings

Parâmetro	Tipo	Retornado quando	Comentários
device_name	String	Sempre	O nome do dispositivo exposto à instância (por exemplo, /dev/sdh ou xvdh).
ebs	complex	Sempre	Parâmetros usados para configurar automaticamente os volumes do EBS quando a instância é iniciada.

Subcampos do valor de retorno ebs

Parâmetro	Tipo	Retornado quando	Comentários
attach_time	String	Sempre	O carimbo de hora quando o anexo foi iniciado.
delete_on_termination	String	Sempre	Indica se o volume é excluído no encerramento da instância.
status	String	Sempre	O estado de apego.
volume_id	String	Sempre	O ID do volume EBS

Subcampos do valor de retorno iam_instance_profile

Parâmetro	Tipo	Retornado quando	Comentários
arn	String	Sempre	O nome de recurso da Amazon (ARN) do perfil da instância.
id	String	Sempre	O ID do perfil da instância

Subcampos do valor de retorno monitoring

Parâmetro	Tipo	Retornado quando	Comentários
state	String	Sempre	Indica se o monitoramento detalhado está ativado. Caso contrário, o monitoramento básico é ativado.

Subcampos do valor de retorno network_interfaces

Parâmetro	Tipo	Retornado quando	Comentários
association	complex	sempre	As informações de associação para um Elastic IPv4 associado à interface de rede.
attachment	complex	sempre	O anexo da interface de rede.
description	string	sempre	A descrição.
groups	list of complex	sempre	Um ou mais grupos de segurança.
ipv6_addresses	complex	sempre	Um ou mais endereços IPv6 associados à interface de rede.
mac_address	string	sempre	O endereço MAC.
network_interface_id	string	sempre	O ID da interface de rede.
owner_id	string	sempre	O ID da conta da AWS do proprietário da interface de rede.
private_ip_address	string	sempre	O endereço IPv4 da interface de rede na sub-rede.
private_ip_addresses	list of complex	sempre	Os endereços IPv4 privados associados à interface de rede.
source_dest_check	boolean	sempre	Indica se a verificação de origem/destino está habilitada.
status	string	sempre	O status da interface de rede.
subnet_id	string	sempre	O ID da sub-rede para a interface de rede.
vpc_id	string	sempre	O ID da VPC para a interface de rede.

Subcampos do valor de retorno association

Parâmetro	Tipo	Retornado quando	Comentários
ip_owner_id	string	sempre	O ID do proprietário do endereço IP elástico.
public_dns_name	string	sempre	O nome DNS público.
public_ip	string	sempre	O endereço IP público ou endereço IP elástico vinculado à interface de rede.

Subcampos do valor de retorno attachment

Parâmetro	Tipo	Retornado quando	Comentários
attach_time	string	sempre	O carimbo de hora quando o anexo foi iniciado.
attachment_id	string	sempre	A ID do anexo da interface de rede.
delete_on_termination	boolean	sempre	Indica se a interface de rede é excluída quando a instância é encerrada.
device_index	integer	sempre	O índice do dispositivo na instância para o anexo da interface de rede.
status	string	sempre	O estado do attachment.

Subcampos do valor de retorno groups

Parâmetro	Tipo	Retornado quando	Comentários
group_id	string	sempre	A ID do grupo de segurança.
group_name	string	sempre	O nome do grupo de segurança.

Subcampos do valor de retorno ipv6_addresses

Parâmetro	Tipo	Retornado quando	Comentários
ipv6_address	string	sempre	O endereço IPv6.

Subcampos do valor de retorno private_ip_addresses

Parâmetro	Tipo	Retornado quando	Comentários
association	complex	sempre	As informações de associação para um endereço IP elástico (IPv4) associado à interface de rede.
primary	boolean	sempre	Indica se este endereço IPv4 é o endereço IP privado primário da interface de rede.
private_ip_address	string	sempre	O endereço IPv4 privado da interface de rede.

Subcampos do valor de retorno association

Parâmetro	Tipo	Retornado quando	Comentários
ip_owner_id	string	sempre	O ID do proprietário do endereço IP elástico.
public_dns_name	string	sempre	O nome DNS público.
public_ip	string	sempre	O endereço IP público ou endereço IP elástico vinculado à interface de rede.

Subcampos do valor de retorno placement

Parâmetro	Tipo	Retornado quando	Comentários
availability_zone	string	sempre	A zona de disponibilidade da instância.
group_name	string	sempre	O nome do placement group em que a instância está (para instâncias de computação em cluster).
tenancy	string	sempre	A locação da instância (se a instância estiver sendo executada em uma VPC).

Subcampos do valor de retorno product_codes

Parâmetro	Tipo	Retornado quando	Comentários
product_code_id	string	sempre	O código do produto.
product_code_type	string	sempre	O tipo de código do produto.

Subcampos do valor de retorno security_groups

Parâmetro	Tipo	Retornado quando	Comentários
group_id	string	sempre	A ID do grupo de segurança.
group_name	string	sempre	O nome do grupo de segurança.

Subcampos do valor de retorno state

Parâmetro	Tipo	Retornado quando	Comentários
code	string	sempre	O byte baixo representa o estado.
name	string	sempre	O nome do estado.