mon-put-metric-alarm - Amazon CloudWatch
DescriçãoSintaxeOpçõesOpções comunsSaídaExemplosTópicos relacionados da

mon-put-metric-alarm

Descrição

Cria ou atualiza um alarme e associa-o à métrica do CloudWatch especificada. Também é possível usar esse comando para associar um ou mais recursos do Amazon Simple Notification Service (Amazon SNS) a um alarme.

Quando essa operação cria um alarme, o estado do alarme é definido imediatamente como INSUFFICIENT_DATA. O alarme é avaliado e StateValue é definido corretamente. Em seguida, todas as ações associadas a StateValue são executadas.

nota

Durante a atualização de um alarme existente, StateValue permanece inalterado.

Sintaxe

mon-put-metric-alarm AlarmName --comparison-operator value --evaluation-periods value --metric-name value --namespace value --period value [--statistic value] [--extendedstatistic value] --threshold value [--actions-enabled value] [--alarm-actions value[,value...] ] [--alarm-description value] [--dimensions "key1=value1,key2=value2..."] [--ok-actions value[,value...] ] [--unit value] [--insufficient-data-actions value[,value...]] [Common Options]

Opções

Nome Descrição

AlarmName

O nome do alarme a ser atualizado ou criado. O nome deve ser exclusivo em sua conta da AWS. Também defina esse valor usando --alarm-name.

Tipo: argumento

Valores válidos: uma string UTF-8.

Padrão: n/d

Obrigatório: Sim

--actions-enabled VALUE

Indica se as ações devem ser executadas quando o estado do alarme muda.

Tipo: booliano

Valores válidos: True ou False

Padrão: verdadeiro

Obrigatório: Não

--alarm-actions VALUE1,VALUE2,VALUE3...

As ações (até cinco) a serem executadas quando esse alarme muda para um estado ALARM de qualquer outro estado. Cada ação é especificada como um Nome de recurso da Amazon (ARN). Usando ações de alarme, publique em um tópico do Amazon SNS, ative uma política do Amazon EC2 Auto Scaling ou interrompa, termine ou recupere uma instância do Amazon EC2.

nota

Se estiver usando uma conta do AWS Identity and Access Management (IAM) para criar ou modificar um alarme, é necessário ter as seguintes permissões do Amazon EC2:

  • ec2:DescribeInstanceStatus e ec2:DescribeInstances para todos os alarmes nas métricas de status da instância do Amazon EC2.

  • ec2:StopInstances para alarmes com ações de interrupção.

  • ec2:TerminateInstances para alarmes com ações de encerramento.

  • ec2:DescribeInstanceRecoveryAttribute e ec2:RecoverInstances para alarmes com ações de recuperação.

Se tiver permissões de leitura/gravação para o Amazon CloudWatch, mas não para o Amazon EC2, você ainda poderá criar um alarme, mas as ações de interromper ou terminar não serão realizadas na instância do Amazon EC2. No entanto, se você receber a permissão mais tarde para usar as APIs associadas do Amazon EC2, as ações de alarme que você tiver criado anteriormente serão executadas. Para obter mais informações sobre as permissões do IAM, consulte Permissões e políticas no Manual do usuário do IAM.

Se estiver usando uma função do IAM (por exemplo, um perfil de instância do Amazon EC2), você não poderá interromper ou terminar a instância usando ações de alarme. No entanto, ainda é possível ver o estado do alarme e executar todas as outras ações, como notificações do Amazon SNS ou políticas do Amazon EC2 Auto Scaling.

Se estiver usando credenciais de segurança temporárias concedidas usando o AWS Security Token Service (AWS STS), você não poderá interromper ou terminar uma instância do Amazon EC2 usando ações de alarme.

Tipo: string

Valores válidos: um ARN para um tópico do Amazon SNS, uma política do Auto Scaling ou um ARN para interromper, terminar ou recuperar uma instância do Amazon EC2.

Padrão: n/d

Obrigatório: Não

--alarm-description VALUE

A descrição do alarme.

Tipo: string

Valores válidos: qualquer string Unicode entre 1 e 255 caracteres de comprimento.

Padrão: n/d

Obrigatório: Não

--comparison-operator VALUE

O operador de comparação usado para comparar um ponto de dados com o limite.

Tipo: enumeração

Valores válidos: um de GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold ou LessThanOrEqualToThreshold

Padrão: n/d

Obrigatório: Sim

--dimensions "key1=value1,key2=value2..."

As dimensões da métrica a ser criada para a qual você deseja criar um alarme. Especifique dimensões de duas maneiras, e os formatos podem ser combinados ou usados de maneira intercambiável:

  • Uma opção por dimensão: --dimensions "key1=value1" --dimensions "key2=value2"

  • Opção multifuncional: --dimensions "key1=value1,key2=value2"

Tipo: mapa

