Spec-Zone.ru › AWS CLI v2

[ aws . rds ]

копировать-снимок-бд

Описание

Копирует указанный снимок базы данных. Источник снимка базы данных должен быть в состоянии available.

Вы можете скопировать снимок из одной области Amazon Web Services в другую. В этом случае регион Amazon Web Services, в котором вы вызываете операцию CopyDBSnapshot, является целевым регионом Amazon Web Services для копии снимка базы данных.

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

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

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

Синтаксис

  copy-db-snapshot
--source-db-snapshot-identifier <value>
--target-db-snapshot-identifier <value>
[--kms-key-id <value>]
[--tags <value>]
[--copy-tags | --no-copy-tags]
[--pre-signed-url <value>]
[--option-group-name <value>]
[--target-custom-availability-zone <value>]
[--copy-option-group | --no-copy-option-group]
[--source-region <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]

Параметры

--source-db-snapshot-identifier (строка)

Идентификатор исходного снимка базы данных.

Если исходный снимок находится в той же области Amazon Web Services, что и копия, укажите допустимый идентификатор снимка базы данных. Например, вы можете указать rds:mysql-instance1-snapshot-20130805.

Если исходный снимок находится в другой области Amazon Web Services, чем копия, укажите допустимый ARN снимка базы данных. Например, вы можете указать arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

Если вы копируете общий ручной снимок базы данных, этот параметр должен быть Amazon Resource Name (ARN) общего снимка базы данных.

Если вы копируете зашифрованный снимок, этот параметр должен быть в формате ARN для исходной области Amazon Web Services.

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

  • Необходимо указать допустимый системный снимок в состоянии «доступен».

Пример: rds:mydb-2012-04-02-00-01

Пример: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805

--target-db-snapshot-identifier (строка)

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

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

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

Пример: my-db-snapshot

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

Идентификатор ключа Amazon Web Services KMS для зашифрованного снимка базы данных. Идентификатор ключа Amazon Web Services KMS — это ARN ключа, идентификатор ключа, ARN псевдонима или имя псевдонима для ключа KMS.

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

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

Если вы укажете этот параметр при копировании незашифрованного снимка, копия шифруется.

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

--tags (список)

Список тегов.

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

(структура)

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

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

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

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

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

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

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

Key=string,Value=string ...

Синтаксис JSON:

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

--copy-tags | --no-copy-tags (булево)

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

--pre-signed-url (строка)

При копировании снимка из одной области Amazon Web Services GovCloud (US) в другую — URL, содержащий подписанный запрос версии 4 подписи для операции API CopyDBSnapshot в исходной области Amazon Web Services, содержащей копируемый исходный снимок базы данных.

Это свойство применяется только к областям Amazon Web Services GovCloud (US). Оно игнорируется в других областях Amazon Web Services.

Вы должны указать этот параметр при копировании зашифрованного снимка базы данных из другой области Amazon Web Services с помощью API Amazon RDS. Не указывайте PreSignedUrl при копировании зашифрованного снимка базы данных в той же области Amazon Web Services.

Предварительно подписанный URL-адрес должен быть действительным запросом для операции API CopyDBClusterSnapshot, которая может выполняться в исходной области Amazon Web Services, содержащей копируемый зашифрованный снимок кластера базы данных. Запрос предварительно подписанного URL-адреса должен содержать следующие значения параметров:

  • DestinationRegion — Область Amazon Web Services, в которую копируется зашифрованный снимок базы данных. Эта область Amazon Web Services совпадает с той, в которой вызывается операция CopyDBSnapshot, содержащая этот предварительно подписанный URL-адрес. Например, если вы копируете зашифрованный снимок базы данных из области Amazon Web Services us-west-2 в область us-east-1, то вы вызываете операцию CopyDBSnapshot в области us-east-1 и предоставляете предварительно подписанный URL-адрес, содержащий вызов операции CopyDBSnapshot в области us-west-2. В этом примере DestinationRegion в предварительно подписанном URL-адресе должен быть установлен на область Amazon Web Services us-east-1.
  • KmsKeyId — Идентификатор ключа KMS для ключа KMS, используемого для шифрования копии снимка базы данных в целевой области Amazon Web Services. Это тот же идентификатор, что и для операции CopyDBSnapshot, которая вызывается в целевой области Amazon Web Services, и для операции, содержащейся в предварительно подписанном URL-адресе.
  • SourceDBSnapshotIdentifier — Идентификатор снимка базы данных для копируемого зашифрованного снимка. Этот идентификатор должен быть в формате Amazon Resource Name (ARN) для исходной области Amazon Web Services. Например, если вы копируете зашифрованный снимок базы данных из области Amazon Web Services us-west-2, то ваш SourceDBSnapshotIdentifier выглядит следующим образом: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.

