Exemples d'utilisation de Security Lake AWS CLI - AWS Command Line Interface
Actions

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.

Exemples d'utilisation de Security Lake AWS CLI

Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants à l'aide de AWS Command Line Interface with Security Lake.

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Les actions vous indiquent comment appeler des fonctions de service individuelles, mais vous pouvez les visualiser dans leur contexte dans les scénarios correspondants.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la façon de configurer et d'exécuter le code en contexte.

Rubriques

Actions

L'exemple de code suivant montre comment utilisercreate-aws-logsource.

AWS CLI

Pour ajouter un Amazon Web Service pris en charge de manière native en tant que source Amazon Security Lake

L'create-aws-logsourceexemple suivant ajoute VPC Flow Logs en tant que source Security Lake dans les comptes et régions désignés.

aws securitylake create-aws-log-source \
    --sources '[{"regions": ["us-east-1"], "accounts": ["123456789012"], "sourceName": "SH_FINDINGS", "sourceVersion": "2.0"}]'

Sortie :

{
    "failed": [
        "123456789012"
    ]
}

Pour plus d'informations, consultez la section Ajout d'un AWS service en tant que source dans le guide de l'utilisateur d'Amazon Security Lake.

  • Pour API plus de détails, voir CreateAwsLogsourcela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-custom-logsource.

AWS CLI

Pour ajouter une source personnalisée en tant que source Amazon Security Lake

L'create-custom-logsourceexemple suivant ajoute une source personnalisée en tant que source Security Lake dans le compte du fournisseur de journaux désigné et dans la région désignée.

aws securitylake create-custom-log-source \
    --source-name "VPC_FLOW" \
    --event-classes '["DNS_ACTIVITY", "NETWORK_ACTIVITY"]' \
    --configuration '{"crawlerConfiguration": {"roleArn": "arn:aws:glue:eu-west-2:123456789012:crawler/E1WG1ZNPRXT0D4"},"providerIdentity": {"principal": "029189416600","externalId": "123456789012"}}' --region "us-east-1"

Sortie :

{
    "customLogSource": {
        "attributes": {
            "crawlerArn": "arn:aws:glue:eu-west-2:123456789012:crawler/E1WG1ZNPRXT0D4",
            "databaseArn": "arn:aws:glue:eu-west-2:123456789012:database/E1WG1ZNPRXT0D4",
            "tableArn": "arn:aws:glue:eu-west-2:123456789012:table/E1WG1ZNPRXT0D4"
        },
        "provider": {
            "location": "DOC-EXAMPLE-BUCKET--usw2-az1--x-s3",
            "roleArn": "arn:aws:iam::123456789012:role/AmazonSecurityLake-Provider-testCustom2-eu-west-2"
        },
        "sourceName": "testCustom2"
        "sourceVersion": "2.0"
    }
}

Pour plus d'informations, consultez la section Ajout d'une source personnalisée dans le guide de l'utilisateur d'Amazon Security Lake.

L'exemple de code suivant montre comment utilisercreate-data-lake-exception-subscription.

AWS CLI

Pour envoyer des notifications concernant les exceptions de Security Lake

L'create-data-lake-exception-subscriptionexemple suivant envoie des notifications relatives aux exceptions de Security Lake au compte spécifié par le biais SMS de la livraison. Le message d'exception est conservé pendant la période spécifiée.

aws securitylake create-data-lake-exception-subscription \
    --notification-endpoint "123456789012" \
    --exception-time-to-live 30 \
    --subscription-protocol "sms"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Résolution des problèmes liés à Amazon Security Lake dans le guide de l'utilisateur d'Amazon Security Lake.

L'exemple de code suivant montre comment utilisercreate-data-lake-organization-configuration.

AWS CLI

Pour configurer Security Lake dans les nouveaux comptes d'organisation

L'create-data-lake-organization-configurationexemple suivant active Security Lake et la collecte des événements sources spécifiés et enregistre les nouveaux comptes d'organisation.

aws securitylake create-data-lake-organization-configuration \
    --auto-enable-new-account '[{"region":"us-east-1","sources":[{"sourceName":"SH_FINDINGS","sourceVersion": "1.0"}]}]'

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Gestion de plusieurs comptes auprès d' AWS Organizations dans le guide de l'utilisateur d'Amazon Security Lake.

L'exemple de code suivant montre comment utilisercreate-data-lake.

AWS CLI

Exemple 1 : pour configurer votre lac de données dans plusieurs régions

L'create-data-lakeexemple suivant active Amazon Security Lake dans plusieurs AWS régions et configure votre lac de données.

aws securitylake create-data-lake \
    --configurations '[{"encryptionConfiguration": {"kmsKeyId":"S3_MANAGED_KEY"},"region":"us-east-1","lifecycleConfiguration": {"expiration":{"days":365},"transitions":[{"days":60,"storageClass":"ONEZONE_IA"}]}}, {"encryptionConfiguration": {"kmsKeyId":"S3_MANAGED_KEY"},"region":"us-east-2","lifecycleConfiguration": {"expiration":{"days":365},"transitions":[{"days":60,"storageClass":"ONEZONE_IA"}]}}]' \
    --meta-store-manager-role-arn "arn:aws:iam:us-east-1:123456789012:role/service-role/AmazonSecurityLakeMetaStoreManager"

Sortie :

