Overview
This is an interface reference for Amazon Redshift. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift clusters. Note that Amazon Redshift is asynchronous, which means that some interfaces may require techniques, such as polling or asynchronous callback handlers, to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a change is applied immediately, on the next instance reboot, or during the next maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to Using the Amazon Redshift Management Interfaces.
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.
If you are a first-time user of Amazon Redshift, we recommend that you begin by reading the Amazon Redshift Getting Started Guide.
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.
License: Apache 2.0 License
Resources
Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs.
Request
Query
| Name | Data Type | Description |
|---|---|---|
ReservedNodeId
|
string |
A string representing the node identifier of the DC1 Reserved Node to be exchanged. |
TargetReservedNodeOfferingId
|
string |
The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling GetReservedNodeExchangeOfferings |
Action
|
string Allowed values: - AcceptReservedNodeExchange |
|
Version
|
string Allowed values: - 2012-12-01 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AcceptReservedNodeExchangeOutputMessage
|
object |
Properties
ExchangedReservedNode
|
ReservedNode | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ReservedNodeNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidReservedNodeStateFault
|
Body
| Name | Data Type | Description |
|---|---|---|
ReservedNodeAlreadyMigratedFault
|
Body
| Name | Data Type | Description |
|---|---|---|
ReservedNodeOfferingNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
UnsupportedOperationFault
|
Body
| Name | Data Type | Description |
|---|---|---|
DependentServiceUnavailableFault
|
Body
| Name | Data Type | Description |
|---|---|---|
ReservedNodeAlreadyExistsFault
|
Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AcceptReservedNodeExchange |
|
Version
|
string Allowed values: - 2012-12-01 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
ReservedNodeId
|
string |
A string representing the node identifier of the DC1 Reserved Node to be exchanged. |
TargetReservedNodeOfferingId
|
string |
The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling GetReservedNodeExchangeOfferings |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AcceptReservedNodeExchangeOutputMessage
|
object |
Properties
ExchangedReservedNode
|
ReservedNode | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ReservedNodeNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidReservedNodeStateFault
|
Body
| Name | Data Type | Description |
|---|---|---|
ReservedNodeAlreadyMigratedFault
|
Body
| Name | Data Type | Description |
|---|---|---|
ReservedNodeOfferingNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
UnsupportedOperationFault
|
Body
| Name | Data Type | Description |
|---|---|---|
DependentServiceUnavailableFault
|
Body
| Name | Data Type | Description |
|---|---|---|
ReservedNodeAlreadyExistsFault
|
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 Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.
If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same AWS Region.
If you authorize access to a CIDR/IP address range, specify CIDRIP. 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 Cluster Management Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
ClusterSecurityGroupName
|
string |
The name of the security group to which the ingress rule is added. |
CIDRIP
|
string |
The IP range to be added the Amazon Redshift security group. |
EC2SecurityGroupName
|
string |
The EC2 security group to be added the Amazon Redshift security group. |
EC2SecurityGroupOwnerId
|
string |
The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. Example: |
Action
|
string Allowed values: - AuthorizeClusterSecurityGroupIngress |
|
Version
|
string Allowed values: - 2012-12-01 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AuthorizeClusterSecurityGroupIngressResult
|
object |
Properties
ClusterSecurityGroup
|
ClusterSecurityGroup | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ClusterSecurityGroupNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidClusterSecurityGroupStateFault
|
Body
| Name | Data Type | Description |
|---|---|---|
AuthorizationAlreadyExistsFault
|
Body
| Name | Data Type | Description |
|---|---|---|
AuthorizationQuotaExceededFault
|
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 Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.
If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same AWS Region.
If you authorize access to a CIDR/IP address range, specify CIDRIP. 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 Cluster Management Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AuthorizeClusterSecurityGroupIngress |
|
Version
|
string Allowed values: - 2012-12-01 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
ClusterSecurityGroupName
|
string |
The name of the security group to which the ingress rule is added. |
CIDRIP
|
string |
The IP range to be added the Amazon Redshift security group. |
EC2SecurityGroupName
|
string |
The EC2 security group to be added the Amazon Redshift security group. |
EC2SecurityGroupOwnerId
|
string |
The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. Example: |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AuthorizeClusterSecurityGroupIngressResult
|
object |
Properties
ClusterSecurityGroup
|
ClusterSecurityGroup | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ClusterSecurityGroupNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidClusterSecurityGroupStateFault
|
Body
| Name | Data Type | Description |
|---|---|---|
AuthorizationAlreadyExistsFault
|
Body
| Name | Data Type | Description |
|---|---|---|
AuthorizationQuotaExceededFault
|
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 Cluster Management Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
SnapshotIdentifier
|
string |
The identifier of the snapshot the account is authorized to restore. |
SnapshotClusterIdentifier
|
string |
The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. |
AccountWithRestoreAccess
|
string |
The identifier of the AWS customer account authorized to restore the specified snapshot. To share a snapshot with AWS support, specify amazon-redshift-support. |
Action
|
string Allowed values: - AuthorizeSnapshotAccess |
|
Version
|
string Allowed values: - 2012-12-01 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AuthorizeSnapshotAccessResult
|
object |
Properties
Snapshot
|
Snapshot | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ClusterSnapshotNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
AuthorizationAlreadyExistsFault
|
Body
| Name | Data Type | Description |
|---|---|---|
AuthorizationQuotaExceededFault
|
Body
| Name | Data Type | Description |
|---|---|---|
DependentServiceRequestThrottlingFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidClusterSnapshotStateFault
|
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededFault
|
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 Cluster Management Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AuthorizeSnapshotAccess |
|
Version
|
string Allowed values: - 2012-12-01 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
SnapshotIdentifier
|
string |
The identifier of the snapshot the account is authorized to restore. |
SnapshotClusterIdentifier
|
string |
The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. |
AccountWithRestoreAccess
|
string |
The identifier of the AWS customer account authorized to restore the specified snapshot. To share a snapshot with AWS support, specify amazon-redshift-support. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AuthorizeSnapshotAccessResult
|
object |
Properties
Snapshot
|
Snapshot | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ClusterSnapshotNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
AuthorizationAlreadyExistsFault
|
Body
| Name | Data Type | Description |
|---|---|---|
AuthorizationQuotaExceededFault
|
Body
| Name | Data Type | Description |
|---|---|---|
DependentServiceRequestThrottlingFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidClusterSnapshotStateFault
|
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededFault
|
Deletes a set of cluster snapshots.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Identifiers
|
array |
A list of identifiers for the snapshots that you want to delete. |
Action
|
string Allowed values: - BatchDeleteClusterSnapshots |
|
Version
|
string Allowed values: - 2012-12-01 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
BatchDeleteClusterSnapshotsResult
|
object |
Properties
Errors
|
BatchSnapshotOperationErrorList |
A list of any errors returned. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
Resources
|
SnapshotIdentifierList |
A list of the snapshot identifiers that were deleted. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
BatchDeleteRequestSizeExceededFault
|
Deletes a set of cluster snapshots.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - BatchDeleteClusterSnapshots |
|
Version
|
string Allowed values: - 2012-12-01 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
Identifiers
|
array |
A list of identifiers for the snapshots that you want to delete. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
BatchDeleteClusterSnapshotsResult
|
object |
Properties
Errors
|
BatchSnapshotOperationErrorList |
A list of any errors returned. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
Resources
|
SnapshotIdentifierList |
A list of the snapshot identifiers that were deleted. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
BatchDeleteRequestSizeExceededFault
|
Modifies the settings for a set of cluster snapshots.
Request
Query
| Name | Data Type | Description |
|---|---|---|
SnapshotIdentifierList
|
array |
A list of snapshot identifiers you want to modify. |
ManualSnapshotRetentionPeriod
|
integer |
The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely. The number must be either -1 or an integer between 1 and 3,653. If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option. |
Force
|
boolean |
A boolean value indicating whether to override an exception if the retention period has passed. |
Action
|
string Allowed values: - BatchModifyClusterSnapshots |
|
Version
|
string Allowed values: - 2012-12-01 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
BatchModifyClusterSnapshotsOutputMessage
|
object |
Properties
Errors
|
BatchSnapshotOperationErrors |
A list of any errors returned. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
Resources
|
SnapshotIdentifierList |
A list of the snapshots that were modified. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRetentionPeriodFault
|
Body
| Name | Data Type | Description |
|---|---|---|
BatchModifyClusterSnapshotsLimitExceededFault
|
Modifies the settings for a set of cluster snapshots.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - BatchModifyClusterSnapshots |
|
Version
|
string Allowed values: - 2012-12-01 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
SnapshotIdentifierList
|
array |
A list of snapshot identifiers you want to modify. |
ManualSnapshotRetentionPeriod
|
integer |
The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely. The number must be either -1 or an integer between 1 and 3,653. If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option. |
Force
|
boolean |
A boolean value indicating whether to override an exception if the retention period has passed. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
BatchModifyClusterSnapshotsOutputMessage
|
object |
Properties
Errors
|
BatchSnapshotOperationErrors |
A list of any errors returned. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
Resources
|
SnapshotIdentifierList |
A list of the snapshots that were modified. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRetentionPeriodFault
|
Body
| Name | Data Type | Description |
|---|---|---|
BatchModifyClusterSnapshotsLimitExceededFault
|
Cancels a resize operation for a cluster.
Request
Query
| Name | Data Type | Description |
|---|---|---|
ClusterIdentifier
|
string |
The unique identifier for the cluster that you want to cancel a resize operation for. |
Action
|
string Allowed values: - CancelResize |
|
Version
|
string Allowed values: - 2012-12-01 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ResizeProgressMessage
|
object |
Describes the result of a cluster resize operation. |
Properties
DataTransferProgressPercent
|
DoubleOptional |
The percent of data transferred from source cluster to target cluster. |
|||||||||||
|
|||||||||||||
TargetEncryptionType
|
String |
The type of encryption for the cluster after the resize is complete. Possible values are |
|||||||||||
|
|||||||||||||
Message
|
String |
An optional string to provide additional details about the resize action. |
|||||||||||
|
|||||||||||||
ResizeType
|
String |
An enum with possible values of |
|||||||||||
|
|||||||||||||
EstimatedTimeToCompletionInSeconds
|
LongOptional |
The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0. |
|||||||||||
|
|||||||||||||
ElapsedTimeInSeconds
|
LongOptional |
The amount of seconds that have elapsed since the resize operation began. After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation. |
|||||||||||
|
|||||||||||||
ProgressInMegaBytes
|
LongOptional |
While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize). |
|||||||||||
|
|||||||||||||
TotalResizeDataInMegaBytes
|
LongOptional |
The estimated total amount of data, in megabytes, on the cluster before the resize operation began. |
|||||||||||
|
|||||||||||||
AvgResizeRateInMegaBytesPerSecond
|
DoubleOptional |
The average rate of the resize operation over the last few minutes, measured in megabytes per second. After the resize operation completes, this value shows the average rate of the entire resize operation. |
|||||||||||
|
|||||||||||||
ImportTablesNotStarted
|
ImportTablesNotStarted |
The names of tables that have not been yet imported. Valid Values: List of table names |
|||||||||||
|
|||||||||||||
ImportTablesInProgress
|
ImportTablesInProgress |
The names of tables that are being currently imported. Valid Values: List of table names. |
|||||||||||
|
|||||||||||||
ImportTablesCompleted
|
ImportTablesCompleted |
The names of tables that have been completely imported . Valid Values: List of table names. |
|||||||||||
|
|||||||||||||
Status
|
String |
The status of the resize operation. Valid Values: |
|||||||||||
|
|||||||||||||
TargetClusterType
|
String |
The cluster type after the resize operation is complete. Valid Values: |
|||||||||||
|
|||||||||||||
TargetNumberOfNodes
|
IntegerOptional |
The number of nodes that the cluster will have after the resize operation is complete. |
|||||||||||
|
|||||||||||||
TargetNodeType
|
String |
The node type that the cluster will have after the resize operation is complete. |
|||||||||||
|
|||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ClusterNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
ResizeNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidClusterStateFault
|
Body
| Name | Data Type | Description |
|---|---|---|
UnsupportedOperationFault
|
Cancels a resize operation for a cluster.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - CancelResize |
|
Version
|
string Allowed values: - 2012-12-01 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
ClusterIdentifier
|
string |
The unique identifier for the cluster that you want to cancel a resize operation for. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ResizeProgressMessage
|
object |
Describes the result of a cluster resize operation. |
Properties
DataTransferProgressPercent
|
DoubleOptional |
The percent of data transferred from source cluster to target cluster. |
|||||||||||
|
|||||||||||||
TargetEncryptionType
|
String |
The type of encryption for the cluster after the resize is complete. Possible values are |
|||||||||||
|
|||||||||||||
Message
|
String |
An optional string to provide additional details about the resize action. |
|||||||||||
|
|||||||||||||
ResizeType
|
String |
An enum with possible values of |
|||||||||||
|
|||||||||||||
EstimatedTimeToCompletionInSeconds
|
LongOptional |
The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0. |
|||||||||||
|
|||||||||||||
ElapsedTimeInSeconds
|
LongOptional |
The amount of seconds that have elapsed since the resize operation began. After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation. |
|||||||||||
|
|||||||||||||
ProgressInMegaBytes
|
LongOptional |
While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize). |
|||||||||||
|
|||||||||||||
TotalResizeDataInMegaBytes
|
LongOptional |
The estimated total amount of data, in megabytes, on the cluster before the resize operation began. |
|||||||||||
|
|||||||||||||
AvgResizeRateInMegaBytesPerSecond
|
DoubleOptional |
The average rate of the resize operation over the last few minutes, measured in megabytes per second. After the resize operation completes, this value shows the average rate of the entire resize operation. |
|||||||||||
|
|||||||||||||
ImportTablesNotStarted
|
ImportTablesNotStarted |
The names of tables that have not been yet imported. Valid Values: List of table names |
|||||||||||
|
|||||||||||||
ImportTablesInProgress
|
ImportTablesInProgress |
The names of tables that are being currently imported. Valid Values: List of table names. |
|||||||||||
|
|||||||||||||
ImportTablesCompleted
|
ImportTablesCompleted |
The names of tables that have been completely imported . Valid Values: List of table names. |
|||||||||||
|
|||||||||||||
Status
|
String |
The status of the resize operation. Valid Values: |
|||||||||||
|
|||||||||||||
TargetClusterType
|
String |
The cluster type after the resize operation is complete. Valid Values: |
|||||||||||
|
|||||||||||||
TargetNumberOfNodes
|
IntegerOptional |
The number of nodes that the cluster will have after the resize operation is complete. |
|||||||||||
|
|||||||||||||
TargetNodeType
|
String |
The node type that the cluster will have after the resize operation is complete. |
|||||||||||
|
|||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ClusterNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
ResizeNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidClusterStateFault
|
Body
| Name | Data Type | Description |
|---|---|---|
UnsupportedOperationFault
|
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 Cluster Management Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
SourceSnapshotIdentifier
|
string |
The identifier for the source snapshot. Constraints:
|
SourceSnapshotClusterIdentifier
|
string |
The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. Constraints:
|
TargetSnapshotIdentifier
|
string |
The identifier given to the new manual snapshot. Constraints:
|
ManualSnapshotRetentionPeriod
|
integer |
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653. The default value is -1. |
Action
|
string Allowed values: - CopyClusterSnapshot |
|
Version
|
string Allowed values: - 2012-12-01 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CopyClusterSnapshotResult
|
object |
Properties
Snapshot
|
Snapshot | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ClusterSnapshotAlreadyExistsFault
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterSnapshotNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidClusterSnapshotStateFault
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterSnapshotQuotaExceededFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRetentionPeriodFault
|
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 Cluster Management Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - CopyClusterSnapshot |
|
Version
|
string Allowed values: - 2012-12-01 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
SourceSnapshotIdentifier
|
string |
The identifier for the source snapshot. Constraints:
|
SourceSnapshotClusterIdentifier
|
string |
The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. Constraints:
|
TargetSnapshotIdentifier
|
string |
The identifier given to the new manual snapshot. Constraints:
|
ManualSnapshotRetentionPeriod
|
integer |
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. The value must be either -1 or an integer between 1 and 3,653. The default value is -1. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CopyClusterSnapshotResult
|
object |
Properties
Snapshot
|
Snapshot | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ClusterSnapshotAlreadyExistsFault
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterSnapshotNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidClusterSnapshotStateFault
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterSnapshotQuotaExceededFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRetentionPeriodFault
|
Creates a new cluster with the specified parameters.
To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2012-12-01 |
|
Action
|
string Allowed values: - CreateCluster |
|
SnapshotScheduleIdentifier
|
string |
A unique identifier for the snapshot schedule. |
MaintenanceTrackName
|
string |
An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the |
IamRoles
|
array |
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request. A cluster can have up to 10 IAM roles associated with it at any time. |
AdditionalInfo
|
string |
Reserved. |
EnhancedVpcRouting
|
boolean |
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is Default: false |
KmsKeyId
|
string |
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. |
Tags
|
array |
A list of tag instances. |
ElasticIp
|
string |
The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide. |
HsmConfigurationIdentifier
|
string |
Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. |
HsmClientCertificateIdentifier
|
string |
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. |
Encrypted
|
boolean |
If Default: false |
PubliclyAccessible
|
boolean |
If |
NumberOfNodes
|
integer |
The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster. Default: Constraints: Value must be at least 1 and no more than 100. |
AllowVersionUpgrade
|
boolean |
If When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster. Default: |
ClusterVersion
|
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: |
Port
|
integer |
The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default: Valid Values: |
ManualSnapshotRetentionPeriod
|
integer |
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. The value must be either -1 or an integer between 1 and 3,653. |
AutomatedSnapshotRetentionPeriod
|
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: Constraints: Must be a value from 0 to 35. |
ClusterParameterGroupName
|
string |
The name of the parameter group to be associated with this cluster. Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups Constraints:
|
PreferredMaintenanceWindow
|
string |
The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Minimum 30-minute window. |
AvailabilityZone
|
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. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint. Example: Constraint: The specified Availability Zone must be in the same region as the current endpoint. |
ClusterSubnetGroupName
|
string |
The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC). |
VpcSecurityGroupIds
|
array |
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. |
ClusterSecurityGroups
|
array |
A list of security groups to be associated with this cluster. Default: The default cluster security group for Amazon Redshift. |
MasterUserPassword
|
string |
The password associated with the master user account for the cluster that is being created. Constraints:
|
MasterUsername
|
string |
The user name associated with the master user account for the cluster that is being created. Constraints:
|
NodeType
|
string |
The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. Valid Values: |
ClusterType
|
string |
The type of the cluster. When cluster type is specified as
Valid Values: Default: |
ClusterIdentifier
|
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: |
DBName
|
string |
The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide. Default: Constraints:
|
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateClusterResult
|
object |
Properties
Cluster
|
Cluster | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ClusterAlreadyExistsFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InsufficientClusterCapacityFault
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterParameterGroupNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterSecurityGroupNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterQuotaExceededFault
|
Body
| Name | Data Type | Description |
|---|---|---|
NumberOfNodesQuotaExceededFault
|
Body
| Name | Data Type | Description |
|---|---|---|
NumberOfNodesPerClusterLimitExceededFault
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterSubnetGroupNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidVPCNetworkStateFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidClusterSubnetGroupStateFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidSubnet
|
Body
| Name | Data Type | Description |
|---|---|---|
UnauthorizedOperation
|
Body
| Name | Data Type | Description |
|---|---|---|
HsmClientCertificateNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
HsmConfigurationNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidElasticIpFault
|
Body
| Name | Data Type | Description |
|---|---|---|
TagLimitExceededFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidTagFault
|
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededFault
|
Body
| Name | Data Type | Description |
|---|---|---|
DependentServiceRequestThrottlingFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidClusterTrackFault
|
Body
| Name | Data Type | Description |
|---|---|---|
SnapshotScheduleNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRetentionPeriodFault
|
Creates a new cluster with the specified parameters.
To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string Allowed values: - 2012-12-01 |
|
Action
|
string Allowed values: - CreateCluster |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
SnapshotScheduleIdentifier
|
string |
A unique identifier for the snapshot schedule. |
MaintenanceTrackName
|
string |
An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the |
IamRoles
|
array |
A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request. A cluster can have up to 10 IAM roles associated with it at any time. |
AdditionalInfo
|
string |
Reserved. |
EnhancedVpcRouting
|
boolean |
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide. If this option is Default: false |
KmsKeyId
|
string |
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. |
Tags
|
array |
A list of tag instances. |
ElasticIp
|
string |
The Elastic IP (EIP) address for the cluster. Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide. |
HsmConfigurationIdentifier
|
string |
Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. |
HsmClientCertificateIdentifier
|
string |
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. |
Encrypted
|
boolean |
If Default: false |
PubliclyAccessible
|
boolean |
If |
NumberOfNodes
|
integer |
The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster. Default: Constraints: Value must be at least 1 and no more than 100. |
AllowVersionUpgrade
|
boolean |
If When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster. Default: |
ClusterVersion
|
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: |
Port
|
integer |
The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default: Valid Values: |
ManualSnapshotRetentionPeriod
|
integer |
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. The value must be either -1 or an integer between 1 and 3,653. |
AutomatedSnapshotRetentionPeriod
|
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: Constraints: Must be a value from 0 to 35. |
ClusterParameterGroupName
|
string |
The name of the parameter group to be associated with this cluster. Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups Constraints:
|
PreferredMaintenanceWindow
|
string |
The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide. Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun Constraints: Minimum 30-minute window. |
AvailabilityZone
|
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. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint. Example: Constraint: The specified Availability Zone must be in the same region as the current endpoint. |
ClusterSubnetGroupName
|
string |
The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC). |
VpcSecurityGroupIds
|
array |
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. |
ClusterSecurityGroups
|
array |
A list of security groups to be associated with this cluster. Default: The default cluster security group for Amazon Redshift. |
MasterUserPassword
|
string |
The password associated with the master user account for the cluster that is being created. Constraints:
|
MasterUsername
|
string |
The user name associated with the master user account for the cluster that is being created. Constraints:
|
NodeType
|
string |
The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide. Valid Values: |
ClusterType
|
string |
The type of the cluster. When cluster type is specified as
Valid Values: Default: |
ClusterIdentifier
|
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: |
DBName
|
string |
The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide. Default: Constraints:
|
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateClusterResult
|
object |
Properties
Cluster
|
Cluster | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ClusterAlreadyExistsFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InsufficientClusterCapacityFault
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterParameterGroupNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterSecurityGroupNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterQuotaExceededFault
|
Body
| Name | Data Type | Description |
|---|---|---|
NumberOfNodesQuotaExceededFault
|
Body
| Name | Data Type | Description |
|---|---|---|
NumberOfNodesPerClusterLimitExceededFault
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterSubnetGroupNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidVPCNetworkStateFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidClusterSubnetGroupStateFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidSubnet
|
Body
| Name | Data Type | Description |
|---|---|---|
UnauthorizedOperation
|
Body
| Name | Data Type | Description |
|---|---|---|
HsmClientCertificateNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
HsmConfigurationNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidElasticIpFault
|
Body
| Name | Data Type | Description |
|---|---|---|
TagLimitExceededFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidTagFault
|
Body
| Name | Data Type | Description |
|---|---|---|
LimitExceededFault
|
Body
| Name | Data Type | Description |
|---|---|---|
DependentServiceRequestThrottlingFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidClusterTrackFault
|
Body
| Name | Data Type | Description |
|---|---|---|
SnapshotScheduleNotFoundFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidRetentionPeriodFault
|
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 parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
ParameterGroupName
|
string |
The name of the cluster parameter group. Constraints:
This value is stored as a lower-case string. |
ParameterGroupFamily
|
string |
The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters. To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is "redshift-1.0". |
Description
|
string |
A description of the parameter group. |
Tags
|
array |
A list of tag instances. |
Action
|
string Allowed values: - CreateClusterParameterGroup |
|
Version
|
string Allowed values: - 2012-12-01 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateClusterParameterGroupResult
|
object |
Properties
ClusterParameterGroup
|
ClusterParameterGroup | |||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ClusterParameterGroupQuotaExceededFault
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterParameterGroupAlreadyExistsFault
|
Body
| Name | Data Type | Description |
|---|---|---|
TagLimitExceededFault
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidTagFault
|
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 parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - CreateClusterParameterGroup |
|
Version
|
string Allowed values: - 2012-12-01 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
ParameterGroupName
|
string |
The name of the cluster parameter group. Constraints:
This value is stored as a lower-case string. |
ParameterGroupFamily
|
string |
The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters. To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is "redshift-1.0". |
Description
|
string |
A description of the parameter group. |
Tags
|
array |
A list of tag instances. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateClusterParameterGroupResult
|
object |
Properties
ClusterParameterGroup
|
ClusterParameterGroup | |||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ClusterParameterGroupQuotaExceededFault
|
Body
| Name | Data Type |
|---|