create-connection

Описание

Создает новое подключение. В Amazon DataZone подключение позволяет вам подключать свои ресурсы (домены, проекты и окружения) к внешним ресурсам и службам.

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

Синтаксис

  create-connection
[--aws-location <value>]
[--client-token <value>]
[--description <value>]
--domain-identifier <value>
--environment-identifier <value>
--name <value>
[--props <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]

Параметры

--aws-location (структура)

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

accessRole=string,awsAccountId=string,awsRegion=string,iamConnectionId=string

Синтаксис JSON:

{
  "accessRole": "string",
  "awsAccountId": "string",
  "awsRegion": "string",
  "iamConnectionId": "string"
}

--client-token (строка)

--description (строка)

--domain-identifier (строка)

--environment-identifier (строка)

--name (строка)

--props (структура помеченного объединения)

Синтаксис JSON:

{
  "athenaProperties": {
    "workgroupName": "string"
  },
  "glueProperties": {
    "glueConnectionInput": {
      "athenaProperties": {"string": "string"
        ...},
      "authenticationConfiguration": {
        "authenticationType": "BASIC"|"OAUTH2"|"CUSTOM",
        "basicAuthenticationCredentials": {
          "password": "string",
          "userName": "string"
        },
        "customAuthenticationCredentials": {"string": "string"
          ...},
        "kmsKeyArn": "string",
        "oAuth2Properties": {
          "authorizationCodeProperties": {
            "authorizationCode": "string",
            "redirectUri": "string"
          },
          "oAuth2ClientApplication": {
            "aWSManagedClientApplicationReference": "string",
            "userManagedClientApplicationClientId": "string"
          },
          "oAuth2Credentials": {
            "accessToken": "string",
            "jwtToken": "string",
            "refreshToken": "string",
            "userManagedClientApplicationClientSecret": "string"
          },
          "oAuth2GrantType": "AUTHORIZATION_CODE"|"CLIENT_CREDENTIALS"|"JWT_BEARER",
          "tokenUrl": "string",
          "tokenUrlParametersMap": {"string": "string"
            ...}
        },
        "secretArn": "string"
      },
      "connectionProperties": {"string": "string"
        ...},
      "connectionType": "SNOWFLAKE"|"BIGQUERY"|"DOCUMENTDB"|"DYNAMODB"|"MYSQL"|"OPENSEARCH"|"ORACLE"|"POSTGRESQL"|"REDSHIFT"|"SAPHANA"|"SQLSERVER"|"TERADATA"|"VERTICA",
      "description": "string",
      "matchCriteria": "string",
      "name": "string",
      "physicalConnectionRequirements": {
        "availabilityZone": "string",
        "securityGroupIdList": ["string", ...],
        "subnetId": "string",
        "subnetIdList": ["string", ...]
      },
      "pythonProperties": {"string": "string"
        ...},
      "sparkProperties": {"string": "string"
        ...},
      "validateCredentials": true|false,
      "validateForComputeEnvironments": ["SPARK"|"ATHENA"|"PYTHON", ...]
    }
  },
  "hyperPodProperties": {
    "clusterName": "string"
  },
  "iamProperties": {
    "glueLineageSyncEnabled": true|false
  },
  "redshiftProperties": {
    "credentials": {
      "secretArn": "string",
      "usernamePassword": {
        "password": "string",
        "username": "string"
      }
    },
    "databaseName": "string",
    "host": "string",
    "lineageSync": {
      "enabled": true|false,
      "schedule": {
        "schedule": "string"
      }
    },
    "port": integer,
    "storage": {
      "clusterName": "string",
      "workgroupName": "string"
    }
  },
  "sparkEmrProperties": {
    "computeArn": "string",
    "instanceProfileArn": "string",
    "javaVirtualEnv": "string",
    "logUri": "string",
    "pythonVirtualEnv": "string",
    "runtimeRole": "string",
    "trustedCertificatesS3Uri": "string"
  },
  "sparkGlueProperties": {
    "additionalArgs": {
      "connection": "string"
    },
    "glueConnectionName": "string",
    "glueVersion": "string",
    "idleTimeout": integer,
    "javaVirtualEnv": "string",
    "numberOfWorkers": integer,
    "pythonVirtualEnv": "string",
    "workerType": "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.

Вывод

connectionId -> (строка)

description -> (строка)

domainId -> (строка)

domainUnitId -> (строка)

environmentId -> (строка)

name -> (строка)

physicalEndpoints -> (список)

type -> (строка)