CloudWatch Exemples d'Observability Access Monitor utilisant AWS CLI - AWS Command Line Interface
Actions

Cette documentation concerne AWS CLI uniquement la version 1. Pour la documentation relative à la version 2 du AWS CLI, consultez le guide de l'utilisateur de la version 2.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

CloudWatch Exemples d'Observability Access Monitor utilisant AWS CLI

Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l'aide du moniteur AWS Command Line Interface d'accès à l' CloudWatch observabilité.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.

Rubriques

Actions

L'exemple de code suivant montre comment utilisercreate-link.

AWS CLI

Pour créer un lien

L’exemple create-link suivant crée un lien entre un compte source et un récepteur que vous avez créé dans un compte de surveillance.

aws oam create-link \
    --label-template sourceAccount \
    --resource-types AWS::CloudWatch::Metric \
    --sink-identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345

Sortie :

{
    "Arn": "arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111",
    "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
    "Label": "sourceAccount",
    "LabelTemplate": "sourceAccount",
    "ResourceTypes": [
        "AWS::CloudWatch::Metric"
    ],
    "SinkArn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345",
    "Tags": {}
}

Pour plus d'informations, consultez la CloudWatch section sur l'observabilité entre comptes dans le guide de CloudWatch l'utilisateur Amazon.

  • Pour plus de détails sur l'API, voir CreateLinkla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-sink.

AWS CLI

Pour créer un récepteur

L'create-sinkexemple suivant crée un puits dans le compte courant, afin qu'il puisse être utilisé comme compte de surveillance dans le cadre de l' CloudWatch observabilité entre comptes.

aws oam create-sink \
    --name DemoSink

Sortie :

{
    "Arn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345",
    "Id": "a1b2c3d4-5678-90ab-cdef-example12345",
    "Name": "DemoSink",
    "Tags": {}
}

Pour plus d'informations, consultez la CloudWatch section sur l'observabilité entre comptes dans le guide de CloudWatch l'utilisateur Amazon.

  • Pour plus de détails sur l'API, voir CreateSinkla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-link.

AWS CLI

Pour supprimer un lien

L’exemple delete-link suivant supprime un lien entre un récepteur de compte de surveillance et un compte source.

aws oam delete-link \
    --identifier arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la CloudWatch section sur l'observabilité entre comptes dans le guide de CloudWatch l'utilisateur Amazon.

  • Pour plus de détails sur l'API, voir DeleteLinkla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-sink.

AWS CLI

Pour supprimer un récepteur

L’exemple delete-sink suivant supprime un récepteur. Vous devez supprimer tous les liens vers un récepteur avant de pouvoir le supprimer.

aws oam delete-sink \
    --identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la CloudWatch section sur l'observabilité entre comptes dans le guide de CloudWatch l'utilisateur Amazon.

  • Pour plus de détails sur l'API, voir DeleteSinkla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-link.

AWS CLI

Pour renvoyer des informations complètes sur un lien

L’exemple get-link suivant renvoie des informations complètes sur un lien.

aws oam get-link \
    --identifier arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111

Sortie :

{
    "Arn": "arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111",
    "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
    "Label": "sourceAccount",
    "LabelTemplate": "sourceAccount",
    "ResourceTypes": [
        "AWS::CloudWatch::Metric"
    ],
    "SinkArn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345",
    "Tags": {}
}

Pour plus d'informations, consultez la CloudWatch section sur l'observabilité entre comptes dans le guide de CloudWatch l'utilisateur Amazon.

  • Pour plus de détails sur l'API, voir GetLinkla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-sink-policy.

AWS CLI

Pour renvoyer la politique de récepteur actuelle attachée au récepteur

L’exemple get-sink-policy suivant renvoie la politique de récepteur actuelle attachée au récepteur.

aws oam get-sink-policy \
    --sink-identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345

Sortie :

