AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . redshift ]

create-scheduled-action

Description

Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the ResizeCluster API operation.

See also: AWS API Documentation

Synopsis

  create-scheduled-action
--scheduled-action-name <value>
--target-action <value>
--schedule <value>
--iam-role <value>
[--scheduled-action-description <value>]
[--start-time <value>]
[--end-time <value>]
[--enable | --no-enable]
[--cli-input-json <value>]
[--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>]

Options

--scheduled-action-name (string)

The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see ScheduledAction .

--target-action (structure)

A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see ScheduledAction .

ResizeCluster -> (structure)

An action that runs a ResizeCluster API operation.

ClusterIdentifier -> (string)

The unique identifier for the cluster to resize.

ClusterType -> (string)

The new cluster type for the specified cluster.

NodeType -> (string)

The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.

NumberOfNodes -> (integer)

The new number of nodes for the cluster. If not specified, the cluster's current number of nodes is used.

Classic -> (boolean)

A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic.

ReservedNodeId -> (string)

The identifier of the reserved node.

TargetReservedNodeOfferingId -> (string)

The identifier of the target reserved node offering.

PauseCluster -> (structure)

An action that runs a PauseCluster API operation.

ClusterIdentifier -> (string)

The identifier of the cluster to be paused.

ResumeCluster -> (structure)

An action that runs a ResumeCluster API operation.

ClusterIdentifier -> (string)

The identifier of the cluster to be resumed.

Shorthand Syntax:

ResizeCluster={ClusterIdentifier=string,ClusterType=string,NodeType=string,NumberOfNodes=integer,Classic=boolean,ReservedNodeId=string,TargetReservedNodeOfferingId=string},PauseCluster={ClusterIdentifier=string},ResumeCluster={ClusterIdentifier=string}

JSON Syntax:

{
  "ResizeCluster": {
    "ClusterIdentifier": "string",
    "ClusterType": "string",
    "NodeType": "string",
    "NumberOfNodes": integer,
    "Classic": true|false,
    "ReservedNodeId": "string",
    "TargetReservedNodeOfferingId": "string"
  },
  "PauseCluster": {
    "ClusterIdentifier": "string"
  },
  "ResumeCluster": {
    "ClusterIdentifier": "string"
  }
}

--schedule (string)

The schedule in at( ) or cron( ) format. For more information about this parameter, see ScheduledAction .

--iam-role (string)

The IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction .

--scheduled-action-description (string)

The description of the scheduled action.

--start-time (timestamp)

The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction .

--end-time (timestamp)

The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction .

--enable | --no-enable (boolean)

If true, the schedule is enabled. If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

ScheduledActionName -> (string)

The name of the scheduled action.

TargetAction -> (structure)

A JSON format string of the Amazon Redshift API operation with input parameters.

"{\"ResizeCluster\":{\"NodeType\":\"ra3.4xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}} ".

ResizeCluster -> (structure)

An action that runs a ResizeCluster API operation.

ClusterIdentifier -> (string)

The unique identifier for the cluster to resize.

ClusterType -> (string)

The new cluster type for the specified cluster.

NodeType -> (string)

The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.

NumberOfNodes -> (integer)

The new number of nodes for the cluster. If not specified, the cluster's current number of nodes is used.

Classic -> (boolean)

A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic.

ReservedNodeId -> (string)

The identifier of the reserved node.

TargetReservedNodeOfferingId -> (string)

The identifier of the target reserved node offering.

PauseCluster -> (structure)

An action that runs a PauseCluster API operation.

ClusterIdentifier -> (string)

The identifier of the cluster to be paused.

ResumeCluster -> (structure)

An action that runs a ResumeCluster API operation.

ClusterIdentifier -> (string)

The identifier of the cluster to be resumed.

Schedule -> (string)

The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.

Format of at expressions is "at(yyyy-mm-ddThh:mm:ss) ". For example, "at(2016-03-04T17:27:00) ".

Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year) ". For example, "cron(0 10 ? * MON *) ". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide .

IamRole -> (string)

The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide .

ScheduledActionDescription -> (string)

The description of the scheduled action.

State -> (string)

The state of the scheduled action. For example, DISABLED .

NextInvocations -> (list)

List of times when the scheduled action will run.

(timestamp)

StartTime -> (timestamp)

The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

EndTime -> (timestamp)

The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.