Spec-Zone.ru › AWS CLI v2

[ aws . dms ]

create-replication-instance

Описание

Создает реплицирующий экземпляр с указанными параметрами.

DMS требует, чтобы в вашей учетной записи были определенные роли с соответствующими разрешениями, прежде чем вы сможете создать реплицирующий экземпляр. Сведения о необходимых ролях см. в разделе Создание ролей IAM для использования с CLI и API DMS. Сведения о необходимых разрешениях см. в разделе Разрешения IAM, необходимые для использования DMS.

Примечание

Если вы не укажете версию при создании реплицирующего экземпляра, DMS создаст экземпляр с использованием версии по умолчанию. Сведения о версии движка по умолчанию см. в разделе Примечания к выпуску.

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

Синтаксис

  create-replication-instance
--replication-instance-identifier <value>
[--allocated-storage <value>]
--replication-instance-class <value>
[--vpc-security-group-ids <value>]
[--availability-zone <value>]
[--replication-subnet-group-identifier <value>]
[--preferred-maintenance-window <value>]
[--multi-az | --no-multi-az]
[--engine-version <value>]
[--auto-minor-version-upgrade | --no-auto-minor-version-upgrade]
[--tags <value>]
[--kms-key-id <value>]
[--publicly-accessible | --no-publicly-accessible]
[--dns-name-servers <value>]
[--resource-identifier <value>]
[--network-type <value>]
[--kerberos-authentication-settings <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]

Параметры

--replication-instance-identifier (строка)

Идентификатор реплицирующего экземпляра. Этот параметр хранится как строка в нижнем регистре.

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

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

Пример: myrepinstance

--allocated-storage (целое число)

Объем хранилища (в гигабайтах), который будет изначально выделен для реплицирующего экземпляра.

--replication-instance-class (строка)

Вычислительная и емкостная мощность реплицирующего экземпляра, как определено для указанного класса реплицирующего экземпляра. Например, для указания класса экземпляра dms.c4.large установите этот параметр на "dms.c4.large".

Для получения дополнительной информации о настройках и емкостях для доступных классов реплицирующих экземпляров см. `Выбор подходящего реплицирующего экземпляра DMS <https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.Types.html >`__ и Выбор оптимального размера реплицирующего экземпляра.

--vpc-security-group-ids (список)

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

(строка)

Синтаксис:

"string" "string" ...

--availability-zone (строка)

Зона доступности, в которой будет создан реплицирующий экземпляр. Значение по умолчанию — случайная зона доступности, выбранная системой, в регионе Amazon Web Services конечной точки, например: us-east-1d.

--replication-subnet-group-identifier (строка)

Группа подсетей для ассоциации с реплицирующим экземпляром.

--preferred-maintenance-window (строка)

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

Формат: ddd:hh24:mi-ddd:hh24:mi

Значение по умолчанию: 30-минутный интервал, выбранный случайным образом из 8-часового блока времени в каждом регионе Amazon Web Services, в случайный день недели.

Допустимые дни: Пн, Вт, Ср, Чт, Пт, Сб, Вс

Ограничения: Минимальный интервал — 30 минут.

--multi-az | --no-multi-az (логическое значение)

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

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

Номер версии движка реплицирующего экземпляра.

--auto-minor-version-upgrade | --no-auto-minor-version-upgrade (логическое значение)

Значение, указывающее, применяются ли автоматические обновления движка младших версий к реплицирующему экземпляру во время окна технического обслуживания. По умолчанию этот параметр равен true.

Значение по умолчанию: true

--tags (список)

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

(структура)

Пользовательская пара ключ-значение, которая описывает метаданные, добавленные к ресурсу DMS, и которая используется такими операциями, как:

  • AddTagsToResource
  • ListTagsForResource
  • RemoveTagsFromResource

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

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

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

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

ResourceArn -> (строка)

Строка Amazon Resource Name (ARN), которая однозначно идентифицирует ресурс, для которого создается тег.

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

