Spec-Zone.ru › AWS CLI v2

[ aws . securitylake ]

create-data-lake

Описание

Инициализирует экземпляр Amazon Security Lake с предоставленной (или по умолчанию) конфигурацией. Вы можете включить Security Lake в регионах Amazon Web Services с настроенными параметрами перед включением сбора журналов в регионах. Для указания конкретных регионов настройте эти регионы с помощью параметра configurations. Если вы уже включили Security Lake в регионе при вызове этой команды, команда обновит регион, если вы предоставите новые параметры конфигурации. Если вы еще не включили Security Lake в регионе при вызове API, он настроит озеро данных в регионе с указанными конфигурациями.

При включении Security Lake он начинает сбор данных безопасности после вызова CreateAwsLogSource и после создания подписчиков с помощью API CreateSubscriber. Это включает сбор данных безопасности из источников, хранение данных и предоставление данных подписчикам. Security Lake также включает все существующие настройки и ресурсы, которые он хранит или поддерживает для вашей учетной записи Amazon Web Services в текущем регионе, включая данные журналов безопасности и событий. Дополнительную информацию см. в руководстве пользователя Amazon Security Lake.

См. также: Документация AWS API

Синтаксис

  create-data-lake
--configurations <value>
--meta-store-manager-role-arn <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--configurations (список)

Укажите регион или регионы, которые будут вносить данные в регион сводки.

(структура)

Предоставляет подробную информацию об объекте Amazon Security Lake.

encryptionConfiguration -> (структура)

Предоставляет данные шифрования объекта Amazon Security Lake.

kmsKeyId -> (строка)

Идентификатор ключа шифрования KMS, используемого Amazon Security Lake для шифрования объекта Security Lake.

lifecycleConfiguration -> (структура)

Предоставляет данные о жизненном цикле объекта Amazon Security Lake.

expiration -> (структура)

Предоставляет данные о сроке действия данных объекта Amazon Security Lake.

days -> (целое число)

Количество дней до истечения срока действия данных в объекте Amazon Security Lake.

transitions -> (список)

Предоставляет данные о переходе в хранилище объекта Amazon Security Lake.

(структура)

Предоставляет данные о переходе жизненного цикла объекта Amazon Security Lake.

days -> (целое число)

Количество дней до перехода данных в другой класс хранения S3 в объекте Amazon Security Lake.

storageClass -> (строка)

Диапазон классов хранения, которые вы можете выбрать в зависимости от требований к доступу к данным, надежности и стоимости ваших рабочих нагрузок.

region -> (строка)

Регионы Amazon Web Services, в которых Security Lake автоматически включается.

replicationConfiguration -> (структура)

Предоставляет данные о репликации объекта Amazon Security Lake.

regions -> (список)

Указывает один или несколько централизованных регионов сводки. Регион Amazon Web Services, указанный в параметре region операции ` CreateDataLake https://docs.aws.amazon.com/security-lake/latest/APIReference/API_CreateDataLake.html`__ или ` UpdateDataLake https://docs.aws.amazon.com/security-lake/latest/APIReference/API_UpdateDataLake.html`__, вносит данные в регион или регионы сводки, указанные в этом параметре.

Репликация обеспечивает автоматическое асинхронное копирование объектов между ведрами Amazon S3. Ведра S3, настроенные для репликации объектов, могут принадлежать той же учетной записи Amazon Web Services или различным учетным записям. Вы можете реплицировать объекты в одно целевое ведро или в несколько целевых ведер. Целевые ведра могут находиться в различных регионах или в том же регионе, что и исходное ведро.

(строка)

roleArn -> (строка)

Параметры репликации для ведер Amazon S3. Этот параметр использует роль управления идентификацией и доступом (IAM), которую вы создали и которая управляется Security Lake, для обеспечения правильности параметров репликации.

Синтаксис JSON:

[
  {
    "encryptionConfiguration": {
      "kmsKeyId": "string"
    },
    "lifecycleConfiguration": {
      "expiration": {
        "days": integer
      },
      "transitions": [
        {
          "days": integer,
          "storageClass": "string"
        }
        ...
      ]
    },
    "region": "string",
    "replicationConfiguration": {
      "regions": ["string", ...],
      "roleArn": "string"
    }
  }
  ...
]

--meta-store-manager-role-arn (строка)

Используемый Amazon Resource Name (ARN) для создания и обновления таблицы Glue. Эта таблица содержит разделы, сгенерированные путем сбора и нормализации источников журналов Amazon Web Services и пользовательских источников.

--tags (список)

Массив объектов, по одному для каждой метки, которая должна быть ассоциирована с конфигурацией озера данных. Для каждой метки вы должны указать и ключ, и значение метки. Значение метки не может быть null, но может быть пустой строкой.

(структура)

Метка — это метка, которую вы можете определить и ассоциировать с ресурсами Amazon Web Services, включая определенные типы ресурсов Amazon Security Lake. Метки могут помочь вам идентифицировать, категоризировать и управлять ресурсами различными способами, такими как владелец, среда или другие критерии. Вы можете ассоциировать метки со следующими типами ресурсов Security Lake: подписчики и конфигурация озера данных для вашей учетной записи Amazon Web Services в отдельных регионах Amazon Web Services.

Ресурс может иметь до 50 меток. Каждая метка состоит из требуемого ключа метки и связанного с ним значения метки . Ключ метки — это общая метка, которая действует как категория для более конкретного значения метки (value). Каждый ключ метки должен быть уникальным и может иметь только одно значение метки. Значение метки действует как описание для ключа метки. Ключи и значения меток чувствительны к регистру. Они могут содержать буквы, цифры, пробелы или следующие символы: _ . : / = + @ -

