Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
modify-snapshot-schedule
--schedule-identifier <value>
--schedule-definitions <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--schedule-identifier
(string)
A unique alphanumeric identifier of the schedule to modify.
--schedule-definitions
(list)
An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, “cron(30 12 *)” or “rate(12 hours)”.
(string)
Syntax:
"string" "string" ...
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To modify snapshot schedule
The following modify-snapshot-schedule
example modifies the rate of the specified snapshot schedule to every 10 hours.
aws redshift modify-snapshot-schedule \
--schedule-identifier mysnapshotschedule \
--schedule-definitions "rate(10 hours)"
Output:
{
"ScheduleDefinitions": [
"rate(10 hours)"
],
"ScheduleIdentifier": "mysnapshotschedule",
"ScheduleDescription": "My schedule description",
"Tags": []
}
For more information, see Snapshot Schedule Format in the Amazon Redshift Cluster Management Guide.
ScheduleDefinitions -> (list)
A list of ScheduleDefinitions.
(string)
ScheduleIdentifier -> (string)
A unique identifier for the schedule.
ScheduleDescription -> (string)
The description of the schedule.
Tags -> (list)
An optional set of tags describing the schedule.
(structure)
A tag consisting of a name/value pair for a resource.
Key -> (string)
The key, or name, for the resource tag.
Value -> (string)
The value for the resource tag.
NextInvocations -> (list)
(timestamp)
AssociatedClusterCount -> (integer)
The number of clusters associated with the schedule.
AssociatedClusters -> (list)
A list of clusters associated with the schedule. A maximum of 100 clusters is returned.
(structure)
ClusterIdentifier -> (string)
ScheduleAssociationState -> (string)