Valores válidos: uma string do formato nome = valor, em que a chave é o nome da dimensão e o valor é o valor da dimensão. Os nomes de dimensão e os valores devem ser uma string ANSI entre 1 e 250 caracteres. Um máximo de 10 dimensões é permitido.

Padrão: n/d

Obrigatório: Não

--evaluation-periods VALUE

O número de períodos consecutivos pelo qual o valor da métrica é comparado com o limite para determinar o status do alarme.

Tipo: número inteiro

Valores válidos: um número maior que zero.

Padrão: n/d

Obrigatório: Sim

--metric-name VALUE

O nome da métrica para alarme.

Tipo: argumento

Valores válidos: uma string ANSI entre 1 e 250 caracteres de comprimento.

Padrão: n/d

Obrigatório: Sim

--namespace VALUE

O namespace da métrica para alarme. Para obter mais informações sobre namespaces, consulte Namespaces do AWS.

Tipo: string

Valores válidos: uma string ANSI entre 1 e 250 caracteres de comprimento.

Padrão: n/d

Obrigatório: Sim

--ok-actions VALUE1,VALUE2,VALUE3...

As ações (até cinco) a serem executadas quando esse alarme muda para um estado OK de qualquer outro estado. Cada ação é especificada como um Nome de recurso da Amazon (ARN).

Tipo: string

Valores válidos: um identificador ARN válido.

Padrão: n/d

Obrigatório: Não

--period VALUE

O período da métrica para alarme (em segundos).

Tipo: argumento

Valores válidos: um número, em segundos, que seja um múltiplo de 60 segundos.

Padrão: n/d

Obrigatório: Sim

--statistic VALUE

A estatística da métrica para alarme.

Tipo: enumeração

Valores válidos: SampleCount, Average, Sum, Minimum ou Maximum

Padrão: n/d

Obrigatório: você deve especificar --statistic ou --extendedstatistic.

--extendedstatistic VALUE

A estatística do percentil da métrica para alarme.

Tipo: string

Valores válidos: qualquer percentil, com até duas casas decimais (por exemplo, p95.45).

Padrão: n/d

Obrigatório: você deve especificar --statistic ou --extendedstatistic.

--threshold VALUE

O limite em que os pontos de dados são comparados para determinar o estado do alarme.

Tipo: duplo

Valores válidos: um valor duplo. Todos os valores devem ser um número entre 1E-130 e 1E130.

Padrão: n/d

Obrigatório: Sim

--unit VALUE

A unidade da métrica para alarme.

Tipo: enumeração

Valores válidos: um dos seguintes:

  • Segundos

  • Microssegundos

  • Milissegundos

  • Bytes

  • Kilobytes

  • Megabytes

  • Gigabytes

  • Terabytes

  • Bits

  • Kilobits

  • Megabits

  • Gigabits

  • Terabits

  • Percentual

  • Contagem

  • Bytes/segundo

  • Kilobytes/segundo

  • Megabytes/segundo

  • Gigabytes/segundo

  • Terabytes/segundo

  • Bits/segundo

  • Kilobits/segundo

  • Megabits/segundo

  • Gigabits/segundo

  • Terabits/segundo

  • Contagem/segundo

  • Nenhum

Padrão: n/d

Obrigatório: Não

--insufficient-data-actions VALUE1,VALUE2,VALUE3...

As ações (até cinco) a serem executadas quando esse alarme muda para um estado INSUFFICIENT_DATA de qualquer outro estado. Cada ação é especificada como um Nome de recurso da Amazon (ARN).

Tipo: string

Valores válidos: um identificador ARN válido.

Padrão: n/d

Obrigatório: Não

Opções comuns

Nome Descrição

--aws-credential-file VALUE

O local do arquivo com suas credenciais da AWS. É possível definir esse valor usando a variável de ambiente AWS_CREDENTIAL_FILE. Se você definir a variável de ambiente ou fornecer o caminho para o arquivo de credenciais, a solicitação falhará caso o arquivo não exista. Todas as solicitações do CloudWatch deverão ser assinadas usando seu ID da chave de acesso e sua chave de acesso secreta.

Tipo: string

Valores válidos: um caminho válido para um arquivo contendo seu ID da chave de acesso e sua chave de acesso secreta.

Padrão: usa a variável de ambiente AWS_CREDENTIAL_FILE, se estiver definida.

-C, --ec2-cert-file-path VALUE

O local do arquivo de certificado do EC2 para solicitações de assinatura. É possível usar a variável de ambiente EC2_CERT para especificar esse valor.

Tipo: string

Valores válidos: um caminho de arquivo válido para o arquivo PEM fornecido pelo Amazon EC2 ou pelo AWS Identity and Access Management.

Padrão: usa a variável de ambiente EC2_CERT, se estiver definida.

--connection-timeout VALUE

O valor de tempo limite de conexão, em segundos.

Tipo: número inteiro

Valores válidos: qualquer número positivo.

Padrão: 30

