2015/06/24 - Amazon Redshift - 3 new20 updated api methods
Returns a list of snapshot copy grants owned by the AWS account in the destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
Request Syntax
client.describe_snapshot_copy_grants(
SnapshotCopyGrantName='string',
MaxRecords=123,
Marker='string',
TagKeys=[
'string',
],
TagValues=[
'string',
]
)
string
The name of the snapshot copy grant.
integer
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
string
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.
list
A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.
(string) --
list
A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.
(string) --
dict
Response Syntax
{
'Marker': 'string',
'SnapshotCopyGrants': [
{
'SnapshotCopyGrantName': 'string',
'KmsKeyId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
}
Response Structure
(dict) --
The result of the snapshot copy grant.
Marker (string) --
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.
SnapshotCopyGrants (list) --
The list of snapshot copy grants.
(dict) --
The snapshot copy grant that grants Amazon Redshift permission to encrypt copied snapshots with the specified customer master key (CMK) from AWS KMS in the destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
KmsKeyId (string) --
The unique identifier of the customer master key (CMK) in AWS KMS to which Amazon Redshift is granted permission.
Tags (list) --
A list of tag instances.
(dict) --
A tag consisting of a name/value pair for a resource.
Key (string) --
The key, or name, for the resource tag.
Value (string) --
The value for the resource tag.
Deletes the specified snapshot copy grant.
Request Syntax
client.delete_snapshot_copy_grant(
SnapshotCopyGrantName='string'
)
string
[REQUIRED]
The name of the snapshot copy grant to delete.
None
Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key Management Service (AWS KMS) to encrypt copied snapshots in a destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
Request Syntax
client.create_snapshot_copy_grant(
SnapshotCopyGrantName='string',
KmsKeyId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name of the snapshot copy grant. This name must be unique in the region for the AWS account.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
string
The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.
list
A list of tag instances.
(dict) --
A tag consisting of a name/value pair for a resource.
Key (string) --
The key, or name, for the resource tag.
Value (string) --
The value for the resource tag.
dict
Response Syntax
{
'SnapshotCopyGrant': {
'SnapshotCopyGrantName': 'string',
'KmsKeyId': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
The snapshot copy grant that grants Amazon Redshift permission to encrypt copied snapshots with the specified customer master key (CMK) from AWS KMS in the destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
SnapshotCopyGrant (dict) --
The snapshot copy grant that grants Amazon Redshift permission to encrypt copied snapshots with the specified customer master key (CMK) from AWS KMS in the destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
KmsKeyId (string) --
The unique identifier of the customer master key (CMK) in AWS KMS to which Amazon Redshift is granted permission.
Tags (list) --
A list of tag instances.
(dict) --
A tag consisting of a name/value pair for a resource.
Key (string) --
The key, or name, for the resource tag.
Value (string) --
The value for the resource tag.
{'Snapshot': {'RestorableNodeTypes': ['string']}}
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 Syntax
client.authorize_snapshot_access(
SnapshotIdentifier='string',
SnapshotClusterIdentifier='string',
AccountWithRestoreAccess='string'
)
string
[REQUIRED]
The identifier of the snapshot the account is authorized to restore.
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.
string
[REQUIRED]
The identifier of the AWS customer account authorized to restore the specified snapshot.
dict
Response Syntax
{
'Snapshot': {
'SnapshotIdentifier': 'string',
'ClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'ClusterVersion': 'string',
'SnapshotType': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'DBName': 'string',
'VpcId': 'string',
'Encrypted': True|False,
'KmsKeyId': 'string',
'EncryptedWithHSM': True|False,
'AccountsWithRestoreAccess': [
{
'AccountId': 'string'
},
],
'OwnerAccount': 'string',
'TotalBackupSizeInMegaBytes': 123.0,
'ActualIncrementalBackupSizeInMegaBytes': 123.0,
'BackupProgressInMegaBytes': 123.0,
'CurrentBackupRateInMegaBytesPerSecond': 123.0,
'EstimatedSecondsToCompletion': 123,
'ElapsedTimeInSeconds': 123,
'SourceRegion': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'RestorableNodeTypes': [
'string',
]
}
}
Response Structure
(dict) --
Describes a snapshot.
Snapshot (dict) --
Describes a snapshot.
SnapshotIdentifier (string) --
The snapshot identifier that is provided in the request.
ClusterIdentifier (string) --
The identifier of the cluster for which the snapshot was taken.
SnapshotCreateTime (datetime) --
The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.
Status (string) --
The snapshot status. The value of the status depends on the API operation used.
CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
DeleteClusterSnapshot returns status as "deleted".
Port (integer) --
The port that the cluster is listening on.
AvailabilityZone (string) --
The Availability Zone in which the cluster was created.
ClusterCreateTime (datetime) --
The time (UTC) when the cluster was originally created.
MasterUsername (string) --
The master user name for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
SnapshotType (string) --
The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".
NodeType (string) --
The node type of the nodes in the cluster.
NumberOfNodes (integer) --
The number of nodes in the cluster.
DBName (string) --
The name of the database that was created when the cluster was created.
VpcId (string) --
The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.
Encrypted (boolean) --
If true, the data in the snapshot is encrypted at rest.
KmsKeyId (string) --
The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.
EncryptedWithHSM (boolean) --
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.
AccountsWithRestoreAccess (list) --
A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
(dict) --
Describes an AWS customer account authorized to restore a snapshot.
AccountId (string) --
The identifier of an AWS customer account authorized to restore a snapshot.
OwnerAccount (string) --
For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
TotalBackupSizeInMegaBytes (float) --
The size of the complete set of backup data that would be used to restore the cluster.
ActualIncrementalBackupSizeInMegaBytes (float) --
The size of the incremental backup.
BackupProgressInMegaBytes (float) --
The number of megabytes that have been transferred to the snapshot backup.
CurrentBackupRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.
EstimatedSecondsToCompletion (integer) --
The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
SourceRegion (string) --
The source region from which the snapshot was copied.
Tags (list) --
The list of tags for the cluster snapshot.
(dict) --
A tag consisting of a name/value pair for a resource.
Key (string) --
The key, or name, for the resource tag.
Value (string) --
The value for the resource tag.
RestorableNodeTypes (list) --
The list of node types that this cluster snapshot is able to restore into.
(string) --
{'Snapshot': {'RestorableNodeTypes': ['string']}}
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 Syntax
client.copy_cluster_snapshot(
SourceSnapshotIdentifier='string',
SourceSnapshotClusterIdentifier='string',
TargetSnapshotIdentifier='string'
)
string
[REQUIRED]
The identifier for the source snapshot.
Constraints:
Must be the identifier for a valid automated snapshot whose state is available.
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:
Must be the identifier for a valid cluster.
string
[REQUIRED]
The identifier given to the new manual snapshot.
Constraints:
Cannot be null, empty, or blank.
Must contain from 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for the AWS account that is making the request.
dict
Response Syntax
{
'Snapshot': {
'SnapshotIdentifier': 'string',
'ClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'ClusterVersion': 'string',
'SnapshotType': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'DBName': 'string',
'VpcId': 'string',
'Encrypted': True|False,
'KmsKeyId': 'string',
'EncryptedWithHSM': True|False,
'AccountsWithRestoreAccess': [
{
'AccountId': 'string'
},
],
'OwnerAccount': 'string',
'TotalBackupSizeInMegaBytes': 123.0,
'ActualIncrementalBackupSizeInMegaBytes': 123.0,
'BackupProgressInMegaBytes': 123.0,
'CurrentBackupRateInMegaBytesPerSecond': 123.0,
'EstimatedSecondsToCompletion': 123,
'ElapsedTimeInSeconds': 123,
'SourceRegion': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'RestorableNodeTypes': [
'string',
]
}
}
Response Structure
(dict) --
Describes a snapshot.
Snapshot (dict) --
Describes a snapshot.
SnapshotIdentifier (string) --
The snapshot identifier that is provided in the request.
ClusterIdentifier (string) --
The identifier of the cluster for which the snapshot was taken.
SnapshotCreateTime (datetime) --
The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.
Status (string) --
The snapshot status. The value of the status depends on the API operation used.
CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
DeleteClusterSnapshot returns status as "deleted".
Port (integer) --
The port that the cluster is listening on.
AvailabilityZone (string) --
The Availability Zone in which the cluster was created.
ClusterCreateTime (datetime) --
The time (UTC) when the cluster was originally created.
MasterUsername (string) --
The master user name for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
SnapshotType (string) --
The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".
NodeType (string) --
The node type of the nodes in the cluster.
NumberOfNodes (integer) --
The number of nodes in the cluster.
DBName (string) --
The name of the database that was created when the cluster was created.
VpcId (string) --
The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.
Encrypted (boolean) --
If true, the data in the snapshot is encrypted at rest.
KmsKeyId (string) --
The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.
EncryptedWithHSM (boolean) --
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.
AccountsWithRestoreAccess (list) --
A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
(dict) --
Describes an AWS customer account authorized to restore a snapshot.
AccountId (string) --
The identifier of an AWS customer account authorized to restore a snapshot.
OwnerAccount (string) --
For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
TotalBackupSizeInMegaBytes (float) --
The size of the complete set of backup data that would be used to restore the cluster.
ActualIncrementalBackupSizeInMegaBytes (float) --
The size of the incremental backup.
BackupProgressInMegaBytes (float) --
The number of megabytes that have been transferred to the snapshot backup.
CurrentBackupRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.
EstimatedSecondsToCompletion (integer) --
The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
SourceRegion (string) --
The source region from which the snapshot was copied.
Tags (list) --
The list of tags for the cluster snapshot.
(dict) --
A tag consisting of a name/value pair for a resource.
Key (string) --
The key, or name, for the resource tag.
Value (string) --
The value for the resource tag.
RestorableNodeTypes (list) --
The list of node types that this cluster snapshot is able to restore into.
(string) --
{'Cluster': {'ClusterParameterGroups': {'ClusterParameterStatusList': [{'ParameterApplyErrorDescription': 'string',
'ParameterApplyStatus': 'string',
'ParameterName': 'string'}]},
'ClusterSnapshotCopyStatus': {'SnapshotCopyGrantName': 'string'}}}
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 Cluster Management Guide .
Request Syntax
client.create_cluster(
DBName='string',
ClusterIdentifier='string',
ClusterType='string',
NodeType='string',
MasterUsername='string',
MasterUserPassword='string',
ClusterSecurityGroups=[
'string',
],
VpcSecurityGroupIds=[
'string',
],
ClusterSubnetGroupName='string',
AvailabilityZone='string',
PreferredMaintenanceWindow='string',
ClusterParameterGroupName='string',
AutomatedSnapshotRetentionPeriod=123,
Port=123,
ClusterVersion='string',
AllowVersionUpgrade=True|False,
NumberOfNodes=123,
PubliclyAccessible=True|False,
Encrypted=True|False,
HsmClientCertificateIdentifier='string',
HsmConfigurationIdentifier='string',
ElasticIp='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
KmsKeyId='string'
)
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: dev
Constraints:
Must contain 1 to 64 alphanumeric characters.
Must contain only lowercase letters.
Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
string
[REQUIRED]
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:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
Example: myexamplecluster
string
The type of the cluster. When cluster type is specified as
single-node, the NumberOfNodes parameter is not required.
multi-node, the NumberOfNodes parameter is required.
Valid Values: multi-node | single-node
Default: multi-node
string
[REQUIRED]
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: ds1.xlarge | ds1.8xlarge | ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge.
string
[REQUIRED]
The user name associated with the master user account for the cluster that is being created.
Constraints:
Must be 1 - 128 alphanumeric characters.
First character must be a letter.
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
string
[REQUIRED]
The password associated with the master user account for the cluster that is being created.
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.
Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), , /, @, or space.
list
A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
(string) --
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.
(string) --
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).
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: us-east-1d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
string
The weekly time range (in UTC) during which automated cluster maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
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.
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:
Must be 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
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.
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: 5439
Valid Values: 1150-65535
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
boolean
If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
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: true
integer
The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.
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: 1
Constraints: Value must be at least 1 and no more than 100.
boolean
If true, the cluster can be accessed from a public network.
boolean
If true, the data in the cluster is encrypted at rest.
Default: false
string
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
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.
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.
list
A list of tag instances.
(dict) --
A tag consisting of a name/value pair for a resource.
Key (string) --
The key, or name, for the resource tag.
Value (string) --
The value for the resource tag.
string
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterSecurityGroups': [
{
'ClusterSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'ClusterParameterGroups': [
{
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'ClusterParameterStatusList': [
{
'ParameterName': 'string',
'ParameterApplyStatus': 'string',
'ParameterApplyErrorDescription': 'string'
},
]
},
],
'ClusterSubnetGroupName': 'string',
'VpcId': 'string',
'AvailabilityZone': 'string',
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'MasterUserPassword': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'ClusterType': 'string',
'ClusterVersion': 'string',
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterIdentifier': 'string'
},
'ClusterVersion': 'string',
'AllowVersionUpgrade': True|False,
'NumberOfNodes': 123,
'PubliclyAccessible': True|False,
'Encrypted': True|False,
'RestoreStatus': {
'Status': 'string',
'CurrentRestoreRateInMegaBytesPerSecond': 123.0,
'SnapshotSizeInMegaBytes': 123,
'ProgressInMegaBytes': 123,
'ElapsedTimeInSeconds': 123,
'EstimatedTimeToCompletionInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'SnapshotCopyGrantName': 'string'
},
'ClusterPublicKey': 'string',
'ClusterNodes': [
{
'NodeRole': 'string',
'PrivateIPAddress': 'string',
'PublicIPAddress': 'string'
},
],
'ElasticIpStatus': {
'ElasticIp': 'string',
'Status': 'string'
},
'ClusterRevisionNumber': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'KmsKeyId': 'string'
}
}
Response Structure
(dict) --
Describes a cluster.
Cluster (dict) --
Describes a cluster.
ClusterIdentifier (string) --
The unique identifier of the cluster.
NodeType (string) --
The node type for the nodes in the cluster.
ClusterStatus (string) --
The current state of this cluster. Possible values include available, creating, deleting, rebooting, renaming, and resizing.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The master user name for the cluster. This name is used to connect to the database that is specified in DBName.
DBName (string) --
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named "dev" was created by default.
Endpoint (dict) --
The connection endpoint.
Address (string) --
The DNS address of the Cluster.
Port (integer) --
The port that the database engine is listening on.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ClusterSecurityGroups (list) --
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group.
Status (string) --
The status of the cluster security group.
VpcSecurityGroups (list) --
A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
Status (string) --
ClusterParameterGroups (list) --
The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
(dict) --
Describes the status of a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
ClusterParameterStatusList (list) --
The list of parameter statuses.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
(dict) --
Describes the status of a parameter group.
ParameterName (string) --
The name of the parameter.
ParameterApplyStatus (string) --
The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.
The following are possible statuses and descriptions.
in-sync: The parameter value is in sync with the database.
pending-reboot: The parameter value will be applied after the cluster reboots.
applying: The parameter value is being applied to the database.
invalid-parameter: Cannot apply the parameter value because it has an invalid value or syntax.
apply-deferred: The parameter contains static property changes. The changes are deferred until the cluster reboots.
apply-error: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.
unknown-error: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.
ParameterApplyErrorDescription (string) --
The error that prevented the parameter from being applied to the database.
ClusterSubnetGroupName (string) --
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
VpcId (string) --
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
AvailabilityZone (string) --
The name of the Availability Zone in which the cluster is located.
PreferredMaintenanceWindow (string) --
The weekly time range (in UTC) during which system maintenance can occur.
PendingModifiedValues (dict) --
If present, changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the master user password for the cluster.
NodeType (string) --
The pending or in-progress change of the cluster's node type.
NumberOfNodes (integer) --
The pending or in-progress change of the number of nodes in the cluster.
ClusterType (string) --
The pending or in-progress change of the cluster type.
ClusterVersion (string) --
The pending or in-progress change of the service version.
AutomatedSnapshotRetentionPeriod (integer) --
The pending or in-progress change of the automated snapshot retention period.
ClusterIdentifier (string) --
The pending or in-progress change of the new identifier for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
If true, major version upgrades will be applied automatically to the cluster during the maintenance window.
NumberOfNodes (integer) --
The number of compute nodes in the cluster.
PubliclyAccessible (boolean) --
If true, the cluster can be accessed from a public network.
Encrypted (boolean) --
If true, data in the cluster is encrypted at rest.
RestoreStatus (dict) --
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
Status (string) --
The status of the restore action. Returns starting, restoring, completed, or failed.
CurrentRestoreRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
HsmStatus (dict) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
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.
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.
Status (string) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
ClusterSnapshotCopyStatus (dict) --
Returns the destination region and retention period that are configured for cross-region snapshot copy.
DestinationRegion (string) --
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
RetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in a cluster.
(dict) --
The identifier of a node in a cluster.
NodeRole (string) --
Whether the node is a leader node or a compute node.
PrivateIPAddress (string) --
The private IP address of a node within a cluster.
PublicIPAddress (string) --
The public IP address of a node within a cluster.
ElasticIpStatus (dict) --
Describes the status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
Describes the status of the elastic IP (EIP) address.
ClusterRevisionNumber (string) --
The specific revision number of the database in the cluster.
Tags (list) --
The list of tags for the cluster.
(dict) --
A tag consisting of a name/value pair for a resource.
Key (string) --
The key, or name, for the resource tag.
Value (string) --
The value for the resource tag.
KmsKeyId (string) --
The AWS Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
{'Snapshot': {'RestorableNodeTypes': ['string']}}
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 Cluster Management Guide.
Request Syntax
client.create_cluster_snapshot(
SnapshotIdentifier='string',
ClusterIdentifier='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account.
Constraints:
Cannot be null, empty, or blank
Must contain from 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
string
[REQUIRED]
The cluster identifier for which you want a snapshot.
list
A list of tag instances.
(dict) --
A tag consisting of a name/value pair for a resource.
Key (string) --
The key, or name, for the resource tag.
Value (string) --
The value for the resource tag.
dict
Response Syntax
{
'Snapshot': {
'SnapshotIdentifier': 'string',
'ClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'ClusterVersion': 'string',
'SnapshotType': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'DBName': 'string',
'VpcId': 'string',
'Encrypted': True|False,
'KmsKeyId': 'string',
'EncryptedWithHSM': True|False,
'AccountsWithRestoreAccess': [
{
'AccountId': 'string'
},
],
'OwnerAccount': 'string',
'TotalBackupSizeInMegaBytes': 123.0,
'ActualIncrementalBackupSizeInMegaBytes': 123.0,
'BackupProgressInMegaBytes': 123.0,
'CurrentBackupRateInMegaBytesPerSecond': 123.0,
'EstimatedSecondsToCompletion': 123,
'ElapsedTimeInSeconds': 123,
'SourceRegion': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'RestorableNodeTypes': [
'string',
]
}
}
Response Structure
(dict) --
Describes a snapshot.
Snapshot (dict) --
Describes a snapshot.
SnapshotIdentifier (string) --
The snapshot identifier that is provided in the request.
ClusterIdentifier (string) --
The identifier of the cluster for which the snapshot was taken.
SnapshotCreateTime (datetime) --
The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.
Status (string) --
The snapshot status. The value of the status depends on the API operation used.
CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
DeleteClusterSnapshot returns status as "deleted".
Port (integer) --
The port that the cluster is listening on.
AvailabilityZone (string) --
The Availability Zone in which the cluster was created.
ClusterCreateTime (datetime) --
The time (UTC) when the cluster was originally created.
MasterUsername (string) --
The master user name for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
SnapshotType (string) --
The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".
NodeType (string) --
The node type of the nodes in the cluster.
NumberOfNodes (integer) --
The number of nodes in the cluster.
DBName (string) --
The name of the database that was created when the cluster was created.
VpcId (string) --
The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.
Encrypted (boolean) --
If true, the data in the snapshot is encrypted at rest.
KmsKeyId (string) --
The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.
EncryptedWithHSM (boolean) --
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.
AccountsWithRestoreAccess (list) --
A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
(dict) --
Describes an AWS customer account authorized to restore a snapshot.
AccountId (string) --
The identifier of an AWS customer account authorized to restore a snapshot.
OwnerAccount (string) --
For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
TotalBackupSizeInMegaBytes (float) --
The size of the complete set of backup data that would be used to restore the cluster.
ActualIncrementalBackupSizeInMegaBytes (float) --
The size of the incremental backup.
BackupProgressInMegaBytes (float) --
The number of megabytes that have been transferred to the snapshot backup.
CurrentBackupRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.
EstimatedSecondsToCompletion (integer) --
The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
SourceRegion (string) --
The source region from which the snapshot was copied.
Tags (list) --
The list of tags for the cluster snapshot.
(dict) --
A tag consisting of a name/value pair for a resource.
Key (string) --
The key, or name, for the resource tag.
Value (string) --
The value for the resource tag.
RestorableNodeTypes (list) --
The list of node types that this cluster snapshot is able to restore into.
(string) --
{'Cluster': {'ClusterParameterGroups': {'ClusterParameterStatusList': [{'ParameterApplyErrorDescription': 'string',
'ParameterApplyStatus': 'string',
'ParameterName': 'string'}]},
'ClusterSnapshotCopyStatus': {'SnapshotCopyGrantName': 'string'}}}
Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. 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 Cluster Management Guide .
If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to false and specify a name for FinalClusterSnapshotIdentifier. You can later restore this snapshot to resume using the cluster. 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.
For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide .
Request Syntax
client.delete_cluster(
ClusterIdentifier='string',
SkipFinalClusterSnapshot=True|False,
FinalClusterSnapshotIdentifier='string'
)
string
[REQUIRED]
The identifier of the cluster to be deleted.
Constraints:
Must contain lowercase characters.
Must contain from 1 to 63 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
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
string
The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.
Constraints:
Must be 1 to 255 alphanumeric characters.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterSecurityGroups': [
{
'ClusterSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'ClusterParameterGroups': [
{
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'ClusterParameterStatusList': [
{
'ParameterName': 'string',
'ParameterApplyStatus': 'string',
'ParameterApplyErrorDescription': 'string'
},
]
},
],
'ClusterSubnetGroupName': 'string',
'VpcId': 'string',
'AvailabilityZone': 'string',
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'MasterUserPassword': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'ClusterType': 'string',
'ClusterVersion': 'string',
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterIdentifier': 'string'
},
'ClusterVersion': 'string',
'AllowVersionUpgrade': True|False,
'NumberOfNodes': 123,
'PubliclyAccessible': True|False,
'Encrypted': True|False,
'RestoreStatus': {
'Status': 'string',
'CurrentRestoreRateInMegaBytesPerSecond': 123.0,
'SnapshotSizeInMegaBytes': 123,
'ProgressInMegaBytes': 123,
'ElapsedTimeInSeconds': 123,
'EstimatedTimeToCompletionInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'SnapshotCopyGrantName': 'string'
},
'ClusterPublicKey': 'string',
'ClusterNodes': [
{
'NodeRole': 'string',
'PrivateIPAddress': 'string',
'PublicIPAddress': 'string'
},
],
'ElasticIpStatus': {
'ElasticIp': 'string',
'Status': 'string'
},
'ClusterRevisionNumber': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'KmsKeyId': 'string'
}
}
Response Structure
(dict) --
Describes a cluster.
Cluster (dict) --
Describes a cluster.
ClusterIdentifier (string) --
The unique identifier of the cluster.
NodeType (string) --
The node type for the nodes in the cluster.
ClusterStatus (string) --
The current state of this cluster. Possible values include available, creating, deleting, rebooting, renaming, and resizing.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The master user name for the cluster. This name is used to connect to the database that is specified in DBName.
DBName (string) --
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named "dev" was created by default.
Endpoint (dict) --
The connection endpoint.
Address (string) --
The DNS address of the Cluster.
Port (integer) --
The port that the database engine is listening on.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ClusterSecurityGroups (list) --
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group.
Status (string) --
The status of the cluster security group.
VpcSecurityGroups (list) --
A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
Status (string) --
ClusterParameterGroups (list) --
The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
(dict) --
Describes the status of a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
ClusterParameterStatusList (list) --
The list of parameter statuses.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
(dict) --
Describes the status of a parameter group.
ParameterName (string) --
The name of the parameter.
ParameterApplyStatus (string) --
The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.
The following are possible statuses and descriptions.
in-sync: The parameter value is in sync with the database.
pending-reboot: The parameter value will be applied after the cluster reboots.
applying: The parameter value is being applied to the database.
invalid-parameter: Cannot apply the parameter value because it has an invalid value or syntax.
apply-deferred: The parameter contains static property changes. The changes are deferred until the cluster reboots.
apply-error: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.
unknown-error: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.
ParameterApplyErrorDescription (string) --
The error that prevented the parameter from being applied to the database.
ClusterSubnetGroupName (string) --
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
VpcId (string) --
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
AvailabilityZone (string) --
The name of the Availability Zone in which the cluster is located.
PreferredMaintenanceWindow (string) --
The weekly time range (in UTC) during which system maintenance can occur.
PendingModifiedValues (dict) --
If present, changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the master user password for the cluster.
NodeType (string) --
The pending or in-progress change of the cluster's node type.
NumberOfNodes (integer) --
The pending or in-progress change of the number of nodes in the cluster.
ClusterType (string) --
The pending or in-progress change of the cluster type.
ClusterVersion (string) --
The pending or in-progress change of the service version.
AutomatedSnapshotRetentionPeriod (integer) --
The pending or in-progress change of the automated snapshot retention period.
ClusterIdentifier (string) --
The pending or in-progress change of the new identifier for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
If true, major version upgrades will be applied automatically to the cluster during the maintenance window.
NumberOfNodes (integer) --
The number of compute nodes in the cluster.
PubliclyAccessible (boolean) --
If true, the cluster can be accessed from a public network.
Encrypted (boolean) --
If true, data in the cluster is encrypted at rest.
RestoreStatus (dict) --
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
Status (string) --
The status of the restore action. Returns starting, restoring, completed, or failed.
CurrentRestoreRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
HsmStatus (dict) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
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.
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.
Status (string) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
ClusterSnapshotCopyStatus (dict) --
Returns the destination region and retention period that are configured for cross-region snapshot copy.
DestinationRegion (string) --
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
RetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in a cluster.
(dict) --
The identifier of a node in a cluster.
NodeRole (string) --
Whether the node is a leader node or a compute node.
PrivateIPAddress (string) --
The private IP address of a node within a cluster.
PublicIPAddress (string) --
The public IP address of a node within a cluster.
ElasticIpStatus (dict) --
Describes the status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
Describes the status of the elastic IP (EIP) address.
ClusterRevisionNumber (string) --
The specific revision number of the database in the cluster.
Tags (list) --
The list of tags for the cluster.
(dict) --
A tag consisting of a name/value pair for a resource.
Key (string) --
The key, or name, for the resource tag.
Value (string) --
The value for the resource tag.
KmsKeyId (string) --
The AWS Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
{'Snapshot': {'RestorableNodeTypes': ['string']}}
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.
Request Syntax
client.delete_cluster_snapshot(
SnapshotIdentifier='string',
SnapshotClusterIdentifier='string'
)
string
[REQUIRED]
The unique identifier of the manual snapshot to be deleted.
Constraints: Must be the name of an existing snapshot that is in the available state.
string
The unique 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.
Constraints: Must be the name of valid cluster.
dict
Response Syntax
{
'Snapshot': {
'SnapshotIdentifier': 'string',
'ClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'ClusterVersion': 'string',
'SnapshotType': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'DBName': 'string',
'VpcId': 'string',
'Encrypted': True|False,
'KmsKeyId': 'string',
'EncryptedWithHSM': True|False,
'AccountsWithRestoreAccess': [
{
'AccountId': 'string'
},
],
'OwnerAccount': 'string',
'TotalBackupSizeInMegaBytes': 123.0,
'ActualIncrementalBackupSizeInMegaBytes': 123.0,
'BackupProgressInMegaBytes': 123.0,
'CurrentBackupRateInMegaBytesPerSecond': 123.0,
'EstimatedSecondsToCompletion': 123,
'ElapsedTimeInSeconds': 123,
'SourceRegion': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'RestorableNodeTypes': [
'string',
]
}
}
Response Structure
(dict) --
Describes a snapshot.
Snapshot (dict) --
Describes a snapshot.
SnapshotIdentifier (string) --
The snapshot identifier that is provided in the request.
ClusterIdentifier (string) --
The identifier of the cluster for which the snapshot was taken.
SnapshotCreateTime (datetime) --
The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.
Status (string) --
The snapshot status. The value of the status depends on the API operation used.
CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
DeleteClusterSnapshot returns status as "deleted".
Port (integer) --
The port that the cluster is listening on.
AvailabilityZone (string) --
The Availability Zone in which the cluster was created.
ClusterCreateTime (datetime) --
The time (UTC) when the cluster was originally created.
MasterUsername (string) --
The master user name for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
SnapshotType (string) --
The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".
NodeType (string) --
The node type of the nodes in the cluster.
NumberOfNodes (integer) --
The number of nodes in the cluster.
DBName (string) --
The name of the database that was created when the cluster was created.
VpcId (string) --
The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.
Encrypted (boolean) --
If true, the data in the snapshot is encrypted at rest.
KmsKeyId (string) --
The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.
EncryptedWithHSM (boolean) --
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.
AccountsWithRestoreAccess (list) --
A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
(dict) --
Describes an AWS customer account authorized to restore a snapshot.
AccountId (string) --
The identifier of an AWS customer account authorized to restore a snapshot.
OwnerAccount (string) --
For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
TotalBackupSizeInMegaBytes (float) --
The size of the complete set of backup data that would be used to restore the cluster.
ActualIncrementalBackupSizeInMegaBytes (float) --
The size of the incremental backup.
BackupProgressInMegaBytes (float) --
The number of megabytes that have been transferred to the snapshot backup.
CurrentBackupRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.
EstimatedSecondsToCompletion (integer) --
The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
SourceRegion (string) --
The source region from which the snapshot was copied.
Tags (list) --
The list of tags for the cluster snapshot.
(dict) --
A tag consisting of a name/value pair for a resource.
Key (string) --
The key, or name, for the resource tag.
Value (string) --
The value for the resource tag.
RestorableNodeTypes (list) --
The list of node types that this cluster snapshot is able to restore into.
(string) --
{'Parameters': {'ApplyType': 'static | dynamic'}}
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 parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
Request Syntax
client.describe_cluster_parameters(
ParameterGroupName='string',
Source='string',
MaxRecords=123,
Marker='string'
)
string
[REQUIRED]
The name of a cluster parameter group for which to return details.
string
The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.
Default: All parameter types returned.
Valid Values: user | engine-default
integer
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
string
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
dict
Response Syntax
{
'Parameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'ApplyType': 'static'|'dynamic',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string'
},
],
'Marker': 'string'
}
Response Structure
(dict) --
Contains the output from the DescribeClusterParameters action.
Parameters (list) --
A list of Parameter instances. Each instance lists the parameters of one cluster parameter group.
(dict) --
Describes a parameter in a cluster parameter group.
ParameterName (string) --
The name of the parameter.
ParameterValue (string) --
The value of the parameter.
Description (string) --
A description of the parameter.
Source (string) --
The source of the parameter value, such as "engine-default" or "user".
DataType (string) --
The data type of the parameter.
AllowedValues (string) --
The valid range of values for the parameter.
ApplyType (string) --
Specifies how to apply the parameter. Supported value: static.
IsModifiable (boolean) --
If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion (string) --
The earliest engine version to which the parameter can apply.
Marker (string) --
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
{'Snapshots': {'RestorableNodeTypes': ['string']}}
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.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters.
If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.
Request Syntax
client.describe_cluster_snapshots(
ClusterIdentifier='string',
SnapshotIdentifier='string',
SnapshotType='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
MaxRecords=123,
Marker='string',
OwnerAccount='string',
TagKeys=[
'string',
],
TagValues=[
'string',
]
)
string
The identifier of the cluster for which information about snapshots is requested.
string
The snapshot identifier of the snapshot about which to return information.
string
The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.
Valid Values: automated | manual
datetime
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
datetime
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
integer
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
string
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
string
The AWS customer account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your AWS customer account, or do not specify the parameter.
list
A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.
(string) --
list
A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.
(string) --
dict
Response Syntax
{
'Marker': 'string',
'Snapshots': [
{
'SnapshotIdentifier': 'string',
'ClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'ClusterVersion': 'string',
'SnapshotType': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'DBName': 'string',
'VpcId': 'string',
'Encrypted': True|False,
'KmsKeyId': 'string',
'EncryptedWithHSM': True|False,
'AccountsWithRestoreAccess': [
{
'AccountId': 'string'
},
],
'OwnerAccount': 'string',
'TotalBackupSizeInMegaBytes': 123.0,
'ActualIncrementalBackupSizeInMegaBytes': 123.0,
'BackupProgressInMegaBytes': 123.0,
'CurrentBackupRateInMegaBytesPerSecond': 123.0,
'EstimatedSecondsToCompletion': 123,
'ElapsedTimeInSeconds': 123,
'SourceRegion': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'RestorableNodeTypes': [
'string',
]
},
]
}
Response Structure
(dict) --
Contains the output from the DescribeClusterSnapshots action.
Marker (string) --
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
Snapshots (list) --
A list of Snapshot instances.
(dict) --
Describes a snapshot.
SnapshotIdentifier (string) --
The snapshot identifier that is provided in the request.
ClusterIdentifier (string) --
The identifier of the cluster for which the snapshot was taken.
SnapshotCreateTime (datetime) --
The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.
Status (string) --
The snapshot status. The value of the status depends on the API operation used.
CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
DeleteClusterSnapshot returns status as "deleted".
Port (integer) --
The port that the cluster is listening on.
AvailabilityZone (string) --
The Availability Zone in which the cluster was created.
ClusterCreateTime (datetime) --
The time (UTC) when the cluster was originally created.
MasterUsername (string) --
The master user name for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
SnapshotType (string) --
The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".
NodeType (string) --
The node type of the nodes in the cluster.
NumberOfNodes (integer) --
The number of nodes in the cluster.
DBName (string) --
The name of the database that was created when the cluster was created.
VpcId (string) --
The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.
Encrypted (boolean) --
If true, the data in the snapshot is encrypted at rest.
KmsKeyId (string) --
The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.
EncryptedWithHSM (boolean) --
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.
AccountsWithRestoreAccess (list) --
A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
(dict) --
Describes an AWS customer account authorized to restore a snapshot.
AccountId (string) --
The identifier of an AWS customer account authorized to restore a snapshot.
OwnerAccount (string) --
For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
TotalBackupSizeInMegaBytes (float) --
The size of the complete set of backup data that would be used to restore the cluster.
ActualIncrementalBackupSizeInMegaBytes (float) --
The size of the incremental backup.
BackupProgressInMegaBytes (float) --
The number of megabytes that have been transferred to the snapshot backup.
CurrentBackupRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.
EstimatedSecondsToCompletion (integer) --
The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
SourceRegion (string) --
The source region from which the snapshot was copied.
Tags (list) --
The list of tags for the cluster snapshot.
(dict) --
A tag consisting of a name/value pair for a resource.
Key (string) --
The key, or name, for the resource tag.
Value (string) --
The value for the resource tag.
RestorableNodeTypes (list) --
The list of node types that this cluster snapshot is able to restore into.
(string) --
{'Clusters': {'ClusterParameterGroups': {'ClusterParameterStatusList': [{'ParameterApplyErrorDescription': 'string',
'ParameterApplyStatus': 'string',
'ParameterName': 'string'}]},
'ClusterSnapshotCopyStatus': {'SnapshotCopyGrantName': 'string'}}}
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 Cluster Management Guide .
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all clusters that have any combination of those values are returned.
If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.
Request Syntax
client.describe_clusters(
ClusterIdentifier='string',
MaxRecords=123,
Marker='string',
TagKeys=[
'string',
],
TagValues=[
'string',
]
)
string
The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.
The default is that all clusters defined for an account are returned.
integer
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
string
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.
list
A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.
(string) --
list
A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.
(string) --
dict
Response Syntax
{
'Marker': 'string',
'Clusters': [
{
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterSecurityGroups': [
{
'ClusterSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'ClusterParameterGroups': [
{
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'ClusterParameterStatusList': [
{
'ParameterName': 'string',
'ParameterApplyStatus': 'string',
'ParameterApplyErrorDescription': 'string'
},
]
},
],
'ClusterSubnetGroupName': 'string',
'VpcId': 'string',
'AvailabilityZone': 'string',
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'MasterUserPassword': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'ClusterType': 'string',
'ClusterVersion': 'string',
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterIdentifier': 'string'
},
'ClusterVersion': 'string',
'AllowVersionUpgrade': True|False,
'NumberOfNodes': 123,
'PubliclyAccessible': True|False,
'Encrypted': True|False,
'RestoreStatus': {
'Status': 'string',
'CurrentRestoreRateInMegaBytesPerSecond': 123.0,
'SnapshotSizeInMegaBytes': 123,
'ProgressInMegaBytes': 123,
'ElapsedTimeInSeconds': 123,
'EstimatedTimeToCompletionInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'SnapshotCopyGrantName': 'string'
},
'ClusterPublicKey': 'string',
'ClusterNodes': [
{
'NodeRole': 'string',
'PrivateIPAddress': 'string',
'PublicIPAddress': 'string'
},
],
'ElasticIpStatus': {
'ElasticIp': 'string',
'Status': 'string'
},
'ClusterRevisionNumber': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'KmsKeyId': 'string'
},
]
}
Response Structure
(dict) --
Contains the output from the DescribeClusters action.
Marker (string) --
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
Clusters (list) --
A list of Cluster objects, where each object describes one cluster.
(dict) --
Describes a cluster.
ClusterIdentifier (string) --
The unique identifier of the cluster.
NodeType (string) --
The node type for the nodes in the cluster.
ClusterStatus (string) --
The current state of this cluster. Possible values include available, creating, deleting, rebooting, renaming, and resizing.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The master user name for the cluster. This name is used to connect to the database that is specified in DBName.
DBName (string) --
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named "dev" was created by default.
Endpoint (dict) --
The connection endpoint.
Address (string) --
The DNS address of the Cluster.
Port (integer) --
The port that the database engine is listening on.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ClusterSecurityGroups (list) --
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group.
Status (string) --
The status of the cluster security group.
VpcSecurityGroups (list) --
A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
Status (string) --
ClusterParameterGroups (list) --
The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
(dict) --
Describes the status of a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
ClusterParameterStatusList (list) --
The list of parameter statuses.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
(dict) --
Describes the status of a parameter group.
ParameterName (string) --
The name of the parameter.
ParameterApplyStatus (string) --
The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.
The following are possible statuses and descriptions.
in-sync: The parameter value is in sync with the database.
pending-reboot: The parameter value will be applied after the cluster reboots.
applying: The parameter value is being applied to the database.
invalid-parameter: Cannot apply the parameter value because it has an invalid value or syntax.
apply-deferred: The parameter contains static property changes. The changes are deferred until the cluster reboots.
apply-error: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.
unknown-error: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.
ParameterApplyErrorDescription (string) --
The error that prevented the parameter from being applied to the database.
ClusterSubnetGroupName (string) --
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
VpcId (string) --
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
AvailabilityZone (string) --
The name of the Availability Zone in which the cluster is located.
PreferredMaintenanceWindow (string) --
The weekly time range (in UTC) during which system maintenance can occur.
PendingModifiedValues (dict) --
If present, changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the master user password for the cluster.
NodeType (string) --
The pending or in-progress change of the cluster's node type.
NumberOfNodes (integer) --
The pending or in-progress change of the number of nodes in the cluster.
ClusterType (string) --
The pending or in-progress change of the cluster type.
ClusterVersion (string) --
The pending or in-progress change of the service version.
AutomatedSnapshotRetentionPeriod (integer) --
The pending or in-progress change of the automated snapshot retention period.
ClusterIdentifier (string) --
The pending or in-progress change of the new identifier for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
If true, major version upgrades will be applied automatically to the cluster during the maintenance window.
NumberOfNodes (integer) --
The number of compute nodes in the cluster.
PubliclyAccessible (boolean) --
If true, the cluster can be accessed from a public network.
Encrypted (boolean) --
If true, data in the cluster is encrypted at rest.
RestoreStatus (dict) --
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
Status (string) --
The status of the restore action. Returns starting, restoring, completed, or failed.
CurrentRestoreRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
HsmStatus (dict) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
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.
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.
Status (string) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
ClusterSnapshotCopyStatus (dict) --
Returns the destination region and retention period that are configured for cross-region snapshot copy.
DestinationRegion (string) --
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
RetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in a cluster.
(dict) --
The identifier of a node in a cluster.
NodeRole (string) --
Whether the node is a leader node or a compute node.
PrivateIPAddress (string) --
The private IP address of a node within a cluster.
PublicIPAddress (string) --
The public IP address of a node within a cluster.
ElasticIpStatus (dict) --
Describes the status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
Describes the status of the elastic IP (EIP) address.
ClusterRevisionNumber (string) --
The specific revision number of the database in the cluster.
Tags (list) --
The list of tags for the cluster.
(dict) --
A tag consisting of a name/value pair for a resource.
Key (string) --
The key, or name, for the resource tag.
Value (string) --
The value for the resource tag.
KmsKeyId (string) --
The AWS Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
{'DefaultClusterParameters': {'Parameters': {'ApplyType': 'static | dynamic'}}}
Returns a list of parameter settings for the specified parameter group family.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
Request Syntax
client.describe_default_cluster_parameters(
ParameterGroupFamily='string',
MaxRecords=123,
Marker='string'
)
string
[REQUIRED]
The name of the cluster parameter group family.
integer
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
string
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDefaultClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
dict
Response Syntax
{
'DefaultClusterParameters': {
'ParameterGroupFamily': 'string',
'Marker': 'string',
'Parameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'ApplyType': 'static'|'dynamic',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string'
},
]
}
}
Response Structure
(dict) --
Describes the default cluster parameters for a parameter group family.
DefaultClusterParameters (dict) --
Describes the default cluster parameters for a parameter group family.
ParameterGroupFamily (string) --
The name of the cluster parameter group family to which the engine default parameters apply.
Marker (string) --
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
Parameters (list) --
The list of cluster default parameters.
(dict) --
Describes a parameter in a cluster parameter group.
ParameterName (string) --
The name of the parameter.
ParameterValue (string) --
The value of the parameter.
Description (string) --
A description of the parameter.
Source (string) --
The source of the parameter value, such as "engine-default" or "user".
DataType (string) --
The data type of the parameter.
AllowedValues (string) --
The valid range of values for the parameter.
ApplyType (string) --
Specifies how to apply the parameter. Supported value: static.
IsModifiable (boolean) --
If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion (string) --
The earliest engine version to which the parameter can apply.
{'Cluster': {'ClusterParameterGroups': {'ClusterParameterStatusList': [{'ParameterApplyErrorDescription': 'string',
'ParameterApplyStatus': 'string',
'ParameterName': 'string'}]},
'ClusterSnapshotCopyStatus': {'SnapshotCopyGrantName': 'string'}}}
Disables the automatic copying of snapshots from one region to another region for a specified cluster.
If your cluster and its snapshots are encrypted using a customer master key (CMK) from AWS KMS, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the CMK in the destination region.
Request Syntax
client.disable_snapshot_copy(
ClusterIdentifier='string'
)
string
[REQUIRED]
The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterSecurityGroups': [
{
'ClusterSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'ClusterParameterGroups': [
{
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'ClusterParameterStatusList': [
{
'ParameterName': 'string',
'ParameterApplyStatus': 'string',
'ParameterApplyErrorDescription': 'string'
},
]
},
],
'ClusterSubnetGroupName': 'string',
'VpcId': 'string',
'AvailabilityZone': 'string',
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'MasterUserPassword': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'ClusterType': 'string',
'ClusterVersion': 'string',
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterIdentifier': 'string'
},
'ClusterVersion': 'string',
'AllowVersionUpgrade': True|False,
'NumberOfNodes': 123,
'PubliclyAccessible': True|False,
'Encrypted': True|False,
'RestoreStatus': {
'Status': 'string',
'CurrentRestoreRateInMegaBytesPerSecond': 123.0,
'SnapshotSizeInMegaBytes': 123,
'ProgressInMegaBytes': 123,
'ElapsedTimeInSeconds': 123,
'EstimatedTimeToCompletionInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'SnapshotCopyGrantName': 'string'
},
'ClusterPublicKey': 'string',
'ClusterNodes': [
{
'NodeRole': 'string',
'PrivateIPAddress': 'string',
'PublicIPAddress': 'string'
},
],
'ElasticIpStatus': {
'ElasticIp': 'string',
'Status': 'string'
},
'ClusterRevisionNumber': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'KmsKeyId': 'string'
}
}
Response Structure
(dict) --
Describes a cluster.
Cluster (dict) --
Describes a cluster.
ClusterIdentifier (string) --
The unique identifier of the cluster.
NodeType (string) --
The node type for the nodes in the cluster.
ClusterStatus (string) --
The current state of this cluster. Possible values include available, creating, deleting, rebooting, renaming, and resizing.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The master user name for the cluster. This name is used to connect to the database that is specified in DBName.
DBName (string) --
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named "dev" was created by default.
Endpoint (dict) --
The connection endpoint.
Address (string) --
The DNS address of the Cluster.
Port (integer) --
The port that the database engine is listening on.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ClusterSecurityGroups (list) --
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group.
Status (string) --
The status of the cluster security group.
VpcSecurityGroups (list) --
A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
Status (string) --
ClusterParameterGroups (list) --
The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
(dict) --
Describes the status of a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
ClusterParameterStatusList (list) --
The list of parameter statuses.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
(dict) --
Describes the status of a parameter group.
ParameterName (string) --
The name of the parameter.
ParameterApplyStatus (string) --
The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.
The following are possible statuses and descriptions.
in-sync: The parameter value is in sync with the database.
pending-reboot: The parameter value will be applied after the cluster reboots.
applying: The parameter value is being applied to the database.
invalid-parameter: Cannot apply the parameter value because it has an invalid value or syntax.
apply-deferred: The parameter contains static property changes. The changes are deferred until the cluster reboots.
apply-error: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.
unknown-error: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.
ParameterApplyErrorDescription (string) --
The error that prevented the parameter from being applied to the database.
ClusterSubnetGroupName (string) --
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
VpcId (string) --
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
AvailabilityZone (string) --
The name of the Availability Zone in which the cluster is located.
PreferredMaintenanceWindow (string) --
The weekly time range (in UTC) during which system maintenance can occur.
PendingModifiedValues (dict) --
If present, changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the master user password for the cluster.
NodeType (string) --
The pending or in-progress change of the cluster's node type.
NumberOfNodes (integer) --
The pending or in-progress change of the number of nodes in the cluster.
ClusterType (string) --
The pending or in-progress change of the cluster type.
ClusterVersion (string) --
The pending or in-progress change of the service version.
AutomatedSnapshotRetentionPeriod (integer) --
The pending or in-progress change of the automated snapshot retention period.
ClusterIdentifier (string) --
The pending or in-progress change of the new identifier for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
If true, major version upgrades will be applied automatically to the cluster during the maintenance window.
NumberOfNodes (integer) --
The number of compute nodes in the cluster.
PubliclyAccessible (boolean) --
If true, the cluster can be accessed from a public network.
Encrypted (boolean) --
If true, data in the cluster is encrypted at rest.
RestoreStatus (dict) --
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
Status (string) --
The status of the restore action. Returns starting, restoring, completed, or failed.
CurrentRestoreRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
HsmStatus (dict) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
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.
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.
Status (string) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
ClusterSnapshotCopyStatus (dict) --
Returns the destination region and retention period that are configured for cross-region snapshot copy.
DestinationRegion (string) --
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
RetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in a cluster.
(dict) --
The identifier of a node in a cluster.
NodeRole (string) --
Whether the node is a leader node or a compute node.
PrivateIPAddress (string) --
The private IP address of a node within a cluster.
PublicIPAddress (string) --
The public IP address of a node within a cluster.
ElasticIpStatus (dict) --
Describes the status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
Describes the status of the elastic IP (EIP) address.
ClusterRevisionNumber (string) --
The specific revision number of the database in the cluster.
Tags (list) --
The list of tags for the cluster.
(dict) --
A tag consisting of a name/value pair for a resource.
Key (string) --
The key, or name, for the resource tag.
Value (string) --
The value for the resource tag.
KmsKeyId (string) --
The AWS Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
{'SnapshotCopyGrantName': 'string'}
Response {'Cluster': {'ClusterParameterGroups': {'ClusterParameterStatusList': [{'ParameterApplyErrorDescription': 'string',
'ParameterApplyStatus': 'string',
'ParameterName': 'string'}]},
'ClusterSnapshotCopyStatus': {'SnapshotCopyGrantName': 'string'}}}
Enables the automatic copy of snapshots from one region to another region for a specified cluster.
Request Syntax
client.enable_snapshot_copy(
ClusterIdentifier='string',
DestinationRegion='string',
RetentionPeriod=123,
SnapshotCopyGrantName='string'
)
string
[REQUIRED]
The unique identifier of the source cluster to copy snapshots from.
Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.
string
[REQUIRED]
The destination region that you want to copy snapshots to.
Constraints: Must be the name of a valid region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.
integer
The number of days to retain automated snapshots in the destination region after they are copied from the source region.
Default: 7.
Constraints: Must be at least 1 and no more than 35.
string
The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterSecurityGroups': [
{
'ClusterSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'ClusterParameterGroups': [
{
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'ClusterParameterStatusList': [
{
'ParameterName': 'string',
'ParameterApplyStatus': 'string',
'ParameterApplyErrorDescription': 'string'
},
]
},
],
'ClusterSubnetGroupName': 'string',
'VpcId': 'string',
'AvailabilityZone': 'string',
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'MasterUserPassword': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'ClusterType': 'string',
'ClusterVersion': 'string',
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterIdentifier': 'string'
},
'ClusterVersion': 'string',
'AllowVersionUpgrade': True|False,
'NumberOfNodes': 123,
'PubliclyAccessible': True|False,
'Encrypted': True|False,
'RestoreStatus': {
'Status': 'string',
'CurrentRestoreRateInMegaBytesPerSecond': 123.0,
'SnapshotSizeInMegaBytes': 123,
'ProgressInMegaBytes': 123,
'ElapsedTimeInSeconds': 123,
'EstimatedTimeToCompletionInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'SnapshotCopyGrantName': 'string'
},
'ClusterPublicKey': 'string',
'ClusterNodes': [
{
'NodeRole': 'string',
'PrivateIPAddress': 'string',
'PublicIPAddress': 'string'
},
],
'ElasticIpStatus': {
'ElasticIp': 'string',
'Status': 'string'
},
'ClusterRevisionNumber': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'KmsKeyId': 'string'
}
}
Response Structure
(dict) --
Describes a cluster.
Cluster (dict) --
Describes a cluster.
ClusterIdentifier (string) --
The unique identifier of the cluster.
NodeType (string) --
The node type for the nodes in the cluster.
ClusterStatus (string) --
The current state of this cluster. Possible values include available, creating, deleting, rebooting, renaming, and resizing.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The master user name for the cluster. This name is used to connect to the database that is specified in DBName.
DBName (string) --
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named "dev" was created by default.
Endpoint (dict) --
The connection endpoint.
Address (string) --
The DNS address of the Cluster.
Port (integer) --
The port that the database engine is listening on.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ClusterSecurityGroups (list) --
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group.
Status (string) --
The status of the cluster security group.
VpcSecurityGroups (list) --
A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
Status (string) --
ClusterParameterGroups (list) --
The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
(dict) --
Describes the status of a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
ClusterParameterStatusList (list) --
The list of parameter statuses.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
(dict) --
Describes the status of a parameter group.
ParameterName (string) --
The name of the parameter.
ParameterApplyStatus (string) --
The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.
The following are possible statuses and descriptions.
in-sync: The parameter value is in sync with the database.
pending-reboot: The parameter value will be applied after the cluster reboots.
applying: The parameter value is being applied to the database.
invalid-parameter: Cannot apply the parameter value because it has an invalid value or syntax.
apply-deferred: The parameter contains static property changes. The changes are deferred until the cluster reboots.
apply-error: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.
unknown-error: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.
ParameterApplyErrorDescription (string) --
The error that prevented the parameter from being applied to the database.
ClusterSubnetGroupName (string) --
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
VpcId (string) --
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
AvailabilityZone (string) --
The name of the Availability Zone in which the cluster is located.
PreferredMaintenanceWindow (string) --
The weekly time range (in UTC) during which system maintenance can occur.
PendingModifiedValues (dict) --
If present, changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the master user password for the cluster.
NodeType (string) --
The pending or in-progress change of the cluster's node type.
NumberOfNodes (integer) --
The pending or in-progress change of the number of nodes in the cluster.
ClusterType (string) --
The pending or in-progress change of the cluster type.
ClusterVersion (string) --
The pending or in-progress change of the service version.
AutomatedSnapshotRetentionPeriod (integer) --
The pending or in-progress change of the automated snapshot retention period.
ClusterIdentifier (string) --
The pending or in-progress change of the new identifier for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
If true, major version upgrades will be applied automatically to the cluster during the maintenance window.
NumberOfNodes (integer) --
The number of compute nodes in the cluster.
PubliclyAccessible (boolean) --
If true, the cluster can be accessed from a public network.
Encrypted (boolean) --
If true, data in the cluster is encrypted at rest.
RestoreStatus (dict) --
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
Status (string) --
The status of the restore action. Returns starting, restoring, completed, or failed.
CurrentRestoreRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
HsmStatus (dict) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
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.
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.
Status (string) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
ClusterSnapshotCopyStatus (dict) --
Returns the destination region and retention period that are configured for cross-region snapshot copy.
DestinationRegion (string) --
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
RetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in a cluster.
(dict) --
The identifier of a node in a cluster.
NodeRole (string) --
Whether the node is a leader node or a compute node.
PrivateIPAddress (string) --
The private IP address of a node within a cluster.
PublicIPAddress (string) --
The public IP address of a node within a cluster.
ElasticIpStatus (dict) --
Describes the status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
Describes the status of the elastic IP (EIP) address.
ClusterRevisionNumber (string) --
The specific revision number of the database in the cluster.
Tags (list) --
The list of tags for the cluster.
(dict) --
A tag consisting of a name/value pair for a resource.
Key (string) --
The key, or name, for the resource tag.
Value (string) --
The value for the resource tag.
KmsKeyId (string) --
The AWS Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
{'Cluster': {'ClusterParameterGroups': {'ClusterParameterStatusList': [{'ParameterApplyErrorDescription': 'string',
'ParameterApplyStatus': 'string',
'ParameterName': 'string'}]},
'ClusterSnapshotCopyStatus': {'SnapshotCopyGrantName': 'string'}}}
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 a 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 Cluster 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.
Request Syntax
client.modify_cluster(
ClusterIdentifier='string',
ClusterType='string',
NodeType='string',
NumberOfNodes=123,
ClusterSecurityGroups=[
'string',
],
VpcSecurityGroupIds=[
'string',
],
MasterUserPassword='string',
ClusterParameterGroupName='string',
AutomatedSnapshotRetentionPeriod=123,
PreferredMaintenanceWindow='string',
ClusterVersion='string',
AllowVersionUpgrade=True|False,
HsmClientCertificateIdentifier='string',
HsmConfigurationIdentifier='string',
NewClusterIdentifier='string'
)
string
[REQUIRED]
The unique identifier of the cluster to be modified.
Example: examplecluster
string
The new cluster type.
When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.
Valid Values: multi-node | single-node
string
The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.
When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.
Valid Values: ds1.xlarge | ds1.8xlarge | ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge.
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.
When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.
Valid Values: Integer greater than 0.
list
A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible.
Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
(string) --
list
A list of virtual private cloud (VPC) security groups to be associated with the cluster.
(string) --
string
The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
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.
Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), , /, @, or space.
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.
Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.
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.
If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.
Default: Uses existing setting.
Constraints: Must be a value from 0 to 35.
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.
This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied.
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.
string
The new version number of the Amazon Redshift engine to upgrade to.
For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
Example: 1.0
boolean
If true, major version upgrades will be applied automatically to the cluster during the maintenance window.
Default: false
string
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
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.
string
The new identifier for the cluster.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
Example: examplecluster
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterSecurityGroups': [
{
'ClusterSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'ClusterParameterGroups': [
{
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'ClusterParameterStatusList': [
{
'ParameterName': 'string',
'ParameterApplyStatus': 'string',
'ParameterApplyErrorDescription': 'string'
},
]
},
],
'ClusterSubnetGroupName': 'string',
'VpcId': 'string',
'AvailabilityZone': 'string',
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'MasterUserPassword': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'ClusterType': 'string',
'ClusterVersion': 'string',
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterIdentifier': 'string'
},
'ClusterVersion': 'string',
'AllowVersionUpgrade': True|False,
'NumberOfNodes': 123,
'PubliclyAccessible': True|False,
'Encrypted': True|False,
'RestoreStatus': {
'Status': 'string',
'CurrentRestoreRateInMegaBytesPerSecond': 123.0,
'SnapshotSizeInMegaBytes': 123,
'ProgressInMegaBytes': 123,
'ElapsedTimeInSeconds': 123,
'EstimatedTimeToCompletionInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'SnapshotCopyGrantName': 'string'
},
'ClusterPublicKey': 'string',
'ClusterNodes': [
{
'NodeRole': 'string',
'PrivateIPAddress': 'string',
'PublicIPAddress': 'string'
},
],
'ElasticIpStatus': {
'ElasticIp': 'string',
'Status': 'string'
},
'ClusterRevisionNumber': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'KmsKeyId': 'string'
}
}
Response Structure
(dict) --
Describes a cluster.
Cluster (dict) --
Describes a cluster.
ClusterIdentifier (string) --
The unique identifier of the cluster.
NodeType (string) --
The node type for the nodes in the cluster.
ClusterStatus (string) --
The current state of this cluster. Possible values include available, creating, deleting, rebooting, renaming, and resizing.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The master user name for the cluster. This name is used to connect to the database that is specified in DBName.
DBName (string) --
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named "dev" was created by default.
Endpoint (dict) --
The connection endpoint.
Address (string) --
The DNS address of the Cluster.
Port (integer) --
The port that the database engine is listening on.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ClusterSecurityGroups (list) --
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group.
Status (string) --
The status of the cluster security group.
VpcSecurityGroups (list) --
A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
Status (string) --
ClusterParameterGroups (list) --
The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
(dict) --
Describes the status of a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
ClusterParameterStatusList (list) --
The list of parameter statuses.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
(dict) --
Describes the status of a parameter group.
ParameterName (string) --
The name of the parameter.
ParameterApplyStatus (string) --
The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.
The following are possible statuses and descriptions.
in-sync: The parameter value is in sync with the database.
pending-reboot: The parameter value will be applied after the cluster reboots.
applying: The parameter value is being applied to the database.
invalid-parameter: Cannot apply the parameter value because it has an invalid value or syntax.
apply-deferred: The parameter contains static property changes. The changes are deferred until the cluster reboots.
apply-error: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.
unknown-error: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.
ParameterApplyErrorDescription (string) --
The error that prevented the parameter from being applied to the database.
ClusterSubnetGroupName (string) --
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
VpcId (string) --
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
AvailabilityZone (string) --
The name of the Availability Zone in which the cluster is located.
PreferredMaintenanceWindow (string) --
The weekly time range (in UTC) during which system maintenance can occur.
PendingModifiedValues (dict) --
If present, changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the master user password for the cluster.
NodeType (string) --
The pending or in-progress change of the cluster's node type.
NumberOfNodes (integer) --
The pending or in-progress change of the number of nodes in the cluster.
ClusterType (string) --
The pending or in-progress change of the cluster type.
ClusterVersion (string) --
The pending or in-progress change of the service version.
AutomatedSnapshotRetentionPeriod (integer) --
The pending or in-progress change of the automated snapshot retention period.
ClusterIdentifier (string) --
The pending or in-progress change of the new identifier for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
If true, major version upgrades will be applied automatically to the cluster during the maintenance window.
NumberOfNodes (integer) --
The number of compute nodes in the cluster.
PubliclyAccessible (boolean) --
If true, the cluster can be accessed from a public network.
Encrypted (boolean) --
If true, data in the cluster is encrypted at rest.
RestoreStatus (dict) --
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
Status (string) --
The status of the restore action. Returns starting, restoring, completed, or failed.
CurrentRestoreRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
HsmStatus (dict) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
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.
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.
Status (string) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
ClusterSnapshotCopyStatus (dict) --
Returns the destination region and retention period that are configured for cross-region snapshot copy.
DestinationRegion (string) --
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
RetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in a cluster.
(dict) --
The identifier of a node in a cluster.
NodeRole (string) --
Whether the node is a leader node or a compute node.
PrivateIPAddress (string) --
The private IP address of a node within a cluster.
PublicIPAddress (string) --
The public IP address of a node within a cluster.
ElasticIpStatus (dict) --
Describes the status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
Describes the status of the elastic IP (EIP) address.
ClusterRevisionNumber (string) --
The specific revision number of the database in the cluster.
Tags (list) --
The list of tags for the cluster.
(dict) --
A tag consisting of a name/value pair for a resource.
Key (string) --
The key, or name, for the resource tag.
Value (string) --
The value for the resource tag.
KmsKeyId (string) --
The AWS Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
{'Parameters': {'ApplyType': 'static | dynamic'}}
Modifies the parameters of a parameter group.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
Request Syntax
client.modify_cluster_parameter_group(
ParameterGroupName='string',
Parameters=[
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'ApplyType': 'static'|'dynamic',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string'
},
]
)
string
[REQUIRED]
The name of the parameter group to be modified.
list
[REQUIRED]
An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.
For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.
(dict) --
Describes a parameter in a cluster parameter group.
ParameterName (string) --
The name of the parameter.
ParameterValue (string) --
The value of the parameter.
Description (string) --
A description of the parameter.
Source (string) --
The source of the parameter value, such as "engine-default" or "user".
DataType (string) --
The data type of the parameter.
AllowedValues (string) --
The valid range of values for the parameter.
ApplyType (string) --
Specifies how to apply the parameter. Supported value: static.
IsModifiable (boolean) --
If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion (string) --
The earliest engine version to which the parameter can apply.
dict
Response Syntax
{
'ParameterGroupName': 'string',
'ParameterGroupStatus': 'string'
}
Response Structure
(dict) --
Contains the output from the ModifyClusterParameterGroup and ResetClusterParameterGroup actions and indicate the parameter group involved and the status of the operation on the parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterGroupStatus (string) --
The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.
{'Cluster': {'ClusterParameterGroups': {'ClusterParameterStatusList': [{'ParameterApplyErrorDescription': 'string',
'ParameterApplyStatus': 'string',
'ParameterName': 'string'}]},
'ClusterSnapshotCopyStatus': {'SnapshotCopyGrantName': 'string'}}}
Modifies the number of days to retain automated snapshots in the destination region after they are copied from the source region.
Request Syntax
client.modify_snapshot_copy_retention_period(
ClusterIdentifier='string',
RetentionPeriod=123
)
string
[REQUIRED]
The unique identifier of the cluster for which you want to change the retention period for automated snapshots that are copied to a destination region.
Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.
integer
[REQUIRED]
The number of days to retain automated snapshots in the destination region after they are copied from the source region.
If you decrease the retention period for automated snapshots that are copied to a destination region, Amazon Redshift will delete any existing automated snapshots that were copied to the destination region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterSecurityGroups': [
{
'ClusterSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'ClusterParameterGroups': [
{
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'ClusterParameterStatusList': [
{
'ParameterName': 'string',
'ParameterApplyStatus': 'string',
'ParameterApplyErrorDescription': 'string'
},
]
},
],
'ClusterSubnetGroupName': 'string',
'VpcId': 'string',
'AvailabilityZone': 'string',
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'MasterUserPassword': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'ClusterType': 'string',
'ClusterVersion': 'string',
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterIdentifier': 'string'
},
'ClusterVersion': 'string',
'AllowVersionUpgrade': True|False,
'NumberOfNodes': 123,
'PubliclyAccessible': True|False,
'Encrypted': True|False,
'RestoreStatus': {
'Status': 'string',
'CurrentRestoreRateInMegaBytesPerSecond': 123.0,
'SnapshotSizeInMegaBytes': 123,
'ProgressInMegaBytes': 123,
'ElapsedTimeInSeconds': 123,
'EstimatedTimeToCompletionInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'SnapshotCopyGrantName': 'string'
},
'ClusterPublicKey': 'string',
'ClusterNodes': [
{
'NodeRole': 'string',
'PrivateIPAddress': 'string',
'PublicIPAddress': 'string'
},
],
'ElasticIpStatus': {
'ElasticIp': 'string',
'Status': 'string'
},
'ClusterRevisionNumber': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'KmsKeyId': 'string'
}
}
Response Structure
(dict) --
Describes a cluster.
Cluster (dict) --
Describes a cluster.
ClusterIdentifier (string) --
The unique identifier of the cluster.
NodeType (string) --
The node type for the nodes in the cluster.
ClusterStatus (string) --
The current state of this cluster. Possible values include available, creating, deleting, rebooting, renaming, and resizing.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The master user name for the cluster. This name is used to connect to the database that is specified in DBName.
DBName (string) --
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named "dev" was created by default.
Endpoint (dict) --
The connection endpoint.
Address (string) --
The DNS address of the Cluster.
Port (integer) --
The port that the database engine is listening on.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ClusterSecurityGroups (list) --
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group.
Status (string) --
The status of the cluster security group.
VpcSecurityGroups (list) --
A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
Status (string) --
ClusterParameterGroups (list) --
The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
(dict) --
Describes the status of a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
ClusterParameterStatusList (list) --
The list of parameter statuses.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
(dict) --
Describes the status of a parameter group.
ParameterName (string) --
The name of the parameter.
ParameterApplyStatus (string) --
The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.
The following are possible statuses and descriptions.
in-sync: The parameter value is in sync with the database.
pending-reboot: The parameter value will be applied after the cluster reboots.
applying: The parameter value is being applied to the database.
invalid-parameter: Cannot apply the parameter value because it has an invalid value or syntax.
apply-deferred: The parameter contains static property changes. The changes are deferred until the cluster reboots.
apply-error: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.
unknown-error: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.
ParameterApplyErrorDescription (string) --
The error that prevented the parameter from being applied to the database.
ClusterSubnetGroupName (string) --
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
VpcId (string) --
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
AvailabilityZone (string) --
The name of the Availability Zone in which the cluster is located.
PreferredMaintenanceWindow (string) --
The weekly time range (in UTC) during which system maintenance can occur.
PendingModifiedValues (dict) --
If present, changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the master user password for the cluster.
NodeType (string) --
The pending or in-progress change of the cluster's node type.
NumberOfNodes (integer) --
The pending or in-progress change of the number of nodes in the cluster.
ClusterType (string) --
The pending or in-progress change of the cluster type.
ClusterVersion (string) --
The pending or in-progress change of the service version.
AutomatedSnapshotRetentionPeriod (integer) --
The pending or in-progress change of the automated snapshot retention period.
ClusterIdentifier (string) --
The pending or in-progress change of the new identifier for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
If true, major version upgrades will be applied automatically to the cluster during the maintenance window.
NumberOfNodes (integer) --
The number of compute nodes in the cluster.
PubliclyAccessible (boolean) --
If true, the cluster can be accessed from a public network.
Encrypted (boolean) --
If true, data in the cluster is encrypted at rest.
RestoreStatus (dict) --
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
Status (string) --
The status of the restore action. Returns starting, restoring, completed, or failed.
CurrentRestoreRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
HsmStatus (dict) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
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.
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.
Status (string) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
ClusterSnapshotCopyStatus (dict) --
Returns the destination region and retention period that are configured for cross-region snapshot copy.
DestinationRegion (string) --
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
RetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in a cluster.
(dict) --
The identifier of a node in a cluster.
NodeRole (string) --
Whether the node is a leader node or a compute node.
PrivateIPAddress (string) --
The private IP address of a node within a cluster.
PublicIPAddress (string) --
The public IP address of a node within a cluster.
ElasticIpStatus (dict) --
Describes the status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
Describes the status of the elastic IP (EIP) address.
ClusterRevisionNumber (string) --
The specific revision number of the database in the cluster.
Tags (list) --
The list of tags for the cluster.
(dict) --
A tag consisting of a name/value pair for a resource.
Key (string) --
The key, or name, for the resource tag.
Value (string) --
The value for the resource tag.
KmsKeyId (string) --
The AWS Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
{'Cluster': {'ClusterParameterGroups': {'ClusterParameterStatusList': [{'ParameterApplyErrorDescription': 'string',
'ParameterApplyStatus': 'string',
'ParameterName': 'string'}]},
'ClusterSnapshotCopyStatus': {'SnapshotCopyGrantName': 'string'}}}
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 Cluster Management Guide
Request Syntax
client.reboot_cluster(
ClusterIdentifier='string'
)
string
[REQUIRED]
The cluster identifier.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterSecurityGroups': [
{
'ClusterSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'ClusterParameterGroups': [
{
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'ClusterParameterStatusList': [
{
'ParameterName': 'string',
'ParameterApplyStatus': 'string',
'ParameterApplyErrorDescription': 'string'
},
]
},
],
'ClusterSubnetGroupName': 'string',
'VpcId': 'string',
'AvailabilityZone': 'string',
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'MasterUserPassword': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'ClusterType': 'string',
'ClusterVersion': 'string',
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterIdentifier': 'string'
},
'ClusterVersion': 'string',
'AllowVersionUpgrade': True|False,
'NumberOfNodes': 123,
'PubliclyAccessible': True|False,
'Encrypted': True|False,
'RestoreStatus': {
'Status': 'string',
'CurrentRestoreRateInMegaBytesPerSecond': 123.0,
'SnapshotSizeInMegaBytes': 123,
'ProgressInMegaBytes': 123,
'ElapsedTimeInSeconds': 123,
'EstimatedTimeToCompletionInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'SnapshotCopyGrantName': 'string'
},
'ClusterPublicKey': 'string',
'ClusterNodes': [
{
'NodeRole': 'string',
'PrivateIPAddress': 'string',
'PublicIPAddress': 'string'
},
],
'ElasticIpStatus': {
'ElasticIp': 'string',
'Status': 'string'
},
'ClusterRevisionNumber': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'KmsKeyId': 'string'
}
}
Response Structure
(dict) --
Describes a cluster.
Cluster (dict) --
Describes a cluster.
ClusterIdentifier (string) --
The unique identifier of the cluster.
NodeType (string) --
The node type for the nodes in the cluster.
ClusterStatus (string) --
The current state of this cluster. Possible values include available, creating, deleting, rebooting, renaming, and resizing.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The master user name for the cluster. This name is used to connect to the database that is specified in DBName.
DBName (string) --
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named "dev" was created by default.
Endpoint (dict) --
The connection endpoint.
Address (string) --
The DNS address of the Cluster.
Port (integer) --
The port that the database engine is listening on.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ClusterSecurityGroups (list) --
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group.
Status (string) --
The status of the cluster security group.
VpcSecurityGroups (list) --
A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
Status (string) --
ClusterParameterGroups (list) --
The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
(dict) --
Describes the status of a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
ClusterParameterStatusList (list) --
The list of parameter statuses.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
(dict) --
Describes the status of a parameter group.
ParameterName (string) --
The name of the parameter.
ParameterApplyStatus (string) --
The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.
The following are possible statuses and descriptions.
in-sync: The parameter value is in sync with the database.
pending-reboot: The parameter value will be applied after the cluster reboots.
applying: The parameter value is being applied to the database.
invalid-parameter: Cannot apply the parameter value because it has an invalid value or syntax.
apply-deferred: The parameter contains static property changes. The changes are deferred until the cluster reboots.
apply-error: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.
unknown-error: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.
ParameterApplyErrorDescription (string) --
The error that prevented the parameter from being applied to the database.
ClusterSubnetGroupName (string) --
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
VpcId (string) --
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
AvailabilityZone (string) --
The name of the Availability Zone in which the cluster is located.
PreferredMaintenanceWindow (string) --
The weekly time range (in UTC) during which system maintenance can occur.
PendingModifiedValues (dict) --
If present, changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the master user password for the cluster.
NodeType (string) --
The pending or in-progress change of the cluster's node type.
NumberOfNodes (integer) --
The pending or in-progress change of the number of nodes in the cluster.
ClusterType (string) --
The pending or in-progress change of the cluster type.
ClusterVersion (string) --
The pending or in-progress change of the service version.
AutomatedSnapshotRetentionPeriod (integer) --
The pending or in-progress change of the automated snapshot retention period.
ClusterIdentifier (string) --
The pending or in-progress change of the new identifier for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
If true, major version upgrades will be applied automatically to the cluster during the maintenance window.
NumberOfNodes (integer) --
The number of compute nodes in the cluster.
PubliclyAccessible (boolean) --
If true, the cluster can be accessed from a public network.
Encrypted (boolean) --
If true, data in the cluster is encrypted at rest.
RestoreStatus (dict) --
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
Status (string) --
The status of the restore action. Returns starting, restoring, completed, or failed.
CurrentRestoreRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
HsmStatus (dict) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
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.
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.
Status (string) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
ClusterSnapshotCopyStatus (dict) --
Returns the destination region and retention period that are configured for cross-region snapshot copy.
DestinationRegion (string) --
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
RetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in a cluster.
(dict) --
The identifier of a node in a cluster.
NodeRole (string) --
Whether the node is a leader node or a compute node.
PrivateIPAddress (string) --
The private IP address of a node within a cluster.
PublicIPAddress (string) --
The public IP address of a node within a cluster.
ElasticIpStatus (dict) --
Describes the status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
Describes the status of the elastic IP (EIP) address.
ClusterRevisionNumber (string) --
The specific revision number of the database in the cluster.
Tags (list) --
The list of tags for the cluster.
(dict) --
A tag consisting of a name/value pair for a resource.
Key (string) --
The key, or name, for the resource tag.
Value (string) --
The value for the resource tag.
KmsKeyId (string) --
The AWS Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
{'Parameters': {'ApplyType': 'static | dynamic'}}
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.
Request Syntax
client.reset_cluster_parameter_group(
ParameterGroupName='string',
ResetAllParameters=True|False,
Parameters=[
{
'ParameterName': 'string',
'ParameterValue': 'string',
'Description': 'string',
'Source': 'string',
'DataType': 'string',
'AllowedValues': 'string',
'ApplyType': 'static'|'dynamic',
'IsModifiable': True|False,
'MinimumEngineVersion': 'string'
},
]
)
string
[REQUIRED]
The name of the cluster parameter group to be reset.
boolean
If true, all parameters in the specified parameter group will be reset to their default values.
Default: true
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.
Constraints: A maximum of 20 parameters can be reset in a single request.
(dict) --
Describes a parameter in a cluster parameter group.
ParameterName (string) --
The name of the parameter.
ParameterValue (string) --
The value of the parameter.
Description (string) --
A description of the parameter.
Source (string) --
The source of the parameter value, such as "engine-default" or "user".
DataType (string) --
The data type of the parameter.
AllowedValues (string) --
The valid range of values for the parameter.
ApplyType (string) --
Specifies how to apply the parameter. Supported value: static.
IsModifiable (boolean) --
If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
MinimumEngineVersion (string) --
The earliest engine version to which the parameter can apply.
dict
Response Syntax
{
'ParameterGroupName': 'string',
'ParameterGroupStatus': 'string'
}
Response Structure
(dict) --
Contains the output from the ModifyClusterParameterGroup and ResetClusterParameterGroup actions and indicate the parameter group involved and the status of the operation on the parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterGroupStatus (string) --
The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.
{'NodeType': 'string'}
Response {'Cluster': {'ClusterParameterGroups': {'ClusterParameterStatusList': [{'ParameterApplyErrorDescription': 'string',
'ParameterApplyStatus': 'string',
'ParameterName': 'string'}]},
'ClusterSnapshotCopyStatus': {'SnapshotCopyGrantName': 'string'}}}
Creates a new cluster from a snapshot. By default, 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 groups. 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 you are using a DS node type, you can also choose to change to another DS node type of the same size during restore.
If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored.
For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.
Request Syntax
client.restore_from_cluster_snapshot(
ClusterIdentifier='string',
SnapshotIdentifier='string',
SnapshotClusterIdentifier='string',
Port=123,
AvailabilityZone='string',
AllowVersionUpgrade=True|False,
ClusterSubnetGroupName='string',
PubliclyAccessible=True|False,
OwnerAccount='string',
HsmClientCertificateIdentifier='string',
HsmConfigurationIdentifier='string',
ElasticIp='string',
ClusterParameterGroupName='string',
ClusterSecurityGroups=[
'string',
],
VpcSecurityGroupIds=[
'string',
],
PreferredMaintenanceWindow='string',
AutomatedSnapshotRetentionPeriod=123,
KmsKeyId='string',
NodeType='string'
)
string
[REQUIRED]
The identifier of the cluster that will be created from restoring the snapshot.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.
string
[REQUIRED]
The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
Example: my-snapshot-id
string
The name 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.
integer
The port number on which the cluster accepts connections.
Default: The same port as the original cluster.
Constraints: Must be between 1115 and 65535.
string
The Amazon EC2 Availability Zone in which to restore the cluster.
Default: A random, system-chosen Availability Zone.
Example: us-east-1a
boolean
If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
Default: true
string
The name of the subnet group where you want to cluster restored.
A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.
boolean
If true, the cluster can be accessed from a public network.
string
The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
string
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
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.
string
The elastic IP (EIP) address for the cluster.
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:
Must be 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
list
A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
Cluster security groups only apply to clusters outside of VPCs.
(string) --
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.
VPC security groups only apply to clusters in VPCs.
(string) --
string
The weekly time range (in UTC) during which automated cluster maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: The value selected for the cluster from which the snapshot was taken. 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.
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: The value selected for the cluster from which the snapshot was taken.
Constraints: Must be a value from 0 to 35.
string
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot.
string
The node type that the restored cluster will be provisioned with.
Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds2.xlarge into ds1.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterSecurityGroups': [
{
'ClusterSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'ClusterParameterGroups': [
{
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'ClusterParameterStatusList': [
{
'ParameterName': 'string',
'ParameterApplyStatus': 'string',
'ParameterApplyErrorDescription': 'string'
},
]
},
],
'ClusterSubnetGroupName': 'string',
'VpcId': 'string',
'AvailabilityZone': 'string',
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'MasterUserPassword': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'ClusterType': 'string',
'ClusterVersion': 'string',
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterIdentifier': 'string'
},
'ClusterVersion': 'string',
'AllowVersionUpgrade': True|False,
'NumberOfNodes': 123,
'PubliclyAccessible': True|False,
'Encrypted': True|False,
'RestoreStatus': {
'Status': 'string',
'CurrentRestoreRateInMegaBytesPerSecond': 123.0,
'SnapshotSizeInMegaBytes': 123,
'ProgressInMegaBytes': 123,
'ElapsedTimeInSeconds': 123,
'EstimatedTimeToCompletionInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'SnapshotCopyGrantName': 'string'
},
'ClusterPublicKey': 'string',
'ClusterNodes': [
{
'NodeRole': 'string',
'PrivateIPAddress': 'string',
'PublicIPAddress': 'string'
},
],
'ElasticIpStatus': {
'ElasticIp': 'string',
'Status': 'string'
},
'ClusterRevisionNumber': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'KmsKeyId': 'string'
}
}
Response Structure
(dict) --
Describes a cluster.
Cluster (dict) --
Describes a cluster.
ClusterIdentifier (string) --
The unique identifier of the cluster.
NodeType (string) --
The node type for the nodes in the cluster.
ClusterStatus (string) --
The current state of this cluster. Possible values include available, creating, deleting, rebooting, renaming, and resizing.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The master user name for the cluster. This name is used to connect to the database that is specified in DBName.
DBName (string) --
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named "dev" was created by default.
Endpoint (dict) --
The connection endpoint.
Address (string) --
The DNS address of the Cluster.
Port (integer) --
The port that the database engine is listening on.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ClusterSecurityGroups (list) --
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group.
Status (string) --
The status of the cluster security group.
VpcSecurityGroups (list) --
A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
Status (string) --
ClusterParameterGroups (list) --
The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
(dict) --
Describes the status of a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
ClusterParameterStatusList (list) --
The list of parameter statuses.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
(dict) --
Describes the status of a parameter group.
ParameterName (string) --
The name of the parameter.
ParameterApplyStatus (string) --
The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.
The following are possible statuses and descriptions.
in-sync: The parameter value is in sync with the database.
pending-reboot: The parameter value will be applied after the cluster reboots.
applying: The parameter value is being applied to the database.
invalid-parameter: Cannot apply the parameter value because it has an invalid value or syntax.
apply-deferred: The parameter contains static property changes. The changes are deferred until the cluster reboots.
apply-error: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.
unknown-error: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.
ParameterApplyErrorDescription (string) --
The error that prevented the parameter from being applied to the database.
ClusterSubnetGroupName (string) --
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
VpcId (string) --
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
AvailabilityZone (string) --
The name of the Availability Zone in which the cluster is located.
PreferredMaintenanceWindow (string) --
The weekly time range (in UTC) during which system maintenance can occur.
PendingModifiedValues (dict) --
If present, changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the master user password for the cluster.
NodeType (string) --
The pending or in-progress change of the cluster's node type.
NumberOfNodes (integer) --
The pending or in-progress change of the number of nodes in the cluster.
ClusterType (string) --
The pending or in-progress change of the cluster type.
ClusterVersion (string) --
The pending or in-progress change of the service version.
AutomatedSnapshotRetentionPeriod (integer) --
The pending or in-progress change of the automated snapshot retention period.
ClusterIdentifier (string) --
The pending or in-progress change of the new identifier for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
If true, major version upgrades will be applied automatically to the cluster during the maintenance window.
NumberOfNodes (integer) --
The number of compute nodes in the cluster.
PubliclyAccessible (boolean) --
If true, the cluster can be accessed from a public network.
Encrypted (boolean) --
If true, data in the cluster is encrypted at rest.
RestoreStatus (dict) --
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
Status (string) --
The status of the restore action. Returns starting, restoring, completed, or failed.
CurrentRestoreRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
HsmStatus (dict) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
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.
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.
Status (string) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
ClusterSnapshotCopyStatus (dict) --
Returns the destination region and retention period that are configured for cross-region snapshot copy.
DestinationRegion (string) --
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
RetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in a cluster.
(dict) --
The identifier of a node in a cluster.
NodeRole (string) --
Whether the node is a leader node or a compute node.
PrivateIPAddress (string) --
The private IP address of a node within a cluster.
PublicIPAddress (string) --
The public IP address of a node within a cluster.
ElasticIpStatus (dict) --
Describes the status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
Describes the status of the elastic IP (EIP) address.
ClusterRevisionNumber (string) --
The specific revision number of the database in the cluster.
Tags (list) --
The list of tags for the cluster.
(dict) --
A tag consisting of a name/value pair for a resource.
Key (string) --
The key, or name, for the resource tag.
Value (string) --
The value for the resource tag.
KmsKeyId (string) --
The AWS Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
{'Snapshot': {'RestorableNodeTypes': ['string']}}
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 Cluster Management Guide.
Request Syntax
client.revoke_snapshot_access(
SnapshotIdentifier='string',
SnapshotClusterIdentifier='string',
AccountWithRestoreAccess='string'
)
string
[REQUIRED]
The identifier of the snapshot that the account can no longer access.
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.
string
[REQUIRED]
The identifier of the AWS customer account that can no longer restore the specified snapshot.
dict
Response Syntax
{
'Snapshot': {
'SnapshotIdentifier': 'string',
'ClusterIdentifier': 'string',
'SnapshotCreateTime': datetime(2015, 1, 1),
'Status': 'string',
'Port': 123,
'AvailabilityZone': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'MasterUsername': 'string',
'ClusterVersion': 'string',
'SnapshotType': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'DBName': 'string',
'VpcId': 'string',
'Encrypted': True|False,
'KmsKeyId': 'string',
'EncryptedWithHSM': True|False,
'AccountsWithRestoreAccess': [
{
'AccountId': 'string'
},
],
'OwnerAccount': 'string',
'TotalBackupSizeInMegaBytes': 123.0,
'ActualIncrementalBackupSizeInMegaBytes': 123.0,
'BackupProgressInMegaBytes': 123.0,
'CurrentBackupRateInMegaBytesPerSecond': 123.0,
'EstimatedSecondsToCompletion': 123,
'ElapsedTimeInSeconds': 123,
'SourceRegion': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'RestorableNodeTypes': [
'string',
]
}
}
Response Structure
(dict) --
Describes a snapshot.
Snapshot (dict) --
Describes a snapshot.
SnapshotIdentifier (string) --
The snapshot identifier that is provided in the request.
ClusterIdentifier (string) --
The identifier of the cluster for which the snapshot was taken.
SnapshotCreateTime (datetime) --
The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.
Status (string) --
The snapshot status. The value of the status depends on the API operation used.
CreateClusterSnapshot and CopyClusterSnapshot returns status as "creating".
DescribeClusterSnapshots returns status as "creating", "available", "final snapshot", or "failed".
DeleteClusterSnapshot returns status as "deleted".
Port (integer) --
The port that the cluster is listening on.
AvailabilityZone (string) --
The Availability Zone in which the cluster was created.
ClusterCreateTime (datetime) --
The time (UTC) when the cluster was originally created.
MasterUsername (string) --
The master user name for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
SnapshotType (string) --
The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".
NodeType (string) --
The node type of the nodes in the cluster.
NumberOfNodes (integer) --
The number of nodes in the cluster.
DBName (string) --
The name of the database that was created when the cluster was created.
VpcId (string) --
The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.
Encrypted (boolean) --
If true, the data in the snapshot is encrypted at rest.
KmsKeyId (string) --
The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.
EncryptedWithHSM (boolean) --
A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.
AccountsWithRestoreAccess (list) --
A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.
(dict) --
Describes an AWS customer account authorized to restore a snapshot.
AccountId (string) --
The identifier of an AWS customer account authorized to restore a snapshot.
OwnerAccount (string) --
For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.
TotalBackupSizeInMegaBytes (float) --
The size of the complete set of backup data that would be used to restore the cluster.
ActualIncrementalBackupSizeInMegaBytes (float) --
The size of the incremental backup.
BackupProgressInMegaBytes (float) --
The number of megabytes that have been transferred to the snapshot backup.
CurrentBackupRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.
EstimatedSecondsToCompletion (integer) --
The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.
SourceRegion (string) --
The source region from which the snapshot was copied.
Tags (list) --
The list of tags for the cluster snapshot.
(dict) --
A tag consisting of a name/value pair for a resource.
Key (string) --
The key, or name, for the resource tag.
Value (string) --
The value for the resource tag.
RestorableNodeTypes (list) --
The list of node types that this cluster snapshot is able to restore into.
(string) --
{'Cluster': {'ClusterParameterGroups': {'ClusterParameterStatusList': [{'ParameterApplyErrorDescription': 'string',
'ParameterApplyStatus': 'string',
'ParameterName': 'string'}]},
'ClusterSnapshotCopyStatus': {'SnapshotCopyGrantName': 'string'}}}
Rotates the encryption keys for a cluster.
Request Syntax
client.rotate_encryption_key(
ClusterIdentifier='string'
)
string
[REQUIRED]
The unique identifier of the cluster that you want to rotate the encryption keys for.
Constraints: Must be the name of valid cluster that has encryption enabled.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterSecurityGroups': [
{
'ClusterSecurityGroupName': 'string',
'Status': 'string'
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'ClusterParameterGroups': [
{
'ParameterGroupName': 'string',
'ParameterApplyStatus': 'string',
'ClusterParameterStatusList': [
{
'ParameterName': 'string',
'ParameterApplyStatus': 'string',
'ParameterApplyErrorDescription': 'string'
},
]
},
],
'ClusterSubnetGroupName': 'string',
'VpcId': 'string',
'AvailabilityZone': 'string',
'PreferredMaintenanceWindow': 'string',
'PendingModifiedValues': {
'MasterUserPassword': 'string',
'NodeType': 'string',
'NumberOfNodes': 123,
'ClusterType': 'string',
'ClusterVersion': 'string',
'AutomatedSnapshotRetentionPeriod': 123,
'ClusterIdentifier': 'string'
},
'ClusterVersion': 'string',
'AllowVersionUpgrade': True|False,
'NumberOfNodes': 123,
'PubliclyAccessible': True|False,
'Encrypted': True|False,
'RestoreStatus': {
'Status': 'string',
'CurrentRestoreRateInMegaBytesPerSecond': 123.0,
'SnapshotSizeInMegaBytes': 123,
'ProgressInMegaBytes': 123,
'ElapsedTimeInSeconds': 123,
'EstimatedTimeToCompletionInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'SnapshotCopyGrantName': 'string'
},
'ClusterPublicKey': 'string',
'ClusterNodes': [
{
'NodeRole': 'string',
'PrivateIPAddress': 'string',
'PublicIPAddress': 'string'
},
],
'ElasticIpStatus': {
'ElasticIp': 'string',
'Status': 'string'
},
'ClusterRevisionNumber': 'string',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'KmsKeyId': 'string'
}
}
Response Structure
(dict) --
Describes a cluster.
Cluster (dict) --
Describes a cluster.
ClusterIdentifier (string) --
The unique identifier of the cluster.
NodeType (string) --
The node type for the nodes in the cluster.
ClusterStatus (string) --
The current state of this cluster. Possible values include available, creating, deleting, rebooting, renaming, and resizing.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The master user name for the cluster. This name is used to connect to the database that is specified in DBName.
DBName (string) --
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named "dev" was created by default.
Endpoint (dict) --
The connection endpoint.
Address (string) --
The DNS address of the Cluster.
Port (integer) --
The port that the database engine is listening on.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ClusterSecurityGroups (list) --
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a security group.
ClusterSecurityGroupName (string) --
The name of the cluster security group.
Status (string) --
The status of the cluster security group.
VpcSecurityGroups (list) --
A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
Status (string) --
ClusterParameterGroups (list) --
The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
(dict) --
Describes the status of a parameter group.
ParameterGroupName (string) --
The name of the cluster parameter group.
ParameterApplyStatus (string) --
The status of parameter updates.
ClusterParameterStatusList (list) --
The list of parameter statuses.
For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
(dict) --
Describes the status of a parameter group.
ParameterName (string) --
The name of the parameter.
ParameterApplyStatus (string) --
The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.
The following are possible statuses and descriptions.
in-sync: The parameter value is in sync with the database.
pending-reboot: The parameter value will be applied after the cluster reboots.
applying: The parameter value is being applied to the database.
invalid-parameter: Cannot apply the parameter value because it has an invalid value or syntax.
apply-deferred: The parameter contains static property changes. The changes are deferred until the cluster reboots.
apply-error: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.
unknown-error: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.
ParameterApplyErrorDescription (string) --
The error that prevented the parameter from being applied to the database.
ClusterSubnetGroupName (string) --
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
VpcId (string) --
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
AvailabilityZone (string) --
The name of the Availability Zone in which the cluster is located.
PreferredMaintenanceWindow (string) --
The weekly time range (in UTC) during which system maintenance can occur.
PendingModifiedValues (dict) --
If present, changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the master user password for the cluster.
NodeType (string) --
The pending or in-progress change of the cluster's node type.
NumberOfNodes (integer) --
The pending or in-progress change of the number of nodes in the cluster.
ClusterType (string) --
The pending or in-progress change of the cluster type.
ClusterVersion (string) --
The pending or in-progress change of the service version.
AutomatedSnapshotRetentionPeriod (integer) --
The pending or in-progress change of the automated snapshot retention period.
ClusterIdentifier (string) --
The pending or in-progress change of the new identifier for the cluster.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
If true, major version upgrades will be applied automatically to the cluster during the maintenance window.
NumberOfNodes (integer) --
The number of compute nodes in the cluster.
PubliclyAccessible (boolean) --
If true, the cluster can be accessed from a public network.
Encrypted (boolean) --
If true, data in the cluster is encrypted at rest.
RestoreStatus (dict) --
Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.
Status (string) --
The status of the restore action. Returns starting, restoring, completed, or failed.
CurrentRestoreRateInMegaBytesPerSecond (float) --
The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage.
ElapsedTimeInSeconds (integer) --
The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
HsmStatus (dict) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
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.
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.
Status (string) --
Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.
Values: active, applying
ClusterSnapshotCopyStatus (dict) --
Returns the destination region and retention period that are configured for cross-region snapshot copy.
DestinationRegion (string) --
The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.
RetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in a cluster.
(dict) --
The identifier of a node in a cluster.
NodeRole (string) --
Whether the node is a leader node or a compute node.
PrivateIPAddress (string) --
The private IP address of a node within a cluster.
PublicIPAddress (string) --
The public IP address of a node within a cluster.
ElasticIpStatus (dict) --
Describes the status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
Describes the status of the elastic IP (EIP) address.
ClusterRevisionNumber (string) --
The specific revision number of the database in the cluster.
Tags (list) --
The list of tags for the cluster.
(dict) --
A tag consisting of a name/value pair for a resource.
Key (string) --
The key, or name, for the resource tag.
Value (string) --
The value for the resource tag.
KmsKeyId (string) --
The AWS Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.