add-option-to-option-group

Описание

Изменяет существующую группу опций.

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

Синтаксис

  add-option-to-option-group
--option-group-name <value>
[--apply-immediately | --no-apply-immediately]
[--options <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 (строка)

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

Постоянные опции, такие как опция TDE для Oracle Advanced Security TDE, не могут быть удалены из группы опций, и эту группу опций нельзя удалить с экземпляра базы данных после её ассоциации с экземпляром базы данных.

--apply-immediately | --no-apply-immediately (булево)

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

--options (список)

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

(структура)

Список всех доступных опций для группы опций.

OptionName -> (строка)

Конфигурация опций для включения в группу.

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

Необязательный порт для опции.

OptionVersion -> (строка)

Версия опции.

DBSecurityGroupMemberships -> (список)

Список групп безопасности базы данных, используемых для этой опции.

(строка)

VpcSecurityGroupMemberships -> (список)

Список имён групп безопасности VPC, используемых для этой опции.

(строка)

OptionSettings -> (список)

Настройки опций, которые необходимо включить в группу опций.

(структура)

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

Name -> (строка)

Имя опции, для которой можно задать настройки.

Value -> (строка)

Текущее значение настройки опции.

DefaultValue -> (строка)

Значение настройки опции по умолчанию.

Description -> (строка)

Описание настройки опции.

ApplyType -> (строка)

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

DataType -> (строка)

Тип данных настройки опции.

AllowedValues -> (строка)

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

IsModifiable -> (булево)

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

IsCollection -> (булево)

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

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

OptionName=string,Port=integer,OptionVersion=string,DBSecurityGroupMemberships=string,string,VpcSecurityGroupMemberships=string,string,OptionSettings=[{Name=string,Value=string,DefaultValue=string,Description=string,ApplyType=string,DataType=string,AllowedValues=string,IsModifiable=boolean,IsCollection=boolean},{Name=string,Value=string,DefaultValue=string,Description=string,ApplyType=string,DataType=string,AllowedValues=string,IsModifiable=boolean,IsCollection=boolean}] ...

Синтаксис JSON:

[
  {
    "OptionName": "string",
    "Port": integer,
    "OptionVersion": "string",
    "DBSecurityGroupMemberships": ["string", ...],
    "VpcSecurityGroupMemberships": ["string", ...],
    "OptionSettings": [
      {
        "Name": "string",
        "Value": "string",
        "DefaultValue": "string",
        "Description": "string",
        "ApplyType": "string",
        "DataType": "string",
        "AllowedValues": "string",
        "IsModifiable": true|false,
        "IsCollection": true|false
      }
      ...
    ]
  }
  ...
]

--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-auto-prompt (булево)

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

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

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

Примеры

Примечание

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

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

Добавление опции в группу опций

В следующем add-option-to-option-group примере добавляется опция в указанную группу опций.

aws rds add-option-to-option-group \
    --option-group-name myoptiongroup \
    --options OptionName=OEM,Port=5500,DBSecurityGroupMemberships=default \
    --apply-immediately

Вывод:

{
    "OptionGroup": {
        "OptionGroupName": "myoptiongroup",
        "OptionGroupDescription": "Test Option Group",
        "EngineName": "oracle-ee",
        "MajorEngineVersion": "12.1",
        "Options": [
            {
                "OptionName": "Timezone",
                "OptionDescription": "Change time zone",
                "Persistent": true,
                "Permanent": false,
                "OptionSettings": [
                    {
                        "Name": "TIME_ZONE",
                        "Value": "Australia/Sydney",
                        "DefaultValue": "UTC",
                        "Description": "Specifies the timezone the user wants to change the system time to",
                        "ApplyType": "DYNAMIC",
                        "DataType": "STRING",
                        "AllowedValues": "Africa/Cairo,Africa/Casablanca,Africa/Harare,Africa/Lagos,Africa/Luanda,Africa/Monrovia,Africa/Nairobi,Africa/Tripoli,Africa/Windhoek,America/Araguaina,America/Argentina/Buenos_Aires,America/Asuncion,America/Bogota,America/Caracas,America/Chicago,America/Chihuahua,America/Cuiaba,America/Denver,America/Detroit,America/Fortaleza,America/Godthab,America/Guatemala,America/Halifax,America/Lima,America/Los_Angeles,America/Manaus,America/Matamoros,America/Mexico_City,America/Monterrey,America/Montevideo,America/New_York,America/Phoenix,America/Santiago,America/Sao_Paulo,America/Tijuana,America/Toronto,Asia/Amman,Asia/Ashgabat,Asia/Baghdad,Asia/Baku,Asia/Bangkok,Asia/Beirut,Asia/Calcutta,Asia/Damascus,Asia/Dhaka,Asia/Hong_Kong,Asia/Irkutsk,Asia/Jakarta,Asia/Jerusalem,Asia/Kabul,Asia/Karachi,Asia/Kathmandu,Asia/Kolkata,Asia/Krasnoyarsk,Asia/Magadan,Asia/Manila,Asia/Muscat,Asia/Novosibirsk,Asia/Rangoon,Asia/Riyadh,Asia/Seoul,Asia/Shanghai,Asia/Singapore,Asia/Taipei,Asia/Tehran,Asia/Tokyo,Asia/Ulaanbaatar,Asia/Vladivostok,Asia/Yakutsk,Asia/Yerevan,Atlantic/Azores,Atlantic/Cape_Verde,Australia/Adelaide,Australia/Brisbane,Australia/Darwin,Australia/Eucla,Australia/Hobart,Australia/Lord_Howe,Australia/Perth,Australia/Sydney,Brazil/DeNoronha,Brazil/East,Canada/Newfoundland,Canada/Saskatchewan,Etc/GMT-3,Europe/Amsterdam,Europe/Athens,Europe/Berlin,Europe/Dublin,Europe/Helsinki,Europe/Kaliningrad,Europe/London,Europe/Madrid,Europe/Moscow,Europe/Paris,Europe/Prague,Europe/Rome,Europe/Sarajevo,Pacific/Apia,Pacific/Auckland,Pacific/Chatham,Pacific/Fiji,Pacific/Guam,Pacific/Honolulu,Pacific/Kiritimati,Pacific/Marquesas,Pacific/Samoa,Pacific/Tongatapu,Pacific/Wake,US/Alaska,US/Central,US/East-Indiana,US/Eastern,US/Pacific,UTC",
                        "IsModifiable": true,
                        "IsCollection": false
                    }
                ],
                "DBSecurityGroupMemberships": [],
                "VpcSecurityGroupMemberships": []
            },
            {
                "OptionName": "OEM",
                "OptionDescription": "Oracle 12c EM Express",
                "Persistent": false,
                "Permanent": false,
                "Port": 5500,
                "OptionSettings": [],
                "DBSecurityGroupMemberships": [
                    {
                        "DBSecurityGroupName": "default",
                        "Status": "authorized"
                    }
                ],
                "VpcSecurityGroupMemberships": []
            }
        ],
        "AllowsVpcAndNonVpcInstanceMemberships": false,
        "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:myoptiongroup"
    }
}

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

Вывод

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 -> (метка времени)

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

END_OF_DOCUMENT_MARKER