--delimiter VALUE

O delimitador a ser usado quando são exibidos resultados delimitados (longos).

Tipo: string

Valores válidos: qualquer string.

Padrão: vírgula (,)

--headers

Se estiver exibindo resultados tabulares ou delimitados, inclua os cabeçalhos de coluna. Se estiver exibindo resultados em XML, retorne os cabeçalhos HTTP da solicitação de serviço, quando aplicável.

Tipo: sinalizador

Valores válidos: quando presente, exibe cabeçalhos.

Padrão: a opção --headers fica desativada por padrão.

-I, --access-key-id VALUE

O ID da chave de acesso que será usada, em conjunto com a chave secreta, para assinar a solicitação. Esse parâmetro deverá ser usado em conjunto com --secret-key, ou a opção será ignorada. Todas as solicitações para o CloudWatch deverão ser assinadas, ou a solicitação será rejeitada.

Tipo: string

Valores válidos: um ID da chave de acesso válido.

Padrão: nenhum

-K, --ec2-private-key-file-path VALUE

A chave privada que será usada para assinar a solicitação. Utilizar chaves públicas/privadas faz com que a CLI use SOAP. A solicitação é assinada com um certificado público e uma chave privada. Esse parâmetro deverá ser usado em conjunto com EC2_CERT, ou o valor será ignorado. O valor da variável de ambiente EC2_PRIVATE_KEY será usado se estiver definido e se essa opção não estiver especificada. Essa opção será ignorada se a variável de ambiente AWS_CREDENTIAL_FILE estiver definida ou quando se utilizar --aws-credentials-file. Todas as solicitações para o CloudWatch deverão ser assinadas, ou a solicitação será rejeitada.

Tipo: string

Valores válidos: o caminho para uma chave privada ASN.1 válida.

Padrão: nenhum

--region VALUE

A região para onde as solicitações são direcionadas. É possível usar a variável de ambiente EC2_REGION para especificar o valor. Utiliza-se a região para criar a URL usada para chamar o CloudWatch e deve ser uma região da Amazon Web Services válida (AWS).

Tipo: string

Valores válidos: qualquer região da AWS, por exemplo, us-east-1.

Padrão: us-east-1, a menos que a variável de ambiente EC2_REGION esteja definida.

S, --secret-key VALUE

A chave de acesso secreta que será usada para assinar a solicitação, em conjunto com a ID da chave de acesso. Esse parâmetro deverá ser usado em conjunto com --access-key-id, ou essa opção será ignorada.

Tipo: string

Valores válidos: seu ID da chave de acesso.

Padrão: nenhum

--show-empty-fields

Exibe campos vazios usando (nil) como espaço reservado para indicar que esses dados não foram solicitados.

Tipo: sinalizador

Valores válidos: nenhum

Padrão: campos vazios não são exibidos por padrão.

--show-request

Exibe a URL que a CLI usa para chamar a AWS.

Tipo: sinalizador

Valores válidos: nenhum

Padrão: False

--show-table, --show-long, --show-xml, --quiet

Especifica como os resultados são exibidos: em uma tabela, delimitados (longos), XML ou nenhuma saída (silenciosos). A exibição --show-table mostra um subconjunto dos dados em forma fixa de largura de coluna; --show-long exibe todos os valores retornados delimitados por um caractere; --show-xml é o retorno bruto do serviço; e --quiet suprime todas as saídas padrão. Todas as opções são mutuamente exclusivas, tendo prioridade --show-table, --show-long, --show-xml e --quiet.

Tipo: sinalizador

Valores válidos: nenhum

Padrão: --show-table

-U, --url VALUE

A URL usada para entrar em contato com o CloudWatch. É possível definir esse valor usando a variável de ambiente AWS_CLOUDWATCH_URL. Esse valor é usado em conjunto com --region para criar a URL esperada. Essa opção substitui a URL da chamada de serviço.

Tipo: string

Valores válidos: uma URL HTTP ou HTTPS válida.

Padrão: usa o valor especificado em AWS_CLOUDWATCH_URL, se estiver definido.

Saída

Esse comando cria ou atualiza um alarme associado à métrica especificada.

A CLI do Amazon CloudWatch exibe erros em stderr.

Exemplos

Exemplo de solicitação

Esse exemplo cria um alarme que publica uma mensagem em um tópico quando a utilização da CPU de uma instância do EC2 excede 90% por três períodos consecutivos de um minuto.

mon-put-metric-alarm --alarm-name my-alarm --alarm-description "some desc" \
--metric-name CPUUtilization --namespace AWS/EC2 --statistic Average  --period 60 --threshold 90 \
--comparison-operator GreaterThanThreshold  --dimensions InstanceId=i-abcdef --evaluation-periods 3  \
--unit Percent --alarm-actions arn:aws:sns:us-east-1:1234567890:my-topic

Tópicos relacionados da

Baixar

Ação relacionada

Comando relacionado