{
    "dataLakes": [
        {
            "createStatus": "COMPLETED",
            "dataLakeArn": "arn:aws:securitylake:us-east-1:522481757177:data-lake/default",
            "encryptionConfiguration": {
                "kmsKeyId": "S3_MANAGED_KEY"
            },
            "lifecycleConfiguration": {
                "expiration": {
                    "days": 365
                },
                "transitions": [
                    {
                        "days": 60,
                        "storageClass": "ONEZONE_IA"
                    }
                ]
            },
            "region": "us-east-1",
            "replicationConfiguration": {
                "regions": [
                    "ap-northeast-3"
                ],
                "roleArn": "arn:aws:securitylake:ap-northeast-3:522481757177:data-lake/default"
            },
            "s3BucketArn": "arn:aws:s3:::aws-security-data-lake-us-east-1-gnevt6s8z7bzby8oi3uiaysbr8v2ml",
            "updateStatus": {
                "exception": {},
                "requestId": "f20a6450-d24a-4f87-a6be-1d4c075a59c2",
                "status": "INITIALIZED"
            }
        },
        {
            "createStatus": "COMPLETED",
            "dataLakeArn": "arn:aws:securitylake:us-east-2:522481757177:data-lake/default",
            "encryptionConfiguration": {
                "kmsKeyId": "S3_MANAGED_KEY"
            },
            "lifecycleConfiguration": {
                "expiration": {
                    "days": 365
                },
                "transitions": [
                    {
                        "days": 60,
                        "storageClass": "ONEZONE_IA"
                    }
                ]
            },
            "region": "us-east-2",
            "replicationConfiguration": {
                "regions": [
                    "ap-northeast-3"
                ],
                "roleArn": "arn:aws:securitylake:ap-northeast-3:522481757177:data-lake/default"
            },
            "s3BucketArn": "arn:aws:s3:::aws-security-data-lake-us-east-2-cehuifzl5rwmhm6m62h7zhvtseogr9",
            "updateStatus": {
                "exception": {},
                "requestId": "f20a6450-d24a-4f87-a6be-1d4c075a59c2",
                "status": "INITIALIZED"
            }
        }
    ]
}

Pour plus d'informations, consultez Getting started with Amazon Security Lake dans le guide de l'utilisateur d'Amazon Security Lake.

Exemple 2 : pour configurer votre lac de données dans une seule région

L'create-data-lakeexemple suivant active Amazon Security Lake dans une seule AWS région et configure votre lac de données.

aws securitylake create-data-lake \
    --configurations '[{"encryptionConfiguration": {"kmsKeyId":"1234abcd-12ab-34cd-56ef-1234567890ab"},"region":"us-east-2","lifecycleConfiguration": {"expiration":{"days":500},"transitions":[{"days":30,"storageClass":"GLACIER"}]}}]' \
    --meta-store-manager-role-arn "arn:aws:iam:us-east-1:123456789012:role/service-role/AmazonSecurityLakeMetaStoreManager"

Sortie :

{
    "dataLakes": [
        {
            "createStatus": "COMPLETED",
            "dataLakeArn": "arn:aws:securitylake:us-east-2:522481757177:data-lake/default",
            "encryptionConfiguration": {
                "kmsKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
            },
            "lifecycleConfiguration": {
                "expiration": {
                    "days": 500
                },
                "transitions": [
                    {
                        "days": 30,
                        "storageClass": "GLACIER"
                    }
                ]
            },
            "region": "us-east-2",
            "replicationConfiguration": {
                "regions": [
                    "ap-northeast-3"
                ],
                "roleArn": "arn:aws:securitylake:ap-northeast-3:522481757177:data-lake/default"
            },
            "s3BucketArn": "arn:aws:s3:::aws-security-data-lake-us-east-2-cehuifzl5rwmhm6m62h7zhvtseogr9",
            "updateStatus": {
                "exception": {},
                "requestId": "77702a53-dcbf-493e-b8ef-518e362f3003",
                "status": "INITIALIZED"
            }
        }
    ]
}

Pour plus d'informations, consultez Getting started with Amazon Security Lake dans le guide de l'utilisateur d'Amazon Security Lake.

  • Pour API plus de détails, voir CreateDataLakela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-subscriber-data-access.

AWS CLI

Pour créer un abonné avec accès aux données

L'create-subscriberexemple suivant crée un abonné dans Security Lake avec accès aux données de la AWS région actuelle pour l'identité d'abonné spécifiée pour une AWS source.

aws securitylake create-subscriber \
    --access-types "S3" \
    --sources '[{"awsLogSource": {"sourceName": "VPC_FLOW","sourceVersion": "2.0"}}]' \
    --subscriber-name "opensearch-s3" \
    --subscriber-identity '{"principal": "029189416600","externalId": "123456789012"}'

Sortie :

{
    "subscriber": {
        "accessTypes": [
            "S3"
        ],
        "createdAt": "2024-07-17T19:08:26.787000+00:00",
        "roleArn": "arn:aws:iam::773172568199:role/AmazonSecurityLake-896f218b-cfba-40be-a255-8b49a65d0407",
        "s3BucketArn": "arn:aws:s3:::aws-security-data-lake-us-east-1-um632ufwpvxkyz0bc5hkb64atycnf3",
        "sources": [
            {
                "awsLogSource": {
                    "sourceName": "VPC_FLOW",
                    "sourceVersion": "2.0"
                }
            }
        ],
        "subscriberArn": "arn:aws:securitylake:us-east-1:773172568199:subscriber/896f218b-cfba-40be-a255-8b49a65d0407",
        "subscriberId": "896f218b-cfba-40be-a255-8b49a65d0407",
        "subscriberIdentity": {
            "externalId": "123456789012",
            "principal": "029189416600"
        },
        "subscriberName": "opensearch-s3",
        "subscriberStatus": "ACTIVE",
        "updatedAt": "2024-07-17T19:08:27.133000+00:00"
    }
}

