Exemples d’utilisation de l’AWS CLI avec CloudWatch Observability Access Monitor

Les exemples de code suivants montrent comment réaliser des actions et mettre en œuvre des scénarios courants en utilisant l’AWS Command Line Interface avec CloudWatch Observability Access Monitor.

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

Actions

L’exemple de code suivant montre comment utiliser create-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 Observabilité inter-comptes CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez CreateLink dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-sink.

AWS CLI

Pour créer un récepteur

L’exemple create-sink suivant crée un récepteur dans le compte actuel, de sorte qu’il puisse être utilisé comme compte de surveillance dans l’observabilité inter-comptes CloudWatch.


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 Observabilité inter-comptes CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez CreateSink dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-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 Observabilité inter-comptes CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez DeleteLink dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-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 Observabilité inter-comptes CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez DeleteSink dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-link.

AWS CLI

Pour renvoyer des informations complètes sur un lien

L’exemple get-link suivant renvoie les 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 Observabilité inter-comptes CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez GetLink dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-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 Observabilité inter-comptes CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez GetSinkPolicy dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-sink.

AWS CLI

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

L’exemple get-sink suivant renvoie les 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 Observabilité inter-comptes CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez GetSink dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-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 Observabilité inter-comptes CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez ListAttachedLinks dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-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 Observabilité inter-comptes CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez ListLinks dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-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 Observabilité inter-comptes CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez ListSinks dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser list-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 Observabilité inter-comptes CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez ListTagsForResource dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser put-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 Observabilité inter-comptes CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez PutSinkPolicy dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser tag-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 Observabilité inter-comptes CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez TagResource dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser untag-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 Observabilité inter-comptes CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez UntagResource dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-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 Observabilité inter-comptes CloudWatch dans le Guide de l’utilisateur Amazon CloudWatch.

Pour plus de détails sur l’API, consultez UpdateLink dans la Référence des commandes de l’AWS CLI.

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

CloudWatch Network Monitoring

CloudWatch Observability Admin