Чтобы узнать, как создать подписанный запрос версии 4 подписи, см. Авторизация запросов: использование параметров запроса (подпись Amazon Web Services версии 4) и Процесс подписи версии 4.

Примечание

Если вы используете инструмент Amazon Web Services SDK или командную строку, вы можете указать SourceRegion (или --source-region для командной строки) вместо ручного указания PreSignedUrl. Указание SourceRegion автоматически генерирует предварительно подписанный URL-адрес, который является действительным запросом для операции, которая может выполняться в исходной области Amazon Web Services.

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

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

Укажите этот параметр, если вы копируете снимок из одной области Amazon Web Services в другую, и ваш экземпляр базы данных использует группу параметров отличную от стандартной. Если ваш исходный экземпляр базы данных использует Transparent Data Encryption для Oracle или Microsoft SQL Server, вы должны указать этот параметр при копировании между областями Amazon Web Services. Дополнительную информацию см. в разделе Учет особенностей групп параметров в руководстве пользователя Amazon RDS.

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

Внешний идентификатор зоны доступности пользовательской зоны (CAZ) для целевой зоны CAZ.

Пример: rds-caz-aiqhTgQv.

--copy-option-group | --no-copy-option-group (булево)

Указывает, нужно ли копировать группу параметров базы данных, связанную с исходным снимком базы данных, в целевую учетную запись Amazon Web Services и связать с целевым снимком базы данных. Связанная группа параметров может быть скопирована только с вызовами копирования снимков между учетными записями.

--source-region (строка)

Идентификатор области, содержащей копируемый снимок.

--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 для вывода.

--cli-auto-prompt (boolean)

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

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

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

Примеры

Примечание

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

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

Для создания копии DB-снэпшота

Следующий copy-db-snapshot пример создает копию DB-снэпшота.

aws rds copy-db-snapshot \
    --source-db-snapshot-identifier rds:database-mysql-2019-06-06-08-38
    --target-db-snapshot-identifier mydbsnapshotcopy

Вывод:

{
    "DBSnapshot": {
        "VpcId": "vpc-6594f31c",
        "Status": "creating",
        "Encrypted": true,
        "SourceDBSnapshotIdentifier": "arn:aws:rds:us-east-1:123456789012:snapshot:rds:database-mysql-2019-06-06-08-38",
        "MasterUsername": "admin",
        "Iops": 1000,
        "Port": 3306,
        "LicenseModel": "general-public-license",
        "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshotcopy",
        "EngineVersion": "5.6.40",
        "OptionGroupName": "default:mysql-5-6",
        "ProcessorFeatures": [],
        "Engine": "mysql",
        "StorageType": "io1",
        "DbiResourceId": "db-ZI7UJ5BLKMBYFGX7FDENCKADC4",
        "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE",
        "SnapshotType": "manual",
        "IAMDatabaseAuthenticationEnabled": false,
        "SourceRegion": "us-east-1",
        "DBInstanceIdentifier": "database-mysql",
        "InstanceCreateTime": "2019-04-30T15:45:53.663Z",
        "AvailabilityZone": "us-east-1f",
        "PercentProgress": 0,
        "AllocatedStorage": 100,
        "DBSnapshotIdentifier": "mydbsnapshotcopy"
    }
}

Дополнительную информацию см. в разделе Копирование снэпшота в руководстве пользователя Amazon RDS.

Вывод

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

Содержит сведения о снимке Amazon RDS DB.

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

DBSnapshotIdentifier -> (строка)

Указывает идентификатор снимка DB.

DBInstanceIdentifier -> (строка)

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

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

Указывает время создания снимка в формате UTC (Всемирное координированное время). Изменяется при копировании снимка.

Engine -> (строка)

Указывает имя базы данных.

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

Указывает размер выделенного хранилища в гигабайтах (GiB).

Status -> (строка)

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

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

Указывает порт, на котором работал движок базы данных во время создания снимка.

AvailabilityZone -> (строка)

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

VpcId -> (строка)

Предоставляет идентификатор VPC, связанный со снимком DB.

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

Указывает время создания экземпляра DB (из которого был взят снимок) в формате UTC (Всемирное координированное время).

MasterUsername -> (строка)

Предоставляет имя пользователя-владельца для снимка DB.

EngineVersion -> (строка)

Указывает версию движка базы данных.

LicenseModel -> (строка)

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

SnapshotType -> (строка)

Предоставляет тип снимка DB.

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

Указывает значение Provisioned IOPS (операции ввода-вывода в секунду) экземпляра DB на момент создания снимка.

OptionGroupName -> (строка)

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

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

Процент завершённости предполагаемого переноса данных.