{
    "SinkArn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345",
    "SinkId": "a1b2c3d4-5678-90ab-cdef-example12345",
    "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789111:root\"},\"Action\":[\"oam:CreateLink\",\"oam:UpdateLink\"],\"Resource\":\"*\",\"Condition\":{\"ForAllValues:StringEquals\":{\"oam:ResourceTypes\":[\"AWS::Logs::LogGroup\",\"AWS::CloudWatch::Metric\",\"AWS::XRay::Trace\",\"AWS::ApplicationInsights::Application\"]}}}]}"
}

Pour plus d'informations, consultez la CloudWatch section sur l'observabilité entre comptes dans le guide de CloudWatch l'utilisateur Amazon.

  • Pour plus de détails sur l'API, voir GetSinkPolicyla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-sink.

AWS CLI

Pour renvoyer des informations complètes sur un récepteur de compte de surveillance

L’exemple get-sink suivant renvoie des informations complètes sur un récepteur de compte de surveillance.

aws oam get-sink \
    --identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345

Sortie :

{
    "Arn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345",
    "Id": "a1b2c3d4-5678-90ab-cdef-example12345",
    "Name": "DemoSink",
    "Tags": {}
}

Pour plus d'informations, consultez la CloudWatch section sur l'observabilité entre comptes dans le guide de CloudWatch l'utilisateur Amazon.

  • Pour plus de détails sur l'API, voir GetSinkla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-attached-links.

AWS CLI

Pour renvoyer une liste des liens de comptes sources liés à ce récepteur de compte de surveillance

L’exemple list-attached-links suivant renvoie une liste de liens de comptes source liés à ce récepteur de compte de surveillance.

aws oam list-attached-links \
    --sink-identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345

Sortie :

{
    "Items": [{
        "Label": "Monitoring account",
        "LinkArn": "arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111",
        "ResourceTypes": [
            "AWS::ApplicationInsights::Application",
            "AWS::Logs::LogGroup",
            "AWS::CloudWatch::Metric",
            "AWS::XRay::Trace"
        ]
    }]
}

Pour plus d'informations, consultez la CloudWatch section sur l'observabilité entre comptes dans le guide de CloudWatch l'utilisateur Amazon.

  • Pour plus de détails sur l'API, voir ListAttachedLinksla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-links.

AWS CLI

Pour renvoyer une liste de liens pour un récepteur de compte de surveillance

L’exemple list-links suivant renvoie une liste de liens pour un récepteur de compte de surveillance. Exécutez cette opération dans un compte source pour renvoyer une liste de liens vers les récepteurs de compte de surveillance de ce compte source.

aws oam list-links

Sortie :

{
    "Items": [{
        "Arn": "arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111",
        "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
        "Label": "sourceAccount",
        "ResourceTypes": [
            "AWS::CloudWatch::Metric"
        ],
        "SinkArn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345"
    }]
}

Pour plus d'informations, consultez la CloudWatch section sur l'observabilité entre comptes dans le guide de CloudWatch l'utilisateur Amazon.

  • Pour plus de détails sur l'API, voir ListLinksla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-sinks.

AWS CLI

Pour renvoyer la liste des récepteurs créés dans le compte de surveillance

L’exemple list-sinks suivant renvoie une liste des récepteurs créés dans le compte de surveillance. Exécutez cette opération dans un compte de surveillance.

aws oam list-sinks

Sortie :

{
    "Items": [
        {
            "Arn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345",
            "Id": "a1b2c3d4-5678-90ab-cdef-example12345",
            "Name": "DemoSink"
        }
    ]
}

Pour plus d'informations, consultez la CloudWatch section sur l'observabilité entre comptes dans le guide de CloudWatch l'utilisateur Amazon.

  • Pour plus de détails sur l'API, voir ListSinksla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-tags-for-resource.

AWS CLI

Pour afficher les balises associées à une ressource

L’exemple list-tags-for-resource suivant affiche les balises associées à un récepteur.

aws oam list-tags-for-resource \
    --resource-arn arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345

Sortie :

{
    "Tags": {
        "Team": "Devops"
    }
}

