Spec-Zone.ru › AWS CLI v2

[ aws . lakeformation ]

create-lake-formation-opt-in

Описание

Принудительное применение разрешений Lake Formation для заданных баз данных, таблиц и принципалов.

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

Синтаксис

  create-lake-formation-opt-in
--principal <value>
--resource <value>
[--condition <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]

Параметры

--principal (структура)

Принципал Lake Formation. Поддерживаются принципалы IAM-пользователи или IAM-роли.

DataLakePrincipalIdentifier -> (строка)

Идентификатор принципала Lake Formation.

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

DataLakePrincipalIdentifier=string

Синтаксис JSON:

{
  "DataLakePrincipalIdentifier": "string"
}

--resource (структура)

Структура для ресурса.

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

Идентификатор каталога данных. По умолчанию — идентификатор учетной записи. Каталог данных — это постоянное хранилище метаданных. Он содержит определения баз данных, определения таблиц и другую управляющую информацию для управления вашим окружением Lake Formation.

Id -> (строка)

Идентификатор ресурса каталога.

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

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

CatalogId -> (строка)

Идентификатор каталога данных. По умолчанию — идентификатор учетной записи вызывающего.

Name -> (строка)

Имя ресурса базы данных. Уникально для каталога данных.

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

Таблица для ресурса. Таблица — это метаданные, представляющие ваши данные. Вы можете предоставлять и отзывать права на таблицу для принципала.

CatalogId -> (строка)

Идентификатор каталога данных. По умолчанию — идентификатор учетной записи вызывающего.

DatabaseName -> (строка)

Имя базы данных для таблицы. Уникально для каталога данных. База данных — это набор связанных определений таблиц, организованных в логическую группу. Вы можете предоставлять и отзывать разрешения на базу данных для принципала.

Name -> (строка)

Имя таблицы.

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

Объект-подстановочное значение, представляющий все таблицы в базе данных.

Требуется хотя бы один из TableResource$Name или TableResource$TableWildcard.

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

Таблица со столбцами для ресурса. Принципал с разрешениями на этот ресурс может выбирать метаданные из столбцов таблицы в каталоге данных и подлежащие данные в Amazon S3.

CatalogId -> (строка)

Идентификатор каталога данных. По умолчанию — идентификатор учетной записи вызывающего.

DatabaseName -> (строка)

Имя базы данных для таблицы со столбцами. Уникально для каталога данных. База данных — это набор связанных определений таблиц, организованных в логическую группу. Вы можете предоставлять и отзывать разрешения на базу данных для принципала.

Name -> (строка)

Имя таблицы. Таблица — это метаданные, представляющие ваши данные. Вы можете предоставлять и отзывать права на таблицу для принципала.

ColumnNames -> (список)

Список имён столбцов таблицы. Требуется хотя бы один из ColumnNames или ColumnWildcard.

(строка)

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

Подстановочное значение, заданное объектом ColumnWildcard. Требуется хотя бы один из ColumnNames или ColumnWildcard.

ExcludedColumnNames -> (список)

Исключает имена столбцов. Любой столбец с этим именем будет исключен.

(строка)

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

Расположение пути Amazon S3, где предоставляются или отзываются разрешения.

CatalogId -> (строка)

Идентификатор каталога данных, в котором расположение зарегистрировано в Lake Formation. По умолчанию — идентификатор учетной записи вызывающего.

ResourceArn -> (строка)

Amazon Resource Name (ARN), уникально идентифицирующий ресурс расположения данных.

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

Фильтр данных ячеек.

TableCatalogId -> (строка)

Идентификатор каталога, к которому принадлежит таблица.

DatabaseName -> (строка)

База данных в Glue Data Catalog.

TableName -> (строка)

Имя таблицы.

Name -> (строка)

Имя фильтра данных ячеек.

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

Ключ и значения LF-тега, прикреплённые к ресурсу.

CatalogId -> (строка)