Key=string,Value=string,ResourceArn=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string",
    "ResourceArn": "string"
  }
  ...
]

--kms-key-id (строка)

Идентификатор ключа KMS, используемый для шифрования данных в реплицирующем экземпляре.

Если вы не укажете значение для параметра KmsKeyId, DMS будет использовать ваш ключ шифрования по умолчанию.

KMS создает ключ шифрования по умолчанию для вашей учетной записи Amazon Web Services. У каждой учетной записи Amazon Web Services в каждом регионе Amazon Web Services есть свой отдельный ключ шифрования по умолчанию.

--publicly-accessible | --no-publicly-accessible (логическое значение)

Указывает параметры доступности для реплицирующего экземпляра. Значение true представляет экземпляр с общедоступным IP-адресом. Значение false представляет экземпляр с частным IP-адресом. Значение по умолчанию — true.

--dns-name-servers (строка)

Список пользовательских DNS-серверов, поддерживаемых реплицирующим экземпляром для доступа к вашему локальному источнику или целевой базе данных. Этот список переопределяет поддерживаемые по умолчанию имена серверов реплицирующего экземпляра. Вы можете указать список адресов интернета через запятую для до четырех локальных DNS-серверов. Например: "1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4"

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

Дружественное имя для идентификатора ресурса в конце параметра EndpointArn, которое возвращается в созданном объекте Endpoint. Значение этого параметра может иметь до 31 символа. Оно может содержать только ASCII буквы, цифры и дефисы ('-'). Также оно не может заканчиваться дефисом или содержать два последовательных дефиса, и может начинаться только с буквы, например, Example-App-ARN1. Например, это значение может привести к значению EndpointArn arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1. Если вы не указываете значение ResourceIdentifier, DMS генерирует значение идентификатора по умолчанию для конца EndpointArn.

--network-type (строка)

Тип протокола IP-адреса, используемого реплицирующим экземпляром, например, только IPv4 или Dual-stack, который поддерживает как IPv4, так и IPv6 адресацию. IPv6 только пока не поддерживается.

--kerberos-authentication-settings (структура)

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

KeyCacheSecretId -> (строка)

Указывает идентификатор секрета, хранящего файл кэша ключей, необходимый для аутентификации Kerberos.

KeyCacheSecretIamArn -> (строка)

Указывает Amazon Resource Name (ARN) роли IAM, предоставляющей Amazon Web Services DMS доступ к секрету, содержащему файл кэша ключей для аутентификации Kerberos.

Krb5FileContents -> (строка)

Указывает содержимое конфигурационного файла krb5, необходимого для аутентификации Kerberos.

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

KeyCacheSecretId=string,KeyCacheSecretIamArn=string,Krb5FileContents=string

Синтаксис JSON:

{
  "KeyCacheSecretId": "string",
  "KeyCacheSecretIamArn": "string",
  "Krb5FileContents": "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)

Файл с сертификатами доверенных корневых центров для проверки 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 для вывода.

--cli-auto-prompt (boolean)

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

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

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

Примеры

Примечание

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

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

Для создания экземпляра репликации

Следующий create-replication-instance пример создает экземпляр репликации.

aws dms create-replication-instance \
    --replication-instance-identifier my-repl-instance \
    --replication-instance-classdms.t2.micro \
    --allocated-storage 5

Вывод:

{
    "ReplicationInstance": {
        "ReplicationInstanceIdentifier": "my-repl-instance",
        "ReplicationInstanceClass": "dms.t2.micro",
        "ReplicationInstanceStatus": "creating",
        "AllocatedStorage": 5,
        "VpcSecurityGroups": [
            {
                "VpcSecurityGroupId": "sg-f839b688",
                "Status": "active"
            }
        ],
        "ReplicationSubnetGroup": {
            "ReplicationSubnetGroupIdentifier": "default",
            "ReplicationSubnetGroupDescription": "default",
            "VpcId": "vpc-136a4c6a",
            "SubnetGroupStatus": "Complete",
            "Subnets": [
                {
                    "SubnetIdentifier": "subnet-da327bf6",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1a"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-42599426",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1d"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-bac383e0",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1c"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-6746046b",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1f"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-d7c825e8",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1e"
                    },
                    "SubnetStatus": "Active"
                },
                {
                    "SubnetIdentifier": "subnet-cbfff283",
                    "SubnetAvailabilityZone": {
                        "Name": "us-east-1b"
                    },
                    "SubnetStatus": "Active"
                }
            ]
        },
        "PreferredMaintenanceWindow": "sat:12:35-sat:13:05",
        "PendingModifiedValues": {},
        "MultiAZ": false,
        "EngineVersion": "3.3.2",
        "AutoMinorVersionUpgrade": true,
        "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/f7bc0f8e-1a3a-4ace-9faa-e8494fa3921a",
        "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:ZK2VQBUWFDBAWHIXHAYG5G2PKY",
        "PubliclyAccessible": true
    }
}

