Gerencie painéis com o AWS CLI - AWS CloudTrail
Obtenha um painel com o AWS CLIListe painéis com o AWS CLIAnexe uma política baseada em recursos a um repositório de dados ou painel de controle de eventos com o AWS CLIAtualize manualmente um painel com o AWS CLIAtualize um painel com o AWS CLI

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Gerencie painéis com o AWS CLI

Esta seção descreve vários outros comandos que você pode executar para gerenciar seus painéis, incluindo obter um painel, listar seus painéis, atualizar um painel e atualizar um painel.

Ao usar o AWS CLI, lembre-se de que seus comandos são Região da AWS executados no configurado para seu perfil. Se você deseja executar os comandos em uma região diferente, altere a região padrão para o seu perfil ou use o parâmetro --region com o comando.

Obtenha um painel com o AWS CLI

Execute o get-dashboard comando para retornar um painel. Especifique o --dashboard-id fornecendo o ARN do painel ou o nome do painel.

aws cloudtrail get-dashboard --dashboard-id arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash

Liste painéis com o AWS CLI

Execute o list-dashboards comando para listar os painéis da sua conta.

  • Inclua o --type parâmetro para visualizar somente os MANAGED painéis CUSTOM ou.

  • Inclua o --max-results parâmetro para limitar o número de resultados. Os valores válidos são de 1 a 100.

  • Inclua o --name-prefix para retornar painéis que correspondam ao prefixo especificado.

O exemplo a seguir lista todos os painéis.

aws cloudtrail list-dashboards

Este exemplo lista somente os CUSTOM painéis.

aws cloudtrail list-dashboards --type CUSTOM

O próximo exemplo lista somente os MANAGED painéis.

aws cloudtrail list-dashboards --type MANAGED

O exemplo final lista os painéis que correspondem ao prefixo especificado.

aws cloudtrail list-dashboards --name-prefix ExamplePrefix

Anexe uma política baseada em recursos a um repositório de dados ou painel de controle de eventos com o AWS CLI

Execute o put-resource-policy comando para aplicar uma política baseada em recursos a um painel ou armazenamento de dados de eventos.

Anexe uma política baseada em recursos a um armazenamento de dados de eventos

Para executar consultas em um painel durante uma atualização manual ou programada, você precisa anexar uma política baseada em recursos a cada armazenamento de dados de eventos associado a um widget no painel. Isso permite que o CloudTrail Lake execute as consultas em seu nome. Para obter mais informações sobre a política baseada em recursos, consulte. Exemplo: permitir CloudTrail a execução de consultas para atualizar um painel

O exemplo a seguir anexa uma política baseada em recursos a um armazenamento de dados de eventos. account-idSubstitua pelo ID da sua conta, eds-arn pelo ARN do armazenamento de dados do evento para o qual CloudTrail serão executadas consultas e dashboard-arn pelo ARN do painel.

aws cloudtrail put-resource-policy \
--resource-arn eds-arn \
--resource-policy '{"Version": "2012-10-17", "Statement": [{"Sid": "EDSPolicy", "Effect": "Allow", "Principal": { "Service": "cloudtrail.amazonaws.com" }, "Action": "cloudtrail:StartQuery", "Condition": { "StringEquals": { "AWS:SourceArn": "dashboard-arn", "AWS:SourceAccount": "account-id"}}} ]}'

Anexe uma política baseada em recursos a um painel

Para definir um cronograma de atualização para um painel, você precisa anexar uma política baseada em recursos ao painel para permitir que o CloudTrail Lake atualize o painel em seu nome. Para obter mais informações sobre a política baseada em recursos, consulte. Exemplo de política baseada em recursos para um painel

O exemplo a seguir anexa uma política baseada em recursos a um painel. account-idSubstitua pelo ID da sua conta e dashboard-arn pelo ARN do painel.

aws cloudtrail put-resource-policy \
--resource-arn dashboard-arn \
--resource-policy '{"Version": "2012-10-17", "Statement": [{"Sid": "DashboardPolicy", "Effect": "Allow", "Principal": { "Service": "cloudtrail.amazonaws.com" }, "Action": "cloudtrail:StartDashboardRefresh", "Condition": { "StringEquals": { "AWS:SourceArn": "dashboard-arn", "AWS:SourceAccount": "account-id"}}}]}'

Atualize manualmente um painel com o AWS CLI