Идентификатор каталога данных. По умолчанию — идентификатор учетной записи. Каталог данных — это постоянное хранилище метаданных. Он содержит определения баз данных, определения таблиц и другую управляющую информацию для управления вашим окружением Lake Formation.

TagKey -> (строка)

Имя ключа LF-тега.

TagValues -> (список)

Список возможных значений, которые может принимать атрибут.

(строка)

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

Список условий LF-тега или сохранённых выражений LF-тега, определяющих политику LF-тега ресурса.

CatalogId -> (строка)

Идентификатор каталога данных. По умолчанию — идентификатор учетной записи. Каталог данных — это постоянное хранилище метаданных. Он содержит определения баз данных, определения таблиц и другую управляющую информацию для управления вашим окружением Lake Formation.

ResourceType -> (строка)

Тип ресурса, к которому применяется политика LF-тега.

Expression -> (список)

Список условий LF-тега или сохранённого выражения, которые применяются к политике LF-тега ресурса.

(структура)

Структура, позволяющая администратору предоставлять пользователям разрешения при определённых условиях. Например, предоставление роли доступа ко всем столбцам, не имеющим LF-тега «PII», в таблицах, имеющих LF-тег «Prod».

TagKey -> (строка)

Имя ключа LF-тега.

TagValues -> (список)

Список возможных значений, которые может принимать атрибут.

Максимальное количество значений, которые можно определить для LF-тега, равно 1000. Один вызов API поддерживает 50 значений. Вы можете использовать несколько вызовов API для добавления большего количества значений.

(строка)

ExpressionName -> (строка)

Если указано, разрешения предоставляются ресурсам каталога данных, чьи назначенные LF-теги соответствуют выражению тела сохранённого выражения по предоставленному ExpressionName.

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

LF-тег выражения ресурса. Логическое выражение, составленное из одного или нескольких пар ключ:значение LF-тега.

CatalogId -> (строка)

Идентификатор каталога данных. По умолчанию — идентификатор учетной записи.

Name -> (строка)

Имя выражения LF-тега, на которое предоставляются разрешения.

Синтаксис JSON:

{
  "Catalog": {
    "Id": "string"
  },
  "Database": {
    "CatalogId": "string",
    "Name": "string"
  },
  "Table": {
    "CatalogId": "string",
    "DatabaseName": "string",
    "Name": "string",
    "TableWildcard": {

    }
  },
  "TableWithColumns": {
    "CatalogId": "string",
    "DatabaseName": "string",
    "Name": "string",
    "ColumnNames": ["string", ...],
    "ColumnWildcard": {
      "ExcludedColumnNames": ["string", ...]
    }
  },
  "DataLocation": {
    "CatalogId": "string",
    "ResourceArn": "string"
  },
  "DataCellsFilter": {
    "TableCatalogId": "string",
    "DatabaseName": "string",
    "TableName": "string",
    "Name": "string"
  },
  "LFTag": {
    "CatalogId": "string",
    "TagKey": "string",
    "TagValues": ["string", ...]
  },
  "LFTagPolicy": {
    "CatalogId": "string",
    "ResourceType": "DATABASE"|"TABLE",
    "Expression": [
      {
        "TagKey": "string",
        "TagValues": ["string", ...]
      }
      ...
    ],
    "ExpressionName": "string"
  },
  "LFTagExpression": {
    "CatalogId": "string",
    "Name": "string"
  }
}

--condition (структура)

Условие Lake Formation, которое применяется к разрешениям и подпискам, содержащим выражение.

Expression -> (строка)

Выражение, написанное на языке Cedar Policy Language для сопоставления атрибутов принципала.

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

Expression=string

Синтаксис JSON:

{
  "Expression": "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 (boolean)

Включить отладку логов.

--endpoint-url (string)

Переопределить стандартный URL команды на указанный URL.

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (string)

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

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

--query (string)

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

--profile (string)

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

--region (string)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (string)

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

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

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

--ca-bundle (string)

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (string)

Стиль форматирования для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить страницу кли для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

Нет

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

Spec-Zone.ru

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