Pour plus d'informations, consultez la section Création d'un abonné avec accès aux données dans le guide de l'utilisateur d'Amazon Security Lake.

L'exemple de code suivant montre comment utilisercreate-subscriber-notification.

AWS CLI

Pour créer une notification d'abonné

L'create-subscriber-notificationexemple suivant montre comment spécifier une notification aux abonnés pour créer une notification lorsque de nouvelles données sont écrites dans le lac de données.

aws securitylake create-subscriber-notification \
    --subscriber-id "12345ab8-1a34-1c34-1bd4-12345ab9012" \
    --configuration '{"httpsNotificationConfiguration": {"targetRoleArn":"arn:aws:iam::XXX:role/service-role/RoleName", "endpoint":"https://account-management.$3.$2.securitylake.aws.dev/v1/datalake"}}'

Sortie :

{
    "subscriberEndpoint": [
        "https://account-management.$3.$2.securitylake.aws.dev/v1/datalake"
    ]
}

Pour plus d'informations, consultez la section Gestion des abonnés dans le guide de l'utilisateur d'Amazon Security Lake.

L'exemple de code suivant montre comment utilisercreate-subscriber-query-access.

AWS CLI

Pour créer un abonné avec accès aux requêtes

L'create-subscriberexemple suivant crée un abonné dans Security Lake avec un accès aux requêtes dans la AWS région actuelle pour l'identité d'abonné spécifiée.

aws securitylake create-subscriber \
    --access-types "LAKEFORMATION" \
    --sources '[{"awsLogSource": {"sourceName": "VPC_FLOW","sourceVersion": "2.0"}}]' \
    --subscriber-name "opensearch-s3" \
    --subscriber-identity '{"principal": "029189416600","externalId": "123456789012"}'

Sortie :

{
    "subscriber": {
        "accessTypes": [
            "LAKEFORMATION"
        ],
        "createdAt": "2024-07-18T01:05:55.853000+00:00",
        "resourceShareArn": "arn:aws:ram:us-east-1:123456789012:resource-share/8c31da49-c224-4f1e-bb12-37ab756d6d8a",
        "resourceShareName": "LakeFormation-V2-NAMENAMENA-123456789012",
        "sources": [
            {
                "awsLogSource": {
                    "sourceName": "VPC_FLOW",
                    "sourceVersion": "2.0"
                }
            }
        ],
        "subscriberArn": "arn:aws:securitylake:us-east-1:123456789012:subscriber/e762aabb-ce3d-4585-beab-63474597845d",
        "subscriberId": "e762aabb-ce3d-4585-beab-63474597845d",
        "subscriberIdentity": {
            "externalId": "123456789012",
            "principal": "029189416600"
        },
        "subscriberName": "opensearch-s3",
        "subscriberStatus": "ACTIVE",
        "updatedAt": "2024-07-18T01:05:58.393000+00:00"
    }
}

Pour plus d'informations, consultez la section Création d'un abonné avec accès aux requêtes dans le guide de l'utilisateur d'Amazon Security Lake.

L'exemple de code suivant montre comment utiliserdelete-aws-logsource.

AWS CLI

Pour supprimer un service pris en charge de manière native. AWS

L'delete-aws-logsourceexemple suivant supprime les journaux de VPC flux en tant que source Security Lake dans les comptes et régions désignés.

aws securitylake delete-aws-log-source \
    --sources '[{"regions": ["us-east-1"], "accounts": ["123456789012"], "sourceName": "SH_FINDINGS", "sourceVersion": "2.0"}]'

Sortie :

{
    "failed": [
        "123456789012"
    ]
}

Pour plus d'informations, consultez la section Suppression d'un AWS service en tant que source dans le guide de l'utilisateur d'Amazon Security Lake.

  • Pour API plus de détails, voir DeleteAwsLogsourcela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-custom-logsource.

AWS CLI

Pour supprimer une source personnalisée.

L'delete-custom-logsourceexemple suivant supprime une source personnalisée dans le compte du fournisseur de journaux désigné dans la région désignée.

aws securitylake delete-custom-log-source \
    --source-name "CustomSourceName"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez Supprimer une source personnalisée dans le guide de l'utilisateur d'Amazon Security Lake.

L'exemple de code suivant montre comment utiliserdelete-data-lake-organization-configuration.

AWS CLI

Pour arrêter la collecte automatique des sources dans les comptes des membres

L'delete-data-lake-organization-configurationexemple suivant arrête la collecte automatique des résultats du AWS Security Hub à partir des nouveaux comptes membres qui rejoignent l'organisation. Seul l'administrateur délégué de Security Lake peut exécuter cette commande. Cela empêche les nouveaux comptes membres de fournir automatiquement des données au lac de données.

aws securitylake delete-data-lake-organization-configuration \
    --auto-enable-new-account '[{"region":"us-east-1","sources":[{"sourceName":"SH_FINDINGS"}]}]'

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Gestion de plusieurs comptes auprès d' AWS Organizations dans le guide de l'utilisateur d'Amazon Security Lake.

L'exemple de code suivant montre comment utiliserdelete-data-lake.

AWS CLI