Дополнительную информацию см. в разделе Работа с экземпляром репликации AWS DMS в Руководстве пользователя AWS Database Migration Service.

Вывод

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

Созданный экземпляр репликации.

ReplicationInstanceIdentifier -> (строка)

Идентификатор экземпляра репликации — обязательный параметр. Этот параметр хранится в виде строки в нижнем регистре.

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

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

Пример: myrepinstance

ReplicationInstanceClass -> (строка)

Вычислительная и емкостная мощность экземпляра репликации, определённая для указанного класса экземпляра репликации. Это обязательный параметр, хотя в консоли DMS предусмотрено значение по умолчанию.

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

ReplicationInstanceStatus -> (строка)

Статус экземпляра репликации. Возможные значения возврата включают:

  • "available"
  • "creating"
  • "deleted"
  • "deleting"
  • "failed"
  • "modifying"
  • "upgrading"
  • "rebooting"
  • "resetting-master-credentials"
  • "storage-full"
  • "incompatible-credentials"
  • "incompatible-network"
  • "maintenance"

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

Объем выделенного хранилища (в гигабайтах) для экземпляра репликации.

InstanceCreateTime -> (метка времени)

Время создания экземпляра репликации.

VpcSecurityGroups -> (список)

Группа безопасности VPC для экземпляра.

(структура)

Описание статуса группы безопасности, связанной с виртуальной частной областью (VPC), в которой размещены ваша репликация и экземпляры БД.

VpcSecurityGroupId -> (строка)

Идентификатор группы безопасности VPC.

Status -> (строка)

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

AvailabilityZone -> (строка)

Зона доступности экземпляра.

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

Группа подсетей для экземпляра репликации.

ReplicationSubnetGroupIdentifier -> (строка)

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

ReplicationSubnetGroupDescription -> (строка)

Описание группы подсетей репликации.

VpcId -> (строка)

Идентификатор VPC.

SubnetGroupStatus -> (строка)

Статус группы подсетей.

Subnets -> (список)

Подсети, входящие в группу подсетей.

(структура)

В ответ на запрос операции DescribeReplicationSubnetGroups этот объект идентифицирует подсеть по ее заданной зоне доступности, идентификатору подсети и статусу.

SubnetIdentifier -> (строка)

Идентификатор подсети.

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

Зона доступности подсети.

Name -> (строка)

Название зоны доступности.

SubnetStatus -> (строка)

Статус подсети.

SupportedNetworkTypes -> (список)

Протокол IP-адресации, поддерживаемый группой подсетей. Используется экземпляром репликации со значениями, такими как только IPv4 или Dual-stack, который поддерживает как IPv4, так и IPv6 адресацию. IPv6 только пока не поддерживается.

(строка)

PreferredMaintenanceWindow -> (строка)

Временные интервалы планового обслуживания для экземпляра репликации. Любые запланированные обновления экземпляра репликации выполняются в это время.

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