Дополнительную информацию см. в руководстве пользователя Amazon Security Lake по меткам ресурсов Amazon Security Lake.

key -> (строка)

Имя метки. Это общая метка, которая действует как категория для более конкретного значения метки (value).

value -> (строка)

Значение, связанное с указанным ключом метки (key). Это значение действует как описание для ключа метки. Значение метки не может быть null, но может быть пустой строкой.

Сокращенный синтаксис:

key=string,value=string ...

Синтаксис JSON:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение без значения или значение input, выводится пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено значение yaml-input, будет выведен пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, будет валидироваться ввод команд и возвращаться пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое значение)

Включает отладку протоколирования.

--endpoint-url (строка)

Переопределяет URL по умолчанию команды заданным URL.

--no-verify-ssl (логическое значение)

По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого соединения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.

--no-paginate (логическое значение)

Отключает автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из файла учетных данных.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

  • on
  • off
  • auto

--no-sign-request (логическое значение)

Отключить подписание запросов. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификата CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения к сокету в секундах. Если значение установлено в 0, подключение к сокету будет блокирующим и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной строкой base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

Отключить кли-паджинатор для вывода.

--cli-auto-prompt (логическое значение)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (логическое значение)

Отключить автоматическое запрошенние параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров, необходимо установить и настроить AWS CLI. Подробнее см. руководство по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования, аналогичные Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей командной строки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Пример 1: Настройка озера данных в нескольких регионах

Следующий create-data-lake пример включает Amazon Security Lake в нескольких регионах AWS и настраивает ваше озеро данных.

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"

Вывод:

{
    "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"
            }
        }
    ]
}

Для получения дополнительной информации, см. Начало работы с Amazon Security Lake в Руководстве пользователя Amazon Security Lake.

Пример 2: Настройка озера данных в одном регионе

Следующий create-data-lake пример включает Amazon Security Lake в одном регионе AWS и настраивает ваше озеро данных.

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"

Вывод:

{
    "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"
            }
        }
    ]
}

Для получения дополнительной информации, см. Начало работы с Amazon Security Lake в Руководстве пользователя Amazon Security Lake.

Вывод

dataLakes -> (список)

Созданный объект конфигурации Security Lake.

(структура)

Предоставляет подробную информацию об объекте Amazon Security Lake.

createStatus -> (строка)

Возвращает состояние вызова CreateDatalake API для учетной записи в Amazon Security Lake.

dataLakeArn -> (строка)

Идентификатор ресурса Amazon (ARN), созданный вами для предоставления подписчику. Дополнительную информацию об ARN и способах их использования в политиках см. в Руководстве пользователя Amazon Security Lake.

encryptionConfiguration -> (структура)

Предоставляет сведения об шифровании объекта Amazon Security Lake.

kmsKeyId -> (строка)

Идентификатор ключа шифрования KMS, используемого Amazon Security Lake для шифрования объекта Security Lake.

lifecycleConfiguration -> (структура)

Предоставляет сведения о жизненном цикле объекта Amazon Security Lake.

expiration -> (структура)

Предоставляет сведения о сроке действия данных объекта Amazon Security Lake.

days -> (целое число)

Количество дней до истечения срока действия данных в объекте Amazon Security Lake.

transitions -> (список)

Предоставляет сведения о переходе хранения данных объекта Amazon Security Lake.

(структура)

Предоставляет подробности о жизненном цикле перехода объекта Amazon Security Lake.

days -> (целое число)

Количество дней до перехода данных в другой класс хранения S3 в объекте Amazon Security Lake.

storageClass -> (строка)

Диапазон классов хранения, который вы можете выбрать, исходя из потребностей вашего рабочего процесса в доступе к данным, надежности и стоимости.

region -> (строка)

Регионы Amazon Web Services, в которых включен Security Lake.

replicationConfiguration -> (структура)

Предоставляет сведения о репликации объекта Amazon Security Lake.

regions -> (список)

Указывает один или несколько централизованных регионов сводки. Регион Amazon Web Services, указанный в параметре region операции ` CreateDataLake https://docs.aws.amazon.com/security-lake/latest/APIReference/API_CreateDataLake.html`__ или ` UpdateDataLake https://docs.aws.amazon.com/security-lake/latest/APIReference/API_UpdateDataLake.html`__, предоставляет данные в сводный регион или регионы, указанные в этом параметре.

Репликация обеспечивает автоматическое асинхронное копирование объектов между корзинами Amazon S3. Корзины S3, настроенные для репликации объектов, могут принадлежать одной и той же учетной записи Amazon Web Services или разным учетным записям. Вы можете реплицировать объекты в одну целевую корзину или в несколько целевых корзин. Целевые корзины могут находиться в разных регионах или в том же регионе, что и исходная корзина.

(строка)

roleArn -> (строка)

Параметры репликации для корзин Amazon S3. Этот параметр использует роль управления идентификацией и доступом (IAM), которую вы создали и которая управляется Security Lake, для обеспечения правильности параметров репликации.

s3BucketArn -> (строка)

ARN корзины Amazon S3 Amazon Security Lake.

updateStatus -> (структура)

Состояние последнего UpdateDataLake или DeleteDataLake запроса API.

exception -> (структура)

Подробная информация о последнем UpdateDataLake или DeleteDataLake запросе API, который завершился ошибкой.

code -> (строка)

Код причины исключения последнего UpdateDataLake или DeleteDataLake запроса API.

reason -> (строка)

Причина исключения последнего UpdateDataLake или DeleteDataLake запроса API.

requestId -> (строка)

Уникальный идентификатор последнего UpdateDataLake или DeleteDataLake запроса API.

status -> (строка)

Состояние последнего UpdateDataLake или DeleteDataLake запроса API, который был запрошен.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API