Pour désactiver votre lac de données

L'delete-data-lakeexemple suivant désactive votre lac de données dans les AWS régions spécifiées. Dans les régions spécifiées, les sources ne fournissent plus de données au lac de données. Pour un déploiement de Security Lake utilisant AWS Organizations, seul l'administrateur délégué de Security Lake à l'organisation peut désactiver Security Lake pour les comptes de l'organisation.

aws securitylake delete-data-lake \
    --regions "ap-northeast-1" "eu-central-1"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Désactivation d'Amazon Security Lake dans le guide de l'utilisateur d'Amazon Security Lake.

  • Pour API plus de détails, voir DeleteDataLakela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-subscriber-notification.

AWS CLI

Pour supprimer une notification d'abonné

L'delete-subscriber-notificationexemple suivant montre comment supprimer la notification d'abonné pour un abonné Security Lake spécifique.

aws securitylake delete-subscriber-notification \
    --subscriber-id "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Gestion des abonnés dans le guide de l'utilisateur d'Amazon Security Lake.

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

AWS CLI

Pour supprimer un abonné

L'delete-subscriberexemple suivant montre comment supprimer un abonné si vous ne souhaitez plus qu'il consomme les données de Security Lake.

aws securitylake delete-subscriber \
    --subscriber-id "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Gestion des abonnés dans le guide de l'utilisateur d'Amazon Security Lake.

  • Pour API plus de détails, voir DeleteSubscriberla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-data-lake-exception-subscription.

AWS CLI

Pour obtenir des informations sur un abonnement exceptionnel

L'get-data-lake-exception-subscriptionexemple suivant fournit des détails sur un abonnement d'exception à Security Lake. Dans cet exemple, l'utilisateur du AWS compte spécifié est informé des erreurs lors de la SMS livraison. Le message d'exception reste dans le compte pendant la période spécifiée. Un abonnement d'exception informe un utilisateur de Security Lake d'une erreur via le protocole préféré du demandeur.

aws securitylake get-data-lake-exception-subscription

Sortie :

{
    "exceptionTimeToLive": 30,
    "notificationEndpoint": "123456789012",
    "subscriptionProtocol": "sms"
}

Pour plus d'informations, consultez la section Résolution des problèmes liés à l'état des lacs de données dans le guide de l'utilisateur d'Amazon Security Lake.

L'exemple de code suivant montre comment utiliserget-data-lake-organization-configuration.

AWS CLI

Pour obtenir des informations détaillées sur la configuration des nouveaux comptes d'organisation

L'get-data-lake-organization-configurationexemple suivant permet de récupérer des informations sur les journaux sources que les nouveaux comptes d'entreprise enverront après leur intégration à Amazon Security Lake.

aws securitylake get-data-lake-organization-configuration

Sortie :

{
    "autoEnableNewAccount": [
        {
            "region": "us-east-1",
            "sources": [
                {
                    "sourceName": "VPC_FLOW",
                    "sourceVersion": "1.0"
                },
                {
                    "sourceName": "ROUTE53",
                    "sourceVersion": "1.0"
                },
                {
                    "sourceName": "SH_FINDINGS",
                    "sourceVersion": "1.0"
                }
            ]
        }
    ]
}

Pour plus d'informations, consultez la section Gestion de plusieurs comptes auprès d' AWS Organizations dans le guide de l'utilisateur d'Amazon Security Lake.

L'exemple de code suivant montre comment utiliserget-data-lake-sources.

AWS CLI

Pour connaître l'état de la collecte des journaux

L'get-data-lake-sourcesexemple suivant permet d'obtenir un instantané de la collecte de journaux pour le compte spécifié dans la AWS région actuelle. Amazon Security Lake est activé sur le compte.

aws securitylake get-data-lake-sources \
    --accounts "123456789012"

Sortie :

{
    "dataLakeSources": [
        {
            "account": "123456789012",
            "sourceName": "SH_FINDINGS",
            "sourceStatuses": [
                {
                    "resource": "vpc-1234567890abcdef0",
                    "status": "COLLECTING"
                }
            ]
        },
        {
            "account": "123456789012",
            "sourceName": "VPC_FLOW",
            "sourceStatuses": [
                {
                    "resource": "vpc-1234567890abcdef0",
                    "status": "NOT_COLLECTING"
                }
            ]
        },
        {
            "account": "123456789012",
            "sourceName": "LAMBDA_EXECUTION",
            "sourceStatuses": [
                {
                    "resource": "vpc-1234567890abcdef0",
                    "status": "COLLECTING"
                }
            ]
        },
        {
            "account": "123456789012",
            "sourceName": "ROUTE53",
            "sourceStatuses": [
                {
                    "resource": "vpc-1234567890abcdef0",
                    "status": "COLLECTING"
                }
            ]
        },
        {
            "account": "123456789012",
            "sourceName": "CLOUD_TRAIL_MGMT",
            "sourceStatuses": [
                {
                    "resource": "vpc-1234567890abcdef0",
                    "status": "COLLECTING"
                }
            ]
        }
    ],
    "dataLakeArn": null
}

Pour plus d'informations, consultez la section Collecte de données à partir AWS des services dans le guide de l'utilisateur d'Amazon Security Lake.

  • Pour API plus de détails, voir GetDataLakeSourcesla section Référence des AWS CLI commandes.

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

AWS CLI

Pour récupérer les informations d'abonnement

L'get-subscriberexemple suivant récupère les informations d'abonnement pour l'abonné Securiy Lake spécifié.