Значения ожидаемых изменений.

ReplicationInstanceClass -> (строка)

Вычислительная и емкостная мощность экземпляра репликации, определённая для указанного класса экземпляра репликации.

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

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

Объем выделенного хранилища (в гигабайтах) для экземпляра репликации.

MultiAZ -> (булево)

Указывает, является ли экземпляр репликации развертыванием Multi-AZ. Параметр AvailabilityZone нельзя установить, если параметр Multi-AZ имеет значение true.

EngineVersion -> (строка)

Номер версии движка экземпляра репликации.

NetworkType -> (строка)

Тип протокола IP-адресации, используемый экземпляром репликации, например, только IPv4 или Dual-stack, который поддерживает как IPv4, так и IPv6 адресацию. IPv6 только пока не поддерживается.

MultiAZ -> (булево)

Указывает, является ли экземпляр репликации развертыванием Multi-AZ. Параметр AvailabilityZone нельзя установить, если параметр Multi-AZ имеет значение true.

EngineVersion -> (строка)

Номер версии движка экземпляра репликации.

Если номер версии движка не указан при создании экземпляра репликации, используется последняя доступная версия движка по умолчанию.

При изменении основной версии движка экземпляра также необходимо установить AllowMajorVersionUpgrade в true.

AutoMinorVersionUpgrade -> (булево)

Булево значение, указывающее, будут ли автоматически применяться незначительные обновления версии для экземпляра.

KmsKeyId -> (строка)

Идентификатор ключа KMS, используемого для шифрования данных в экземпляре репликации.

Если вы не укажете значение для параметра KmsKeyId, DMS использует ключ шифрования по умолчанию.

KMS создаёт ключ шифрования по умолчанию для вашей учетной записи Amazon Web Services. У вашей учетной записи Amazon Web Services есть другой ключ шифрования по умолчанию для каждого региона Amazon Web Services.

ReplicationInstanceArn -> (строка)

Amazon Resource Name (ARN) экземпляра репликации.

ReplicationInstancePublicIpAddress -> (строка)

Общедоступный IP-адрес экземпляра репликации.

ReplicationInstancePrivateIpAddress -> (строка)

Приватный IP-адрес экземпляра репликации.

ReplicationInstancePublicIpAddresses -> (список)

Один или несколько общедоступных IP-адресов для экземпляра репликации.

(строка)

ReplicationInstancePrivateIpAddresses -> (список)

Один или несколько приватных IP-адресов для экземпляра репликации.

(строка)

ReplicationInstanceIpv6Addresses -> (список)

Один или несколько IPv6-адресов для экземпляра репликации.

(строка)

PubliclyAccessible -> (булево)

Указывает параметры доступности экземпляра репликации. Значение true обозначает экземпляр с общедоступным IP-адресом. Значение false обозначает экземпляр с приватным IP-адресом. Значение по умолчанию — true.

SecondaryAvailabilityZone -> (строка)

Зона доступности резервного экземпляра репликации в развертывании Multi-AZ.

FreeUntil -> (метка времени)

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

DnsNameServers -> (строка)

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

NetworkType -> (строка)

Тип протокола IP-адресации, используемый экземпляром репликации, например, только IPv4 или Dual-stack, который поддерживает как IPv4, так и IPv6 адресацию. IPv6 только пока не поддерживается.

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

Указывает параметры, необходимые для аутентификации Kerberos при репликации экземпляра.

KeyCacheSecretId -> (строка)

Указывает ID секрета, хранящего файл кэша ключей, необходимый для аутентификации Kerberos.

KeyCacheSecretIamArn -> (строка)

Указывает Amazon Resource Name (ARN) роли IAM, предоставляющей Amazon Web Services DMS доступ к секрету, содержащему файл кэша ключей для аутентификации Kerberos.

Krb5FileContents -> (строка)

Указывает содержимое конфигурационного файла krb5, необходимого для аутентификации Kerberos.

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

Spec-Zone.ru

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