создать-снэпшот

Описание

Создаёт копию всего кластера или группы репликации в определённый момент времени.

Примечание

Данная операция допустима только для Valkey или Redis OSS.

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

Синтаксис

  create-snapshot
[--replication-group-id <value>]
[--cache-cluster-id <value>]
--snapshot-name <value>
[--kms-key-id <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]

Параметры

--replication-group-id (строка)

Идентификатор существующей группы репликации. Снэпшот создаётся из этой группы репликации.

--cache-cluster-id (строка)

Идентификатор существующего кластера. Снэпшот создаётся из этого кластера.

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

Имя создаваемого снэпшота.

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

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

--tags (список)

Список тегов, которые нужно добавить к этому ресурсу. Тег — это пара ключ-значение. Ключ тега должен сопровождаться значением тега, хотя допускается значение null.

(структура)

Тег, который можно добавить к кластеру или группе репликации ElastiCache. Теги состоят из пары ключ/значение. Можно использовать теги для категоризации и отслеживания всех ресурсов ElastiCache, за исключением глобальной группы репликации. При добавлении или удалении тегов из групп репликации эти действия будут реплицированы на все узлы в группе репликации. Тег с нулевым значением разрешён.

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

Ключ тега. Не может быть null.

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

Значение тега. Может быть null.

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

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.

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

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

Следующий пример create-snapshot создаёт снэпшот с использованием движка Redis.

aws elasticache create-snapshot \
    --snapshot-name mysnapshot \
    --cache-cluster-id cluster-test

Вывод:

{
    "Snapshot": {
        "SnapshotName": "mysnapshot",
        "CacheClusterId": "cluster-test",
        "SnapshotStatus": "creating",
        "SnapshotSource": "manual",
        "CacheNodeType": "cache.m5.large",
        "Engine": "redis",
        "EngineVersion": "5.0.5",
        "NumCacheNodes": 1,
        "PreferredAvailabilityZone": "us-west-2b",
        "CacheClusterCreateTime": "2020-03-19T03:12:01.483Z",
        "PreferredMaintenanceWindow": "sat:13:00-sat:14:00",
        "Port": 6379,
        "CacheParameterGroupName": "default.redis5.0",
        "CacheSubnetGroupName": "default",
        "VpcId": "vpc-a3e97cdb",
        "AutoMinorVersionUpgrade": true,
        "SnapshotRetentionLimit": 0,
        "SnapshotWindow": "06:30-07:30",
        "NodeSnapshots": [
            {
                "CacheNodeId": "0001",
                "CacheSize": "",
                "CacheNodeCreateTime": "2020-03-19T03:12:01.483Z"
            }
        ]
    }
}

Дополнительные сведения см. в разделе Резервное копирование и восстановление ElastiCache для Redis в руководстве пользователя Elasticache.

Вывод

Снэпшот -> (структура)

Представляет копию всего кластера Valkey или Redis OSS на момент создания снимка.

SnapshotName -> (строка)

Имя снимка. Для автоматического снимка имя генерируется системой. Для ручного снимка это имя, указанное пользователем.

ReplicationGroupId -> (строка)

Уникальный идентификатор исходной группы репликации.

ReplicationGroupDescription -> (строка)

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

CacheClusterId -> (строка)

Указанный пользователем идентификатор исходного кластера.

SnapshotStatus -> (строка)

Статус снимка. Допустимые значения: creating | available | restoring | copying | deleting .

SnapshotSource -> (строка)

Указывает, получен ли снимок из автоматической резервной копии (automated ) или был создан вручную (manual ).

CacheNodeType -> (строка)

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

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

Общие типы:
- Текущее поколение: Типы узлов M7g : cache.m7g.large , cache.m7g.xlarge , cache.m7g.2xlarge , cache.m7g.4xlarge , cache.m7g.8xlarge , cache.m7g.12xlarge , cache.m7g.16xlarge
Примечание

Доступность в регионах см. в разделе Поддерживаемые типы узлов