aws securitylake get-subscriber \
    --subscriber-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Sortie :

{
    "subscriber": {
        "accessTypes": [
            "LAKEFORMATION"
        ],
        "createdAt": "2024-04-19T15:19:44.421803+00:00",
        "resourceShareArn": "arn:aws:ram:eu-west-2:123456789012:resource-share/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "resourceShareName": "LakeFormation-V3-TKJGBHCKTZ-123456789012",
        "sources": [
            {
                "awsLogSource": {
                    "sourceName": "LAMBDA_EXECUTION",
                    "sourceVersion": "1.0"
                }
            },
            {
                "awsLogSource": {
                    "sourceName": "EKS_AUDIT",
                    "sourceVersion": "2.0"
                }
            },
            {
                "awsLogSource": {
                    "sourceName": "ROUTE53",
                    "sourceVersion": "1.0"
                }
            },
            {
                "awsLogSource": {
                    "sourceName": "SH_FINDINGS",
                    "sourceVersion": "1.0"
                }
            },
            {
                "awsLogSource": {
                    "sourceName": "VPC_FLOW",
                    "sourceVersion": "1.0"
                }
            },
            {
                "customLogSource": {
                    "attributes": {
                        "crawlerArn": "arn:aws:glue:eu-west-2:123456789012:crawler/testCustom2",
                        "databaseArn": "arn:aws:glue:eu-west-2:123456789012:database/amazon_security_lake_glue_db_eu_west_2",
                        "tableArn": "arn:aws:glue:eu-west-2:123456789012:table/amazon_security_lake_table_eu_west_2_ext_testcustom2"
                    },
                    "provider": {
                        "location": "s3://aws-security-data-lake-eu-west-2-8ugsus4ztnsfpjbldwbgf4vge98av9/ext/testCustom2/",
                        "roleArn": "arn:aws:iam::123456789012:role/AmazonSecurityLake-Provider-testCustom2-eu-west-2"
                    },
                    "sourceName": "testCustom2"
                }
            },
            {
                "customLogSource": {
                    "attributes": {
                        "crawlerArn": "arn:aws:glue:eu-west-2:123456789012:crawler/TestCustom",
                        "databaseArn": "arn:aws:glue:eu-west-2:123456789012:database/amazon_security_lake_glue_db_eu_west_2",
                        "tableArn": "arn:aws:glue:eu-west-2:123456789012:table/amazon_security_lake_table_eu_west_2_ext_testcustom"
                    },
                    "provider": {
                        "location": "s3://aws-security-data-lake-eu-west-2-8ugsus4ztnsfpjbldwbgf4vge98av9/ext/TestCustom/",
                        "roleArn": "arn:aws:iam::123456789012:role/AmazonSecurityLake-Provider-TestCustom-eu-west-2"
                    },
                    "sourceName": "TestCustom"
                }
            }
        ],
        "subscriberArn": "arn:aws:securitylake:eu-west-2:123456789012:subscriber/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "subscriberId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "subscriberIdentity": {
            "externalId": "123456789012",
            "principal": "123456789012"
        },
        "subscriberName": "test",
        "subscriberStatus": "ACTIVE",
        "updatedAt": "2024-04-19T15:19:55.230588+00:00"
    }
}

Pour plus d'informations, consultez la section Gestion des abonnés dans le guide de l'utilisateur d'Amazon Security Lake.

  • Pour API plus de détails, voir GetSubscriberla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-data-lake-exceptions.

AWS CLI

Pour répertorier les problèmes affectant votre lac de données

L'list-data-lake-exceptionsexemple suivant répertorie les problèmes qui ont affecté votre lac de données au cours des 14 derniers jours dans les AWS régions spécifiées.

aws securitylake list-data-lake-exceptions \
    --regions "us-east-1" "eu-west-3"

Sortie :

{
    "exceptions": [
        {
            "exception": "The account does not have the required role permissions. Update your role permissions to use the new data source version.",
            "region": "us-east-1",
            "timestamp": "2024-02-29T12:24:15.641725+00:00"
        },
        {
            "exception": "The account does not have the required role permissions. Update your role permissions to use the new data source version.",
            "region": "eu-west-3",
            "timestamp": "2024-02-29T12:24:15.641725+00:00"
        }
    ]
}

Pour plus d'informations, consultez la section Résolution des problèmes liés à Amazon Security Lake dans le guide de l'utilisateur d'Amazon Security Lake.

L'exemple de code suivant montre comment utiliserlist-data-lakes.

AWS CLI

Pour répertorier l'objet de configuration Security Lake

L'list-data-lakesexemple suivant répertorie l'objet de configuration Amazon Security Lake pour la AWS région spécifiée. Vous pouvez utiliser cette commande pour déterminer si Security Lake est activé dans une ou plusieurs régions spécifiques.

aws securitylake list-data-lakes \
    --regions "us-east-1"

Sortie :

{
    "dataLakes": [
        {
            "createStatus": "COMPLETED",
            "dataLakeArn": "arn:aws:securitylake:us-east-1:123456789012:data-lake/default",
            "encryptionConfiguration": {
                "kmsKeyId": "S3_MANAGED_KEY"
            },
            "lifecycleConfiguration": {
                "expiration": {
                    "days": 365
                },
                "transitions": [
                    {
                        "days": 60,
                        "storageClass": "ONEZONE_IA"
                    }
                ]
            },
            "region": "us-east-1",
            "replicationConfiguration": {
                "regions": [
                    "ap-northeast-3"
                ],
                "roleArn": "arn:aws:securitylake:ap-northeast-3:123456789012:data-lake/default"
            },
            "s3BucketArn": "arn:aws:s3:::aws-security-data-lake-us-east-1-1234567890abcdef0",
            "updateStatus": {
                "exception": {
                    "code": "software.amazon.awssdk.services.s3.model.S3Exception",
                    "reason": ""
                },
                "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
                "status": "FAILED"
            }
        }
    ]
}

