Esta página fornece uma referência para as ações do AWS Auto Scaling disponíveis no catálogo de ações de automação de fluxo de trabalho. Use essas ações para gerenciar Auto Scaling Groups (ASGs) — anexar e desanexar instâncias, ajustar a capacidade, executar políticas de escalabilidade, gerenciar atualizações de instância, controlar processos de escalabilidade e consultar o estado do ASG.
Pré-requisitos
Para pré-requisitos e configuração de credenciais, consulte Configurar credenciais da AWS.
Anexar instâncias
O identificador da ação é aws.autoscaling.attachInstances.
Anexe uma ou mais instâncias de EC2 a um Auto Scaling group existente. Anexar instâncias aumenta a capacidade desejada pelo número anexado. É possível anexar até 20 instâncias por chamada. As instâncias devem estar no estado em execução ou interrompido, e a anexação não deve exceder o tamanho máximo do grupo.
A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
awsRoleArn | Corda | Opcional. ARN da função do IAM. O executor assume essa função via STS para se autenticar na AWS. Recomendado em vez de credenciais estáticas. Pelo menos um campo de autenticação é obrigatório. |
|
awsAccessKeyId | Corda | Opcional. ID da chave de acesso da AWS. Deve ser passado como uma referência de segredo. |
|
awsSecretAccessKey | Corda | Opcional. Chave de acesso secreta da AWS. Deve ser passado como uma referência de segredo. |
|
awsSessionToken | Corda | Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como uma referência de segredo. |
|
região | Corda | Obrigatório. Região da AWS onde o grupo do Auto Scaling está localizado. |
|
autoScalingGroupName | Corda | Obrigatório. Nome do grupo do Auto Scaling. |
|
instanceIds | Lista | Obrigatório. IDs de instâncias de EC2 para anexar. |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Descrição |
|---|---|---|
response | Objeto | Objeto de resposta da API da AWS. Consulte attach_instances — documentação do Boto3 para ver a sintaxe completa da resposta. |
success | Boleano |
se a ação foi bem-sucedida,
caso contrário. |
errorMessage | Corda | Mensagem de erro se a ação falhar.
em caso de sucesso. |
O exemplo a seguir anexa uma instância de EC2 a um Auto Scaling group.
Exemplo de fluxo de trabalho |
|---|
|
Desvincular instâncias
O identificador da ação é aws.autoscaling.detachInstances.
Desvincule uma ou mais instâncias de EC2 de um grupo do Auto Scaling. É possível desvincular até 20 instâncias por chamada. As instâncias devem estar no estado InService ou Standby. Se shouldDecrementDesiredCapacity for false, o ASG realiza o lançamento de instâncias de substituição para manter a capacidade desejada.
A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
awsRoleArn | Corda | Opcional. ARN da função do IAM. O executor assume essa função via STS para se autenticar na AWS. Recomendado em vez de credenciais estáticas. Pelo menos um campo de autenticação é obrigatório. |
|
awsAccessKeyId | Corda | Opcional. ID da chave de acesso da AWS. Deve ser passado como uma referência de segredo. |
|
awsSecretAccessKey | Corda | Opcional. Chave de acesso secreta da AWS. Deve ser passado como uma referência de segredo. |
|
awsSessionToken | Corda | Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como uma referência de segredo. |
|
região | Corda | Obrigatório. Região da AWS onde o grupo do Auto Scaling está localizado. |
|
autoScalingGroupName | Corda | Obrigatório. Nome do grupo do Auto Scaling. |
|
instanceIds | Lista | Obrigatório. IDs de instâncias de EC2 para desanexar. |
|
shouldDecrementDesiredCapacity | Boleano | Obrigatório. Se
, reduz a capacidade desejada pelo número de instâncias desanexadas. Se
, o ASG realiza o lançamento de substituições. |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Descrição |
|---|---|---|
response | Objeto | Objeto de resposta da API da AWS. Consulte detach_instances — documentação do Boto3 para ver a sintaxe completa da resposta. |
success | Boleano |
se a ação foi bem-sucedida,
caso contrário. |
errorMessage | Corda | Mensagem de erro se a ação falhar.
em caso de sucesso. |
O exemplo a seguir desvincula uma instância e diminui a capacidade desejada.
Exemplo de fluxo de trabalho |
|---|
|
Definir capacidade desejada
O identificador da ação é aws.autoscaling.setDesiredCapacity.
Atualize a contagem de instância desejada de um grupo do Auto Scaling. O novo valor deve estar entre MinSize e MaxSize do grupo. Se honorCooldown for true, a solicitação será rejeitada quando o ASG estiver em seu período de cooldown.
A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
awsRoleArn | Corda | Opcional. ARN da função do IAM. O executor assume essa função via STS para se autenticar na AWS. Recomendado em vez de credenciais estáticas. Pelo menos um campo de autenticação é obrigatório. |
|
awsAccessKeyId | Corda | Opcional. ID da chave de acesso da AWS. Deve ser passado como uma referência de segredo. |
|
awsSecretAccessKey | Corda | Opcional. Chave de acesso secreta da AWS. Deve ser passado como uma referência de segredo. |
|
awsSessionToken | Corda | Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como uma referência de segredo. |
|
região | Corda | Obrigatório. Região da AWS onde o grupo do Auto Scaling está localizado. |
|
autoScalingGroupName | Corda | Obrigatório. Nome do grupo do Auto Scaling. |
|
desiredCapacity | Interno | Obrigatório. Número de instâncias de destino. Deve estar entre
e
do grupo. |
|
honorCooldown | Boleano | Opcional. Se
, rejeita a solicitação quando o ASG estiver em um período de espera. O padrão é
. |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Descrição |
|---|---|---|
response | Objeto | Objeto de resposta da API da AWS. Consulte set_desired_capacity — Boto3 documentation para obter a sintaxe completa da resposta. |
success | Boleano |
se a ação foi bem-sucedida,
caso contrário. |
errorMessage | Corda | Mensagem de erro se a ação falhar.
em caso de sucesso. |
O exemplo a seguir define a capacidade desejada para 5 instâncias.
Exemplo de fluxo de trabalho |
|---|
|
Executar uma política de escalonamento
O identificador da ação é aws.autoscaling.executePolicy.
Execute uma política de escalabilidade nomeada em um grupo do Auto Scaling. A política já deve existir no grupo. Para políticas de escalabilidade em etapas, metricValue e breachThreshold podem substituir os limites da política. Se honorCooldown for true e o ASG estiver em cooldown, a chamada será bem-sucedida, mas nenhuma atividade de escalabilidade será acionada.
A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
awsRoleArn | Corda | Opcional. ARN da função do IAM. O executor assume essa função via STS para se autenticar na AWS. Recomendado em vez de credenciais estáticas. Pelo menos um campo de autenticação é obrigatório. |
|
awsAccessKeyId | Corda | Opcional. ID da chave de acesso da AWS. Deve ser passado como uma referência de segredo. |
|
awsSecretAccessKey | Corda | Opcional. Chave de acesso secreta da AWS. Deve ser passado como uma referência de segredo. |
|
awsSessionToken | Corda | Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como uma referência de segredo. |
|
região | Corda | Obrigatório. Região da AWS onde o grupo do Auto Scaling está localizado. |
|
autoScalingGroupName | Corda | Obrigatório. Nome do grupo do Auto Scaling. |
|
policyName | Corda | Obrigatório. Nome ou ARN da política de escalonamento a ser executada. |
|
honorCooldown | Boleano | Opcional. Se
e o ASG estiver em cooldown, a chamada será bem-sucedida, mas nenhuma atividade de escalonamento será acionada. |
|
metricValue | Corda | Opcional. Substituição do valor da métrica para políticas de escalabilidade em etapas. |
|
breachThreshold | Corda | Opcional. Substituição do limite de violação para políticas de escalabilidade em etapas. |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Descrição |
|---|---|---|
response | Objeto | Objeto de resposta da API da AWS. Consulte execute_policy — Boto3 documentation para ver a sintaxe completa da resposta. |
success | Boleano |
se a ação foi bem-sucedida,
caso contrário. |
errorMessage | Corda | Mensagem de erro se a ação falhar.
em caso de sucesso. |
O exemplo a seguir executa uma política de scale-out nomeada.
Exemplo de fluxo de trabalho |
|---|
|
Iniciar uma atualização de instância
O identificador da ação é aws.autoscaling.startInstanceRefresh.
Inicie uma substituição contínua de instâncias usando o modelo de lançamento ou configuração mais recente. Apenas uma atualização pode estar ativa por grupo por vez — se uma já estiver em andamento, a chamada falhará com InstanceRefreshInProgress. Use aws.autoscaling.describeInstanceRefreshes para consultar o status.
A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
awsRoleArn | Corda | Opcional. ARN da função do IAM. O executor assume essa função via STS para se autenticar na AWS. Recomendado em vez de credenciais estáticas. Pelo menos um campo de autenticação é obrigatório. |
|
awsAccessKeyId | Corda | Opcional. ID da chave de acesso da AWS. Deve ser passado como uma referência de segredo. |
|
awsSecretAccessKey | Corda | Opcional. Chave de acesso secreta da AWS. Deve ser passado como uma referência de segredo. |
|
awsSessionToken | Corda | Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como uma referência de segredo. |
|
região | Corda | Obrigatório. Região da AWS onde o grupo do Auto Scaling está localizado. |
|
autoScalingGroupName | Corda | Obrigatório. Nome do grupo do Auto Scaling. |
|
estratégia | Corda | Opcional. Estratégia de atualização.
é o único valor compatível. |
|
preferências | Mapa | Opcional. Preferências de atualização.
controla quantas instâncias permanecem íntegras durante a substituição (padrão de 90%).
define quanto tempo esperar depois que uma instância atinge
antes de substituir o próximo lote. |
|
desiredConfiguration | Mapa | Opcional. Substitua o modelo de lançamento ou a configuração para esta atualização. |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Descrição |
|---|---|---|
response | Objeto | Contém
(UUID de string) que identifica a atualização. Consulte start_instance_refresh — documentação do Boto3 para obter a sintaxe de resposta completa. |
success | Boleano |
se a ação foi bem-sucedida,
caso contrário. |
errorMessage | Corda | Mensagem de erro se a ação falhar.
em caso de sucesso. |
O exemplo a seguir inicia uma atualização contínua de instância com um mínimo de 90% de instâncias íntegras.
Exemplo de fluxo de trabalho |
|---|
|
Cancelar uma atualização de instância
O identificador da ação é aws.autoscaling.cancelInstanceRefresh.
Cancelar uma atualização de instância em andamento. Apenas uma atualização em andamento pode ser cancelada — chamar isso quando nenhuma atualização estiver ativa falha com ActiveInstanceRefreshNotFound. As instâncias já substituídas não são revertidas; use aws.autoscaling.rollbackInstanceRefresh para reverter as instâncias substituídas.
A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
awsRoleArn | Corda | Opcional. ARN da função do IAM. O executor assume essa função via STS para se autenticar na AWS. Recomendado em vez de credenciais estáticas. Pelo menos um campo de autenticação é obrigatório. |
|
awsAccessKeyId | Corda | Opcional. ID da chave de acesso da AWS. Deve ser passado como uma referência de segredo. |
|
awsSecretAccessKey | Corda | Opcional. Chave de acesso secreta da AWS. Deve ser passado como uma referência de segredo. |
|
awsSessionToken | Corda | Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como uma referência de segredo. |
|
região | Corda | Obrigatório. Região da AWS onde o grupo do Auto Scaling está localizado. |
|
autoScalingGroupName | Corda | Obrigatório. Nome do grupo do Auto Scaling. |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Descrição |
|---|---|---|
response | Objeto | Contém
da atualização cancelada. Consulte cancel_instance_refresh — documentação do Boto3 para obter a sintaxe completa da resposta. |
success | Boleano |
se a ação foi bem-sucedida,
caso contrário. |
errorMessage | Corda | Mensagem de erro se a ação falhar.
em caso de sucesso. |
O exemplo a seguir cancela uma atualização de instância em andamento.
Exemplo de fluxo de trabalho |
|---|
|
Reverter uma atualização de instância
O identificador da ação é aws.autoscaling.rollbackInstanceRefresh.
Reverta uma atualização de instância em andamento, revertendo as instâncias substituídas para seu modelo de lançamento ou configuração anterior. O grupo deve ter um checkpoint habilitado para suportar a reversão. Se nenhuma atualização for elegível para reversão, a chamada falhará com ActiveInstanceRefreshNotFound.
A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
awsRoleArn | Corda | Opcional. ARN da função do IAM. O executor assume essa função via STS para se autenticar na AWS. Recomendado em vez de credenciais estáticas. Pelo menos um campo de autenticação é obrigatório. |
|
awsAccessKeyId | Corda | Opcional. ID da chave de acesso da AWS. Deve ser passado como uma referência de segredo. |
|
awsSecretAccessKey | Corda | Opcional. Chave de acesso secreta da AWS. Deve ser passado como uma referência de segredo. |
|
awsSessionToken | Corda | Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como uma referência de segredo. |
|
região | Corda | Obrigatório. Região da AWS onde o grupo do Auto Scaling está localizado. |
|
autoScalingGroupName | Corda | Obrigatório. Nome do grupo do Auto Scaling. |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Descrição |
|---|---|---|
response | Objeto | Contém
da atualização revertida. Consulte rollback_instance_refresh — Boto3 documentation para obter a sintaxe completa da resposta. |
success | Boleano |
se a ação foi bem-sucedida,
caso contrário. |
errorMessage | Corda | Mensagem de erro se a ação falhar.
em caso de sucesso. |
O exemplo a seguir reverte uma atualização de instância em andamento.
Exemplo de fluxo de trabalho |
|---|
|
Suspender processos de escalabilidade
O identificador da ação é aws.autoscaling.suspendProcesses.
Suspenda um ou mais processos de escalabilidade de um grupo do Auto Scaling. Use durante implantações ou janelas de manutenção para evitar atividades de escalabilidade indesejadas. Se omitir scalingProcesses, todos os processos serão suspensos. Os processos suspensos permanecem suspensos até serem retomados explicitamente com aws.autoscaling.resumeProcesses.
A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
awsRoleArn | Corda | Opcional. ARN da função do IAM. O executor assume essa função via STS para se autenticar na AWS. Recomendado em vez de credenciais estáticas. Pelo menos um campo de autenticação é obrigatório. |
|
awsAccessKeyId | Corda | Opcional. ID da chave de acesso da AWS. Deve ser passado como uma referência de segredo. |
|
awsSecretAccessKey | Corda | Opcional. Chave de acesso secreta da AWS. Deve ser passado como uma referência de segredo. |
|
awsSessionToken | Corda | Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como uma referência de segredo. |
|
região | Corda | Obrigatório. Região da AWS onde o grupo do Auto Scaling está localizado. |
|
autoScalingGroupName | Corda | Obrigatório. Nome do grupo do Auto Scaling. |
|
scalingProcesses | Lista | Opcional. Processos a serem suspensos. Omita para suspender todos os processos. Valores válidos:
,
,
,
,
,
,
,
,
. |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Descrição |
|---|---|---|
response | Objeto | Objeto de resposta da API da AWS. Consulte suspend_processes — documentação do Boto3 para ver a sintaxe completa da resposta. |
success | Boleano |
se a ação foi bem-sucedida,
caso contrário. |
errorMessage | Corda | Mensagem de erro se a ação falhar.
em caso de sucesso. |
O exemplo a seguir suspende os processos de Lançamento, Terminate e HealthCheck antes de uma implantação.
Exemplo de fluxo de trabalho |
|---|
|
Retomar processos de dimensionamento
O identificador da ação é aws.autoscaling.resumeProcesses.
Retome um ou mais processos de escalabilidade suspensos. Use após implantações ou janelas de manutenção para restaurar o comportamento normal de escalabilidade. Se omitir scalingProcesses, todos os processos suspensos serão retomados. Se nenhum processo estiver suspenso no momento, a chamada será bem-sucedida sem efeito.
A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
awsRoleArn | Corda | Opcional. ARN da função do IAM. O executor assume essa função via STS para se autenticar na AWS. Recomendado em vez de credenciais estáticas. Pelo menos um campo de autenticação é obrigatório. |
|
awsAccessKeyId | Corda | Opcional. ID da chave de acesso da AWS. Deve ser passado como uma referência de segredo. |
|
awsSecretAccessKey | Corda | Opcional. Chave de acesso secreta da AWS. Deve ser passado como uma referência de segredo. |
|
awsSessionToken | Corda | Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como uma referência de segredo. |
|
região | Corda | Obrigatório. Região da AWS onde o grupo do Auto Scaling está localizado. |
|
autoScalingGroupName | Corda | Obrigatório. Nome do grupo do Auto Scaling. |
|
scalingProcesses | Lista | Opcional. Processos a serem retomados. Omita para retomar todos os processos suspensos. |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Descrição |
|---|---|---|
response | Objeto | Objeto de resposta da API da AWS. Consulte resume_processes — documentação do Boto3 para obter a sintaxe de resposta completa. |
success | Boleano |
se a ação foi bem-sucedida,
caso contrário. |
errorMessage | Corda | Mensagem de erro se a ação falhar.
em caso de sucesso. |
O exemplo a seguir retoma os processos de escalabilidade após uma implantação.
Exemplo de fluxo de trabalho |
|---|
|
Encerrar uma instância em um grupo
O identificador da ação é aws.autoscaling.terminateInstanceInAutoScalingGroup.
Encerrar uma instância específica em um grupo do Auto Scaling respeitando os ganchos de ciclo de vida. Defina shouldDecrementDesiredCapacity como false para substituir a instância automaticamente, ou true para reduzir o grupo.
A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
awsRoleArn | Corda | Opcional. ARN da função do IAM. O executor assume essa função via STS para se autenticar na AWS. Recomendado em vez de credenciais estáticas. Pelo menos um campo de autenticação é obrigatório. |
|
awsAccessKeyId | Corda | Opcional. ID da chave de acesso da AWS. Deve ser passado como uma referência de segredo. |
|
awsSecretAccessKey | Corda | Opcional. Chave de acesso secreta da AWS. Deve ser passado como uma referência de segredo. |
|
awsSessionToken | Corda | Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como uma referência de segredo. |
|
região | Corda | Obrigatório. Região da AWS onde o grupo do Auto Scaling está localizado. |
|
instanceId | Corda | Obrigatório. ID da instância de EC2 a ser encerrada. |
|
shouldDecrementDesiredCapacity | Boleano | Obrigatório. Se
, reduz a capacidade desejada em 1. Se
, o lançamento de uma instância de substituição é realizado automaticamente. |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Descrição |
|---|---|---|
response | Objeto | Contém um objeto
com
,
e
. Consulte terminate_instance_in_auto_scaling_group — documentação do Boto3 para ver a sintaxe completa da resposta. |
success | Boleano |
se a ação foi bem-sucedida,
caso contrário. |
errorMessage | Corda | Mensagem de erro se a ação falhar.
em caso de sucesso. |
O exemplo a seguir encerra uma instância não íntegra e realiza o lançamento de uma substituta.
Exemplo de fluxo de trabalho |
|---|
|
Mover instâncias para standby
O identificador da ação é aws.autoscaling.enterStandby.
Mova uma ou mais instâncias para o modo de espera, retirando-as da rotação ativa sem encerrá-las. Use para manutenção em instâncias específicas. Combine com aws.autoscaling.exitStandby para retornar as instâncias ao serviço.
A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
awsRoleArn | Corda | Opcional. ARN da função do IAM. O executor assume essa função via STS para se autenticar na AWS. Recomendado em vez de credenciais estáticas. Pelo menos um campo de autenticação é obrigatório. |
|
awsAccessKeyId | Corda | Opcional. ID da chave de acesso da AWS. Deve ser passado como uma referência de segredo. |
|
awsSecretAccessKey | Corda | Opcional. Chave de acesso secreta da AWS. Deve ser passado como uma referência de segredo. |
|
awsSessionToken | Corda | Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como uma referência de segredo. |
|
região | Corda | Obrigatório. Região da AWS onde o grupo do Auto Scaling está localizado. |
|
autoScalingGroupName | Corda | Obrigatório. Nome do grupo do Auto Scaling. |
|
instanceIds | Lista | Opcional. ID da instância para mover para o modo de espera. Omita para mover todas as instâncias. |
|
shouldDecrementDesiredCapacity | Boleano | Obrigatório. Se
, reduz a capacidade desejada pelo número de instâncias que entram em espera. |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Descrição |
|---|---|---|
response | Objeto | Contém uma matriz
que descreve a transição para o modo de espera de cada instância. Consulte enter_standby — documentação do Boto3 para ver a sintaxe completa da resposta. |
success | Boleano |
se a ação foi bem-sucedida,
caso contrário. |
errorMessage | Corda | Mensagem de erro se a ação falhar.
em caso de sucesso. |
O exemplo a seguir move uma instância para o modo de espera para manutenção.
Exemplo de fluxo de trabalho |
|---|
|
Sair do modo de espera
O identificador da ação é aws.autoscaling.exitStandby.
Retorna uma ou mais instâncias do modo de espera de volta à rotação ativa. Emparelhe com aws.autoscaling.enterStandby após a conclusão da manutenção. Se você omitir instanceIds, todas as instâncias em espera retornarão ao serviço.
A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
awsRoleArn | Corda | Opcional. ARN da função do IAM. O executor assume essa função via STS para se autenticar na AWS. Recomendado em vez de credenciais estáticas. Pelo menos um campo de autenticação é obrigatório. |
|
awsAccessKeyId | Corda | Opcional. ID da chave de acesso da AWS. Deve ser passado como uma referência de segredo. |
|
awsSecretAccessKey | Corda | Opcional. Chave de acesso secreta da AWS. Deve ser passado como uma referência de segredo. |
|
awsSessionToken | Corda | Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como uma referência de segredo. |
|
região | Corda | Obrigatório. Região da AWS onde o grupo do Auto Scaling está localizado. |
|
autoScalingGroupName | Corda | Obrigatório. Nome do grupo do Auto Scaling. |
|
instanceIds | Lista | Opcional. IDs da instância para retornar à rotação ativa. Omita para retirar todas as instâncias de espera. |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Descrição |
|---|---|---|
response | Objeto | Contém uma matriz
que descreve o retorno de cada instância ao serviço. Consulte exit_standby — documentação do Boto3 para ver a sintaxe de resposta completa. |
success | Boleano |
se a ação foi bem-sucedida,
caso contrário. |
errorMessage | Corda | Mensagem de erro se a ação falhar.
em caso de sucesso. |
O exemplo a seguir retorna uma instância do modo de espera após a manutenção.
Exemplo de fluxo de trabalho |
|---|
|
Criar ou atualizar uma ação agendada
O identificador da ação é aws.autoscaling.putScheduledUpdateGroupAction.
Crie ou atualize uma ação de escalabilidade programada para um grupo do Auto Scaling. Use recurrence para programações baseadas em cron ou startTime para alterações únicas. Combine com aws.autoscaling.deleteScheduledAction para remover ações.
A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
awsRoleArn | Corda | Opcional. ARN da função do IAM. O executor assume essa função via STS para se autenticar na AWS. Recomendado em vez de credenciais estáticas. Pelo menos um campo de autenticação é obrigatório. |
|
awsAccessKeyId | Corda | Opcional. ID da chave de acesso da AWS. Deve ser passado como uma referência de segredo. |
|
awsSecretAccessKey | Corda | Opcional. Chave de acesso secreta da AWS. Deve ser passado como uma referência de segredo. |
|
awsSessionToken | Corda | Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como uma referência de segredo. |
|
região | Corda | Obrigatório. Região da AWS onde o grupo do Auto Scaling está localizado. |
|
autoScalingGroupName | Corda | Obrigatório. Nome do grupo do Auto Scaling. |
|
scheduledActionName | Corda | Obrigatório. Nome da ação programada para criar ou atualizar. |
|
startTime | Corda | Opcional. timestamp UTC ISO 8601 para quando a ação entrar em vigor. |
|
endTime | Corda | Opcional. Timestamp UTC ISO 8601 para quando a ação recorrente é interrompida. |
|
recorrência | Corda | Opcional. Expressão cron para programações recorrentes. |
|
timeZone | Corda | Opcional. Fuso horário da IANA para a expressão cron de recorrência. |
|
minSize | Interno | Opcional. Tamanho mínimo do grupo a ser aplicado no horário agendado. |
|
maxSize | Interno | Opcional. Tamanho máximo do grupo a ser aplicado no horário agendado. |
|
desiredCapacity | Interno | Opcional. Capacidade desejada a ser aplicada no horário programado. |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Descrição |
|---|---|---|
response | Objeto | Objeto de resposta da API da AWS. Consulte put_scheduled_update_group_action — documentação do Boto3 para obter a sintaxe de resposta completa. |
success | Boleano |
se a ação foi bem-sucedida,
caso contrário. |
errorMessage | Corda | Mensagem de erro se a ação falhar.
em caso de sucesso. |
O exemplo a seguir cria uma ação de redução de escala noturna.
Exemplo de fluxo de trabalho |
|---|
|
Excluir uma ação agendada
O identificador da ação é aws.autoscaling.deleteScheduledAction.
Exclua uma ação de escalonamento programada de um grupo do Auto Scaling. Apenas uma ação pode ser excluída por chamada. Se o nome da ação não existir, a chamada falhará com ValidationError. A exclusão de uma ação não afeta nenhuma atividade de escalonamento já em andamento.
A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
awsRoleArn | Corda | Opcional. ARN da função do IAM. O executor assume essa função via STS para se autenticar na AWS. Recomendado em vez de credenciais estáticas. Pelo menos um campo de autenticação é obrigatório. |
|
awsAccessKeyId | Corda | Opcional. ID da chave de acesso da AWS. Deve ser passado como uma referência de segredo. |
|
awsSecretAccessKey | Corda | Opcional. Chave de acesso secreta da AWS. Deve ser passado como uma referência de segredo. |
|
awsSessionToken | Corda | Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como uma referência de segredo. |
|
região | Corda | Obrigatório. Região da AWS onde o grupo do Auto Scaling está localizado. |
|
autoScalingGroupName | Corda | Obrigatório. Nome do grupo do Auto Scaling. |
|
scheduledActionName | Corda | Obrigatório. Nome da ação agendada a ser excluída. |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Descrição |
|---|---|---|
response | Objeto | Objeto de resposta da API da AWS. Consulte delete_scheduled_action — documentação do Boto3 para obter a sintaxe de resposta completa. |
success | Boleano |
se a ação foi bem-sucedida,
caso contrário. |
errorMessage | Corda | Mensagem de erro se a ação falhar.
em caso de sucesso. |
O exemplo a seguir exclui uma ação de escalabilidade agendada.
Exemplo de fluxo de trabalho |
|---|
|
Atualize um grupo do Auto Scaling
O identificador da ação é aws.autoscaling.updateAutoScalingGroup.
Atualize a configuração de um grupo do Auto Scaling existente — tamanho mínimo/máximo, capacidade desejada, configurações de verificação de integridade, modelo de lançamento e muito mais. Use o mapa parameters para passar quaisquer campos adicionais da API boto3 update_auto_scaling_group não listados abaixo.
A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
awsRoleArn | Corda | Opcional. ARN da função do IAM. O executor assume essa função via STS para se autenticar na AWS. Recomendado em vez de credenciais estáticas. Pelo menos um campo de autenticação é obrigatório. |
|
awsAccessKeyId | Corda | Opcional. ID da chave de acesso da AWS. Deve ser passado como uma referência de segredo. |
|
awsSecretAccessKey | Corda | Opcional. Chave de acesso secreta da AWS. Deve ser passado como uma referência de segredo. |
|
awsSessionToken | Corda | Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como uma referência de segredo. |
|
região | Corda | Obrigatório. Região da AWS onde o grupo do Auto Scaling está localizado. |
|
autoScalingGroupName | Corda | Obrigatório. Nome do grupo do Auto Scaling para atualizar. |
|
minSize | Interno | Opcional. Novo tamanho mínimo do grupo. |
|
maxSize | Interno | Opcional. Novo tamanho máximo do grupo. |
|
desiredCapacity | Interno | Opcional. Nova contagem de instâncias desejada. |
|
defaultCooldown | Interno | Opcional. Período de espera padrão em segundos. |
|
healthCheckType | Corda | Opcional. Tipo de verificação de integridade. Valores permitidos:
,
. |
|
healthCheckGracePeriod | Interno | Opcional. Segundos após o lançamento da instância antes do início das verificações de integridade. |
|
parâmetro | Mapa | Opcional. Quaisquer campos adicionais do boto3
não listados acima. |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Descrição |
|---|---|---|
response | Objeto | Objeto de resposta da API da AWS. Consulte update_auto_scaling_group — Boto3 documentation para ver a sintaxe de resposta completa. |
success | Boleano |
se a ação foi bem-sucedida,
caso contrário. |
errorMessage | Corda | Mensagem de erro se a ação falhar.
em caso de sucesso. |
O exemplo a seguir atualiza os limites mínimo/máximo, o tipo de verificação de integridade e o modelo de lançamento.
Exemplo de fluxo de trabalho |
|---|
|
Descrever grupos do Auto Scaling
O identificador da ação é aws.autoscaling.describeAutoScalingGroups.
Descreve um ou mais grupos do Auto Scaling, retornando a configuração e o estado da instância. Se você omitir autoScalingGroupNames, todos os grupos na região serão retornados. Use maxRecords e nextToken para paginar grandes conjuntos de resultados.
A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
awsRoleArn | Corda | Opcional. ARN da função do IAM. O executor assume essa função via STS para se autenticar na AWS. Recomendado em vez de credenciais estáticas. Pelo menos um campo de autenticação é obrigatório. |
|
awsAccessKeyId | Corda | Opcional. ID da chave de acesso da AWS. Deve ser passado como uma referência de segredo. |
|
awsSecretAccessKey | Corda | Opcional. Chave de acesso secreta da AWS. Deve ser passado como uma referência de segredo. |
|
awsSessionToken | Corda | Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como uma referência de segredo. |
|
região | Corda | Obrigatório. Região da AWS onde o grupo do Auto Scaling está localizado. |
|
autoScalingGroupNames | Lista | Opcional. Nomes dos grupos a serem descritos. Omita para retornar todos os grupos na região. |
|
maxRecords | Interno | Opcional. Número máximo de grupos a serem retornados. Máximo de 100. |
|
nextToken | Corda | Opcional. Token de paginação de uma resposta anterior. |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Descrição |
|---|---|---|
response | Objeto | Contém uma matriz
com a configuração e o estado da instância para cada grupo. Consulte describe_auto_scaling_groups — documentação do Boto3 para obter a sintaxe de resposta completa. |
success | Boleano |
se a ação foi bem-sucedida,
caso contrário. |
errorMessage | Corda | Mensagem de erro se a ação falhar.
em caso de sucesso. |
O exemplo a seguir recupera a capacidade desejada, o mínimo, o máximo e a contagem de instância de um grupo.
Exemplo de fluxo de trabalho |
|---|
|
Descrever atualizações de instância
O identificador da ação é aws.autoscaling.describeInstanceRefreshes.
Descreve o status de uma ou mais atualizações de instância para um grupo do Auto Scaling. Use para consultar uma atualização iniciada por aws.autoscaling.startInstanceRefresh. Se omitir instanceRefreshIds, todas as atualizações do grupo serão retornadas, as mais recentes primeiro. Atualizações concluídas, canceladas e com falha são retidas no histórico.
A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
awsRoleArn | Corda | Opcional. ARN da função do IAM. O executor assume essa função via STS para se autenticar na AWS. Recomendado em vez de credenciais estáticas. Pelo menos um campo de autenticação é obrigatório. |
|
awsAccessKeyId | Corda | Opcional. ID da chave de acesso da AWS. Deve ser passado como uma referência de segredo. |
|
awsSecretAccessKey | Corda | Opcional. Chave de acesso secreta da AWS. Deve ser passado como uma referência de segredo. |
|
awsSessionToken | Corda | Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como uma referência de segredo. |
|
região | Corda | Obrigatório. Região da AWS onde o grupo do Auto Scaling está localizado. |
|
autoScalingGroupName | Corda | Obrigatório. Nome do grupo do Auto Scaling. |
|
instanceRefreshIds | Lista | Opcional. IDs de atualizações específicas a serem descritas. Omita para obter todas as atualizações do grupo. |
|
maxRecords | Interno | Opcional. Número máximo de atualizações a serem retornadas. Padrão 50, máx. 100. |
|
nextToken | Corda | Opcional. Token de paginação de uma resposta anterior. |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Descrição |
|---|---|---|
response | Objeto | Contém uma matriz
com
,
e outros detalhes de atualização. Consulte describe_instance_refreshes — Boto3 documentation para ver a sintaxe de resposta completa. |
success | Boleano |
se a ação foi bem-sucedida,
caso contrário. |
errorMessage | Corda | Mensagem de erro se a ação falhar.
em caso de sucesso. |
O exemplo a seguir consulta o status de uma atualização iniciada em uma etapa anterior.
Exemplo de fluxo de trabalho |
|---|
|
Descrever atividades de dimensionamento
O identificador da ação é aws.autoscaling.describeScalingActivities.
Descreva as atividades de escalonamento de um grupo do Auto Scaling, incluindo eventos em andamento e concluídos recentemente. Se você omitir activityIds, todas as atividades do grupo serão retornadas, com as mais recentes primeiro. As atividades incluem eventos de redução e expansão bem-sucedidos e com falha.
A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
awsRoleArn | Corda | Opcional. ARN da função do IAM. O executor assume essa função via STS para se autenticar na AWS. Recomendado em vez de credenciais estáticas. Pelo menos um campo de autenticação é obrigatório. |
|
awsAccessKeyId | Corda | Opcional. ID da chave de acesso da AWS. Deve ser passado como uma referência de segredo. |
|
awsSecretAccessKey | Corda | Opcional. Chave de acesso secreta da AWS. Deve ser passado como uma referência de segredo. |
|
awsSessionToken | Corda | Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como uma referência de segredo. |
|
região | Corda | Obrigatório. Região da AWS onde o grupo do Auto Scaling está localizado. |
|
autoScalingGroupName | Corda | Opcional. Nome do grupo para consulta. Omita para retornar atividades em todos os grupos. |
|
activityIds | Lista | Opcional. IDs de atividades específicas a serem retornadas. |
|
includeDeletedGroups | Boleano | Opcional. Se
, inclui atividades de grupos excluídos. |
|
maxRecords | Interno | Opcional. Número máximo de atividades a serem retornadas. Máximo de 100. |
|
nextToken | Corda | Opcional. Token de paginação de uma resposta anterior. |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Descrição |
|---|---|---|
response | Objeto | Contém uma matriz
com os campos
,
,
e de tempo. Consulte describe_scaling_activities — documentação do Boto3 para ver a sintaxe completa da resposta. |
success | Boleano |
se a ação foi bem-sucedida,
caso contrário. |
errorMessage | Corda | Mensagem de erro se a ação falhar.
em caso de sucesso. |
O exemplo a seguir recupera as 5 atividades de escalonamento mais recentes.
Exemplo de fluxo de trabalho |
|---|
|
Descrever ações programadas
O identificador da ação é aws.autoscaling.describeScheduledActions.
Descreva as ações de escalonamento programadas para um grupo do Auto Scaling. Se você omitir scheduledActionNames, todas as ações do grupo serão retornadas. Filtre por startTime e endTime para restringir os resultados a uma janela de tempo — esses filtros são ignorados quando scheduledActionNames é fornecido.
A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.
Entrada | Tipo | Descrição | Exemplo |
|---|---|---|---|
awsRoleArn | Corda | Opcional. ARN da função do IAM. O executor assume essa função via STS para se autenticar na AWS. Recomendado em vez de credenciais estáticas. Pelo menos um campo de autenticação é obrigatório. |
|
awsAccessKeyId | Corda | Opcional. ID da chave de acesso da AWS. Deve ser passado como uma referência de segredo. |
|
awsSecretAccessKey | Corda | Opcional. Chave de acesso secreta da AWS. Deve ser passado como uma referência de segredo. |
|
awsSessionToken | Corda | Opcional. Token de sessão da AWS para credenciais temporárias. Deve ser passado como uma referência de segredo. |
|
região | Corda | Obrigatório. Região da AWS onde o grupo do Auto Scaling está localizado. |
|
autoScalingGroupName | Corda | Opcional. Nome do grupo para consulta. Omita para listar ações em todos os grupos. |
|
scheduledActionNames | Lista | Opcional. Nomes de ações específicas a serem retornadas. Nomes desconhecidos são ignorados silenciosamente. |
|
startTime | Corda | Opcional. Limite inferior de timestamp UTC ISO 8601 para filtrar resultados. |
|
endTime | Corda | Opcional. Limite superior do timestamp UTC ISO 8601 para filtrar resultados. |
|
maxRecords | Interno | Opcional. Número máximo de ações a serem retornadas. Máximo de 100. |
|
nextToken | Corda | Opcional. Token de paginação de uma resposta anterior. |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Descrição |
|---|---|---|
response | Objeto | Contém uma matriz
com os campos name, recurrence, timezone e capacity para cada ação. Consulte describe_scheduled_actions — Boto3 documentation para ver a sintaxe completa da resposta. |
success | Boleano |
se a ação foi bem-sucedida,
caso contrário. |
errorMessage | Corda | Mensagem de erro se a ação falhar.
em caso de sucesso. |
O exemplo a seguir lista todas as ações agendadas para um grupo.
Exemplo de fluxo de trabalho |
|---|
|