Типы узлов M6g (доступны только для версии Redis OSS движка 5.0.6 и выше, и для движка Memcached версии 1.5.16 и выше): cache.m6g.large , cache.m6g.xlarge , cache.m6g.2xlarge , cache.m6g.4xlarge , cache.m6g.8xlarge , cache.m6g.12xlarge , cache.m6g.16xlarge Типы узлов M5: cache.m5.large , cache.m5.xlarge , cache.m5.2xlarge , cache.m5.4xlarge , cache.m5.12xlarge , cache.m5.24xlarge Типы узлов M4: cache.m4.large , cache.m4.xlarge , cache.m4.2xlarge , cache.m4.4xlarge , cache.m4.10xlarge Типы узлов T4g (доступны только для версии Redis OSS движка 5.0.6 и выше, и для движка Memcached версии 1.5.16 и выше): cache.t4g.micro , cache.t4g.small , cache.t4g.medium Типы узлов T3: cache.t3.micro , cache.t3.small , cache.t3.medium Типы узлов T2: cache.t2.micro , cache.t2.small , cache.t2.medium
- Предыдущее поколение: (не рекомендуется. Существующие кластеры по-прежнему поддерживаются, но создание новых кластеров для этих типов не поддерживается.) Типы узлов T1: cache.t1.micro Типы узлов M1: cache.m1.small , cache.m1.medium , cache.m1.large , cache.m1.xlarge Типы узлов M3: cache.m3.medium , cache.m3.large , cache.m3.xlarge , cache.m3.2xlarge
Оптимизированные для вычислений:
- Предыдущее поколение: (не рекомендуется. Существующие кластеры по-прежнему поддерживаются, но создание новых кластеров для этих типов не поддерживается.) Типы узлов C1: cache.c1.xlarge
Оптимизированные для памяти:
- Текущее поколение: Типы узлов R7g : cache.r7g.large , cache.r7g.xlarge , cache.r7g.2xlarge , cache.r7g.4xlarge , cache.r7g.8xlarge , cache.r7g.12xlarge , cache.r7g.16xlarge
Примечание

Доступность в регионах см. в разделе Поддерживаемые типы узлов

Типы узлов R6g (доступны только для версии Redis OSS движка 5.0.6 и выше, и для движка Memcached версии 1.5.16 и выше): cache.r6g.large , cache.r6g.xlarge , cache.r6g.2xlarge , cache.r6g.4xlarge , cache.r6g.8xlarge , cache.r6g.12xlarge , cache.r6g.16xlarge Типы узлов R5: cache.r5.large , cache.r5.xlarge , cache.r5.2xlarge , cache.r5.4xlarge , cache.r5.12xlarge , cache.r5.24xlarge Типы узлов R4: cache.r4.large , cache.r4.xlarge , cache.r4.2xlarge , cache.r4.4xlarge , cache.r4.8xlarge , cache.r4.16xlarge
- Предыдущее поколение: (не рекомендуется. Существующие кластеры по-прежнему поддерживаются, но создание новых кластеров для этих типов не поддерживается.) Типы узлов M2: cache.m2.xlarge , cache.m2.2xlarge , cache.m2.4xlarge Типы узлов R3: cache.r3.large , cache.r3.xlarge , cache.r3.2xlarge , cache.r3.4xlarge , cache.r3.8xlarge

Дополнительная информация о типах узлов

Все типы экземпляров текущего поколения создаются в Amazon VPC по умолчанию.
Файлы Valkey или Redis OSS append-only (AOF) не поддерживаются для экземпляров T1 или T2.
Valkey или Redis OSS Multi-AZ с автоматическим failover не поддерживаются на экземплярах T1.
Переменные конфигурации appendonly и appendfsync не поддерживаются в Valkey или в Redis OSS версии 2.8.22 и выше.

Engine -> (строка)

Имя используемого движка кэша (memcached или redis ) исходного кластера.

EngineVersion -> (строка)

Версия используемого движка кэша исходного кластера.

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

Количество узлов кэша в исходном кластере.

Для кластеров, работающих на Valkey или Redis OSS, это значение должно быть 1. Для кластеров, работающих на Memcached, это значение должно быть от 1 до 40.