Pour plus d'informations, consultez la section Vérification du statut des régions dans le guide de l'utilisateur d'Amazon Security Lake.

  • Pour API plus de détails, voir ListDataLakesla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-log-sources.

AWS CLI

Pour récupérer les sources du journal Amazon Security Lake

L'list-log-sourcesexemple suivant répertorie les sources de log Amazon Security Lake d'un compte spécifié.

aws securitylake list-log-sources \
    --accounts "123456789012"

Sortie :

{
    "account": "123456789012",
    "region": "xy-region-1",
    "sources": [
        {
               "awsLogSource": {
                "sourceName": "VPC_FLOW",
                "sourceVersion": "2.0"
            }
        },
        {
            "awsLogSource": {
                "sourceName": "SH_FINDINGS",
                "sourceVersion": "2.0"
            }
        }
    ]
}

Pour plus d'informations, consultez la section Gestion des sources dans le guide de l'utilisateur d'Amazon Security Lake.

  • Pour API plus de détails, voir ListLogSourcesla section Référence des AWS CLI commandes.

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

AWS CLI

Pour récupérer les abonnés Amazon Security Lake

L'list-subscribersexemple suivant répertorie tous les abonnés Amazon Security Lake d'un compte spécifique.

aws securitylake list-subscribers

Sortie :

{
    "subscribers": [
        {
            "accessTypes": [
                "S3"
            ],
            "createdAt": "2024-06-04T15:02:28.921000+00:00",
            "roleArn": "arn:aws:iam::123456789012:role/AmazonSecurityLake-E1WG1ZNPRXT0D4",
            "s3BucketArn": "DOC-EXAMPLE-BUCKET--usw2-az1--x-s3",
            "sources": [
                {
                    "awsLogSource": {
                        "sourceName": "CLOUD_TRAIL_MGMT",
                        "sourceVersion": "2.0"
                    }
                },
                {
                    "awsLogSource": {
                        "sourceName": "LAMBDA_EXECUTION",
                        "sourceVersion": "1.0"
                    }
                },
                {
                    "customLogSource": {
                        "attributes": {
                            "crawlerArn": "arn:aws:glue:eu-west-2:123456789012:crawler/E1WG1ZNPRXT0D4",
                            "databaseArn": "arn:aws:glue:eu-west-2:123456789012:database/E1WG1ZNPRXT0D4",
                            "tableArn": "arn:aws:glue:eu-west-2:123456789012:table/E1WG1ZNPRXT0D4"
                        },
                        "provider": {
                            "location": "DOC-EXAMPLE-BUCKET--usw2-az1--x-s3",
                            "roleArn": "arn:aws:iam::123456789012:role/AmazonSecurityLake-E1WG1ZNPRXT0D4"
                        },
                        "sourceName": "testCustom2"
                    }
                }
            ],
            "subscriberArn": "arn:aws:securitylake:eu-west-2:123456789012:subscriber/E1WG1ZNPRXT0D4",
            "subscriberEndpoint": "arn:aws:sqs:eu-west-2:123456789012:AmazonSecurityLake-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111-Main-Queue",
            "subscriberId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "subscriberIdentity": {
                "externalId": "ext123456789012",
                "principal": "123456789012"
            },
            "subscriberName": "Test",
            "subscriberStatus": "ACTIVE",
            "updatedAt": "2024-06-04T15:02:35.617000+00:00"
        }
    ]
}

Pour plus d'informations, consultez la section Gestion des abonnés dans le guide de l'utilisateur d'Amazon Security Lake.

  • Pour API plus de détails, voir ListSubscribersla section Référence des AWS CLI commandes.

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

AWS CLI

Pour répertorier les balises d'une ressource existante

L'list-tags-for-resourceexemple suivant répertorie les balises pour l'abonné Amazon Security Lake spécifié. Dans cet exemple, aucune valeur de balise n'est associée à la clé de balise Owner. Vous pouvez également utiliser cette opération pour répertorier les balises d'autres ressources Security Lake existantes.

aws securitylake list-tags-for-resource \
    --resource-arn "arn:aws:securitylake:us-east-1:123456789012:subscriber/1234abcd-12ab-34cd-56ef-1234567890ab"

Sortie :

{
    "tags": [
        {
            "key": "Environment",
            "value": "Cloud"
        },
        {
            "key": "CostCenter",
            "value": "12345"
        },
        {
            "key": "Owner",
            "value": ""
        }
    ]
}

Pour plus d'informations, consultez la section Marquage des ressources Amazon Security Lake dans le guide de l'utilisateur d'Amazon Security Lake.

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

L'exemple de code suivant montre comment utiliserregister-data-lake-delegated-administrator.

AWS CLI

Pour désigner l'administrateur délégué

L'register-data-lake-delegated-administratorexemple suivant désigne le AWS compte spécifié en tant qu'administrateur délégué d'Amazon Security Lake.