Execute o start-dashboard-refresh comando para atualizar manualmente o painel. Antes de executar esse comando, você deve anexar uma política baseada em recursos a cada armazenamento de dados de eventos associado a um widget do painel.

O exemplo a seguir mostra como atualizar manualmente um painel personalizado.

aws cloudtrail start-dashboard-refresh \ 
--dashboard-id  dashboard-id \ 
--query-parameter-values '{"$StartTime$": "2024-11-05T10:45:24.00Z"}'

O próximo exemplo mostra como atualizar manualmente um painel gerenciado. Como os painéis gerenciados são configurados por CloudTrail, a solicitação de atualização precisa incluir a ID do armazenamento de dados do evento no qual as consultas serão executadas.

aws cloudtrail start-dashboard-refresh \
--dashboard-id dashboard-id  \
--query-parameter-values '{"$StartTime$": "2024-11-05T10:45:24.00Z", "$EventDataStoreId$": "eds-id"}'

Atualize um painel com o AWS CLI

Execute o update-dashboard comando para atualizar um painel. Você pode atualizar o painel para definir uma agenda de atualização, ativar ou desativar uma agenda de atualização, modificar os widgets e ativar ou desativar a proteção contra encerramento.

Atualize o cronograma de atualização com o AWS CLI

O exemplo a seguir atualiza a agenda de atualização de um painel personalizado chamadoAccountActivityDashboard.

aws cloudtrail update-dashboard --dashboard-id AccountActivityDashboard \
--refresh-schedule '{"Frequency": {"Unit": "HOURS", "Value": 6}, "Status": "ENABLED"}'

Desative a proteção contra encerramento e o cronograma de atualização em um painel personalizado com o AWS CLI

O exemplo a seguir desativa a proteção contra encerramento de um painel personalizado chamado AccountActivityDashboard para permitir que o painel seja excluído. Também desativa o cronograma de atualização.

aws cloudtrail update-dashboard --dashboard-id AccountActivityDashboard \
--refresh-schedule '{ "Status": "DISABLED"}' \
--no-termination-protection-enabled

Adicionar um widget a um painel personalizado

O exemplo a seguir adiciona um novo widget chamado TopServices ao painel personalizado chamadoAccountActivityDashboard. A matriz de widgets inclui os dois widgets que já foram criados para o painel e o novo widget.

nota

Neste exemplo, ? está entre aspas simples porque é usado comeventTime. Dependendo do sistema operacional em que você está executando, talvez seja necessário colocar aspas simples entre aspas de escape. Para obter mais informações, consulte Usando aspas e literais com cadeias de caracteres no. AWS CLI

aws cloudtrail update-dashboard --dashboard-id AccountActivityDashboard \
--widgets '[
    {
      "ViewProperties": {
        "Height": "2",
        "Width": "4",
        "Title": "TopErrors",
        "View": "Table"
      },
      "QueryStatement": "SELECT errorCode, COUNT(*) AS eventCount FROM eds WHERE eventTime > '?' AND eventTime < '?' AND (errorCode is not null) GROUP BY errorCode ORDER BY eventCount DESC LIMIT 100",
      "QueryParameters": ["$StartTime$", "$EndTime$"]
    },
    {
      "ViewProperties": {
        "Height": "2",
        "Width": "4",
        "Title": "MostActiveRegions",
        "View": "PieChart",
        "LabelColumn": "awsRegion",
        "ValueColumn": "eventCount",
        "FilterColumn": "awsRegion"
      },
      "QueryStatement": "SELECT awsRegion, COUNT(*) AS eventCount FROM eds where eventTime > '?' and eventTime < '?' GROUP BY awsRegion ORDER BY eventCount LIMIT 100",
      "QueryParameters": ["$StartTime$", "$EndTime$"]
    },
    {
      "ViewProperties": {
        "Height": "2",
        "Width": "4",
        "Title": "TopServices",
        "View": "BarChart",
        "LabelColumn": "service",
        "ValueColumn": "eventCount",
        "FilterColumn": "service",
        "Orientation": "Vertical"
      },
      "QueryStatement": "SELECT replace(eventSource, '.amazonaws.com') AS service, COUNT(*) as eventCount FROM eds WHERE eventTime > '?' AND eventTime < '?' GROUP BY eventSource ORDER BY eventCount DESC LIMIT 100",
      "QueryParameters": ["$StartTime$", "$EndTime$"]
    }
  ]'