PreferredAvailabilityZone -> (строка)

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

PreferredOutpostArn -> (строка)

ARN (Amazon Resource Name) предпочтительного узла.

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

Дата и время создания исходного кластера.

PreferredMaintenanceWindow -> (строка)

Указывает еженедельный интервал времени, в течение которого выполняется обслуживание кластера. Он указывается как диапазон в формате ddd:hh24:mi-ddd:hh24:mi (24-часовой формат UTC). Минимальный интервал обслуживания составляет 60 минут.

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

sun
mon
tue
wed
thu
fri
sat

Пример: sun:23:00-mon:01:30

TopicArn -> (строка)

Amazon Resource Name (ARN) темы, используемой исходным кластером для публикации уведомлений.

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

Номер порта, используемый каждым узлом кэша в исходном кластере.

CacheParameterGroupName -> (строка)

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

CacheSubnetGroupName -> (строка)

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

VpcId -> (строка)

Идентификатор Amazon Virtual Private Cloud (VPC ID) группы подсетей кэша для исходного кластера.

AutoMinorVersionUpgrade -> (булево)

Если вы используете Valkey 7.2 и выше или движок Redis OSS версии 6.0 и выше, установите это значение в yes, если вы хотите принять участие в следующем автоматическом обновлении до следующей незначительной версии. Для предыдущих версий этот параметр отключен.

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

Для автоматического снимка — количество дней, в течение которого ElastiCache сохраняет снимок перед его удалением.

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

Важно Если значение SnapshotRetentionLimit установлено в ноль (0), резервные копии выключаются.

SnapshotWindow -> (строка)

Ежедневный интервал времени, в течение которого ElastiCache создает ежедневные снимки исходного кластера.

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

Количество групп узлов (фрагментов) в этом снимке. При восстановлении из снимка количество групп узлов (фрагментов) в снимке и в восстановленной группе репликации должно быть одинаковым.

AutomaticFailover -> (строка)

Указывает статус автоматического failover для исходной группы репликации Valkey или Redis OSS.

NodeSnapshots -> (список)

Список узлов кэша в исходном кластере.

(структура)

Представляет отдельный узел кэша в снимке кластера.

CacheClusterId -> (строка)

Уникальный идентификатор исходного кластера.

NodeGroupId -> (строка)

Уникальный идентификатор исходной группы узлов (фрагмента).

CacheNodeId -> (строка)

Идентификатор узла кэша для узла в исходном кластере.

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

Настройка исходной группы узлов (фрагмента).

NodeGroupId -> (строка)

4-значный идентификатор, предоставленный ElastiCache, или предоставленный пользователем идентификатор для группы узлов, к которым относятся эти значения конфигурации.

Slots -> (строка)

Строка, определяющая пространство имен ключей для определенной группы узлов. Пространства имен ключей варьируются от 0 до 16 383. Строка имеет формат startkey-endkey .

Пример: "0-3999"

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

Количество узлов-реплик в этой группе узлов (фрагменте).

PrimaryAvailabilityZone -> (строка)

Зона доступности, в которой запущен основной узел этой группы узлов (фрагмента).

ReplicaAvailabilityZones -> (список)

Список зон доступности, используемых для реплик чтения. Количество зон доступности в этом списке должно соответствовать значению ReplicaCount или ReplicasPerNodeGroup, если не указано иное.

(строка)

PrimaryOutpostArn -> (строка)

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

ReplicaOutpostArns -> (список)

ARN узлов-реплик.

(строка)

CacheSize -> (строка)

Размер кэша на исходном узле кэша.

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

Дата и время создания узла кэша в исходном кластере.

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

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

KmsKeyId -> (строка)

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

ARN -> (строка)

Идентификатор ресурса (ARN) снимка.

DataTiering -> (строка)

Включает типы данных. Типы данных поддерживаются только для групп репликации, использующих тип узла r6gd. Этот параметр должен быть установлен в значение true при использовании узлов r6gd. Дополнительную информацию см. в разделе Типы данных.