aws securitylake register-data-lake-delegated-administrator \
    --account-id 123456789012

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Gestion de plusieurs comptes auprès d' AWS Organizations dans le guide de l'utilisateur d'Amazon Security Lake.

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

AWS CLI

Pour ajouter des balises à une ressource existante

L'tag-resourceexemple suivant ajoute des balises à une ressource d'abonné existante. Pour créer une nouvelle ressource et y ajouter une ou plusieurs balises, n'utilisez pas cette opération. Utilisez plutôt l'opération de création appropriée pour le type de ressource que vous souhaitez créer.

aws securitylake tag-resource \
    --resource-arn "arn:aws:securitylake:us-east-1:123456789012:subscriber/1234abcd-12ab-34cd-56ef-1234567890ab" \
    --tags key=Environment,value=Cloud

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Marquage des ressources Amazon Security Lake dans le guide de l'utilisateur d'Amazon Security Lake.

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

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

AWS CLI

Pour supprimer des balises d'une ressource existante

L'untag-resourceexemple suivant supprime les balises spécifiées d'une ressource d'abonné existante.

aws securitylake untag-resource \
    --resource-arn "arn:aws:securitylake:us-east-1:123456789012:subscriber/1234abcd-12ab-34cd-56ef-1234567890ab" \
    --tags Environment Owner

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Marquage des ressources Amazon Security Lake dans le guide de l'utilisateur d'Amazon Security Lake.

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

L'exemple de code suivant montre comment utiliserupdate-data-lake-exception-subscription.

AWS CLI

Pour mettre à jour l'abonnement aux notifications pour les exceptions de Security Lake

L'update-data-lake-exception-subscriptionexemple suivant met à jour l'abonnement aux notifications qui informe les utilisateurs des exceptions de Security Lake.

aws securitylake update-data-lake-exception-subscription \
    --notification-endpoint "123456789012" \
    --exception-time-to-live 30 \
    --subscription-protocol "email"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Résolution des problèmes liés à Amazon Security Lake dans le guide de l'utilisateur d'Amazon Security Lake.

L'exemple de code suivant montre comment utiliserupdate-data-lake.

AWS CLI

Exemple 1 : pour mettre à jour les paramètres de votre lac de données

L'update-data-lakeexemple suivant met à jour les paramètres de votre lac de données Amazon Security Lake. Vous pouvez utiliser cette opération pour spécifier le chiffrement des données, le stockage et les paramètres de région cumulative.

aws securitylake update-data-lake \
    --configurations '[{"encryptionConfiguration": {"kmsKeyId":"S3_MANAGED_KEY"},"region":"us-east-1","lifecycleConfiguration": {"expiration":{"days":365},"transitions":[{"days":60,"storageClass":"ONEZONE_IA"}]}}, {"encryptionConfiguration": {"kmsKeyId":"S3_MANAGED_KEY"},"region":"us-east-2","lifecycleConfiguration": {"expiration":{"days":365},"transitions":[{"days":60,"storageClass":"ONEZONE_IA"}]}}]' \
    --meta-store-manager-role-arn "arn:aws:iam:us-east-1:123456789012:role/service-role/AmazonSecurityLakeMetaStoreManager"

Sortie :

{
    "dataLakes": [
        {
            "createStatus": "COMPLETED",
            "dataLakeArn": "arn:aws:securitylake:us-east-1:522481757177:data-lake/default",
            "encryptionConfiguration": {
                "kmsKeyId": "S3_MANAGED_KEY"
            },
            "lifecycleConfiguration": {
                "expiration": {
                    "days": 365
                },
                "transitions": [
                    {
                        "days": 60,
                        "storageClass": "ONEZONE_IA"
                    }
                ]
            },
            "region": "us-east-1",
            "replicationConfiguration": {
                "regions": [
                    "ap-northeast-3"
                ],
                "roleArn": "arn:aws:securitylake:ap-northeast-3:522481757177:data-lake/default"
            },
            "s3BucketArn": "arn:aws:s3:::aws-security-data-lake-us-east-1-gnevt6s8z7bzby8oi3uiaysbr8v2ml",
            "updateStatus": {
                "exception": {},
                "requestId": "f20a6450-d24a-4f87-a6be-1d4c075a59c2",
                "status": "INITIALIZED"
            }
        },
        {
            "createStatus": "COMPLETED",
            "dataLakeArn": "arn:aws:securitylake:us-east-2:522481757177:data-lake/default",
            "encryptionConfiguration": {
                "kmsKeyId": "S3_MANAGED_KEY"
            },
            "lifecycleConfiguration": {
                "expiration": {
                    "days": 365
                },
                "transitions": [
                    {
                        "days": 60,
                        "storageClass": "ONEZONE_IA"
                    }
                ]
            },
            "region": "us-east-2",
            "replicationConfiguration": {
                "regions": [
                    "ap-northeast-3"
                ],
                "roleArn": "arn:aws:securitylake:ap-northeast-3:522481757177:data-lake/default"
            },
            "s3BucketArn": "arn:aws:s3:::aws-security-data-lake-us-east-2-cehuifzl5rwmhm6m62h7zhvtseogr9",
            "updateStatus": {
                "exception": {},
                "requestId": "f20a6450-d24a-4f87-a6be-1d4c075a59c2",
                "status": "INITIALIZED"
            }
        }
    ]
}

Pour plus d'informations, consultez Getting started with Amazon Security Lake dans le guide de l'utilisateur d'Amazon Security Lake.

Exemple 2 : pour configurer votre lac de données dans une seule région