SourceRegion -> (строка)

Регион Amazon Web Services, в котором был создан или из которого был скопирован снимок DB.

SourceDBSnapshotIdentifier -> (строка)

Amazon Resource Name (ARN) снимка DB, из которого был скопирован текущий снимок DB. Значение присутствует только в случае межрегиональной или межпользовательской копии.

StorageType -> (строка)

Указывает тип хранилища, связанного со снимком DB.

TdeCredentialArn -> (строка)

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

Encrypted -> (булево)

Указывает, зашифрован ли снимок DB.

KmsKeyId -> (строка)

Если Encrypted имеет значение true, то идентификатор ключа Amazon Web Services KMS для зашифрованного снимка DB.

Идентификатор ключа Amazon Web Services KMS — это ARN ключа, ID ключа, ARN псевдонима или имя псевдонима для ключа KMS.

DBSnapshotArn -> (строка)

Amazon Resource Name (ARN) снимка DB.

Timezone -> (строка)

Временная зона снимка DB. В большинстве случаев элемент Timezone пустой. Timezone содержимое появляется только для снимков, созданных из экземпляров DB Microsoft SQL Server, которые были созданы со спецификацией временной зоны.

IAMDatabaseAuthenticationEnabled -> (булево)

Указывает, включено ли сопоставление учетных записей Amazon Web Services Identity and Access Management (IAM) с учетными записями базы данных.

ProcessorFeatures -> (список)

Количество ядер процессора и количество потоков на ядро для класса экземпляра DB на момент создания снимка DB.

(структура)

Содержит характеристики процессора класса экземпляра DB.

Чтобы указать количество ядер процессора, используйте имя атрибута coreCount для параметра Name. Чтобы указать количество потоков на ядро, используйте имя атрибута threadsPerCore для параметра Name.

Вы можете настроить характеристики процессора класса экземпляра DB для экземпляра DB, вызвав одно из следующих действий:

  • CreateDBInstance
  • ModifyDBInstance
  • RestoreDBInstanceFromDBSnapshot
  • RestoreDBInstanceFromS3
  • RestoreDBInstanceToPointInTime

Вы можете просмотреть допустимые значения процессора для определенного класса экземпляра, вызвав действие DescribeOrderableDBInstanceOptions и указав класс экземпляра для параметра DBInstanceClass.

Кроме того, вы можете использовать следующие действия для получения информации о процессоре класса экземпляра DB:

  • DescribeDBInstances
  • DescribeDBSnapshots
  • DescribeValidDBInstanceModifications

Если вы вызываете DescribeDBInstances, то ProcessorFeature возвращает значения, отличные от null, только при выполнении следующих условий:

  • Вы обращаетесь к экземпляру Oracle DB.
  • Ваш класс экземпляра Oracle DB поддерживает настройку количества ядер процессора и потоков на ядро.
  • Текущее число ядер процессора и потоков на ядро установлено не по умолчанию.

Дополнительную информацию см. в разделе Настройка процессора для класса экземпляра DB в RDS для Oracle в Руководстве пользователя Amazon RDS.

Name -> (строка)

Имя атрибута процессора. Допустимые имена — coreCount и threadsPerCore.

Value -> (строка)

Значение атрибута процессора.

DbiResourceId -> (строка)

Идентификатор исходного экземпляра DB, который нельзя изменить и который уникален для региона Amazon Web Services.

TagList -> (список)

Список тегов.

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

(структура)

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

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

Key -> (строка)

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

Value -> (строка)

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

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

Указывает время операции CreateDBSnapshot в формате UTC (Всемирное координированное время). Не меняется при копировании снимка.

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

Временная метка последней транзакции, применённой к базе данных, которую вы резервируете. Таким образом, при восстановлении снимка SnapshotDatabaseTime — это последняя транзакция в восстановленном экземпляре DB. В отличие от этого, originalSnapshotCreateTime указывает системное время завершения создания снимка.

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

SnapshotTarget -> (строка)

Указывает, где хранятся снимки (ручные): в Amazon Web Services Outposts или в регионе Amazon Web Services.

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

Указывает пропускную способность хранилища для снимка DB.

DBSystemId -> (строка)

Идентификатор системы Oracle (SID), который является именем экземпляра базы данных Oracle, управляющего вашими файлами базы данных. SID Oracle также является именем вашей CDB.

DedicatedLogVolume -> (булево)

Указывает, включён ли выделенный том журнала (DLV) для экземпляра DB.

MultiTenant -> (булево)

Указывает, является ли снимок снимком экземпляра DB с многопользовательской конфигурацией (TRUE) или с однопользовательской конфигурацией (FALSE).

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

Spec-Zone.ru

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