Get all available regions for the AWS Redshift service.
Return type: | list |
---|---|
Returns: | A list of boto.regioninfo.RegionInfo |
Amazon Redshift Overview This is the Amazon Redshift API Reference. This guide provides descriptions and samples of the Amazon Redshift API.
Amazon Redshift manages all the work of setting up, operating, and scaling a data warehouse: provisioning capacity, monitoring and backing up the cluster, and applying patches and upgrades to the Amazon Redshift engine. You can focus on using your data to acquire new insights for your business and customers. Are You a First-Time Amazon Redshift User? If you are a first-time user of Amazon Redshift, we recommend that you begin by reading the following sections:
After you complete the Getting Started Guide, we recommend that you explore one of the following guides:
Cluster Management - If you are responsible for managing Amazon Redshift clusters, the `Cluster Management Guide`_ shows you how to create and manage Amazon Redshift clusters. If you are an application developer, you can use the Amazon Redshift Query API to manage clusters programmatically. Additionally, the AWS SDK libraries that wrap the underlying Amazon Redshift API simplify your programming tasks. If you prefer a more interactive way of managing clusters, you can use the Amazon Redshift console and the AWS command line interface (AWS CLI). For information about the API and CLI, go to the following manuals :
- API Reference ( this document )
- `CLI Reference`_
Amazon Redshift Database Database Developer - If you are a database developer, the Amazon Redshift `Database Developer Guide`_ explains how to design, build, query, and maintain the databases that make up your data warehouse.
For a list of supported AWS regions where you can provision a cluster, go to the `Regions and Endpoints`_ section in the Amazon Web Services Glossary .
alias of JSONResponseError
Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR) IP address range or an EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group. The EC2 security group must be defined in the AWS region where the cluster resides. For an overview of CIDR blocks, see the Wikipedia article on `Classless Inter-Domain Routing`_.
You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to `Working with Security Groups`_ in the Amazon Redshift Management Guide .
Parameters: |
|
---|
Example: 111122223333
Authorizes the specified AWS customer account to restore the specified snapshot.
For more information about working with snapshots, go to `Amazon Redshift Snapshots`_ in the Amazon Redshift Management Guide .
Parameters: |
|
---|
Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state.
When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them.
For more information about working with snapshots, go to `Amazon Redshift Snapshots`_ in the Amazon Redshift Management Guide .
Parameters: | source_snapshot_identifier (string) – |
---|
The identifier for the source snapshot.
Constraints:
“available”.
Parameters: |
|
---|
The identifier given to the new manual snapshot.
Constraints:
Creates a new cluster. To create the cluster in virtual private cloud (VPC), you must provide cluster subnet group name. If you don’t provide a cluster subnet group name or the cluster security group parameter, Amazon Redshift creates a non-VPC cluster, it associates the default cluster security group with the cluster. For more information about managing clusters, go to `Amazon Redshift Clusters`_ in the Amazon Redshift Management Guide .
Parameters: | db_name (string) – |
---|
Default: dev
Constraints:
Must contain 1 to 64 alphanumeric characters.
Must contain only lowercase letters.
words can be found in `Reserved Words`_ in the Amazon Redshift Developer Guide.
Parameters: | cluster_identifier (string) – A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console. |
---|
Constraints:
Example: myexamplecluster
Parameters: | cluster_type (string) – The type of the cluster. When cluster type is specified as |
---|
Valid Values: multi-node | single-node
Default: multi-node
Parameters: | node_type (string) – The node type to be provisioned for the cluster. For information about node types, go to ` Working with Clusters`_ in the Amazon Redshift Management Guide . |
---|
Valid Values: dw.hs1.xlarge | dw.hs1.8xlarge.
Parameters: | master_username (string) – |
---|
Constraints:
Must be 1 - 128 alphanumeric characters.
First character must be a letter.
`Reserved Words`_ in the Amazon Redshift Developer Guide.
Parameters: | master_user_password (string) – |
---|
Constraints:
Must be between 8 and 64 characters in length.
Must contain at least one uppercase letter.
Must contain at least one lowercase letter.
Must contain one number.
(single quote), ” (double quote), , /, @, or space.
Parameters: | cluster_security_groups (list) – A list of security groups to be associated with this cluster. |
---|
Default: The default cluster security group for Amazon Redshift.
Parameters: | vpc_security_group_ids (list) – A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. |
---|
Default: The default VPC security group is associated with the cluster.
Parameters: | cluster_subnet_group_name (string) – The name of a cluster subnet group to be associated with this cluster. |
---|
Parameters: | availability_zone (string) – The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency. |
---|
Example: us-east-1d
Parameters: | preferred_maintenance_window (string) – The weekly time range (in UTC) during which automated cluster maintenance can occur. |
---|
Format: ddd:hh24:mi-ddd:hh24:mi
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
Parameters: | cluster_parameter_group_name (string) – |
---|
The name of the parameter group to be associated with this cluster.
Constraints:
Parameters: | automated_snapshot_retention_period (integer) – The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. |
---|
Default: 1
Constraints: Must be a value from 0 to 35.
Parameters: | port (integer) – The port number on which the cluster accepts incoming connections. |
---|
Default: 5439
Valid Values: 1150-65535
Parameters: | cluster_version (string) – The version of the Amazon Redshift engine software that you want to deploy on the cluster. |
---|
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
Parameters: | allow_version_upgrade (boolean) – If True, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. |
---|
Default: True
Parameters: | number_of_nodes (integer) – The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. |
---|
Default: 1
Constraints: Value must be at least 1 and no more than 100.
Parameters: |
|
---|
Default: false
Creates an Amazon Redshift parameter group.
Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster.
Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about managing parameter groups, go to `Amazon Redshift Parameter Groups`_ in the Amazon Redshift Management Guide .
Parameters: | parameter_group_name (string) – |
---|
The name of the cluster parameter group.
Constraints:
This value is stored as a lower-case string.
Parameters: | parameter_group_family (string) – The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters. |
---|
Parameters: | description (string) – A description of the parameter group. |
---|
Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters.
For information about managing security groups, go to`Amazon Redshift Cluster Security Groups`_ in the Amazon Redshift Management Guide .
Parameters: | cluster_security_group_name (string) – The name for the security group. Amazon Redshift stores the value as a lowercase string. |
---|
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be “Default”.
account.
Example: examplesecuritygroup
Parameters: | description (string) – A description for the security group. |
---|
Creates a manual snapshot of the specified cluster. The cluster must be in the “available” state.
For more information about working with snapshots, go to `Amazon Redshift Snapshots`_ in the Amazon Redshift Management Guide .
Parameters: | snapshot_identifier (string) – A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account. |
---|
Constraints:
Example: my-snapshot-id
Parameters: | cluster_identifier (string) – The cluster identifier for which you want a snapshot. |
---|
Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.
For information about subnet groups, go to`Amazon Redshift Cluster Subnet Groups`_ in the Amazon Redshift Management Guide .
Parameters: | cluster_subnet_group_name (string) – The name for the subnet group. Amazon Redshift stores the value as a lowercase string. |
---|
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be “Default”.
account.
Example: examplesubnetgroup
Parameters: |
|
---|
Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. If a final cluster snapshot is requested the status of the cluster will be “final-snapshot” while the snapshot is being taken, then it’s “deleting” once Amazon Redshift begins deleting the cluster. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to `Amazon Redshift Clusters`_ in the Amazon Redshift Management Guide .
Parameters: | cluster_identifier (string) – |
---|
The identifier of the cluster to be deleted.
Constraints:
Parameters: | skip_final_cluster_snapshot (boolean) – Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If True, a final cluster snapshot is not created. If False, a final cluster snapshot is created before the cluster is deleted. |
---|
Default: False
Parameters: | final_cluster_snapshot_identifier (string) – |
---|
Constraints:
Deletes a specified Amazon Redshift parameter group. You cannot delete a parameter group if it is associated with a cluster.
Parameters: | parameter_group_name (string) – |
---|
The name of the parameter group to be deleted.
Constraints:
Deletes an Amazon Redshift security group. You cannot delete a security group that is associated with any clusters. You cannot delete the default security group. For information about managing security groups, go to`Amazon Redshift Cluster Security Groups`_ in the Amazon Redshift Management Guide .
Parameters: | cluster_security_group_name (string) – The name of the cluster security group to be deleted. |
---|
Deletes the specified manual snapshot. The snapshot must be in the “available” state, with no other users authorized to access the snapshot.
Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.
Parameters: | snapshot_identifier (string) – The unique identifier of the manual snapshot to be deleted. |
---|
Parameters: | snapshot_cluster_identifier (string) – |
---|
Deletes the specified cluster subnet group.
Parameters: | cluster_subnet_group_name (string) – The name of the cluster subnet group name to be deleted. |
---|
Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.
For more information about managing parameter groups, go to `Amazon Redshift Parameter Groups`_ in the Amazon Redshift Management Guide .
Parameters: |
|
---|
Default: 100
Constraints: Value must be at least 20 and no more than 100.
Parameters: | marker (string) – An optional marker returned by a previous DescribeClusterParameterGroups request to indicate the first parameter group that the current request will return. |
---|
Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.
You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user .
For more information about managing parameter groups, go to `Amazon Redshift Parameter Groups`_ in the Amazon Redshift Management Guide .
Parameters: |
|
---|
Default: All parameter types returned.
Valid Values: user | engine-default
Parameters: | max_records (integer) – The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, response includes a marker that you can specify in your subsequent request to retrieve remaining result. |
---|
Default: 100
Constraints: Value must be at least 20 and no more than 100.
Parameters: | marker (string) – An optional marker returned from a previous DescribeClusterParameters request. If this parameter is specified, the response includes only records beyond the specified marker, up to the value specified by MaxRecords. |
---|
Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.
For information about managing security groups, go to`Amazon Redshift Cluster Security Groups`_ in the Amazon Redshift Management Guide .
Parameters: | cluster_security_group_name (string) – The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both. |
---|
Example: securitygroup1
Parameters: | max_records (integer) – The maximum number of records to be included in the response. If more records exist than the specified MaxRecords value, a marker is included in the response, which you can use in a subsequent DescribeClusterSecurityGroups request. |
---|
Default: 100
Constraints: Value must be at least 20 and no more than 100.
Parameters: | marker (string) – An optional marker returned by a previous DescribeClusterSecurityGroups request to indicate the first security group that the current request will return. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both. |
---|
Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.
Parameters: |
|
---|
Valid Values: automated | manual
Parameters: | start_time (timestamp) – A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the `ISO8601 Wikipedia page.`_ |
---|
Example: 2012-07-16T18:00:00Z
Parameters: | end_time (timestamp) – A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the `ISO8601 Wikipedia page.`_ |
---|
Example: 2012-07-16T18:00:00Z
Parameters: | max_records (integer) – The maximum number of snapshot records to include in the response. If more records exist than the specified MaxRecords value, the response returns a marker that you can use in a subsequent DescribeClusterSnapshots request in order to retrieve the next set of snapshot records. |
---|
Default: 100
Constraints: Must be at least 20 and no more than 100.
Parameters: |
|
---|
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.
Parameters: |
|
---|
Default: 100
Constraints: Must be at least 20 and no more than 100.
Parameters: | marker (string) – An optional marker returned by a previous DescribeClusterSubnetGroups request to indicate the first cluster subnet group that the current request will return. |
---|
Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to `Amazon Redshift Clusters`_ in the Amazon Redshift Management Guide
Parameters: | cluster_version (string) – The specific cluster version to return. |
---|
Example: 1.0
Parameters: | cluster_parameter_group_family (string) – |
---|
Constraints:
Parameters: | max_records (integer) – The maximum number of records to include in the response. If more than the MaxRecords value is available, a marker is included in the response so that the following results can be retrieved. |
---|
Default: 100
Constraints: Value must be at least 20 and no more than 100.
Parameters: | marker (string) – The marker returned from a previous request. If this parameter is specified, the response includes records beyond the marker only, up to MaxRecords. |
---|
Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to `Amazon Redshift Clusters`_ in the Amazon Redshift Management Guide .
Parameters: | cluster_identifier (string) – The unique identifier of a cluster whose properties you are requesting. This parameter isn’t case sensitive. |
---|
The default is that all clusters defined for an account are returned.
Parameters: | max_records (integer) – The maximum number of records that the response can include. If more records exist than the specified MaxRecords value, a marker is included in the response that can be used in a new DescribeClusters request to continue listing results. |
---|
Default: 100
Constraints: Value must be at least 20 and no more than 100.
Parameters: | marker (string) – An optional marker returned by a previous DescribeClusters request to indicate the first cluster that the current DescribeClusters request will return. |
---|
Returns a list of parameter settings for the specified parameter group family.
For more information about managing parameter groups, go to `Amazon Redshift Parameter Groups`_ in the Amazon Redshift Management Guide .
Parameters: |
|
---|
Default: 100
Constraints: Value must be at least 20 and no more than 100.
Parameters: | marker (string) – An optional marker returned from a previous DescribeDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. |
---|
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
Parameters: | source_identifier (string) – |
---|
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
Specify a cluster identifier when SourceType is cluster.
security-group`.
parameter-group`.
snapshot`.
Parameters: | source_type (string) – |
---|
Constraints:
If SourceType is supplied, SourceIdentifier must also be provided.
Specify cluster when SourceIdentifier is a cluster identifier.
security group name.
parameter group name.
snapshot identifier.
Parameters: | start_time (timestamp) – The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the `ISO8601 Wikipedia page.`_ |
---|
Example: 2009-07-08T18:00Z
Parameters: | end_time (timestamp) – The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the `ISO8601 Wikipedia page.`_ |
---|
Example: 2009-07-08T18:00Z
Parameters: | duration (integer) – The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned. |
---|
Default: 60
Parameters: | max_records (integer) – The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results may be retrieved. |
---|
Default: 100
Constraints: Value must be at least 20 and no more than 100.
Parameters: | marker (string) – An optional marker returned from a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. |
---|
Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to `Amazon Redshift Clusters`_ in the Amazon Redshift Management Guide
Parameters: | cluster_version (string) – The version filter value. Specify this parameter to show only the available offerings matching the specified version. |
---|
Default: All versions.
Parameters: |
|
---|
Default: 100
Constraints: minimum 20, maximum 100.
Parameters: | marker (string) – An optional marker returned from a previous DescribeOrderableClusterOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords. |
---|
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.
For more information about managing parameter groups, go to `Purchasing Reserved Nodes`_ in the Amazon Redshift Management Guide .
Parameters: |
|
---|
Default: 100
Constraints: minimum 20, maximum 100.
Parameters: | marker (string) – An optional marker returned by a previous DescribeReservedNodeOfferings request to indicate the first offering that the request will return. |
---|
Returns the descriptions of the reserved nodes.
Parameters: |
|
---|
Default: 100
Constraints: minimum 20, maximum 100.
Parameters: | marker (string) – An optional marker returned by a previous DescribeReservedNodes request to indicate the first parameter group that the current request will return. |
---|
Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a HTTP 404 error is returned. If a resize operation was initiated and completed, the status of the resize remains as SUCCEEDED until the next resize.
A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.
Parameters: | cluster_identifier (string) – The unique identifier of a cluster whose resize progress you are requesting. This parameter isn’t case- sensitive. |
---|
Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to `Amazon Redshift Clusters`_ in the Amazon Redshift Management Guide
You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change. If you specify the same number of nodes and node type that are already configured for the cluster, an error is returned.
Parameters: | cluster_identifier (string) – The unique identifier of the cluster to be modified. |
---|
Example: examplecluster
Parameters: | cluster_type (string) – The new cluster type. |
---|
Valid Values: ` multi-node | single-node `
Parameters: | node_type (string) – The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter also. |
---|
Valid Values: ` dw.hs1.xlarge` | dw.hs1.8xlarge
Parameters: | number_of_nodes (integer) – The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter also. |
---|
Valid Values: Integer greater than 0.
Parameters: | cluster_security_groups (list) – |
---|
Constraints:
Parameters: |
|
---|
Default: Uses existing setting.
Constraints:
Must be between 8 and 64 characters in length.
Must contain at least one uppercase letter.
Must contain at least one lowercase letter.
Must contain one number.
(single quote), ” (double quote), , /, @, or space.
Parameters: | cluster_parameter_group_name (string) – The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster. |
---|
Default: Uses existing setting.
Parameters: | automated_snapshot_retention_period (integer) – The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot. |
---|
Default: Uses existing setting.
Constraints: Must be a value from 0 to 35.
Parameters: | preferred_maintenance_window (string) – The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage. |
---|
Default: Uses existing setting.
Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Must be at least 30 minutes.
Parameters: | cluster_version (string) – The new version number of the Amazon Redshift engine to upgrade to. |
---|
Example: 1.0
Parameters: | allow_version_upgrade (boolean) – If True, upgrades will be applied automatically to the cluster during the maintenance window. |
---|
Default: False
Modifies the parameters of a parameter group.
For more information about managing parameter groups, go to `Amazon Redshift Parameter Groups`_ in the Amazon Redshift Management Guide .
Parameters: |
|
---|
Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets.
Parameters: |
|
---|
Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve.
For more information about managing parameter groups, go to `Purchasing Reserved Nodes`_ in the Amazon Redshift Management Guide .
Parameters: |
|
---|
Default: 1
Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to rebooting. A cluster event is created when the reboot is completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot. For more information about managing clusters, go to `Amazon Redshift Clusters`_ in the Amazon Redshift Management Guide
Parameters: | cluster_identifier (string) – The cluster identifier. |
---|
Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to “engine-default”. To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters.
Parameters: |
|
---|
Default: True
Parameters: | parameters (list) – An array of names of parameters to be reset. If ResetAllParameters option is not used, then at least one parameter name must be supplied. |
---|
Creates a new cluster from a snapshot. Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter group. After Amazon Redshift creates the cluster you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster.
If a snapshot is taken of a cluster in VPC, you can restore it only in VPC. In this case, you must provide a cluster subnet group where you want the cluster restored. If snapshot is taken of a cluster outside VPC, then you can restore it only outside VPC.
For more information about working with snapshots, go to `Amazon Redshift Snapshots`_ in the Amazon Redshift Management Guide .
Parameters: | cluster_identifier (string) – The identifier of the cluster that will be created from restoring the snapshot. |
---|
Constraints:
Parameters: | snapshot_identifier (string) – The name of the snapshot from which to create the new cluster. This parameter isn’t case sensitive. |
---|
Example: my-snapshot-id
Parameters: |
|
---|
Default: The same port as the original cluster.
Constraints: Must be between 1115 and 65535.
Parameters: | availability_zone (string) – The Amazon EC2 Availability Zone in which to restore the cluster. |
---|
Default: A random, system-chosen Availability Zone.
Example: us-east-1a
Parameters: | allow_version_upgrade (boolean) – If True, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. |
---|
Default: True
Parameters: | cluster_subnet_group_name (string) – The name of the subnet group where you want to cluster restored. |
---|
Parameters: |
|
---|
Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress. For information about managing security groups, go to`Amazon Redshift Cluster Security Groups`_ in the Amazon Redshift Management Guide .
Parameters: |
|
---|
Example: 111122223333
Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion.
For more information about working with snapshots, go to `Amazon Redshift Snapshots`_ in the Amazon Redshift Management Guide .
Parameters: |
|
---|