modify-snapshot-copy-retention-period
Описание
Изменяет количество дней хранения снимков в целевом регионе Amazon Web Services после их копирования из исходного региона Amazon Web Services. По умолчанию эта операция изменяет только срок хранения скопированных автоматических снимков. Сроки хранения как новых, так и существующих скопированных автоматических снимков обновляются новым сроком хранения. Вы можете установить параметр manual, чтобы изменить только сроки хранения скопированных ручных снимков. Если вы установите этот параметр, только недавно скопированные ручные снимки будут иметь новый срок хранения.
См. также: Документацию API AWS
Синтаксис
modify-snapshot-copy-retention-period
--cluster-identifier <value>
--retention-period <value>
[--manual | --no-manual]
[--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]
Параметры
--cluster-identifier (строка)
Уникальный идентификатор кластера, для которого необходимо изменить срок хранения автоматических или ручных снимков, которые копируются в целевой регион Amazon Web Services.
Ограничения: Должно быть действительное имя существующего кластера, у которого включена функция копирования снимков между регионами.
--retention-period (целое число)
Количество дней хранения автоматических снимков в целевом регионе Amazon Web Services после их копирования из исходного региона Amazon Web Services.
По умолчанию изменяется только срок хранения скопированных автоматических снимков.
Если вы уменьшите срок хранения автоматических снимков, которые копируются в целевой регион Amazon Web Services, Amazon Redshift удалит любые существующие автоматические снимки, которые были скопированы в целевой регион Amazon Web Services и которые выходят за рамки нового срока хранения.
Ограничения: Должно быть не менее 1 и не более 35 для автоматических снимков.
Если вы укажете параметр manual, только недавно скопированные ручные снимки будут иметь новый срок хранения.
Если вы укажете значение -1, недавно скопированные ручные снимки будут храниться неопределенно долго.
Ограничения: Количество дней должно быть либо -1, либо целым числом от 1 до 3653 для ручных снимков.
--manual | --no-manual (логическое значение)
--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
- text
- table
- yaml
- yaml-stream
--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».
Изменение срока хранения копий снимков
Следующий modify-snapshot-copy-retention-period пример изменяет количество дней хранения снимков для указанного кластера в целевом регионе AWS после их копирования из исходного региона AWS.
aws redshift modify-snapshot-copy-retention-period \
--cluster-identifier mycluster \
--retention-period 15
Вывод:
{
"Cluster": {
"ClusterIdentifier": "mycluster",
"NodeType": "dc2.large",
"ClusterStatus": "available",
"ClusterAvailabilityStatus": "Available",
"MasterUsername": "adminuser",
"DBName": "dev",
"Endpoint": {
"Address": "mycluster.cmeaswqeuae.us-west-2.redshift.amazonaws.com",
"Port": 5439
},
"ClusterCreateTime": "2019-12-05T18:44:36.991Z",
"AutomatedSnapshotRetentionPeriod": 3,
"ManualSnapshotRetentionPeriod": -1,
"ClusterSecurityGroups": [],
"VpcSecurityGroups": [
{
"VpcSecurityGroupId": "sh-a1a123ab",
"Status": "active"
}
],
"ClusterParameterGroups": [
{
"ParameterGroupName": "default.redshift-1.0",
"ParameterApplyStatus": "in-sync"
}
],
"ClusterSubnetGroupName": "default",
"VpcId": "vpc-b1fet7t9",
"AvailabilityZone": "us-west-2f",
"PreferredMaintenanceWindow": "sat:16:00-sat:16:30",
"PendingModifiedValues": {
"NodeType": "dc2.large",
"NumberOfNodes": 2,
"ClusterType": "multi-node"
},
"ClusterVersion": "1.0",
"AllowVersionUpgrade": true,
"NumberOfNodes": 4,
"PubliclyAccessible": false,
"Encrypted": false,
"ClusterSnapshotCopyStatus": {
"DestinationRegion": "us-west-1",
"RetentionPeriod": 15,
"ManualSnapshotRetentionPeriod": -1
},
"Tags": [
{
"Key": "mytags",
"Value": "tag1"
}
],
"EnhancedVpcRouting": false,
"IamRoles": [],
"MaintenanceTrackName": "current",
"DeferredMaintenanceWindows": [
{
"DeferMaintenanceIdentifier": "dfm-mUdVSfDcT1F4SGhw6fyF",
"DeferMaintenanceStartTime": "2019-12-10T18:18:39.354Z",
"DeferMaintenanceEndTime": "2020-01-09T18:18:39.354Z"
}
],
"NextMaintenanceWindowStartTime": "2020-01-11T16:00:00Z"
}
}
Дополнительную информацию можно найти в разделе «Формат расписания снимков» в «Руководстве по управлению кластерами Amazon Redshift».
Выходные данные
Кластер -> (структура)
Описывает кластер.
ClusterIdentifier -> (строка)
NodeType -> (строка)
ClusterStatus -> (строка)
Текущее состояние кластера. Возможные значения:
availableavailable, prep-for-resizeavailable, resize-cleanupcancelling-resizecreatingdeletingfinal-snapshothardware-failureincompatible-hsmincompatible-networkincompatible-parametersincompatible-restoremodifyingpausedrebootingrenamingresizingrotating-keysstorage-fullupdating-hsm
ClusterAvailabilityStatus -> (строка)
Статус доступности кластера для запросов. Возможные значения:
- Доступно - Кластер доступен для запросов.
- Недоступно - Кластер недоступен для запросов.
- Техническое обслуживание - Кластер временно доступен для запросов из-за работ по техническому обслуживанию.
- Изменение - Кластер временно доступен для запросов из-за изменений, которые модифицируют кластер.
- Ошибка - Кластер вышел из строя и недоступен для запросов.
ModifyStatus -> (строка)
MasterUsername -> (строка)
DBName -> (строка)
dev dev.Endpoint -> (структура)
Конечная точка подключения.
Address -> (строка)
Port -> (целое число)
VpcEndpoints -> (список)
Описание конечной точки подключения.
(структура)
Конечная точка подключения для подключения к кластеру Amazon Redshift через прокси.
VpcEndpointId -> (строка)
VpcId -> (строка)
NetworkInterfaces -> (список)
Один или несколько сетевых интерфейсов конечной точки. Также известны как интерфейсные конечные точки.
(структура)
Описание сетевого интерфейса.
NetworkInterfaceId -> (строка)
SubnetId -> (строка)
PrivateIpAddress -> (строка)
AvailabilityZone -> (строка)
Ipv6Address -> (строка)
ClusterCreateTime -> (временная метка)
AutomatedSnapshotRetentionPeriod -> (целое число)
ManualSnapshotRetentionPeriod -> (целое число)
Установленное по умолчанию количество дней для сохранения ручного снимка. Если значение равно -1, снимок сохраняется неограниченно. Это значение не изменяет срок хранения существующих снимков.
Значение должно быть либо -1, либо целым числом от 1 до 3653.
ClusterSecurityGroups -> (список)
Список групп безопасности кластера, связанных с кластером. Каждая группа безопасности представлена элементом, который содержит ClusterSecurityGroup.Name и ClusterSecurityGroup.Status подэлементы.
Группы безопасности кластера используются, когда кластер не создается в Amazon Virtual Private Cloud (VPC). Кластеры, созданные в VPC, используют группы безопасности VPC, которые перечислены параметром VpcSecurityGroups.
(структура)
Описание группы безопасности кластера.
ClusterSecurityGroupName -> (строка)
Status -> (строка)
VpcSecurityGroups -> (список)
Список групп безопасности Amazon Virtual Private Cloud (Amazon VPC), связанных с кластером. Этот параметр возвращается только если кластер находится в VPC.
(структура)
Описание элементов группы безопасности VPC.
VpcSecurityGroupId -> (строка)
Status -> (строка)
ClusterParameterGroups -> (список)
Список групп параметров кластера, связанных с этим кластером. Каждая группа параметров в списке возвращается со своим статусом.
(структура)
Описание статуса группы параметров.
ParameterGroupName -> (строка)
ParameterApplyStatus -> (строка)
ClusterParameterStatusList -> (список)
Список статусов параметров.
Для получения дополнительной информации о параметрах и группах параметров, перейдите к Amazon Redshift Parameter Groups в руководстве Amazon Redshift Cluster Management Guide.
(структура)
Описание статуса группы параметров.
ParameterName -> (строка)
ParameterApplyStatus -> (строка)
Статус параметра, указывающий, синхронизирован ли параметр с базой данных, ожидает ли перезагрузки кластера или при применении возникла ошибка.
Возможные статусы и описания:
-
in-sync: Значение параметра синхронизировано с базой данных. -
pending-reboot: Значение параметра будет применено после перезагрузки кластера. -
applying: Значение параметра применяется к базе данных. -
invalid-parameter: Невозможно применить значение параметра, так как оно имеет неверное значение или синтаксис. -
apply-deferred: Параметр содержит статические изменения свойств. Изменения отложены до перезагрузки кластера. -
apply-error: Невозможно подключиться к кластеру. Изменение параметра будет применено после перезагрузки кластера. -
unknown-error: Невозможно применить изменение параметра прямо сейчас. Изменение будет применено после перезагрузки кластера.
ParameterApplyErrorDescription -> (строка)
ClusterSubnetGroupName -> (строка)
VpcId -> (строка)
AvailabilityZone -> (строка)
PreferredMaintenanceWindow -> (строка)
PendingModifiedValues -> (структура)
Значение, которое, при наличии, указывает на то, что изменения в кластере находятся в ожидании. Конкретные ожидающие изменения идентифицируются подэлементами.
MasterUserPassword -> (строка)
NodeType -> (строка)
NumberOfNodes -> (целое число)
ClusterType -> (строка)
ClusterVersion -> (строка)
AutomatedSnapshotRetentionPeriod -> (целое число)
ClusterIdentifier -> (строка)
PubliclyAccessible -> (булево значение)
EnhancedVpcRouting -> (булево значение)
Параметр, который указывает, нужно ли создавать кластер с включенным расширенным маршрутизацией VPC. Чтобы создать кластер, использующий расширенную маршрутизацию VPC, кластер должен находиться в VPC. Для получения дополнительной информации см. Расширенная маршрутизация VPC в руководстве по управлению кластерами Amazon Redshift.
Если этот параметр равен true , расширенная маршрутизация VPC включена.
По умолчанию: false
MaintenanceTrackName -> (строка)
EncryptionType -> (строка)
ClusterVersion -> (строка)
AllowVersionUpgrade -> (булево значение)
true , указывает на то, что автоматическое обновление до основной версии будет применено к кластеру во время окна технического обслуживания.NumberOfNodes -> (целое число)
PubliclyAccessible -> (булево значение)
Булево значение, которое, если true , указывает, что к кластеру можно получить доступ из общедоступной сети.
По умолчанию: false
Encrypted -> (булево значение)
true , указывает, что данные в кластере зашифрованы в состоянии покоя.RestoreStatus -> (структура)
Значение, описывающее состояние действия восстановления кластера. Этот параметр возвращает null, если кластер не был создан путём восстановления снимка.
Status -> (строка)
CurrentRestoreRateInMegaBytesPerSecond -> (двойное)
SnapshotSizeInMegaBytes -> (целое)
ProgressInMegaBytes -> (целое)
ElapsedTimeInSeconds -> (целое)
EstimatedTimeToCompletionInSeconds -> (целое)
DataTransferProgress -> (структура)
Status -> (строка)
transferringdata .CurrentRateInMegaBytesPerSecond -> (двойное)
TotalDataInMegaBytes -> (целое)
DataTransferredInMegaBytes -> (целое)
EstimatedTimeToCompletionInSeconds -> (целое)
ElapsedTimeInSeconds -> (целое)
HsmStatus -> (структура)
Значение, которое сообщает, завершил ли кластер Amazon Redshift применение каких-либо изменений настроек модуля аппаратной безопасности (HSM), указанных в команде модификации кластера.
Значения: active, applying
HsmClientCertificateIdentifier -> (строка)
HsmConfigurationIdentifier -> (строка)
Status -> (строка)
Сообщает, завершил ли кластер Amazon Redshift применение каких-либо изменений настроек HSM, указанных в команде модификации кластера.
Значения: active, applying
ClusterSnapshotCopyStatus -> (структура)
Значение, которое возвращает целевой регион и срок хранения, настроенные для копирования снимков в другие регионы.
DestinationRegion -> (строка)
RetentionPeriod -> (целое)
ManualSnapshotRetentionPeriod -> (целое)
Количество дней, в течение которых автоматические снимки сохраняются в целевом регионе после их копирования из исходного региона. Если значение равно -1, ручной снимок хранится неограниченно.
Значение должно быть либо -1, либо целым числом от 1 до 3653.
SnapshotCopyGrantName -> (строка)
ClusterPublicKey -> (строка)
ClusterNodes -> (список)
Узлы в кластере.
(структура)
Идентификатор узла в кластере.
NodeRole -> (строка)
PrivateIPAddress -> (строка)
PublicIPAddress -> (строка)
ElasticIpStatus -> (структура)
Состояние эластичного IP-адреса (EIP).
ElasticIp -> (строка)
Status -> (строка)
ClusterRevisionNumber -> (строка)
Tags -> (список)
Список тегов для кластера.
(структура)
Тег, состоящий из пары имя/значение для ресурса.
Key -> (строка)
Value -> (строка)
KmsKeyId -> (строка)
EnhancedVpcRouting -> (булево)
Параметр, указывающий, нужно ли создавать кластер с включенным улучшенным маршрутизацией VPC. Для создания кластера, использующего улучшенную маршрутизацию VPC, кластер должен находиться в VPC. Дополнительную информацию см. в руководстве по управлению кластерами Amazon Redshift.
Если этот параметр true , улучшенная маршрутизация VPC включена.
По умолчанию: false
IamRoles -> (список)
Список ролей Identity and Access Management (IAM), которые могут использоваться кластером для доступа к другим службам Amazon Web Services.
(структура)
Роль Identity and Access Management (IAM), которая может использоваться связанным кластером Amazon Redshift для доступа к другим службам Amazon Web Services.
IamRoleArn -> (строка)
arn:aws:iam::123456789012:role/RedshiftCopyUnload .ApplyStatus -> (строка)
Значение, описывающее состояние ассоциации роли IAM с кластером Amazon Redshift.
Возможные состояния и их описания:
-
in-sync: Роль доступна для использования кластером. -
adding: Роль находится в процессе ассоциации с кластером. -
removing: Роль находится в процессе отсоединения от кластера.
PendingActions -> (список)
Операции кластера, ожидающие запуска.
(строка)
MaintenanceTrackName -> (строка)
ElasticResizeNumberOfNodeOptions -> (строка)
DeferredMaintenanceWindows -> (список)
Описание группы объектов DeferredMaintenanceWindow .
(структура)
Описание отложенного окна технического обслуживания
DeferMaintenanceIdentifier -> (строка)
DeferMaintenanceStartTime -> (временная метка)
DeferMaintenanceEndTime -> (временная метка)
SnapshotScheduleIdentifier -> (строка)
SnapshotScheduleState -> (строка)
ExpectedNextSnapshotScheduleTime -> (временная метка)
ExpectedNextSnapshotScheduleTimeStatus -> (строка)
Состояние следующего ожидаемого снимка для кластеров с действительным расписанием снимков и включенной резервной копией. Возможные значения:
- OnTrack - Следующий снимок ожидается в срок.
- Pending - Следующий снимок ожидает создания.
NextMaintenanceWindowStartTime -> (временная метка)
ResizeInfo -> (структура)
Возвращает следующее:
- AllowCancelResize: булево значение, указывающее, можно ли отменить операцию изменения размера.
- ResizeType: Возвращает ClassicResize
ResizeType -> (строка)
ClassicResize .AllowCancelResize -> (булево)
AvailabilityZoneRelocationStatus -> (строка)
ClusterNamespaceArn -> (строка)
TotalStorageCapacityInMegaBytes -> (целое)
AquaConfiguration -> (структура)
Это поле устарело. Amazon Redshift автоматически определяет, использовать ли AQUA (Advanced Query Accelerator).
AquaStatus -> (строка)
AquaConfigurationStatus -> (строка)
DefaultIamRoleArn -> (строка)
ReservedNodeExchangeStatus -> (структура)
Состояние запроса обмена узлами с резервированием. Состояния включают в себя в процессе и запрошен.
ReservedNodeExchangeRequestId -> (строка)
Status -> (строка)
RequestTime -> (временная метка)
SourceReservedNodeId -> (строка)
SourceReservedNodeType -> (строка)
SourceReservedNodeCount -> (целое)
TargetReservedNodeOfferingId -> (строка)
TargetReservedNodeType -> (строка)
TargetReservedNodeCount -> (целое)
CustomDomainName -> (строка)
CustomDomainCertificateArn -> (строка)
CustomDomainCertificateExpiryDate -> (временная метка)
MasterPasswordSecretArn -> (string)
MasterPasswordSecretKmsKeyId -> (string)
IpAddressType -> (string)
ipv4 и dualstack.MultiAZ -> (string)
MultiAZSecondary -> (structure)
Вспомогательный вычислительный узел кластера, если включено многозонное развертывание.
AvailabilityZone -> (string)
ClusterNodes -> (list)
узлы вспомогательного вычислительного узла.
(structure)
Идентификатор узла в кластере.
NodeRole -> (string)
PrivateIPAddress -> (string)
PublicIPAddress -> (string)
© Copyright 2025, Amazon Web Services. Created using Sphinx.