L'create-data-lakeexemple suivant active Amazon Security Lake dans une seule AWS région et configure votre lac de données.

aws securitylake create-data-lake \
    --configurations '[{"encryptionConfiguration": {"kmsKeyId":"1234abcd-12ab-34cd-56ef-1234567890ab"},"region":"us-east-2","lifecycleConfiguration": {"expiration":{"days":500},"transitions":[{"days":30,"storageClass":"GLACIER"}]}}]' \
    --meta-store-manager-role-arn "arn:aws:iam:us-east-1:123456789012:role/service-role/AmazonSecurityLakeMetaStoreManager"

Sortie :

{
    "dataLakes": [
        {
            "createStatus": "COMPLETED",
            "dataLakeArn": "arn:aws:securitylake:us-east-2:522481757177:data-lake/default",
            "encryptionConfiguration": {
                "kmsKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab"
            },
            "lifecycleConfiguration": {
                "expiration": {
                    "days": 500
                },
                "transitions": [
                    {
                        "days": 30,
                        "storageClass": "GLACIER"
                    }
                ]
            },
            "region": "us-east-2",
            "replicationConfiguration": {
                "regions": [
                    "ap-northeast-3"
                ],
                "roleArn": "arn:aws:securitylake:ap-northeast-3:522481757177:data-lake/default"
            },
            "s3BucketArn": "arn:aws:s3:::aws-security-data-lake-us-east-2-cehuifzl5rwmhm6m62h7zhvtseogr9",
            "updateStatus": {
                "exception": {},
                "requestId": "77702a53-dcbf-493e-b8ef-518e362f3003",
                "status": "INITIALIZED"
            }
        }
    ]
}

Pour plus d'informations, consultez Getting started with Amazon Security Lake dans le guide de l'utilisateur d'Amazon Security Lake.

  • Pour API plus de détails, voir UpdateDataLakela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-subscriber-notification.

AWS CLI

Pour mettre à jour une notification d'abonné

L'update-subscriber-notificationexemple suivant montre comment mettre à jour la méthode de notification pour un abonné.

aws securitylake update-subscriber-notification \
    --subscriber-id "12345ab8-1a34-1c34-1bd4-12345ab9012" \
    --configuration '{"httpsNotificationConfiguration": {"targetRoleArn":"arn:aws:iam::XXX:role/service-role/RoleName", "endpoint":"https://account-management.$3.$2.securitylake.aws.dev/v1/datalake"}}'

Sortie :

{
    "subscriberEndpoint": [
        "https://account-management.$3.$2.securitylake.aws.dev/v1/datalake"
    ]
}

Pour plus d'informations, consultez la section Gestion des abonnés dans le guide de l'utilisateur d'Amazon Security Lake.

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

AWS CLI

Pour mettre à jour un abonné Amazon Security Lake.

L'update-subscriberexemple suivant met à jour les sources d'accès aux données de Security Lake pour un abonné Security Lake spécifique.

aws securitylake update-subscriber \
    --subscriber-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Sortie :

{
    "subscriber": {
        "accessTypes": [
            "LAKEFORMATION"
        ],
        "createdAt": "2024-04-19T15:19:44.421803+00:00",
        "resourceShareArn": "arn:aws:ram:eu-west-2:123456789012:resource-share/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "resourceShareName": "LakeFormation-V3-TKJGBHCKTZ-123456789012",
        "sources": [
            {
                "awsLogSource": {
                    "sourceName": "LAMBDA_EXECUTION",
                    "sourceVersion": "1.0"
                }
            },
            {
                "awsLogSource": {
                    "sourceName": "EKS_AUDIT",
                    "sourceVersion": "2.0"
                }
            },
            {
                "awsLogSource": {
                    "sourceName": "ROUTE53",
                    "sourceVersion": "1.0"
                }
            },
            {
                "awsLogSource": {
                    "sourceName": "SH_FINDINGS",
                    "sourceVersion": "1.0"
                }
            },
            {
                "awsLogSource": {
                    "sourceName": "VPC_FLOW",
                    "sourceVersion": "1.0"
                }
            },
            {
                "customLogSource": {
                    "attributes": {
                        "crawlerArn": "arn:aws:glue:eu-west-2:123456789012:crawler/E1WG1ZNPRXT0D4",
                        "databaseArn": "arn:aws:glue:eu-west-2:123456789012:database/E1WG1ZNPRXT0D4",
                        "tableArn": "arn:aws:glue:eu-west-2:123456789012:table/E1WG1ZNPRXT0D4"
                    },
                    "provider": {
                        "location": "DOC-EXAMPLE-BUCKET--usw2-az1--x-s3",
                        "roleArn": "arn:aws:iam::123456789012:role/AmazonSecurityLake-E1WG1ZNPRXT0D4"
                    },
                    "sourceName": "testCustom2"
                }
            }
        ],
        "subscriberArn": "arn:aws:securitylake:eu-west-2:123456789012:subscriber/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "subscriberId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "subscriberIdentity": {
            "externalId": "123456789012",
            "principal": "123456789012"
        },
        "subscriberName": "test",
        "subscriberStatus": "ACTIVE",
        "updatedAt": "2024-07-18T20:47:37.098000+00:00"
    }
}

Pour plus d'informations, consultez la section Gestion des abonnés dans le guide de l'utilisateur d'Amazon Security Lake.

  • Pour API plus de détails, voir UpdateSubscriberla section Référence des AWS CLI commandes.