Pour plus d'informations, consultez la CloudWatch section sur l'observabilité entre comptes dans le guide de CloudWatch l'utilisateur Amazon.

  • Pour plus de détails sur l'API, voir ListTagsForResourcela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserput-sink-policy.

AWS CLI

Pour créer ou mettre à jour une politique de ressources

L’exemple put-sink-policy suivant crée la politique de ressources qui autorise les comptes source à établir un lien avec le récepteur de compte de surveillance.

aws oam put-sink-policy \
    --policy '{"Version":"2012-10-17",		 	 	 "Statement":[{"Effect":"Allow","Principal":{"AWS":"arn:aws:iam::123456789111:root"},"Action":["oam:CreateLink","oam:UpdateLink"],"Resource":"*","Condition":{"ForAllValues:StringEquals":{"oam:ResourceTypes":["AWS::Logs::LogGroup","AWS::CloudWatch::Metric","AWS::XRay::Trace","AWS::ApplicationInsights::Application"]}}}]}' \
    --sink-identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345

Sortie :

{
    "SinkArn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345",
    "SinkId": "a1b2c3d4-5678-90ab-cdef-example12345",
    "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789111:root\"},\"Action\":[\"oam:CreateLink\",\"oam:UpdateLink\"],\"Resource\":\"*\",\"Condition\":{\"ForAllValues:StringEquals\":{\"oam:ResourceTypes\":[\"AWS::Logs::LogGroup\",\"AWS::CloudWatch::Metric\",\"AWS::XRay::Trace\",\"AWS::ApplicationInsights::Application\"]}}}]}"
}

Pour plus d'informations, consultez la CloudWatch section sur l'observabilité entre comptes dans le guide de CloudWatch l'utilisateur Amazon.

  • Pour plus de détails sur l'API, voir PutSinkPolicyla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisertag-resource.

AWS CLI

Pour attribuer une ou plusieurs balises à la ressource spécifiée

L’exemple tag-resource suivant balise un récepteur arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345.

aws oam tag-resource \
    --resource-arn arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345 \
    --tags team=Devops

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la CloudWatch section sur l'observabilité entre comptes dans le guide de CloudWatch l'utilisateur Amazon.

  • Pour plus de détails sur l'API, voir TagResourcela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliseruntag-resource.

AWS CLI

Pour supprimer une ou plusieurs balises de la ressource spécifiée.

L’exemple untag-resource suivant supprime une balise avec la clé team du récepteur arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345.

aws oam untag-resource \
    --resource-arn arn:aws:oam:us-east-2:123456789012:sink/f3f42f60-f0f2-425c-1234-12347bdd821f \
    --tag-keys team

Cette commande ne produit aucune sortie.

Pour plus d'informations, consultez la CloudWatch section sur l'observabilité entre comptes dans le guide de CloudWatch l'utilisateur Amazon.

  • Pour plus de détails sur l'API, voir UntagResourcela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-link.

AWS CLI

Pour modifier les types de données partagés entre un compte source et le récepteur de son compte de surveillance lié

L’exemple update-link suivant met à jour le lien arn:aws:oam:us-east-2:123456789111:link/0123e691-e7ef-43fa-1234-c57c837fced0 avec les types de ressources AWS::CloudWatch::Metric et AWS::Logs::LogGroup.

aws oam update-link \
    --identifier arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111 \
    --resource-types "AWS::CloudWatch::Metric" "AWS::Logs::LogGroup"

Sortie :

{
    "Arn": "arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111",
    "Id": "a1b2c3d4-5678-90ab-cdef-example11111",
    "Label": "sourceAccount",
    "LabelTemplate": "sourceAccount",
    "ResourceTypes": [
        "AWS::CloudWatch::Metric",
        "AWS::Logs::LogGroup"
    ],
    "SinkArn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345",
    "Tags": {}
}

Pour plus d'informations, consultez la CloudWatch section sur l'observabilité entre comptes dans le guide de CloudWatch l'utilisateur Amazon.

  • Pour plus de détails sur l'API, voir UpdateLinkla section Référence des AWS CLI commandes.