Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

create-option-group

Описание

Создаёт новую группу параметров. Вы можете создать до 20 групп параметров.

Эта команда не применяется к RDS Custom.

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

Синтаксис

  create-option-group
--option-group-name <value>
--engine-name <value>
--major-engine-version <value>
--option-group-description <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]

Параметры

--option-group-name (строка)

Указывает имя создаваемой группы параметров.

Ограничения:

  • Должно содержать от 1 до 255 букв, цифр или дефисов
  • Первый символ должен быть буквой
  • Не может заканчиваться дефисом или содержать два последовательных дефиса

Пример: myoptiongroup

--engine-name (строка)

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

Допустимые значения:

  • db2-ae
  • db2-se
  • mariadb
  • mysql
  • oracle-ee
  • oracle-ee-cdb
  • oracle-se2
  • oracle-se2-cdb
  • postgres
  • sqlserver-ee
  • sqlserver-se
  • sqlserver-ex
  • sqlserver-web

--major-engine-version (строка)

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

--option-group-description (строка)

Описание группы параметров.

--tags (список)

Теги для назначения группе параметров.

(структура)

Метаданные, назначенные ресурсу Amazon RDS, представляющие собой пару ключ-значение.

Для получения дополнительной информации см. Маркирование ресурсов Amazon RDS в руководстве пользователя Amazon RDS или Маркирование ресурсов Amazon Aurora и Amazon RDS в руководстве пользователя Amazon Aurora.

Ключ -> (строка)

Ключ — это обязательное имя тега. Строковое значение может содержать от 1 до 128 символов Юникода и не может начинаться с aws: или rds:. Строка может содержать только набор символов Юникода, цифр, пробелов, «_», «.», «:», «/», «=», «+», «-», «@» (регулярное выражение Java: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

Значение -> (строка)

Значение — это необязательное значение тега. Строковое значение может содержать от 1 до 256 символов Юникода и не может начинаться с aws: или rds:. Строка может содержать только набор символов Юникода, цифр, пробелов, «_», «.», «:», «/», «=», «+», «-», «@» (регулярное выражение Java: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

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

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
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • включено
  • выключено
  • автоматически

--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.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Примеры

Примечание

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

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

Для создания группы параметров Amazon RDS

Следующая create-option-group команда создаёт новую группу параметров Amazon RDS для Oracle Enterprise Edition версии 11.2`, is named ``MyOptionGroup и включает описание.

aws rds create-option-group \
    --option-group-name MyOptionGroup \
    --engine-name oracle-ee \
    --major-engine-version 11.2 \
    --option-group-description "Oracle Database Manager Database Control"

Вывод:

{
    "OptionGroup": {
        "OptionGroupName": "myoptiongroup",
        "OptionGroupDescription": "Oracle Database Manager Database Control",
        "EngineName": "oracle-ee",
        "MajorEngineVersion": "11.2",
        "Options": [],
        "AllowsVpcAndNonVpcInstanceMemberships": true,
        "OptionGroupArn": "arn:aws:rds:us-west-2:123456789012:og:myoptiongroup"
    }
}

Вывод

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

OptionGroupName -> (строка)

Указывает имя группы параметров.

OptionGroupDescription -> (строка)

Предоставляет описание группы параметров.

EngineName -> (строка)

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

MajorEngineVersion -> (строка)

Указывает основную версию движка, связанную с этой группой параметров.

Options -> (список)

Указывает доступные параметры в группе параметров.

(структура)

Подробности параметра.

OptionName -> (строка)

Имя параметра.

OptionDescription -> (строка)

Описание параметра.

Persistent -> (булево)

Указывает, является ли этот параметр постоянным.

Permanent -> (булево)

Указывает, является ли этот параметр постоянным.

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

Если требуется, порт, настроенный для использования этим параметром.

OptionVersion -> (строка)

Версия параметра.

OptionSettings -> (список)

Параметры параметра.

(структура)

Параметры параметра — это фактические параметры, применяемые или настраиваемые для данного параметра. Используется при изменении группы параметров или описании групп параметров. Например, параметр NATIVE_NETWORK_ENCRYPTION имеет параметр SQLNET.ENCRYPTION_SERVER, который может иметь несколько различных значений.

Name -> (строка)

Имя параметра, для которого можно задать параметры.

Value -> (строка)

Текущее значение параметра.

DefaultValue -> (строка)

Значение параметра по умолчанию.

Description -> (строка)

Описание параметра.

ApplyType -> (строка)

Тип параметра, специфичный для СУБД.

DataType -> (строка)

Тип данных параметра.

AllowedValues -> (строка)

Допустимые значения параметра.

IsModifiable -> (булево)

Указывает, можно ли изменить параметр от значения по умолчанию.

IsCollection -> (булево)

Указывает, является ли параметр частью коллекции.

DBSecurityGroupMemberships -> (список)

Если параметр требует доступа к порту, эта группа безопасности СУБД разрешает доступ к порту.

(структура)

Этот тип данных используется в качестве элемента ответа в следующих действиях:

  • ModifyDBInstance
  • RebootDBInstance
  • RestoreDBInstanceFromDBSnapshot
  • RestoreDBInstanceToPointInTime

DBSecurityGroupName -> (строка)

Имя группы безопасности СУБД.

Status -> (строка)

Статус группы безопасности СУБД.

VpcSecurityGroupMemberships -> (список)

Если параметр требует доступа к порту, эта группа безопасности VPC разрешает доступ к порту.

(структура)

Этот тип данных используется в качестве элемента ответа для запросов о членстве в группе безопасности VPC.

VpcSecurityGroupId -> (строка)

Имя группы безопасности VPC.

Status -> (строка)

Статус членства в группе безопасности VPC.

В настоящее время единственный допустимый статус — active.

AllowsVpcAndNonVpcInstanceMemberships -> (булево)

Указывает, может ли эта группа параметров применяться к экземплярам как VPC, так и вне VPC. Значение true указывает, что группа параметров может применяться как к экземплярам VPC, так и к экземплярам вне VPC.

VpcId -> (строка)

Если AllowsVpcAndNonVpcInstanceMemberships имеет значение false, это поле пустое. Если AllowsVpcAndNonVpcInstanceMemberships имеет значение true, и это поле пустое, то эта группа параметров может применяться как к экземплярам VPC, так и к экземплярам вне VPC. Если это поле содержит значение, то эта группа параметров может применяться только к экземплярам, находящимся в VPC, указанной в этом поле.

OptionGroupArn -> (строка)

Указывает Amazon Resource Name (ARN) для группы параметров.

SourceOptionGroup -> (строка)

Указывает имя группы параметров, из которой скопирована эта группа параметров.

SourceAccountId -> (строка)

Указывает идентификатор учетной записи Amazon Web Services для группы параметров, из которой скопирована эта группа параметров.

CopyTimestamp -> (временная метка)

Указывает время копирования группы параметров.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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