2023/10/27 - Amazon Redshift - 23 updated api methods
Changes added support to create a dual stack cluster
{'IpAddressType': 'string'}
Response {'Cluster': {'Endpoint': {'VpcEndpoints': {'NetworkInterfaces': {'Ipv6Address': 'string'}}},
'IpAddressType': 'string'}}
Creates a new cluster with the specified parameters.
To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide .
See also: AWS API Documentation
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,
ManualSnapshotRetentionPeriod=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',
EnhancedVpcRouting=True|False,
AdditionalInfo='string',
IamRoles=[
'string',
],
MaintenanceTrackName='string',
SnapshotScheduleIdentifier='string',
AvailabilityZoneRelocation=True|False,
AquaConfigurationStatus='enabled'|'disabled'|'auto',
DefaultIamRoleArn='string',
LoadSampleData='string',
ManageMasterPassword=True|False,
MasterPasswordSecretKmsKeyId='string',
IpAddressType='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 Amazon Web Services 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: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge
string
[REQUIRED]
The user name associated with the admin user account for the cluster that is being created.
Constraints:
Must be 1 - 128 alphanumeric characters or hyphens. The user name can't be PUBLIC .
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
The first character must be a letter.
Must not contain a colon (:) or a slash (/).
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
string
The password associated with the admin user account for the cluster that is being created.
You can't use MasterUserPassword if ManageMasterPassword is true .
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-126) except ' (single quote), " (double quote), \ , / , or @ .
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-2d
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 .
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
Default: 1
Constraints: Must be a value from 0 to 35.
integer
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
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. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. 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 Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
boolean
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
string
Reserved.
list
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide .
(string) --
string
An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track.
string
A unique identifier for the snapshot schedule.
boolean
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
string
This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
string
The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.
string
A flag that specifies whether to load sample data once the cluster is created.
boolean
If true , Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.
string
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter if ManageMasterPassword is true.
string
The IP address types that the cluster supports. Possible values are ipv4 and dualstack .
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ClusterAvailabilityStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'VpcEndpoints': [
{
'VpcEndpointId': 'string',
'VpcId': 'string',
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string',
'SubnetId': 'string',
'PrivateIpAddress': 'string',
'AvailabilityZone': 'string',
'Ipv6Address': 'string'
},
]
},
]
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'PubliclyAccessible': True|False,
'EnhancedVpcRouting': True|False,
'MaintenanceTrackName': 'string',
'EncryptionType': '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
},
'DataTransferProgress': {
'Status': 'string',
'CurrentRateInMegaBytesPerSecond': 123.0,
'TotalDataInMegaBytes': 123,
'DataTransferredInMegaBytes': 123,
'EstimatedTimeToCompletionInSeconds': 123,
'ElapsedTimeInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'EnhancedVpcRouting': True|False,
'IamRoles': [
{
'IamRoleArn': 'string',
'ApplyStatus': 'string'
},
],
'PendingActions': [
'string',
],
'MaintenanceTrackName': 'string',
'ElasticResizeNumberOfNodeOptions': 'string',
'DeferredMaintenanceWindows': [
{
'DeferMaintenanceIdentifier': 'string',
'DeferMaintenanceStartTime': datetime(2015, 1, 1),
'DeferMaintenanceEndTime': datetime(2015, 1, 1)
},
],
'SnapshotScheduleIdentifier': 'string',
'SnapshotScheduleState': 'MODIFYING'|'ACTIVE'|'FAILED',
'ExpectedNextSnapshotScheduleTime': datetime(2015, 1, 1),
'ExpectedNextSnapshotScheduleTimeStatus': 'string',
'NextMaintenanceWindowStartTime': datetime(2015, 1, 1),
'ResizeInfo': {
'ResizeType': 'string',
'AllowCancelResize': True|False
},
'AvailabilityZoneRelocationStatus': 'string',
'ClusterNamespaceArn': 'string',
'TotalStorageCapacityInMegaBytes': 123,
'AquaConfiguration': {
'AquaStatus': 'enabled'|'disabled'|'applying',
'AquaConfigurationStatus': 'enabled'|'disabled'|'auto'
},
'DefaultIamRoleArn': 'string',
'ReservedNodeExchangeStatus': {
'ReservedNodeExchangeRequestId': 'string',
'Status': 'REQUESTED'|'PENDING'|'IN_PROGRESS'|'RETRYING'|'SUCCEEDED'|'FAILED',
'RequestTime': datetime(2015, 1, 1),
'SourceReservedNodeId': 'string',
'SourceReservedNodeType': 'string',
'SourceReservedNodeCount': 123,
'TargetReservedNodeOfferingId': 'string',
'TargetReservedNodeType': 'string',
'TargetReservedNodeCount': 123
},
'CustomDomainName': 'string',
'CustomDomainCertificateArn': 'string',
'CustomDomainCertificateExpiryDate': datetime(2015, 1, 1),
'MasterPasswordSecretArn': 'string',
'MasterPasswordSecretKmsKeyId': 'string',
'IpAddressType': 'string'
}
}
Response Structure
(dict) --
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 the cluster. Possible values are the following:
available
available, prep-for-resize
available, resize-cleanup
cancelling-resize
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
paused
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
ClusterAvailabilityStatus (string) --
The availability status of the cluster for queries. Possible values are the following:
Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
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 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.
VpcEndpoints (list) --
Describes a connection endpoint.
(dict) --
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
VpcEndpointId (string) --
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
VpcId (string) --
The VPC identifier that the endpoint is associated.
NetworkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Describes a network interface.
NetworkInterfaceId (string) --
The network interface identifier.
SubnetId (string) --
The subnet identifier.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
AvailabilityZone (string) --
The Availability Zone.
Ipv6Address (string) --
The IPv6 address of the network interface within the subnet.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ManualSnapshotRetentionPeriod (integer) --
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
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 an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a cluster 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 Amazon Virtual Private Cloud (Amazon 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) --
The identifier of the VPC security group.
Status (string) --
The status of the VPC security group.
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 Universal Coordinated Time (UTC), during which system maintenance can occur.
PendingModifiedValues (dict) --
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the admin 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.
PubliclyAccessible (boolean) --
The pending or in-progress change of the ability to connect to the cluster from the public network.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
MaintenanceTrackName (string) --
The name of the maintenance track that the cluster will change to during the next maintenance window.
EncryptionType (string) --
The encryption type for a cluster. Possible values are: KMS and None.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
A boolean value that, if true , indicates that 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) --
A boolean value that, if true , indicates that the cluster can be accessed from a public network.
Encrypted (boolean) --
A boolean value that, if true , indicates that data in the cluster is encrypted at rest.
RestoreStatus (dict) --
A value that describes the status of a cluster restore action. This parameter 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. This field is only updated when you restore to DC2 and DS2 node types.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
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. This field is only updated when you restore to DC2 and DS2 node types.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
DataTransferProgress (dict) --
Status (string) --
Describes the status of the cluster. While the transfer is in progress the status is transferringdata .
CurrentRateInMegaBytesPerSecond (float) --
Describes the data transfer rate in MB's per second.
TotalDataInMegaBytes (integer) --
Describes the total amount of data to be transfered in megabytes.
DataTransferredInMegaBytes (integer) --
Describes the total amount of data that has been transfered in MB's.
EstimatedTimeToCompletionInSeconds (integer) --
Describes the estimated number of seconds remaining to complete the transfer.
ElapsedTimeInSeconds (integer) --
Describes the number of seconds that have elapsed during the data transfer.
HsmStatus (dict) --
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (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) --
A value that 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.
ManualSnapshotRetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in the 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) --
The status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
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 Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
IamRoles (list) --
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
(dict) --
An Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other Amazon Web Services services.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload .
ApplyStatus (string) --
A value that describes the status of the IAM role's association with an Amazon Redshift cluster.
The following are possible statuses and descriptions.
in-sync : The role is available for use by the cluster.
adding : The role is in the process of being associated with the cluster.
removing : The role is in the process of being disassociated with the cluster.
PendingActions (list) --
Cluster operations that are waiting to be started.
(string) --
MaintenanceTrackName (string) --
The name of the maintenance track for the cluster.
ElasticResizeNumberOfNodeOptions (string) --
The number of nodes that you can resize the cluster to with the elastic resize method.
DeferredMaintenanceWindows (list) --
Describes a group of DeferredMaintenanceWindow objects.
(dict) --
Describes a deferred maintenance window
DeferMaintenanceIdentifier (string) --
A unique identifier for the maintenance window.
DeferMaintenanceStartTime (datetime) --
A timestamp for the beginning of the time period when we defer maintenance.
DeferMaintenanceEndTime (datetime) --
A timestamp for the end of the time period when we defer maintenance.
SnapshotScheduleIdentifier (string) --
A unique identifier for the cluster snapshot schedule.
SnapshotScheduleState (string) --
The current state of the cluster snapshot schedule.
ExpectedNextSnapshotScheduleTime (datetime) --
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
ExpectedNextSnapshotScheduleTimeStatus (string) --
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
NextMaintenanceWindowStartTime (datetime) --
The date and time in UTC when system maintenance can begin.
ResizeInfo (dict) --
Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
ResizeType (string) --
Returns the value ClassicResize .
AllowCancelResize (boolean) --
A boolean value indicating if the resize operation can be cancelled.
AvailabilityZoneRelocationStatus (string) --
Describes the status of the Availability Zone relocation operation.
ClusterNamespaceArn (string) --
The namespace Amazon Resource Name (ARN) of the cluster.
TotalStorageCapacityInMegaBytes (integer) --
The total storage capacity of the cluster in megabytes.
AquaConfiguration (dict) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaConfigurationStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
DefaultIamRoleArn (string) --
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
ReservedNodeExchangeStatus (dict) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
ReservedNodeExchangeRequestId (string) --
The identifier of the reserved-node exchange request.
Status (string) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
RequestTime (datetime) --
A date and time that indicate when the reserved-node exchange was requested.
SourceReservedNodeId (string) --
The identifier of the source reserved node.
SourceReservedNodeType (string) --
The source reserved-node type, for example ds2.xlarge.
SourceReservedNodeCount (integer) --
The source reserved-node count in the cluster.
TargetReservedNodeOfferingId (string) --
The identifier of the target reserved node offering.
TargetReservedNodeType (string) --
The node type of the target reserved node, for example ra3.4xlarge.
TargetReservedNodeCount (integer) --
The count of target reserved nodes in the cluster.
CustomDomainName (string) --
The custom domain name associated with the cluster.
CustomDomainCertificateArn (string) --
The certificate Amazon Resource Name (ARN) for the custom domain name.
CustomDomainCertificateExpiryDate (datetime) --
The expiration date for the certificate associated with the custom domain name.
MasterPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
MasterPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
IpAddressType (string) --
The IP address type for the cluster. Possible values are ipv4 and dualstack .
{'ClusterSubnetGroup': {'SupportedClusterIpAddressTypes': ['string']}}
Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.
For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Cluster Management Guide .
See also: AWS API Documentation
Request Syntax
client.create_cluster_subnet_group(
ClusterSubnetGroupName='string',
Description='string',
SubnetIds=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The name for the subnet group. Amazon Redshift stores the value as a lowercase string.
Constraints:
Must contain no more than 255 alphanumeric characters or hyphens.
Must not be "Default".
Must be unique for all subnet groups that are created by your Amazon Web Services account.
Example: examplesubnetgroup
string
[REQUIRED]
A description for the subnet group.
list
[REQUIRED]
An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
(string) --
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
{
'ClusterSubnetGroup': {
'ClusterSubnetGroupName': 'string',
'Description': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string',
'SupportedPlatforms': [
{
'Name': 'string'
},
]
},
'SubnetStatus': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'SupportedClusterIpAddressTypes': [
'string',
]
}
}
Response Structure
(dict) --
ClusterSubnetGroup (dict) --
Describes a subnet group.
ClusterSubnetGroupName (string) --
The name of the cluster subnet group.
Description (string) --
The description of the cluster subnet group.
VpcId (string) --
The VPC ID of the cluster subnet group.
SubnetGroupStatus (string) --
The status of the cluster subnet group. Possible values are Complete , Incomplete and Invalid .
Subnets (list) --
A list of the VPC Subnet elements.
(dict) --
Describes a subnet.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Name (string) --
The name of the availability zone.
SupportedPlatforms (list) --
(dict) --
A list of supported platforms for orderable clusters.
Name (string) --
SubnetStatus (string) --
The status of the subnet.
Tags (list) --
The list of tags for the cluster subnet group.
(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.
SupportedClusterIpAddressTypes (list) --
The IP address types supported by this cluster subnet group. Possible values are ipv4 and dualstack .
(string) --
{'VpcEndpoint': {'NetworkInterfaces': {'Ipv6Address': 'string'}}}
Creates a Redshift-managed VPC endpoint.
See also: AWS API Documentation
Request Syntax
client.create_endpoint_access(
ClusterIdentifier='string',
ResourceOwner='string',
EndpointName='string',
SubnetGroupName='string',
VpcSecurityGroupIds=[
'string',
]
)
string
The cluster identifier of the cluster to access.
string
The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.
string
[REQUIRED]
The Redshift-managed VPC endpoint name.
An endpoint name must contain 1-30 characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be a letter. The name can't contain two consecutive hyphens or end with a hyphen.
string
[REQUIRED]
The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.
list
The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
(string) --
dict
Response Syntax
{
'ClusterIdentifier': 'string',
'ResourceOwner': 'string',
'SubnetGroupName': 'string',
'EndpointStatus': 'string',
'EndpointName': 'string',
'EndpointCreateTime': datetime(2015, 1, 1),
'Port': 123,
'Address': 'string',
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'VpcEndpoint': {
'VpcEndpointId': 'string',
'VpcId': 'string',
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string',
'SubnetId': 'string',
'PrivateIpAddress': 'string',
'AvailabilityZone': 'string',
'Ipv6Address': 'string'
},
]
}
}
Response Structure
(dict) --
Describes a Redshift-managed VPC endpoint.
ClusterIdentifier (string) --
The cluster identifier of the cluster associated with the endpoint.
ResourceOwner (string) --
The Amazon Web Services account ID of the owner of the cluster.
SubnetGroupName (string) --
The subnet group name where Amazon Redshift chooses to deploy the endpoint.
EndpointStatus (string) --
The status of the endpoint.
EndpointName (string) --
The name of the endpoint.
EndpointCreateTime (datetime) --
The time (UTC) that the endpoint was created.
Port (integer) --
The port number on which the cluster accepts incoming connections.
Address (string) --
The DNS address of the endpoint.
VpcSecurityGroups (list) --
The security groups associated with the endpoint.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
The identifier of the VPC security group.
Status (string) --
The status of the VPC security group.
VpcEndpoint (dict) --
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
VpcEndpointId (string) --
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
VpcId (string) --
The VPC identifier that the endpoint is associated.
NetworkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Describes a network interface.
NetworkInterfaceId (string) --
The network interface identifier.
SubnetId (string) --
The subnet identifier.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
AvailabilityZone (string) --
The Availability Zone.
Ipv6Address (string) --
The IPv6 address of the network interface within the subnet.
{'Cluster': {'Endpoint': {'VpcEndpoints': {'NetworkInterfaces': {'Ipv6Address': 'string'}}},
'IpAddressType': 'string'}}
Deletes a previously provisioned cluster without its final snapshot being created. 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 .
See also: AWS API Documentation
Request Syntax
client.delete_cluster(
ClusterIdentifier='string',
SkipFinalClusterSnapshot=True|False,
FinalClusterSnapshotIdentifier='string',
FinalClusterSnapshotRetentionPeriod=123
)
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.
Note
The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false .
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.
integer
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ClusterAvailabilityStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'VpcEndpoints': [
{
'VpcEndpointId': 'string',
'VpcId': 'string',
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string',
'SubnetId': 'string',
'PrivateIpAddress': 'string',
'AvailabilityZone': 'string',
'Ipv6Address': 'string'
},
]
},
]
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'PubliclyAccessible': True|False,
'EnhancedVpcRouting': True|False,
'MaintenanceTrackName': 'string',
'EncryptionType': '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
},
'DataTransferProgress': {
'Status': 'string',
'CurrentRateInMegaBytesPerSecond': 123.0,
'TotalDataInMegaBytes': 123,
'DataTransferredInMegaBytes': 123,
'EstimatedTimeToCompletionInSeconds': 123,
'ElapsedTimeInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'EnhancedVpcRouting': True|False,
'IamRoles': [
{
'IamRoleArn': 'string',
'ApplyStatus': 'string'
},
],
'PendingActions': [
'string',
],
'MaintenanceTrackName': 'string',
'ElasticResizeNumberOfNodeOptions': 'string',
'DeferredMaintenanceWindows': [
{
'DeferMaintenanceIdentifier': 'string',
'DeferMaintenanceStartTime': datetime(2015, 1, 1),
'DeferMaintenanceEndTime': datetime(2015, 1, 1)
},
],
'SnapshotScheduleIdentifier': 'string',
'SnapshotScheduleState': 'MODIFYING'|'ACTIVE'|'FAILED',
'ExpectedNextSnapshotScheduleTime': datetime(2015, 1, 1),
'ExpectedNextSnapshotScheduleTimeStatus': 'string',
'NextMaintenanceWindowStartTime': datetime(2015, 1, 1),
'ResizeInfo': {
'ResizeType': 'string',
'AllowCancelResize': True|False
},
'AvailabilityZoneRelocationStatus': 'string',
'ClusterNamespaceArn': 'string',
'TotalStorageCapacityInMegaBytes': 123,
'AquaConfiguration': {
'AquaStatus': 'enabled'|'disabled'|'applying',
'AquaConfigurationStatus': 'enabled'|'disabled'|'auto'
},
'DefaultIamRoleArn': 'string',
'ReservedNodeExchangeStatus': {
'ReservedNodeExchangeRequestId': 'string',
'Status': 'REQUESTED'|'PENDING'|'IN_PROGRESS'|'RETRYING'|'SUCCEEDED'|'FAILED',
'RequestTime': datetime(2015, 1, 1),
'SourceReservedNodeId': 'string',
'SourceReservedNodeType': 'string',
'SourceReservedNodeCount': 123,
'TargetReservedNodeOfferingId': 'string',
'TargetReservedNodeType': 'string',
'TargetReservedNodeCount': 123
},
'CustomDomainName': 'string',
'CustomDomainCertificateArn': 'string',
'CustomDomainCertificateExpiryDate': datetime(2015, 1, 1),
'MasterPasswordSecretArn': 'string',
'MasterPasswordSecretKmsKeyId': 'string',
'IpAddressType': 'string'
}
}
Response Structure
(dict) --
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 the cluster. Possible values are the following:
available
available, prep-for-resize
available, resize-cleanup
cancelling-resize
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
paused
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
ClusterAvailabilityStatus (string) --
The availability status of the cluster for queries. Possible values are the following:
Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
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 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.
VpcEndpoints (list) --
Describes a connection endpoint.
(dict) --
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
VpcEndpointId (string) --
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
VpcId (string) --
The VPC identifier that the endpoint is associated.
NetworkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Describes a network interface.
NetworkInterfaceId (string) --
The network interface identifier.
SubnetId (string) --
The subnet identifier.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
AvailabilityZone (string) --
The Availability Zone.
Ipv6Address (string) --
The IPv6 address of the network interface within the subnet.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ManualSnapshotRetentionPeriod (integer) --
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
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 an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a cluster 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 Amazon Virtual Private Cloud (Amazon 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) --
The identifier of the VPC security group.
Status (string) --
The status of the VPC security group.
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 Universal Coordinated Time (UTC), during which system maintenance can occur.
PendingModifiedValues (dict) --
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the admin 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.
PubliclyAccessible (boolean) --
The pending or in-progress change of the ability to connect to the cluster from the public network.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
MaintenanceTrackName (string) --
The name of the maintenance track that the cluster will change to during the next maintenance window.
EncryptionType (string) --
The encryption type for a cluster. Possible values are: KMS and None.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
A boolean value that, if true , indicates that 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) --
A boolean value that, if true , indicates that the cluster can be accessed from a public network.
Encrypted (boolean) --
A boolean value that, if true , indicates that data in the cluster is encrypted at rest.
RestoreStatus (dict) --
A value that describes the status of a cluster restore action. This parameter 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. This field is only updated when you restore to DC2 and DS2 node types.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
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. This field is only updated when you restore to DC2 and DS2 node types.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
DataTransferProgress (dict) --
Status (string) --
Describes the status of the cluster. While the transfer is in progress the status is transferringdata .
CurrentRateInMegaBytesPerSecond (float) --
Describes the data transfer rate in MB's per second.
TotalDataInMegaBytes (integer) --
Describes the total amount of data to be transfered in megabytes.
DataTransferredInMegaBytes (integer) --
Describes the total amount of data that has been transfered in MB's.
EstimatedTimeToCompletionInSeconds (integer) --
Describes the estimated number of seconds remaining to complete the transfer.
ElapsedTimeInSeconds (integer) --
Describes the number of seconds that have elapsed during the data transfer.
HsmStatus (dict) --
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (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) --
A value that 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.
ManualSnapshotRetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in the 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) --
The status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
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 Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
IamRoles (list) --
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
(dict) --
An Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other Amazon Web Services services.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload .
ApplyStatus (string) --
A value that describes the status of the IAM role's association with an Amazon Redshift cluster.
The following are possible statuses and descriptions.
in-sync : The role is available for use by the cluster.
adding : The role is in the process of being associated with the cluster.
removing : The role is in the process of being disassociated with the cluster.
PendingActions (list) --
Cluster operations that are waiting to be started.
(string) --
MaintenanceTrackName (string) --
The name of the maintenance track for the cluster.
ElasticResizeNumberOfNodeOptions (string) --
The number of nodes that you can resize the cluster to with the elastic resize method.
DeferredMaintenanceWindows (list) --
Describes a group of DeferredMaintenanceWindow objects.
(dict) --
Describes a deferred maintenance window
DeferMaintenanceIdentifier (string) --
A unique identifier for the maintenance window.
DeferMaintenanceStartTime (datetime) --
A timestamp for the beginning of the time period when we defer maintenance.
DeferMaintenanceEndTime (datetime) --
A timestamp for the end of the time period when we defer maintenance.
SnapshotScheduleIdentifier (string) --
A unique identifier for the cluster snapshot schedule.
SnapshotScheduleState (string) --
The current state of the cluster snapshot schedule.
ExpectedNextSnapshotScheduleTime (datetime) --
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
ExpectedNextSnapshotScheduleTimeStatus (string) --
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
NextMaintenanceWindowStartTime (datetime) --
The date and time in UTC when system maintenance can begin.
ResizeInfo (dict) --
Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
ResizeType (string) --
Returns the value ClassicResize .
AllowCancelResize (boolean) --
A boolean value indicating if the resize operation can be cancelled.
AvailabilityZoneRelocationStatus (string) --
Describes the status of the Availability Zone relocation operation.
ClusterNamespaceArn (string) --
The namespace Amazon Resource Name (ARN) of the cluster.
TotalStorageCapacityInMegaBytes (integer) --
The total storage capacity of the cluster in megabytes.
AquaConfiguration (dict) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaConfigurationStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
DefaultIamRoleArn (string) --
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
ReservedNodeExchangeStatus (dict) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
ReservedNodeExchangeRequestId (string) --
The identifier of the reserved-node exchange request.
Status (string) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
RequestTime (datetime) --
A date and time that indicate when the reserved-node exchange was requested.
SourceReservedNodeId (string) --
The identifier of the source reserved node.
SourceReservedNodeType (string) --
The source reserved-node type, for example ds2.xlarge.
SourceReservedNodeCount (integer) --
The source reserved-node count in the cluster.
TargetReservedNodeOfferingId (string) --
The identifier of the target reserved node offering.
TargetReservedNodeType (string) --
The node type of the target reserved node, for example ra3.4xlarge.
TargetReservedNodeCount (integer) --
The count of target reserved nodes in the cluster.
CustomDomainName (string) --
The custom domain name associated with the cluster.
CustomDomainCertificateArn (string) --
The certificate Amazon Resource Name (ARN) for the custom domain name.
CustomDomainCertificateExpiryDate (datetime) --
The expiration date for the certificate associated with the custom domain name.
MasterPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
MasterPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
IpAddressType (string) --
The IP address type for the cluster. Possible values are ipv4 and dualstack .
{'VpcEndpoint': {'NetworkInterfaces': {'Ipv6Address': 'string'}}}
Deletes a Redshift-managed VPC endpoint.
See also: AWS API Documentation
Request Syntax
client.delete_endpoint_access(
EndpointName='string'
)
string
[REQUIRED]
The Redshift-managed VPC endpoint to delete.
dict
Response Syntax
{
'ClusterIdentifier': 'string',
'ResourceOwner': 'string',
'SubnetGroupName': 'string',
'EndpointStatus': 'string',
'EndpointName': 'string',
'EndpointCreateTime': datetime(2015, 1, 1),
'Port': 123,
'Address': 'string',
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'VpcEndpoint': {
'VpcEndpointId': 'string',
'VpcId': 'string',
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string',
'SubnetId': 'string',
'PrivateIpAddress': 'string',
'AvailabilityZone': 'string',
'Ipv6Address': 'string'
},
]
}
}
Response Structure
(dict) --
Describes a Redshift-managed VPC endpoint.
ClusterIdentifier (string) --
The cluster identifier of the cluster associated with the endpoint.
ResourceOwner (string) --
The Amazon Web Services account ID of the owner of the cluster.
SubnetGroupName (string) --
The subnet group name where Amazon Redshift chooses to deploy the endpoint.
EndpointStatus (string) --
The status of the endpoint.
EndpointName (string) --
The name of the endpoint.
EndpointCreateTime (datetime) --
The time (UTC) that the endpoint was created.
Port (integer) --
The port number on which the cluster accepts incoming connections.
Address (string) --
The DNS address of the endpoint.
VpcSecurityGroups (list) --
The security groups associated with the endpoint.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
The identifier of the VPC security group.
Status (string) --
The status of the VPC security group.
VpcEndpoint (dict) --
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
VpcEndpointId (string) --
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
VpcId (string) --
The VPC identifier that the endpoint is associated.
NetworkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Describes a network interface.
NetworkInterfaceId (string) --
The network interface identifier.
SubnetId (string) --
The subnet identifier.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
AvailabilityZone (string) --
The Availability Zone.
Ipv6Address (string) --
The IPv6 address of the network interface within the subnet.
{'ClusterSubnetGroups': {'SupportedClusterIpAddressTypes': ['string']}}
Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in your Amazon Web Services account.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups 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 subnet groups that have any combination of those values are returned.
If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.
See also: AWS API Documentation
Request Syntax
client.describe_cluster_subnet_groups(
ClusterSubnetGroupName='string',
MaxRecords=123,
Marker='string',
TagKeys=[
'string',
],
TagValues=[
'string',
]
)
string
The name of the cluster subnet group for which information is requested.
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 DescribeClusterSubnetGroups request exceed the value specified in MaxRecords , Amazon Web Services 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.
list
A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet groups 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 subnet groups 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 subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet groups 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 subnet groups that have either or both of these tag values associated with them.
(string) --
dict
Response Syntax
{
'Marker': 'string',
'ClusterSubnetGroups': [
{
'ClusterSubnetGroupName': 'string',
'Description': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string',
'SupportedPlatforms': [
{
'Name': 'string'
},
]
},
'SubnetStatus': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'SupportedClusterIpAddressTypes': [
'string',
]
},
]
}
Response Structure
(dict) --
Contains the output from the DescribeClusterSubnetGroups 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.
ClusterSubnetGroups (list) --
A list of ClusterSubnetGroup instances.
(dict) --
Describes a subnet group.
ClusterSubnetGroupName (string) --
The name of the cluster subnet group.
Description (string) --
The description of the cluster subnet group.
VpcId (string) --
The VPC ID of the cluster subnet group.
SubnetGroupStatus (string) --
The status of the cluster subnet group. Possible values are Complete , Incomplete and Invalid .
Subnets (list) --
A list of the VPC Subnet elements.
(dict) --
Describes a subnet.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Name (string) --
The name of the availability zone.
SupportedPlatforms (list) --
(dict) --
A list of supported platforms for orderable clusters.
Name (string) --
SubnetStatus (string) --
The status of the subnet.
Tags (list) --
The list of tags for the cluster subnet group.
(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.
SupportedClusterIpAddressTypes (list) --
The IP address types supported by this cluster subnet group. Possible values are ipv4 and dualstack .
(string) --
{'Clusters': {'Endpoint': {'VpcEndpoints': {'NetworkInterfaces': {'Ipv6Address': 'string'}}},
'IpAddressType': '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.
See also: AWS API Documentation
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 , Amazon Web Services 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',
'ClusterAvailabilityStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'VpcEndpoints': [
{
'VpcEndpointId': 'string',
'VpcId': 'string',
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string',
'SubnetId': 'string',
'PrivateIpAddress': 'string',
'AvailabilityZone': 'string',
'Ipv6Address': 'string'
},
]
},
]
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'PubliclyAccessible': True|False,
'EnhancedVpcRouting': True|False,
'MaintenanceTrackName': 'string',
'EncryptionType': '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
},
'DataTransferProgress': {
'Status': 'string',
'CurrentRateInMegaBytesPerSecond': 123.0,
'TotalDataInMegaBytes': 123,
'DataTransferredInMegaBytes': 123,
'EstimatedTimeToCompletionInSeconds': 123,
'ElapsedTimeInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'EnhancedVpcRouting': True|False,
'IamRoles': [
{
'IamRoleArn': 'string',
'ApplyStatus': 'string'
},
],
'PendingActions': [
'string',
],
'MaintenanceTrackName': 'string',
'ElasticResizeNumberOfNodeOptions': 'string',
'DeferredMaintenanceWindows': [
{
'DeferMaintenanceIdentifier': 'string',
'DeferMaintenanceStartTime': datetime(2015, 1, 1),
'DeferMaintenanceEndTime': datetime(2015, 1, 1)
},
],
'SnapshotScheduleIdentifier': 'string',
'SnapshotScheduleState': 'MODIFYING'|'ACTIVE'|'FAILED',
'ExpectedNextSnapshotScheduleTime': datetime(2015, 1, 1),
'ExpectedNextSnapshotScheduleTimeStatus': 'string',
'NextMaintenanceWindowStartTime': datetime(2015, 1, 1),
'ResizeInfo': {
'ResizeType': 'string',
'AllowCancelResize': True|False
},
'AvailabilityZoneRelocationStatus': 'string',
'ClusterNamespaceArn': 'string',
'TotalStorageCapacityInMegaBytes': 123,
'AquaConfiguration': {
'AquaStatus': 'enabled'|'disabled'|'applying',
'AquaConfigurationStatus': 'enabled'|'disabled'|'auto'
},
'DefaultIamRoleArn': 'string',
'ReservedNodeExchangeStatus': {
'ReservedNodeExchangeRequestId': 'string',
'Status': 'REQUESTED'|'PENDING'|'IN_PROGRESS'|'RETRYING'|'SUCCEEDED'|'FAILED',
'RequestTime': datetime(2015, 1, 1),
'SourceReservedNodeId': 'string',
'SourceReservedNodeType': 'string',
'SourceReservedNodeCount': 123,
'TargetReservedNodeOfferingId': 'string',
'TargetReservedNodeType': 'string',
'TargetReservedNodeCount': 123
},
'CustomDomainName': 'string',
'CustomDomainCertificateArn': 'string',
'CustomDomainCertificateExpiryDate': datetime(2015, 1, 1),
'MasterPasswordSecretArn': 'string',
'MasterPasswordSecretKmsKeyId': 'string',
'IpAddressType': '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 the cluster. Possible values are the following:
available
available, prep-for-resize
available, resize-cleanup
cancelling-resize
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
paused
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
ClusterAvailabilityStatus (string) --
The availability status of the cluster for queries. Possible values are the following:
Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
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 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.
VpcEndpoints (list) --
Describes a connection endpoint.
(dict) --
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
VpcEndpointId (string) --
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
VpcId (string) --
The VPC identifier that the endpoint is associated.
NetworkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Describes a network interface.
NetworkInterfaceId (string) --
The network interface identifier.
SubnetId (string) --
The subnet identifier.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
AvailabilityZone (string) --
The Availability Zone.
Ipv6Address (string) --
The IPv6 address of the network interface within the subnet.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ManualSnapshotRetentionPeriod (integer) --
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
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 an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a cluster 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 Amazon Virtual Private Cloud (Amazon 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) --
The identifier of the VPC security group.
Status (string) --
The status of the VPC security group.
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 Universal Coordinated Time (UTC), during which system maintenance can occur.
PendingModifiedValues (dict) --
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the admin 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.
PubliclyAccessible (boolean) --
The pending or in-progress change of the ability to connect to the cluster from the public network.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
MaintenanceTrackName (string) --
The name of the maintenance track that the cluster will change to during the next maintenance window.
EncryptionType (string) --
The encryption type for a cluster. Possible values are: KMS and None.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
A boolean value that, if true , indicates that 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) --
A boolean value that, if true , indicates that the cluster can be accessed from a public network.
Encrypted (boolean) --
A boolean value that, if true , indicates that data in the cluster is encrypted at rest.
RestoreStatus (dict) --
A value that describes the status of a cluster restore action. This parameter 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. This field is only updated when you restore to DC2 and DS2 node types.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
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. This field is only updated when you restore to DC2 and DS2 node types.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
DataTransferProgress (dict) --
Status (string) --
Describes the status of the cluster. While the transfer is in progress the status is transferringdata .
CurrentRateInMegaBytesPerSecond (float) --
Describes the data transfer rate in MB's per second.
TotalDataInMegaBytes (integer) --
Describes the total amount of data to be transfered in megabytes.
DataTransferredInMegaBytes (integer) --
Describes the total amount of data that has been transfered in MB's.
EstimatedTimeToCompletionInSeconds (integer) --
Describes the estimated number of seconds remaining to complete the transfer.
ElapsedTimeInSeconds (integer) --
Describes the number of seconds that have elapsed during the data transfer.
HsmStatus (dict) --
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (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) --
A value that 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.
ManualSnapshotRetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in the 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) --
The status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
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 Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
IamRoles (list) --
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
(dict) --
An Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other Amazon Web Services services.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload .
ApplyStatus (string) --
A value that describes the status of the IAM role's association with an Amazon Redshift cluster.
The following are possible statuses and descriptions.
in-sync : The role is available for use by the cluster.
adding : The role is in the process of being associated with the cluster.
removing : The role is in the process of being disassociated with the cluster.
PendingActions (list) --
Cluster operations that are waiting to be started.
(string) --
MaintenanceTrackName (string) --
The name of the maintenance track for the cluster.
ElasticResizeNumberOfNodeOptions (string) --
The number of nodes that you can resize the cluster to with the elastic resize method.
DeferredMaintenanceWindows (list) --
Describes a group of DeferredMaintenanceWindow objects.
(dict) --
Describes a deferred maintenance window
DeferMaintenanceIdentifier (string) --
A unique identifier for the maintenance window.
DeferMaintenanceStartTime (datetime) --
A timestamp for the beginning of the time period when we defer maintenance.
DeferMaintenanceEndTime (datetime) --
A timestamp for the end of the time period when we defer maintenance.
SnapshotScheduleIdentifier (string) --
A unique identifier for the cluster snapshot schedule.
SnapshotScheduleState (string) --
The current state of the cluster snapshot schedule.
ExpectedNextSnapshotScheduleTime (datetime) --
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
ExpectedNextSnapshotScheduleTimeStatus (string) --
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
NextMaintenanceWindowStartTime (datetime) --
The date and time in UTC when system maintenance can begin.
ResizeInfo (dict) --
Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
ResizeType (string) --
Returns the value ClassicResize .
AllowCancelResize (boolean) --
A boolean value indicating if the resize operation can be cancelled.
AvailabilityZoneRelocationStatus (string) --
Describes the status of the Availability Zone relocation operation.
ClusterNamespaceArn (string) --
The namespace Amazon Resource Name (ARN) of the cluster.
TotalStorageCapacityInMegaBytes (integer) --
The total storage capacity of the cluster in megabytes.
AquaConfiguration (dict) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaConfigurationStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
DefaultIamRoleArn (string) --
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
ReservedNodeExchangeStatus (dict) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
ReservedNodeExchangeRequestId (string) --
The identifier of the reserved-node exchange request.
Status (string) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
RequestTime (datetime) --
A date and time that indicate when the reserved-node exchange was requested.
SourceReservedNodeId (string) --
The identifier of the source reserved node.
SourceReservedNodeType (string) --
The source reserved-node type, for example ds2.xlarge.
SourceReservedNodeCount (integer) --
The source reserved-node count in the cluster.
TargetReservedNodeOfferingId (string) --
The identifier of the target reserved node offering.
TargetReservedNodeType (string) --
The node type of the target reserved node, for example ra3.4xlarge.
TargetReservedNodeCount (integer) --
The count of target reserved nodes in the cluster.
CustomDomainName (string) --
The custom domain name associated with the cluster.
CustomDomainCertificateArn (string) --
The certificate Amazon Resource Name (ARN) for the custom domain name.
CustomDomainCertificateExpiryDate (datetime) --
The expiration date for the certificate associated with the custom domain name.
MasterPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
MasterPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
IpAddressType (string) --
The IP address type for the cluster. Possible values are ipv4 and dualstack .
{'EndpointAccessList': {'VpcEndpoint': {'NetworkInterfaces': {'Ipv6Address': 'string'}}}}
Describes a Redshift-managed VPC endpoint.
See also: AWS API Documentation
Request Syntax
client.describe_endpoint_access(
ClusterIdentifier='string',
ResourceOwner='string',
EndpointName='string',
VpcId='string',
MaxRecords=123,
Marker='string'
)
string
The cluster identifier associated with the described endpoint.
string
The Amazon Web Services account ID of the owner of the cluster.
string
The name of the endpoint to be described.
string
The virtual private cloud (VPC) identifier with access to the cluster.
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a Marker is included in the response so that the remaining results can be retrieved.
string
An optional pagination token provided by a previous DescribeEndpointAccess request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.
dict
Response Syntax
{
'EndpointAccessList': [
{
'ClusterIdentifier': 'string',
'ResourceOwner': 'string',
'SubnetGroupName': 'string',
'EndpointStatus': 'string',
'EndpointName': 'string',
'EndpointCreateTime': datetime(2015, 1, 1),
'Port': 123,
'Address': 'string',
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'VpcEndpoint': {
'VpcEndpointId': 'string',
'VpcId': 'string',
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string',
'SubnetId': 'string',
'PrivateIpAddress': 'string',
'AvailabilityZone': 'string',
'Ipv6Address': 'string'
},
]
}
},
],
'Marker': 'string'
}
Response Structure
(dict) --
EndpointAccessList (list) --
The list of endpoints with access to the cluster.
(dict) --
Describes a Redshift-managed VPC endpoint.
ClusterIdentifier (string) --
The cluster identifier of the cluster associated with the endpoint.
ResourceOwner (string) --
The Amazon Web Services account ID of the owner of the cluster.
SubnetGroupName (string) --
The subnet group name where Amazon Redshift chooses to deploy the endpoint.
EndpointStatus (string) --
The status of the endpoint.
EndpointName (string) --
The name of the endpoint.
EndpointCreateTime (datetime) --
The time (UTC) that the endpoint was created.
Port (integer) --
The port number on which the cluster accepts incoming connections.
Address (string) --
The DNS address of the endpoint.
VpcSecurityGroups (list) --
The security groups associated with the endpoint.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
The identifier of the VPC security group.
Status (string) --
The status of the VPC security group.
VpcEndpoint (dict) --
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
VpcEndpointId (string) --
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
VpcId (string) --
The VPC identifier that the endpoint is associated.
NetworkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Describes a network interface.
NetworkInterfaceId (string) --
The network interface identifier.
SubnetId (string) --
The subnet identifier.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
AvailabilityZone (string) --
The Availability Zone.
Ipv6Address (string) --
The IPv6 address of the network interface within the subnet.
Marker (string) --
An optional pagination token provided by a previous DescribeEndpointAccess request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.
{'Cluster': {'Endpoint': {'VpcEndpoints': {'NetworkInterfaces': {'Ipv6Address': 'string'}}},
'IpAddressType': '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 an encrypted symmetric key from Key Management Service, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the key in the destination region.
See also: AWS API Documentation
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',
'ClusterAvailabilityStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'VpcEndpoints': [
{
'VpcEndpointId': 'string',
'VpcId': 'string',
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string',
'SubnetId': 'string',
'PrivateIpAddress': 'string',
'AvailabilityZone': 'string',
'Ipv6Address': 'string'
},
]
},
]
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'PubliclyAccessible': True|False,
'EnhancedVpcRouting': True|False,
'MaintenanceTrackName': 'string',
'EncryptionType': '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
},
'DataTransferProgress': {
'Status': 'string',
'CurrentRateInMegaBytesPerSecond': 123.0,
'TotalDataInMegaBytes': 123,
'DataTransferredInMegaBytes': 123,
'EstimatedTimeToCompletionInSeconds': 123,
'ElapsedTimeInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'EnhancedVpcRouting': True|False,
'IamRoles': [
{
'IamRoleArn': 'string',
'ApplyStatus': 'string'
},
],
'PendingActions': [
'string',
],
'MaintenanceTrackName': 'string',
'ElasticResizeNumberOfNodeOptions': 'string',
'DeferredMaintenanceWindows': [
{
'DeferMaintenanceIdentifier': 'string',
'DeferMaintenanceStartTime': datetime(2015, 1, 1),
'DeferMaintenanceEndTime': datetime(2015, 1, 1)
},
],
'SnapshotScheduleIdentifier': 'string',
'SnapshotScheduleState': 'MODIFYING'|'ACTIVE'|'FAILED',
'ExpectedNextSnapshotScheduleTime': datetime(2015, 1, 1),
'ExpectedNextSnapshotScheduleTimeStatus': 'string',
'NextMaintenanceWindowStartTime': datetime(2015, 1, 1),
'ResizeInfo': {
'ResizeType': 'string',
'AllowCancelResize': True|False
},
'AvailabilityZoneRelocationStatus': 'string',
'ClusterNamespaceArn': 'string',
'TotalStorageCapacityInMegaBytes': 123,
'AquaConfiguration': {
'AquaStatus': 'enabled'|'disabled'|'applying',
'AquaConfigurationStatus': 'enabled'|'disabled'|'auto'
},
'DefaultIamRoleArn': 'string',
'ReservedNodeExchangeStatus': {
'ReservedNodeExchangeRequestId': 'string',
'Status': 'REQUESTED'|'PENDING'|'IN_PROGRESS'|'RETRYING'|'SUCCEEDED'|'FAILED',
'RequestTime': datetime(2015, 1, 1),
'SourceReservedNodeId': 'string',
'SourceReservedNodeType': 'string',
'SourceReservedNodeCount': 123,
'TargetReservedNodeOfferingId': 'string',
'TargetReservedNodeType': 'string',
'TargetReservedNodeCount': 123
},
'CustomDomainName': 'string',
'CustomDomainCertificateArn': 'string',
'CustomDomainCertificateExpiryDate': datetime(2015, 1, 1),
'MasterPasswordSecretArn': 'string',
'MasterPasswordSecretKmsKeyId': 'string',
'IpAddressType': 'string'
}
}
Response Structure
(dict) --
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 the cluster. Possible values are the following:
available
available, prep-for-resize
available, resize-cleanup
cancelling-resize
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
paused
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
ClusterAvailabilityStatus (string) --
The availability status of the cluster for queries. Possible values are the following:
Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
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 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.
VpcEndpoints (list) --
Describes a connection endpoint.
(dict) --
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
VpcEndpointId (string) --
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
VpcId (string) --
The VPC identifier that the endpoint is associated.
NetworkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Describes a network interface.
NetworkInterfaceId (string) --
The network interface identifier.
SubnetId (string) --
The subnet identifier.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
AvailabilityZone (string) --
The Availability Zone.
Ipv6Address (string) --
The IPv6 address of the network interface within the subnet.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ManualSnapshotRetentionPeriod (integer) --
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
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 an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a cluster 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 Amazon Virtual Private Cloud (Amazon 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) --
The identifier of the VPC security group.
Status (string) --
The status of the VPC security group.
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 Universal Coordinated Time (UTC), during which system maintenance can occur.
PendingModifiedValues (dict) --
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the admin 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.
PubliclyAccessible (boolean) --
The pending or in-progress change of the ability to connect to the cluster from the public network.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
MaintenanceTrackName (string) --
The name of the maintenance track that the cluster will change to during the next maintenance window.
EncryptionType (string) --
The encryption type for a cluster. Possible values are: KMS and None.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
A boolean value that, if true , indicates that 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) --
A boolean value that, if true , indicates that the cluster can be accessed from a public network.
Encrypted (boolean) --
A boolean value that, if true , indicates that data in the cluster is encrypted at rest.
RestoreStatus (dict) --
A value that describes the status of a cluster restore action. This parameter 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. This field is only updated when you restore to DC2 and DS2 node types.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
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. This field is only updated when you restore to DC2 and DS2 node types.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
DataTransferProgress (dict) --
Status (string) --
Describes the status of the cluster. While the transfer is in progress the status is transferringdata .
CurrentRateInMegaBytesPerSecond (float) --
Describes the data transfer rate in MB's per second.
TotalDataInMegaBytes (integer) --
Describes the total amount of data to be transfered in megabytes.
DataTransferredInMegaBytes (integer) --
Describes the total amount of data that has been transfered in MB's.
EstimatedTimeToCompletionInSeconds (integer) --
Describes the estimated number of seconds remaining to complete the transfer.
ElapsedTimeInSeconds (integer) --
Describes the number of seconds that have elapsed during the data transfer.
HsmStatus (dict) --
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (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) --
A value that 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.
ManualSnapshotRetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in the 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) --
The status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
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 Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
IamRoles (list) --
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
(dict) --
An Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other Amazon Web Services services.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload .
ApplyStatus (string) --
A value that describes the status of the IAM role's association with an Amazon Redshift cluster.
The following are possible statuses and descriptions.
in-sync : The role is available for use by the cluster.
adding : The role is in the process of being associated with the cluster.
removing : The role is in the process of being disassociated with the cluster.
PendingActions (list) --
Cluster operations that are waiting to be started.
(string) --
MaintenanceTrackName (string) --
The name of the maintenance track for the cluster.
ElasticResizeNumberOfNodeOptions (string) --
The number of nodes that you can resize the cluster to with the elastic resize method.
DeferredMaintenanceWindows (list) --
Describes a group of DeferredMaintenanceWindow objects.
(dict) --
Describes a deferred maintenance window
DeferMaintenanceIdentifier (string) --
A unique identifier for the maintenance window.
DeferMaintenanceStartTime (datetime) --
A timestamp for the beginning of the time period when we defer maintenance.
DeferMaintenanceEndTime (datetime) --
A timestamp for the end of the time period when we defer maintenance.
SnapshotScheduleIdentifier (string) --
A unique identifier for the cluster snapshot schedule.
SnapshotScheduleState (string) --
The current state of the cluster snapshot schedule.
ExpectedNextSnapshotScheduleTime (datetime) --
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
ExpectedNextSnapshotScheduleTimeStatus (string) --
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
NextMaintenanceWindowStartTime (datetime) --
The date and time in UTC when system maintenance can begin.
ResizeInfo (dict) --
Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
ResizeType (string) --
Returns the value ClassicResize .
AllowCancelResize (boolean) --
A boolean value indicating if the resize operation can be cancelled.
AvailabilityZoneRelocationStatus (string) --
Describes the status of the Availability Zone relocation operation.
ClusterNamespaceArn (string) --
The namespace Amazon Resource Name (ARN) of the cluster.
TotalStorageCapacityInMegaBytes (integer) --
The total storage capacity of the cluster in megabytes.
AquaConfiguration (dict) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaConfigurationStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
DefaultIamRoleArn (string) --
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
ReservedNodeExchangeStatus (dict) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
ReservedNodeExchangeRequestId (string) --
The identifier of the reserved-node exchange request.
Status (string) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
RequestTime (datetime) --
A date and time that indicate when the reserved-node exchange was requested.
SourceReservedNodeId (string) --
The identifier of the source reserved node.
SourceReservedNodeType (string) --
The source reserved-node type, for example ds2.xlarge.
SourceReservedNodeCount (integer) --
The source reserved-node count in the cluster.
TargetReservedNodeOfferingId (string) --
The identifier of the target reserved node offering.
TargetReservedNodeType (string) --
The node type of the target reserved node, for example ra3.4xlarge.
TargetReservedNodeCount (integer) --
The count of target reserved nodes in the cluster.
CustomDomainName (string) --
The custom domain name associated with the cluster.
CustomDomainCertificateArn (string) --
The certificate Amazon Resource Name (ARN) for the custom domain name.
CustomDomainCertificateExpiryDate (datetime) --
The expiration date for the certificate associated with the custom domain name.
MasterPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
MasterPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
IpAddressType (string) --
The IP address type for the cluster. Possible values are ipv4 and dualstack .
{'Cluster': {'Endpoint': {'VpcEndpoints': {'NetworkInterfaces': {'Ipv6Address': 'string'}}},
'IpAddressType': 'string'}}
Enables the automatic copy of snapshots from one region to another region for a specified cluster.
See also: AWS API Documentation
Request Syntax
client.enable_snapshot_copy(
ClusterIdentifier='string',
DestinationRegion='string',
RetentionPeriod=123,
SnapshotCopyGrantName='string',
ManualSnapshotRetentionPeriod=123
)
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 Amazon Web Services Region that you want to copy snapshots to.
Constraints: Must be the name of a valid Amazon Web Services 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 Amazon Web Services KMS-encrypted cluster are copied to the destination region.
integer
The number of days to retain newly copied snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ClusterAvailabilityStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'VpcEndpoints': [
{
'VpcEndpointId': 'string',
'VpcId': 'string',
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string',
'SubnetId': 'string',
'PrivateIpAddress': 'string',
'AvailabilityZone': 'string',
'Ipv6Address': 'string'
},
]
},
]
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'PubliclyAccessible': True|False,
'EnhancedVpcRouting': True|False,
'MaintenanceTrackName': 'string',
'EncryptionType': '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
},
'DataTransferProgress': {
'Status': 'string',
'CurrentRateInMegaBytesPerSecond': 123.0,
'TotalDataInMegaBytes': 123,
'DataTransferredInMegaBytes': 123,
'EstimatedTimeToCompletionInSeconds': 123,
'ElapsedTimeInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'EnhancedVpcRouting': True|False,
'IamRoles': [
{
'IamRoleArn': 'string',
'ApplyStatus': 'string'
},
],
'PendingActions': [
'string',
],
'MaintenanceTrackName': 'string',
'ElasticResizeNumberOfNodeOptions': 'string',
'DeferredMaintenanceWindows': [
{
'DeferMaintenanceIdentifier': 'string',
'DeferMaintenanceStartTime': datetime(2015, 1, 1),
'DeferMaintenanceEndTime': datetime(2015, 1, 1)
},
],
'SnapshotScheduleIdentifier': 'string',
'SnapshotScheduleState': 'MODIFYING'|'ACTIVE'|'FAILED',
'ExpectedNextSnapshotScheduleTime': datetime(2015, 1, 1),
'ExpectedNextSnapshotScheduleTimeStatus': 'string',
'NextMaintenanceWindowStartTime': datetime(2015, 1, 1),
'ResizeInfo': {
'ResizeType': 'string',
'AllowCancelResize': True|False
},
'AvailabilityZoneRelocationStatus': 'string',
'ClusterNamespaceArn': 'string',
'TotalStorageCapacityInMegaBytes': 123,
'AquaConfiguration': {
'AquaStatus': 'enabled'|'disabled'|'applying',
'AquaConfigurationStatus': 'enabled'|'disabled'|'auto'
},
'DefaultIamRoleArn': 'string',
'ReservedNodeExchangeStatus': {
'ReservedNodeExchangeRequestId': 'string',
'Status': 'REQUESTED'|'PENDING'|'IN_PROGRESS'|'RETRYING'|'SUCCEEDED'|'FAILED',
'RequestTime': datetime(2015, 1, 1),
'SourceReservedNodeId': 'string',
'SourceReservedNodeType': 'string',
'SourceReservedNodeCount': 123,
'TargetReservedNodeOfferingId': 'string',
'TargetReservedNodeType': 'string',
'TargetReservedNodeCount': 123
},
'CustomDomainName': 'string',
'CustomDomainCertificateArn': 'string',
'CustomDomainCertificateExpiryDate': datetime(2015, 1, 1),
'MasterPasswordSecretArn': 'string',
'MasterPasswordSecretKmsKeyId': 'string',
'IpAddressType': 'string'
}
}
Response Structure
(dict) --
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 the cluster. Possible values are the following:
available
available, prep-for-resize
available, resize-cleanup
cancelling-resize
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
paused
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
ClusterAvailabilityStatus (string) --
The availability status of the cluster for queries. Possible values are the following:
Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
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 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.
VpcEndpoints (list) --
Describes a connection endpoint.
(dict) --
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
VpcEndpointId (string) --
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
VpcId (string) --
The VPC identifier that the endpoint is associated.
NetworkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Describes a network interface.
NetworkInterfaceId (string) --
The network interface identifier.
SubnetId (string) --
The subnet identifier.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
AvailabilityZone (string) --
The Availability Zone.
Ipv6Address (string) --
The IPv6 address of the network interface within the subnet.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ManualSnapshotRetentionPeriod (integer) --
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
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 an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a cluster 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 Amazon Virtual Private Cloud (Amazon 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) --
The identifier of the VPC security group.
Status (string) --
The status of the VPC security group.
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 Universal Coordinated Time (UTC), during which system maintenance can occur.
PendingModifiedValues (dict) --
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the admin 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.
PubliclyAccessible (boolean) --
The pending or in-progress change of the ability to connect to the cluster from the public network.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
MaintenanceTrackName (string) --
The name of the maintenance track that the cluster will change to during the next maintenance window.
EncryptionType (string) --
The encryption type for a cluster. Possible values are: KMS and None.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
A boolean value that, if true , indicates that 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) --
A boolean value that, if true , indicates that the cluster can be accessed from a public network.
Encrypted (boolean) --
A boolean value that, if true , indicates that data in the cluster is encrypted at rest.
RestoreStatus (dict) --
A value that describes the status of a cluster restore action. This parameter 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. This field is only updated when you restore to DC2 and DS2 node types.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
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. This field is only updated when you restore to DC2 and DS2 node types.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
DataTransferProgress (dict) --
Status (string) --
Describes the status of the cluster. While the transfer is in progress the status is transferringdata .
CurrentRateInMegaBytesPerSecond (float) --
Describes the data transfer rate in MB's per second.
TotalDataInMegaBytes (integer) --
Describes the total amount of data to be transfered in megabytes.
DataTransferredInMegaBytes (integer) --
Describes the total amount of data that has been transfered in MB's.
EstimatedTimeToCompletionInSeconds (integer) --
Describes the estimated number of seconds remaining to complete the transfer.
ElapsedTimeInSeconds (integer) --
Describes the number of seconds that have elapsed during the data transfer.
HsmStatus (dict) --
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (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) --
A value that 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.
ManualSnapshotRetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in the 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) --
The status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
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 Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
IamRoles (list) --
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
(dict) --
An Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other Amazon Web Services services.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload .
ApplyStatus (string) --
A value that describes the status of the IAM role's association with an Amazon Redshift cluster.
The following are possible statuses and descriptions.
in-sync : The role is available for use by the cluster.
adding : The role is in the process of being associated with the cluster.
removing : The role is in the process of being disassociated with the cluster.
PendingActions (list) --
Cluster operations that are waiting to be started.
(string) --
MaintenanceTrackName (string) --
The name of the maintenance track for the cluster.
ElasticResizeNumberOfNodeOptions (string) --
The number of nodes that you can resize the cluster to with the elastic resize method.
DeferredMaintenanceWindows (list) --
Describes a group of DeferredMaintenanceWindow objects.
(dict) --
Describes a deferred maintenance window
DeferMaintenanceIdentifier (string) --
A unique identifier for the maintenance window.
DeferMaintenanceStartTime (datetime) --
A timestamp for the beginning of the time period when we defer maintenance.
DeferMaintenanceEndTime (datetime) --
A timestamp for the end of the time period when we defer maintenance.
SnapshotScheduleIdentifier (string) --
A unique identifier for the cluster snapshot schedule.
SnapshotScheduleState (string) --
The current state of the cluster snapshot schedule.
ExpectedNextSnapshotScheduleTime (datetime) --
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
ExpectedNextSnapshotScheduleTimeStatus (string) --
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
NextMaintenanceWindowStartTime (datetime) --
The date and time in UTC when system maintenance can begin.
ResizeInfo (dict) --
Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
ResizeType (string) --
Returns the value ClassicResize .
AllowCancelResize (boolean) --
A boolean value indicating if the resize operation can be cancelled.
AvailabilityZoneRelocationStatus (string) --
Describes the status of the Availability Zone relocation operation.
ClusterNamespaceArn (string) --
The namespace Amazon Resource Name (ARN) of the cluster.
TotalStorageCapacityInMegaBytes (integer) --
The total storage capacity of the cluster in megabytes.
AquaConfiguration (dict) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaConfigurationStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
DefaultIamRoleArn (string) --
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
ReservedNodeExchangeStatus (dict) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
ReservedNodeExchangeRequestId (string) --
The identifier of the reserved-node exchange request.
Status (string) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
RequestTime (datetime) --
A date and time that indicate when the reserved-node exchange was requested.
SourceReservedNodeId (string) --
The identifier of the source reserved node.
SourceReservedNodeType (string) --
The source reserved-node type, for example ds2.xlarge.
SourceReservedNodeCount (integer) --
The source reserved-node count in the cluster.
TargetReservedNodeOfferingId (string) --
The identifier of the target reserved node offering.
TargetReservedNodeType (string) --
The node type of the target reserved node, for example ra3.4xlarge.
TargetReservedNodeCount (integer) --
The count of target reserved nodes in the cluster.
CustomDomainName (string) --
The custom domain name associated with the cluster.
CustomDomainCertificateArn (string) --
The certificate Amazon Resource Name (ARN) for the custom domain name.
CustomDomainCertificateExpiryDate (datetime) --
The expiration date for the certificate associated with the custom domain name.
MasterPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
MasterPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
IpAddressType (string) --
The IP address type for the cluster. Possible values are ipv4 and dualstack .
{'IpAddressType': 'string'}
Response {'Cluster': {'Endpoint': {'VpcEndpoints': {'NetworkInterfaces': {'Ipv6Address': 'string'}}},
'IpAddressType': 'string'}}
Modifies the settings for a cluster.
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.
You can add another security or parameter group, or change the admin 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 .
See also: AWS API Documentation
Request Syntax
client.modify_cluster(
ClusterIdentifier='string',
ClusterType='string',
NodeType='string',
NumberOfNodes=123,
ClusterSecurityGroups=[
'string',
],
VpcSecurityGroupIds=[
'string',
],
MasterUserPassword='string',
ClusterParameterGroupName='string',
AutomatedSnapshotRetentionPeriod=123,
ManualSnapshotRetentionPeriod=123,
PreferredMaintenanceWindow='string',
ClusterVersion='string',
AllowVersionUpgrade=True|False,
HsmClientCertificateIdentifier='string',
HsmConfigurationIdentifier='string',
NewClusterIdentifier='string',
PubliclyAccessible=True|False,
ElasticIp='string',
EnhancedVpcRouting=True|False,
MaintenanceTrackName='string',
Encrypted=True|False,
KmsKeyId='string',
AvailabilityZoneRelocation=True|False,
AvailabilityZone='string',
Port=123,
ManageMasterPassword=True|False,
MasterPasswordSecretKmsKeyId='string',
IpAddressType='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.
For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide .
Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge
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.
For more information about resizing clusters, go to Resizing Clusters in Amazon Redshift in the Amazon Redshift Cluster Management Guide .
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. This change is asynchronously applied as soon as possible.
(string) --
string
The new password for the cluster admin 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.
You can't use MasterUserPassword if ManageMasterPassword is true .
Note
Operations never return the password, so this operation provides a way to regain access to the admin user account for a cluster if the password is lost.
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-126) except ' (single quote), " (double quote), \ , / , or @ .
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.
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
Default: Uses existing setting.
Constraints: Must be a value from 0 to 35.
integer
The default for number of days that a newly created manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. This value doesn't retroactively change the retention periods of existing manual snapshots.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
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 Amazon Web Services account.
Example: examplecluster
boolean
If true , the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.
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.
boolean
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
string
The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.
boolean
Indicates whether the cluster is encrypted. If the value is encrypted (true) and you provide a value for the KmsKeyId parameter, we encrypt the cluster with the provided KmsKeyId . If you don't provide a KmsKeyId , we encrypt with the default key.
If the value is not encrypted (false), then the cluster is decrypted.
string
The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
boolean
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.
string
The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.
integer
The option to change the port of an Amazon Redshift cluster.
boolean
If true , Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.
string
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter if ManageMasterPassword is true.
string
The IP address types that the cluster supports. Possible values are ipv4 and dualstack .
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ClusterAvailabilityStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'VpcEndpoints': [
{
'VpcEndpointId': 'string',
'VpcId': 'string',
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string',
'SubnetId': 'string',
'PrivateIpAddress': 'string',
'AvailabilityZone': 'string',
'Ipv6Address': 'string'
},
]
},
]
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'PubliclyAccessible': True|False,
'EnhancedVpcRouting': True|False,
'MaintenanceTrackName': 'string',
'EncryptionType': '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
},
'DataTransferProgress': {
'Status': 'string',
'CurrentRateInMegaBytesPerSecond': 123.0,
'TotalDataInMegaBytes': 123,
'DataTransferredInMegaBytes': 123,
'EstimatedTimeToCompletionInSeconds': 123,
'ElapsedTimeInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'EnhancedVpcRouting': True|False,
'IamRoles': [
{
'IamRoleArn': 'string',
'ApplyStatus': 'string'
},
],
'PendingActions': [
'string',
],
'MaintenanceTrackName': 'string',
'ElasticResizeNumberOfNodeOptions': 'string',
'DeferredMaintenanceWindows': [
{
'DeferMaintenanceIdentifier': 'string',
'DeferMaintenanceStartTime': datetime(2015, 1, 1),
'DeferMaintenanceEndTime': datetime(2015, 1, 1)
},
],
'SnapshotScheduleIdentifier': 'string',
'SnapshotScheduleState': 'MODIFYING'|'ACTIVE'|'FAILED',
'ExpectedNextSnapshotScheduleTime': datetime(2015, 1, 1),
'ExpectedNextSnapshotScheduleTimeStatus': 'string',
'NextMaintenanceWindowStartTime': datetime(2015, 1, 1),
'ResizeInfo': {
'ResizeType': 'string',
'AllowCancelResize': True|False
},
'AvailabilityZoneRelocationStatus': 'string',
'ClusterNamespaceArn': 'string',
'TotalStorageCapacityInMegaBytes': 123,
'AquaConfiguration': {
'AquaStatus': 'enabled'|'disabled'|'applying',
'AquaConfigurationStatus': 'enabled'|'disabled'|'auto'
},
'DefaultIamRoleArn': 'string',
'ReservedNodeExchangeStatus': {
'ReservedNodeExchangeRequestId': 'string',
'Status': 'REQUESTED'|'PENDING'|'IN_PROGRESS'|'RETRYING'|'SUCCEEDED'|'FAILED',
'RequestTime': datetime(2015, 1, 1),
'SourceReservedNodeId': 'string',
'SourceReservedNodeType': 'string',
'SourceReservedNodeCount': 123,
'TargetReservedNodeOfferingId': 'string',
'TargetReservedNodeType': 'string',
'TargetReservedNodeCount': 123
},
'CustomDomainName': 'string',
'CustomDomainCertificateArn': 'string',
'CustomDomainCertificateExpiryDate': datetime(2015, 1, 1),
'MasterPasswordSecretArn': 'string',
'MasterPasswordSecretKmsKeyId': 'string',
'IpAddressType': 'string'
}
}
Response Structure
(dict) --
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 the cluster. Possible values are the following:
available
available, prep-for-resize
available, resize-cleanup
cancelling-resize
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
paused
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
ClusterAvailabilityStatus (string) --
The availability status of the cluster for queries. Possible values are the following:
Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
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 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.
VpcEndpoints (list) --
Describes a connection endpoint.
(dict) --
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
VpcEndpointId (string) --
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
VpcId (string) --
The VPC identifier that the endpoint is associated.
NetworkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Describes a network interface.
NetworkInterfaceId (string) --
The network interface identifier.
SubnetId (string) --
The subnet identifier.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
AvailabilityZone (string) --
The Availability Zone.
Ipv6Address (string) --
The IPv6 address of the network interface within the subnet.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ManualSnapshotRetentionPeriod (integer) --
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
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 an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a cluster 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 Amazon Virtual Private Cloud (Amazon 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) --
The identifier of the VPC security group.
Status (string) --
The status of the VPC security group.
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 Universal Coordinated Time (UTC), during which system maintenance can occur.
PendingModifiedValues (dict) --
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the admin 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.
PubliclyAccessible (boolean) --
The pending or in-progress change of the ability to connect to the cluster from the public network.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
MaintenanceTrackName (string) --
The name of the maintenance track that the cluster will change to during the next maintenance window.
EncryptionType (string) --
The encryption type for a cluster. Possible values are: KMS and None.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
A boolean value that, if true , indicates that 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) --
A boolean value that, if true , indicates that the cluster can be accessed from a public network.
Encrypted (boolean) --
A boolean value that, if true , indicates that data in the cluster is encrypted at rest.
RestoreStatus (dict) --
A value that describes the status of a cluster restore action. This parameter 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. This field is only updated when you restore to DC2 and DS2 node types.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
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. This field is only updated when you restore to DC2 and DS2 node types.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
DataTransferProgress (dict) --
Status (string) --
Describes the status of the cluster. While the transfer is in progress the status is transferringdata .
CurrentRateInMegaBytesPerSecond (float) --
Describes the data transfer rate in MB's per second.
TotalDataInMegaBytes (integer) --
Describes the total amount of data to be transfered in megabytes.
DataTransferredInMegaBytes (integer) --
Describes the total amount of data that has been transfered in MB's.
EstimatedTimeToCompletionInSeconds (integer) --
Describes the estimated number of seconds remaining to complete the transfer.
ElapsedTimeInSeconds (integer) --
Describes the number of seconds that have elapsed during the data transfer.
HsmStatus (dict) --
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (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) --
A value that 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.
ManualSnapshotRetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in the 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) --
The status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
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 Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
IamRoles (list) --
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
(dict) --
An Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other Amazon Web Services services.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload .
ApplyStatus (string) --
A value that describes the status of the IAM role's association with an Amazon Redshift cluster.
The following are possible statuses and descriptions.
in-sync : The role is available for use by the cluster.
adding : The role is in the process of being associated with the cluster.
removing : The role is in the process of being disassociated with the cluster.
PendingActions (list) --
Cluster operations that are waiting to be started.
(string) --
MaintenanceTrackName (string) --
The name of the maintenance track for the cluster.
ElasticResizeNumberOfNodeOptions (string) --
The number of nodes that you can resize the cluster to with the elastic resize method.
DeferredMaintenanceWindows (list) --
Describes a group of DeferredMaintenanceWindow objects.
(dict) --
Describes a deferred maintenance window
DeferMaintenanceIdentifier (string) --
A unique identifier for the maintenance window.
DeferMaintenanceStartTime (datetime) --
A timestamp for the beginning of the time period when we defer maintenance.
DeferMaintenanceEndTime (datetime) --
A timestamp for the end of the time period when we defer maintenance.
SnapshotScheduleIdentifier (string) --
A unique identifier for the cluster snapshot schedule.
SnapshotScheduleState (string) --
The current state of the cluster snapshot schedule.
ExpectedNextSnapshotScheduleTime (datetime) --
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
ExpectedNextSnapshotScheduleTimeStatus (string) --
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
NextMaintenanceWindowStartTime (datetime) --
The date and time in UTC when system maintenance can begin.
ResizeInfo (dict) --
Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
ResizeType (string) --
Returns the value ClassicResize .
AllowCancelResize (boolean) --
A boolean value indicating if the resize operation can be cancelled.
AvailabilityZoneRelocationStatus (string) --
Describes the status of the Availability Zone relocation operation.
ClusterNamespaceArn (string) --
The namespace Amazon Resource Name (ARN) of the cluster.
TotalStorageCapacityInMegaBytes (integer) --
The total storage capacity of the cluster in megabytes.
AquaConfiguration (dict) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaConfigurationStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
DefaultIamRoleArn (string) --
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
ReservedNodeExchangeStatus (dict) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
ReservedNodeExchangeRequestId (string) --
The identifier of the reserved-node exchange request.
Status (string) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
RequestTime (datetime) --
A date and time that indicate when the reserved-node exchange was requested.
SourceReservedNodeId (string) --
The identifier of the source reserved node.
SourceReservedNodeType (string) --
The source reserved-node type, for example ds2.xlarge.
SourceReservedNodeCount (integer) --
The source reserved-node count in the cluster.
TargetReservedNodeOfferingId (string) --
The identifier of the target reserved node offering.
TargetReservedNodeType (string) --
The node type of the target reserved node, for example ra3.4xlarge.
TargetReservedNodeCount (integer) --
The count of target reserved nodes in the cluster.
CustomDomainName (string) --
The custom domain name associated with the cluster.
CustomDomainCertificateArn (string) --
The certificate Amazon Resource Name (ARN) for the custom domain name.
CustomDomainCertificateExpiryDate (datetime) --
The expiration date for the certificate associated with the custom domain name.
MasterPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
MasterPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
IpAddressType (string) --
The IP address type for the cluster. Possible values are ipv4 and dualstack .
{'Cluster': {'Endpoint': {'VpcEndpoints': {'NetworkInterfaces': {'Ipv6Address': 'string'}}},
'IpAddressType': 'string'}}
Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.
See also: AWS API Documentation
Request Syntax
client.modify_cluster_db_revision(
ClusterIdentifier='string',
RevisionTarget='string'
)
string
[REQUIRED]
The unique identifier of a cluster whose database revision you want to modify.
Example: examplecluster
string
[REQUIRED]
The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ClusterAvailabilityStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'VpcEndpoints': [
{
'VpcEndpointId': 'string',
'VpcId': 'string',
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string',
'SubnetId': 'string',
'PrivateIpAddress': 'string',
'AvailabilityZone': 'string',
'Ipv6Address': 'string'
},
]
},
]
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'PubliclyAccessible': True|False,
'EnhancedVpcRouting': True|False,
'MaintenanceTrackName': 'string',
'EncryptionType': '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
},
'DataTransferProgress': {
'Status': 'string',
'CurrentRateInMegaBytesPerSecond': 123.0,
'TotalDataInMegaBytes': 123,
'DataTransferredInMegaBytes': 123,
'EstimatedTimeToCompletionInSeconds': 123,
'ElapsedTimeInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'EnhancedVpcRouting': True|False,
'IamRoles': [
{
'IamRoleArn': 'string',
'ApplyStatus': 'string'
},
],
'PendingActions': [
'string',
],
'MaintenanceTrackName': 'string',
'ElasticResizeNumberOfNodeOptions': 'string',
'DeferredMaintenanceWindows': [
{
'DeferMaintenanceIdentifier': 'string',
'DeferMaintenanceStartTime': datetime(2015, 1, 1),
'DeferMaintenanceEndTime': datetime(2015, 1, 1)
},
],
'SnapshotScheduleIdentifier': 'string',
'SnapshotScheduleState': 'MODIFYING'|'ACTIVE'|'FAILED',
'ExpectedNextSnapshotScheduleTime': datetime(2015, 1, 1),
'ExpectedNextSnapshotScheduleTimeStatus': 'string',
'NextMaintenanceWindowStartTime': datetime(2015, 1, 1),
'ResizeInfo': {
'ResizeType': 'string',
'AllowCancelResize': True|False
},
'AvailabilityZoneRelocationStatus': 'string',
'ClusterNamespaceArn': 'string',
'TotalStorageCapacityInMegaBytes': 123,
'AquaConfiguration': {
'AquaStatus': 'enabled'|'disabled'|'applying',
'AquaConfigurationStatus': 'enabled'|'disabled'|'auto'
},
'DefaultIamRoleArn': 'string',
'ReservedNodeExchangeStatus': {
'ReservedNodeExchangeRequestId': 'string',
'Status': 'REQUESTED'|'PENDING'|'IN_PROGRESS'|'RETRYING'|'SUCCEEDED'|'FAILED',
'RequestTime': datetime(2015, 1, 1),
'SourceReservedNodeId': 'string',
'SourceReservedNodeType': 'string',
'SourceReservedNodeCount': 123,
'TargetReservedNodeOfferingId': 'string',
'TargetReservedNodeType': 'string',
'TargetReservedNodeCount': 123
},
'CustomDomainName': 'string',
'CustomDomainCertificateArn': 'string',
'CustomDomainCertificateExpiryDate': datetime(2015, 1, 1),
'MasterPasswordSecretArn': 'string',
'MasterPasswordSecretKmsKeyId': 'string',
'IpAddressType': 'string'
}
}
Response Structure
(dict) --
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 the cluster. Possible values are the following:
available
available, prep-for-resize
available, resize-cleanup
cancelling-resize
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
paused
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
ClusterAvailabilityStatus (string) --
The availability status of the cluster for queries. Possible values are the following:
Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
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 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.
VpcEndpoints (list) --
Describes a connection endpoint.
(dict) --
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
VpcEndpointId (string) --
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
VpcId (string) --
The VPC identifier that the endpoint is associated.
NetworkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Describes a network interface.
NetworkInterfaceId (string) --
The network interface identifier.
SubnetId (string) --
The subnet identifier.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
AvailabilityZone (string) --
The Availability Zone.
Ipv6Address (string) --
The IPv6 address of the network interface within the subnet.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ManualSnapshotRetentionPeriod (integer) --
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
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 an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a cluster 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 Amazon Virtual Private Cloud (Amazon 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) --
The identifier of the VPC security group.
Status (string) --
The status of the VPC security group.
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 Universal Coordinated Time (UTC), during which system maintenance can occur.
PendingModifiedValues (dict) --
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the admin 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.
PubliclyAccessible (boolean) --
The pending or in-progress change of the ability to connect to the cluster from the public network.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
MaintenanceTrackName (string) --
The name of the maintenance track that the cluster will change to during the next maintenance window.
EncryptionType (string) --
The encryption type for a cluster. Possible values are: KMS and None.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
A boolean value that, if true , indicates that 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) --
A boolean value that, if true , indicates that the cluster can be accessed from a public network.
Encrypted (boolean) --
A boolean value that, if true , indicates that data in the cluster is encrypted at rest.
RestoreStatus (dict) --
A value that describes the status of a cluster restore action. This parameter 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. This field is only updated when you restore to DC2 and DS2 node types.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
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. This field is only updated when you restore to DC2 and DS2 node types.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
DataTransferProgress (dict) --
Status (string) --
Describes the status of the cluster. While the transfer is in progress the status is transferringdata .
CurrentRateInMegaBytesPerSecond (float) --
Describes the data transfer rate in MB's per second.
TotalDataInMegaBytes (integer) --
Describes the total amount of data to be transfered in megabytes.
DataTransferredInMegaBytes (integer) --
Describes the total amount of data that has been transfered in MB's.
EstimatedTimeToCompletionInSeconds (integer) --
Describes the estimated number of seconds remaining to complete the transfer.
ElapsedTimeInSeconds (integer) --
Describes the number of seconds that have elapsed during the data transfer.
HsmStatus (dict) --
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (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) --
A value that 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.
ManualSnapshotRetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in the 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) --
The status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
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 Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
IamRoles (list) --
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
(dict) --
An Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other Amazon Web Services services.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload .
ApplyStatus (string) --
A value that describes the status of the IAM role's association with an Amazon Redshift cluster.
The following are possible statuses and descriptions.
in-sync : The role is available for use by the cluster.
adding : The role is in the process of being associated with the cluster.
removing : The role is in the process of being disassociated with the cluster.
PendingActions (list) --
Cluster operations that are waiting to be started.
(string) --
MaintenanceTrackName (string) --
The name of the maintenance track for the cluster.
ElasticResizeNumberOfNodeOptions (string) --
The number of nodes that you can resize the cluster to with the elastic resize method.
DeferredMaintenanceWindows (list) --
Describes a group of DeferredMaintenanceWindow objects.
(dict) --
Describes a deferred maintenance window
DeferMaintenanceIdentifier (string) --
A unique identifier for the maintenance window.
DeferMaintenanceStartTime (datetime) --
A timestamp for the beginning of the time period when we defer maintenance.
DeferMaintenanceEndTime (datetime) --
A timestamp for the end of the time period when we defer maintenance.
SnapshotScheduleIdentifier (string) --
A unique identifier for the cluster snapshot schedule.
SnapshotScheduleState (string) --
The current state of the cluster snapshot schedule.
ExpectedNextSnapshotScheduleTime (datetime) --
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
ExpectedNextSnapshotScheduleTimeStatus (string) --
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
NextMaintenanceWindowStartTime (datetime) --
The date and time in UTC when system maintenance can begin.
ResizeInfo (dict) --
Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
ResizeType (string) --
Returns the value ClassicResize .
AllowCancelResize (boolean) --
A boolean value indicating if the resize operation can be cancelled.
AvailabilityZoneRelocationStatus (string) --
Describes the status of the Availability Zone relocation operation.
ClusterNamespaceArn (string) --
The namespace Amazon Resource Name (ARN) of the cluster.
TotalStorageCapacityInMegaBytes (integer) --
The total storage capacity of the cluster in megabytes.
AquaConfiguration (dict) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaConfigurationStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
DefaultIamRoleArn (string) --
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
ReservedNodeExchangeStatus (dict) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
ReservedNodeExchangeRequestId (string) --
The identifier of the reserved-node exchange request.
Status (string) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
RequestTime (datetime) --
A date and time that indicate when the reserved-node exchange was requested.
SourceReservedNodeId (string) --
The identifier of the source reserved node.
SourceReservedNodeType (string) --
The source reserved-node type, for example ds2.xlarge.
SourceReservedNodeCount (integer) --
The source reserved-node count in the cluster.
TargetReservedNodeOfferingId (string) --
The identifier of the target reserved node offering.
TargetReservedNodeType (string) --
The node type of the target reserved node, for example ra3.4xlarge.
TargetReservedNodeCount (integer) --
The count of target reserved nodes in the cluster.
CustomDomainName (string) --
The custom domain name associated with the cluster.
CustomDomainCertificateArn (string) --
The certificate Amazon Resource Name (ARN) for the custom domain name.
CustomDomainCertificateExpiryDate (datetime) --
The expiration date for the certificate associated with the custom domain name.
MasterPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
MasterPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
IpAddressType (string) --
The IP address type for the cluster. Possible values are ipv4 and dualstack .
{'Cluster': {'Endpoint': {'VpcEndpoints': {'NetworkInterfaces': {'Ipv6Address': 'string'}}},
'IpAddressType': 'string'}}
Modifies the list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide .
See also: AWS API Documentation
Request Syntax
client.modify_cluster_iam_roles(
ClusterIdentifier='string',
AddIamRoles=[
'string',
],
RemoveIamRoles=[
'string',
],
DefaultIamRoleArn='string'
)
string
[REQUIRED]
The unique identifier of the cluster for which you want to associate or disassociate IAM roles.
list
Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format.
(string) --
list
Zero or more IAM roles in ARN format to disassociate from the cluster.
(string) --
string
The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ClusterAvailabilityStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'VpcEndpoints': [
{
'VpcEndpointId': 'string',
'VpcId': 'string',
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string',
'SubnetId': 'string',
'PrivateIpAddress': 'string',
'AvailabilityZone': 'string',
'Ipv6Address': 'string'
},
]
},
]
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'PubliclyAccessible': True|False,
'EnhancedVpcRouting': True|False,
'MaintenanceTrackName': 'string',
'EncryptionType': '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
},
'DataTransferProgress': {
'Status': 'string',
'CurrentRateInMegaBytesPerSecond': 123.0,
'TotalDataInMegaBytes': 123,
'DataTransferredInMegaBytes': 123,
'EstimatedTimeToCompletionInSeconds': 123,
'ElapsedTimeInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'EnhancedVpcRouting': True|False,
'IamRoles': [
{
'IamRoleArn': 'string',
'ApplyStatus': 'string'
},
],
'PendingActions': [
'string',
],
'MaintenanceTrackName': 'string',
'ElasticResizeNumberOfNodeOptions': 'string',
'DeferredMaintenanceWindows': [
{
'DeferMaintenanceIdentifier': 'string',
'DeferMaintenanceStartTime': datetime(2015, 1, 1),
'DeferMaintenanceEndTime': datetime(2015, 1, 1)
},
],
'SnapshotScheduleIdentifier': 'string',
'SnapshotScheduleState': 'MODIFYING'|'ACTIVE'|'FAILED',
'ExpectedNextSnapshotScheduleTime': datetime(2015, 1, 1),
'ExpectedNextSnapshotScheduleTimeStatus': 'string',
'NextMaintenanceWindowStartTime': datetime(2015, 1, 1),
'ResizeInfo': {
'ResizeType': 'string',
'AllowCancelResize': True|False
},
'AvailabilityZoneRelocationStatus': 'string',
'ClusterNamespaceArn': 'string',
'TotalStorageCapacityInMegaBytes': 123,
'AquaConfiguration': {
'AquaStatus': 'enabled'|'disabled'|'applying',
'AquaConfigurationStatus': 'enabled'|'disabled'|'auto'
},
'DefaultIamRoleArn': 'string',
'ReservedNodeExchangeStatus': {
'ReservedNodeExchangeRequestId': 'string',
'Status': 'REQUESTED'|'PENDING'|'IN_PROGRESS'|'RETRYING'|'SUCCEEDED'|'FAILED',
'RequestTime': datetime(2015, 1, 1),
'SourceReservedNodeId': 'string',
'SourceReservedNodeType': 'string',
'SourceReservedNodeCount': 123,
'TargetReservedNodeOfferingId': 'string',
'TargetReservedNodeType': 'string',
'TargetReservedNodeCount': 123
},
'CustomDomainName': 'string',
'CustomDomainCertificateArn': 'string',
'CustomDomainCertificateExpiryDate': datetime(2015, 1, 1),
'MasterPasswordSecretArn': 'string',
'MasterPasswordSecretKmsKeyId': 'string',
'IpAddressType': 'string'
}
}
Response Structure
(dict) --
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 the cluster. Possible values are the following:
available
available, prep-for-resize
available, resize-cleanup
cancelling-resize
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
paused
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
ClusterAvailabilityStatus (string) --
The availability status of the cluster for queries. Possible values are the following:
Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
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 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.
VpcEndpoints (list) --
Describes a connection endpoint.
(dict) --
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
VpcEndpointId (string) --
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
VpcId (string) --
The VPC identifier that the endpoint is associated.
NetworkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Describes a network interface.
NetworkInterfaceId (string) --
The network interface identifier.
SubnetId (string) --
The subnet identifier.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
AvailabilityZone (string) --
The Availability Zone.
Ipv6Address (string) --
The IPv6 address of the network interface within the subnet.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ManualSnapshotRetentionPeriod (integer) --
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
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 an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a cluster 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 Amazon Virtual Private Cloud (Amazon 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) --
The identifier of the VPC security group.
Status (string) --
The status of the VPC security group.
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 Universal Coordinated Time (UTC), during which system maintenance can occur.
PendingModifiedValues (dict) --
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the admin 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.
PubliclyAccessible (boolean) --
The pending or in-progress change of the ability to connect to the cluster from the public network.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
MaintenanceTrackName (string) --
The name of the maintenance track that the cluster will change to during the next maintenance window.
EncryptionType (string) --
The encryption type for a cluster. Possible values are: KMS and None.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
A boolean value that, if true , indicates that 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) --
A boolean value that, if true , indicates that the cluster can be accessed from a public network.
Encrypted (boolean) --
A boolean value that, if true , indicates that data in the cluster is encrypted at rest.
RestoreStatus (dict) --
A value that describes the status of a cluster restore action. This parameter 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. This field is only updated when you restore to DC2 and DS2 node types.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
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. This field is only updated when you restore to DC2 and DS2 node types.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
DataTransferProgress (dict) --
Status (string) --
Describes the status of the cluster. While the transfer is in progress the status is transferringdata .
CurrentRateInMegaBytesPerSecond (float) --
Describes the data transfer rate in MB's per second.
TotalDataInMegaBytes (integer) --
Describes the total amount of data to be transfered in megabytes.
DataTransferredInMegaBytes (integer) --
Describes the total amount of data that has been transfered in MB's.
EstimatedTimeToCompletionInSeconds (integer) --
Describes the estimated number of seconds remaining to complete the transfer.
ElapsedTimeInSeconds (integer) --
Describes the number of seconds that have elapsed during the data transfer.
HsmStatus (dict) --
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (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) --
A value that 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.
ManualSnapshotRetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in the 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) --
The status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
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 Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
IamRoles (list) --
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
(dict) --
An Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other Amazon Web Services services.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload .
ApplyStatus (string) --
A value that describes the status of the IAM role's association with an Amazon Redshift cluster.
The following are possible statuses and descriptions.
in-sync : The role is available for use by the cluster.
adding : The role is in the process of being associated with the cluster.
removing : The role is in the process of being disassociated with the cluster.
PendingActions (list) --
Cluster operations that are waiting to be started.
(string) --
MaintenanceTrackName (string) --
The name of the maintenance track for the cluster.
ElasticResizeNumberOfNodeOptions (string) --
The number of nodes that you can resize the cluster to with the elastic resize method.
DeferredMaintenanceWindows (list) --
Describes a group of DeferredMaintenanceWindow objects.
(dict) --
Describes a deferred maintenance window
DeferMaintenanceIdentifier (string) --
A unique identifier for the maintenance window.
DeferMaintenanceStartTime (datetime) --
A timestamp for the beginning of the time period when we defer maintenance.
DeferMaintenanceEndTime (datetime) --
A timestamp for the end of the time period when we defer maintenance.
SnapshotScheduleIdentifier (string) --
A unique identifier for the cluster snapshot schedule.
SnapshotScheduleState (string) --
The current state of the cluster snapshot schedule.
ExpectedNextSnapshotScheduleTime (datetime) --
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
ExpectedNextSnapshotScheduleTimeStatus (string) --
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
NextMaintenanceWindowStartTime (datetime) --
The date and time in UTC when system maintenance can begin.
ResizeInfo (dict) --
Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
ResizeType (string) --
Returns the value ClassicResize .
AllowCancelResize (boolean) --
A boolean value indicating if the resize operation can be cancelled.
AvailabilityZoneRelocationStatus (string) --
Describes the status of the Availability Zone relocation operation.
ClusterNamespaceArn (string) --
The namespace Amazon Resource Name (ARN) of the cluster.
TotalStorageCapacityInMegaBytes (integer) --
The total storage capacity of the cluster in megabytes.
AquaConfiguration (dict) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaConfigurationStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
DefaultIamRoleArn (string) --
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
ReservedNodeExchangeStatus (dict) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
ReservedNodeExchangeRequestId (string) --
The identifier of the reserved-node exchange request.
Status (string) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
RequestTime (datetime) --
A date and time that indicate when the reserved-node exchange was requested.
SourceReservedNodeId (string) --
The identifier of the source reserved node.
SourceReservedNodeType (string) --
The source reserved-node type, for example ds2.xlarge.
SourceReservedNodeCount (integer) --
The source reserved-node count in the cluster.
TargetReservedNodeOfferingId (string) --
The identifier of the target reserved node offering.
TargetReservedNodeType (string) --
The node type of the target reserved node, for example ra3.4xlarge.
TargetReservedNodeCount (integer) --
The count of target reserved nodes in the cluster.
CustomDomainName (string) --
The custom domain name associated with the cluster.
CustomDomainCertificateArn (string) --
The certificate Amazon Resource Name (ARN) for the custom domain name.
CustomDomainCertificateExpiryDate (datetime) --
The expiration date for the certificate associated with the custom domain name.
MasterPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
MasterPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
IpAddressType (string) --
The IP address type for the cluster. Possible values are ipv4 and dualstack .
{'Cluster': {'Endpoint': {'VpcEndpoints': {'NetworkInterfaces': {'Ipv6Address': 'string'}}},
'IpAddressType': 'string'}}
Modifies the maintenance settings of a cluster.
See also: AWS API Documentation
Request Syntax
client.modify_cluster_maintenance(
ClusterIdentifier='string',
DeferMaintenance=True|False,
DeferMaintenanceIdentifier='string',
DeferMaintenanceStartTime=datetime(2015, 1, 1),
DeferMaintenanceEndTime=datetime(2015, 1, 1),
DeferMaintenanceDuration=123
)
string
[REQUIRED]
A unique identifier for the cluster.
boolean
A boolean indicating whether to enable the deferred maintenance window.
string
A unique identifier for the deferred maintenance window.
datetime
A timestamp indicating the start time for the deferred maintenance window.
datetime
A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.
integer
An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ClusterAvailabilityStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'VpcEndpoints': [
{
'VpcEndpointId': 'string',
'VpcId': 'string',
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string',
'SubnetId': 'string',
'PrivateIpAddress': 'string',
'AvailabilityZone': 'string',
'Ipv6Address': 'string'
},
]
},
]
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'PubliclyAccessible': True|False,
'EnhancedVpcRouting': True|False,
'MaintenanceTrackName': 'string',
'EncryptionType': '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
},
'DataTransferProgress': {
'Status': 'string',
'CurrentRateInMegaBytesPerSecond': 123.0,
'TotalDataInMegaBytes': 123,
'DataTransferredInMegaBytes': 123,
'EstimatedTimeToCompletionInSeconds': 123,
'ElapsedTimeInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'EnhancedVpcRouting': True|False,
'IamRoles': [
{
'IamRoleArn': 'string',
'ApplyStatus': 'string'
},
],
'PendingActions': [
'string',
],
'MaintenanceTrackName': 'string',
'ElasticResizeNumberOfNodeOptions': 'string',
'DeferredMaintenanceWindows': [
{
'DeferMaintenanceIdentifier': 'string',
'DeferMaintenanceStartTime': datetime(2015, 1, 1),
'DeferMaintenanceEndTime': datetime(2015, 1, 1)
},
],
'SnapshotScheduleIdentifier': 'string',
'SnapshotScheduleState': 'MODIFYING'|'ACTIVE'|'FAILED',
'ExpectedNextSnapshotScheduleTime': datetime(2015, 1, 1),
'ExpectedNextSnapshotScheduleTimeStatus': 'string',
'NextMaintenanceWindowStartTime': datetime(2015, 1, 1),
'ResizeInfo': {
'ResizeType': 'string',
'AllowCancelResize': True|False
},
'AvailabilityZoneRelocationStatus': 'string',
'ClusterNamespaceArn': 'string',
'TotalStorageCapacityInMegaBytes': 123,
'AquaConfiguration': {
'AquaStatus': 'enabled'|'disabled'|'applying',
'AquaConfigurationStatus': 'enabled'|'disabled'|'auto'
},
'DefaultIamRoleArn': 'string',
'ReservedNodeExchangeStatus': {
'ReservedNodeExchangeRequestId': 'string',
'Status': 'REQUESTED'|'PENDING'|'IN_PROGRESS'|'RETRYING'|'SUCCEEDED'|'FAILED',
'RequestTime': datetime(2015, 1, 1),
'SourceReservedNodeId': 'string',
'SourceReservedNodeType': 'string',
'SourceReservedNodeCount': 123,
'TargetReservedNodeOfferingId': 'string',
'TargetReservedNodeType': 'string',
'TargetReservedNodeCount': 123
},
'CustomDomainName': 'string',
'CustomDomainCertificateArn': 'string',
'CustomDomainCertificateExpiryDate': datetime(2015, 1, 1),
'MasterPasswordSecretArn': 'string',
'MasterPasswordSecretKmsKeyId': 'string',
'IpAddressType': 'string'
}
}
Response Structure
(dict) --
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 the cluster. Possible values are the following:
available
available, prep-for-resize
available, resize-cleanup
cancelling-resize
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
paused
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
ClusterAvailabilityStatus (string) --
The availability status of the cluster for queries. Possible values are the following:
Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
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 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.
VpcEndpoints (list) --
Describes a connection endpoint.
(dict) --
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
VpcEndpointId (string) --
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
VpcId (string) --
The VPC identifier that the endpoint is associated.
NetworkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Describes a network interface.
NetworkInterfaceId (string) --
The network interface identifier.
SubnetId (string) --
The subnet identifier.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
AvailabilityZone (string) --
The Availability Zone.
Ipv6Address (string) --
The IPv6 address of the network interface within the subnet.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ManualSnapshotRetentionPeriod (integer) --
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
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 an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a cluster 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 Amazon Virtual Private Cloud (Amazon 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) --
The identifier of the VPC security group.
Status (string) --
The status of the VPC security group.
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 Universal Coordinated Time (UTC), during which system maintenance can occur.
PendingModifiedValues (dict) --
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the admin 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.
PubliclyAccessible (boolean) --
The pending or in-progress change of the ability to connect to the cluster from the public network.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
MaintenanceTrackName (string) --
The name of the maintenance track that the cluster will change to during the next maintenance window.
EncryptionType (string) --
The encryption type for a cluster. Possible values are: KMS and None.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
A boolean value that, if true , indicates that 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) --
A boolean value that, if true , indicates that the cluster can be accessed from a public network.
Encrypted (boolean) --
A boolean value that, if true , indicates that data in the cluster is encrypted at rest.
RestoreStatus (dict) --
A value that describes the status of a cluster restore action. This parameter 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. This field is only updated when you restore to DC2 and DS2 node types.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
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. This field is only updated when you restore to DC2 and DS2 node types.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
DataTransferProgress (dict) --
Status (string) --
Describes the status of the cluster. While the transfer is in progress the status is transferringdata .
CurrentRateInMegaBytesPerSecond (float) --
Describes the data transfer rate in MB's per second.
TotalDataInMegaBytes (integer) --
Describes the total amount of data to be transfered in megabytes.
DataTransferredInMegaBytes (integer) --
Describes the total amount of data that has been transfered in MB's.
EstimatedTimeToCompletionInSeconds (integer) --
Describes the estimated number of seconds remaining to complete the transfer.
ElapsedTimeInSeconds (integer) --
Describes the number of seconds that have elapsed during the data transfer.
HsmStatus (dict) --
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (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) --
A value that 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.
ManualSnapshotRetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in the 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) --
The status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
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 Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
IamRoles (list) --
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
(dict) --
An Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other Amazon Web Services services.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload .
ApplyStatus (string) --
A value that describes the status of the IAM role's association with an Amazon Redshift cluster.
The following are possible statuses and descriptions.
in-sync : The role is available for use by the cluster.
adding : The role is in the process of being associated with the cluster.
removing : The role is in the process of being disassociated with the cluster.
PendingActions (list) --
Cluster operations that are waiting to be started.
(string) --
MaintenanceTrackName (string) --
The name of the maintenance track for the cluster.
ElasticResizeNumberOfNodeOptions (string) --
The number of nodes that you can resize the cluster to with the elastic resize method.
DeferredMaintenanceWindows (list) --
Describes a group of DeferredMaintenanceWindow objects.
(dict) --
Describes a deferred maintenance window
DeferMaintenanceIdentifier (string) --
A unique identifier for the maintenance window.
DeferMaintenanceStartTime (datetime) --
A timestamp for the beginning of the time period when we defer maintenance.
DeferMaintenanceEndTime (datetime) --
A timestamp for the end of the time period when we defer maintenance.
SnapshotScheduleIdentifier (string) --
A unique identifier for the cluster snapshot schedule.
SnapshotScheduleState (string) --
The current state of the cluster snapshot schedule.
ExpectedNextSnapshotScheduleTime (datetime) --
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
ExpectedNextSnapshotScheduleTimeStatus (string) --
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
NextMaintenanceWindowStartTime (datetime) --
The date and time in UTC when system maintenance can begin.
ResizeInfo (dict) --
Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
ResizeType (string) --
Returns the value ClassicResize .
AllowCancelResize (boolean) --
A boolean value indicating if the resize operation can be cancelled.
AvailabilityZoneRelocationStatus (string) --
Describes the status of the Availability Zone relocation operation.
ClusterNamespaceArn (string) --
The namespace Amazon Resource Name (ARN) of the cluster.
TotalStorageCapacityInMegaBytes (integer) --
The total storage capacity of the cluster in megabytes.
AquaConfiguration (dict) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaConfigurationStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
DefaultIamRoleArn (string) --
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
ReservedNodeExchangeStatus (dict) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
ReservedNodeExchangeRequestId (string) --
The identifier of the reserved-node exchange request.
Status (string) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
RequestTime (datetime) --
A date and time that indicate when the reserved-node exchange was requested.
SourceReservedNodeId (string) --
The identifier of the source reserved node.
SourceReservedNodeType (string) --
The source reserved-node type, for example ds2.xlarge.
SourceReservedNodeCount (integer) --
The source reserved-node count in the cluster.
TargetReservedNodeOfferingId (string) --
The identifier of the target reserved node offering.
TargetReservedNodeType (string) --
The node type of the target reserved node, for example ra3.4xlarge.
TargetReservedNodeCount (integer) --
The count of target reserved nodes in the cluster.
CustomDomainName (string) --
The custom domain name associated with the cluster.
CustomDomainCertificateArn (string) --
The certificate Amazon Resource Name (ARN) for the custom domain name.
CustomDomainCertificateExpiryDate (datetime) --
The expiration date for the certificate associated with the custom domain name.
MasterPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
MasterPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
IpAddressType (string) --
The IP address type for the cluster. Possible values are ipv4 and dualstack .
{'ClusterSubnetGroup': {'SupportedClusterIpAddressTypes': ['string']}}
Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets.
See also: AWS API Documentation
Request Syntax
client.modify_cluster_subnet_group(
ClusterSubnetGroupName='string',
Description='string',
SubnetIds=[
'string',
]
)
string
[REQUIRED]
The name of the subnet group to be modified.
string
A text description of the subnet group to be modified.
list
[REQUIRED]
An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.
(string) --
dict
Response Syntax
{
'ClusterSubnetGroup': {
'ClusterSubnetGroupName': 'string',
'Description': 'string',
'VpcId': 'string',
'SubnetGroupStatus': 'string',
'Subnets': [
{
'SubnetIdentifier': 'string',
'SubnetAvailabilityZone': {
'Name': 'string',
'SupportedPlatforms': [
{
'Name': 'string'
},
]
},
'SubnetStatus': 'string'
},
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'SupportedClusterIpAddressTypes': [
'string',
]
}
}
Response Structure
(dict) --
ClusterSubnetGroup (dict) --
Describes a subnet group.
ClusterSubnetGroupName (string) --
The name of the cluster subnet group.
Description (string) --
The description of the cluster subnet group.
VpcId (string) --
The VPC ID of the cluster subnet group.
SubnetGroupStatus (string) --
The status of the cluster subnet group. Possible values are Complete , Incomplete and Invalid .
Subnets (list) --
A list of the VPC Subnet elements.
(dict) --
Describes a subnet.
SubnetIdentifier (string) --
The identifier of the subnet.
SubnetAvailabilityZone (dict) --
Name (string) --
The name of the availability zone.
SupportedPlatforms (list) --
(dict) --
A list of supported platforms for orderable clusters.
Name (string) --
SubnetStatus (string) --
The status of the subnet.
Tags (list) --
The list of tags for the cluster subnet group.
(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.
SupportedClusterIpAddressTypes (list) --
The IP address types supported by this cluster subnet group. Possible values are ipv4 and dualstack .
(string) --
{'VpcEndpoint': {'NetworkInterfaces': {'Ipv6Address': 'string'}}}
Modifies a Redshift-managed VPC endpoint.
See also: AWS API Documentation
Request Syntax
client.modify_endpoint_access(
EndpointName='string',
VpcSecurityGroupIds=[
'string',
]
)
string
[REQUIRED]
The endpoint to be modified.
list
The complete list of VPC security groups associated with the endpoint after the endpoint is modified.
(string) --
dict
Response Syntax
{
'ClusterIdentifier': 'string',
'ResourceOwner': 'string',
'SubnetGroupName': 'string',
'EndpointStatus': 'string',
'EndpointName': 'string',
'EndpointCreateTime': datetime(2015, 1, 1),
'Port': 123,
'Address': 'string',
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'VpcEndpoint': {
'VpcEndpointId': 'string',
'VpcId': 'string',
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string',
'SubnetId': 'string',
'PrivateIpAddress': 'string',
'AvailabilityZone': 'string',
'Ipv6Address': 'string'
},
]
}
}
Response Structure
(dict) --
Describes a Redshift-managed VPC endpoint.
ClusterIdentifier (string) --
The cluster identifier of the cluster associated with the endpoint.
ResourceOwner (string) --
The Amazon Web Services account ID of the owner of the cluster.
SubnetGroupName (string) --
The subnet group name where Amazon Redshift chooses to deploy the endpoint.
EndpointStatus (string) --
The status of the endpoint.
EndpointName (string) --
The name of the endpoint.
EndpointCreateTime (datetime) --
The time (UTC) that the endpoint was created.
Port (integer) --
The port number on which the cluster accepts incoming connections.
Address (string) --
The DNS address of the endpoint.
VpcSecurityGroups (list) --
The security groups associated with the endpoint.
(dict) --
Describes the members of a VPC security group.
VpcSecurityGroupId (string) --
The identifier of the VPC security group.
Status (string) --
The status of the VPC security group.
VpcEndpoint (dict) --
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
VpcEndpointId (string) --
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
VpcId (string) --
The VPC identifier that the endpoint is associated.
NetworkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Describes a network interface.
NetworkInterfaceId (string) --
The network interface identifier.
SubnetId (string) --
The subnet identifier.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
AvailabilityZone (string) --
The Availability Zone.
Ipv6Address (string) --
The IPv6 address of the network interface within the subnet.
{'Cluster': {'Endpoint': {'VpcEndpoints': {'NetworkInterfaces': {'Ipv6Address': 'string'}}},
'IpAddressType': 'string'}}
Modifies the number of days to retain snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period.
See also: AWS API Documentation
Request Syntax
client.modify_snapshot_copy_retention_period(
ClusterIdentifier='string',
RetentionPeriod=123,
Manual=True|False
)
string
[REQUIRED]
The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination Amazon Web Services 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 Amazon Web Services Region after they are copied from the source Amazon Web Services Region.
By default, this only changes the retention period of copied automated snapshots.
If you decrease the retention period for automated snapshots that are copied to a destination Amazon Web Services Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination Amazon Web Services Region and that fall outside of the new retention period.
Constraints: Must be at least 1 and no more than 35 for automated snapshots.
If you specify the manual option, only newly copied manual snapshots will have the new retention period.
If you specify the value of -1 newly copied manual snapshots are retained indefinitely.
Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.
boolean
Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ClusterAvailabilityStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'VpcEndpoints': [
{
'VpcEndpointId': 'string',
'VpcId': 'string',
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string',
'SubnetId': 'string',
'PrivateIpAddress': 'string',
'AvailabilityZone': 'string',
'Ipv6Address': 'string'
},
]
},
]
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'PubliclyAccessible': True|False,
'EnhancedVpcRouting': True|False,
'MaintenanceTrackName': 'string',
'EncryptionType': '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
},
'DataTransferProgress': {
'Status': 'string',
'CurrentRateInMegaBytesPerSecond': 123.0,
'TotalDataInMegaBytes': 123,
'DataTransferredInMegaBytes': 123,
'EstimatedTimeToCompletionInSeconds': 123,
'ElapsedTimeInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'EnhancedVpcRouting': True|False,
'IamRoles': [
{
'IamRoleArn': 'string',
'ApplyStatus': 'string'
},
],
'PendingActions': [
'string',
],
'MaintenanceTrackName': 'string',
'ElasticResizeNumberOfNodeOptions': 'string',
'DeferredMaintenanceWindows': [
{
'DeferMaintenanceIdentifier': 'string',
'DeferMaintenanceStartTime': datetime(2015, 1, 1),
'DeferMaintenanceEndTime': datetime(2015, 1, 1)
},
],
'SnapshotScheduleIdentifier': 'string',
'SnapshotScheduleState': 'MODIFYING'|'ACTIVE'|'FAILED',
'ExpectedNextSnapshotScheduleTime': datetime(2015, 1, 1),
'ExpectedNextSnapshotScheduleTimeStatus': 'string',
'NextMaintenanceWindowStartTime': datetime(2015, 1, 1),
'ResizeInfo': {
'ResizeType': 'string',
'AllowCancelResize': True|False
},
'AvailabilityZoneRelocationStatus': 'string',
'ClusterNamespaceArn': 'string',
'TotalStorageCapacityInMegaBytes': 123,
'AquaConfiguration': {
'AquaStatus': 'enabled'|'disabled'|'applying',
'AquaConfigurationStatus': 'enabled'|'disabled'|'auto'
},
'DefaultIamRoleArn': 'string',
'ReservedNodeExchangeStatus': {
'ReservedNodeExchangeRequestId': 'string',
'Status': 'REQUESTED'|'PENDING'|'IN_PROGRESS'|'RETRYING'|'SUCCEEDED'|'FAILED',
'RequestTime': datetime(2015, 1, 1),
'SourceReservedNodeId': 'string',
'SourceReservedNodeType': 'string',
'SourceReservedNodeCount': 123,
'TargetReservedNodeOfferingId': 'string',
'TargetReservedNodeType': 'string',
'TargetReservedNodeCount': 123
},
'CustomDomainName': 'string',
'CustomDomainCertificateArn': 'string',
'CustomDomainCertificateExpiryDate': datetime(2015, 1, 1),
'MasterPasswordSecretArn': 'string',
'MasterPasswordSecretKmsKeyId': 'string',
'IpAddressType': 'string'
}
}
Response Structure
(dict) --
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 the cluster. Possible values are the following:
available
available, prep-for-resize
available, resize-cleanup
cancelling-resize
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
paused
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
ClusterAvailabilityStatus (string) --
The availability status of the cluster for queries. Possible values are the following:
Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
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 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.
VpcEndpoints (list) --
Describes a connection endpoint.
(dict) --
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
VpcEndpointId (string) --
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
VpcId (string) --
The VPC identifier that the endpoint is associated.
NetworkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Describes a network interface.
NetworkInterfaceId (string) --
The network interface identifier.
SubnetId (string) --
The subnet identifier.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
AvailabilityZone (string) --
The Availability Zone.
Ipv6Address (string) --
The IPv6 address of the network interface within the subnet.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ManualSnapshotRetentionPeriod (integer) --
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
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 an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a cluster 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 Amazon Virtual Private Cloud (Amazon 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) --
The identifier of the VPC security group.
Status (string) --
The status of the VPC security group.
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 Universal Coordinated Time (UTC), during which system maintenance can occur.
PendingModifiedValues (dict) --
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the admin 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.
PubliclyAccessible (boolean) --
The pending or in-progress change of the ability to connect to the cluster from the public network.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
MaintenanceTrackName (string) --
The name of the maintenance track that the cluster will change to during the next maintenance window.
EncryptionType (string) --
The encryption type for a cluster. Possible values are: KMS and None.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
A boolean value that, if true , indicates that 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) --
A boolean value that, if true , indicates that the cluster can be accessed from a public network.
Encrypted (boolean) --
A boolean value that, if true , indicates that data in the cluster is encrypted at rest.
RestoreStatus (dict) --
A value that describes the status of a cluster restore action. This parameter 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. This field is only updated when you restore to DC2 and DS2 node types.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
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. This field is only updated when you restore to DC2 and DS2 node types.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
DataTransferProgress (dict) --
Status (string) --
Describes the status of the cluster. While the transfer is in progress the status is transferringdata .
CurrentRateInMegaBytesPerSecond (float) --
Describes the data transfer rate in MB's per second.
TotalDataInMegaBytes (integer) --
Describes the total amount of data to be transfered in megabytes.
DataTransferredInMegaBytes (integer) --
Describes the total amount of data that has been transfered in MB's.
EstimatedTimeToCompletionInSeconds (integer) --
Describes the estimated number of seconds remaining to complete the transfer.
ElapsedTimeInSeconds (integer) --
Describes the number of seconds that have elapsed during the data transfer.
HsmStatus (dict) --
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (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) --
A value that 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.
ManualSnapshotRetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in the 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) --
The status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
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 Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
IamRoles (list) --
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
(dict) --
An Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other Amazon Web Services services.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload .
ApplyStatus (string) --
A value that describes the status of the IAM role's association with an Amazon Redshift cluster.
The following are possible statuses and descriptions.
in-sync : The role is available for use by the cluster.
adding : The role is in the process of being associated with the cluster.
removing : The role is in the process of being disassociated with the cluster.
PendingActions (list) --
Cluster operations that are waiting to be started.
(string) --
MaintenanceTrackName (string) --
The name of the maintenance track for the cluster.
ElasticResizeNumberOfNodeOptions (string) --
The number of nodes that you can resize the cluster to with the elastic resize method.
DeferredMaintenanceWindows (list) --
Describes a group of DeferredMaintenanceWindow objects.
(dict) --
Describes a deferred maintenance window
DeferMaintenanceIdentifier (string) --
A unique identifier for the maintenance window.
DeferMaintenanceStartTime (datetime) --
A timestamp for the beginning of the time period when we defer maintenance.
DeferMaintenanceEndTime (datetime) --
A timestamp for the end of the time period when we defer maintenance.
SnapshotScheduleIdentifier (string) --
A unique identifier for the cluster snapshot schedule.
SnapshotScheduleState (string) --
The current state of the cluster snapshot schedule.
ExpectedNextSnapshotScheduleTime (datetime) --
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
ExpectedNextSnapshotScheduleTimeStatus (string) --
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
NextMaintenanceWindowStartTime (datetime) --
The date and time in UTC when system maintenance can begin.
ResizeInfo (dict) --
Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
ResizeType (string) --
Returns the value ClassicResize .
AllowCancelResize (boolean) --
A boolean value indicating if the resize operation can be cancelled.
AvailabilityZoneRelocationStatus (string) --
Describes the status of the Availability Zone relocation operation.
ClusterNamespaceArn (string) --
The namespace Amazon Resource Name (ARN) of the cluster.
TotalStorageCapacityInMegaBytes (integer) --
The total storage capacity of the cluster in megabytes.
AquaConfiguration (dict) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaConfigurationStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
DefaultIamRoleArn (string) --
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
ReservedNodeExchangeStatus (dict) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
ReservedNodeExchangeRequestId (string) --
The identifier of the reserved-node exchange request.
Status (string) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
RequestTime (datetime) --
A date and time that indicate when the reserved-node exchange was requested.
SourceReservedNodeId (string) --
The identifier of the source reserved node.
SourceReservedNodeType (string) --
The source reserved-node type, for example ds2.xlarge.
SourceReservedNodeCount (integer) --
The source reserved-node count in the cluster.
TargetReservedNodeOfferingId (string) --
The identifier of the target reserved node offering.
TargetReservedNodeType (string) --
The node type of the target reserved node, for example ra3.4xlarge.
TargetReservedNodeCount (integer) --
The count of target reserved nodes in the cluster.
CustomDomainName (string) --
The custom domain name associated with the cluster.
CustomDomainCertificateArn (string) --
The certificate Amazon Resource Name (ARN) for the custom domain name.
CustomDomainCertificateExpiryDate (datetime) --
The expiration date for the certificate associated with the custom domain name.
MasterPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
MasterPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
IpAddressType (string) --
The IP address type for the cluster. Possible values are ipv4 and dualstack .
{'Cluster': {'Endpoint': {'VpcEndpoints': {'NetworkInterfaces': {'Ipv6Address': 'string'}}},
'IpAddressType': 'string'}}
Pauses a cluster.
See also: AWS API Documentation
Request Syntax
client.pause_cluster(
ClusterIdentifier='string'
)
string
[REQUIRED]
The identifier of the cluster to be paused.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ClusterAvailabilityStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'VpcEndpoints': [
{
'VpcEndpointId': 'string',
'VpcId': 'string',
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string',
'SubnetId': 'string',
'PrivateIpAddress': 'string',
'AvailabilityZone': 'string',
'Ipv6Address': 'string'
},
]
},
]
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'PubliclyAccessible': True|False,
'EnhancedVpcRouting': True|False,
'MaintenanceTrackName': 'string',
'EncryptionType': '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
},
'DataTransferProgress': {
'Status': 'string',
'CurrentRateInMegaBytesPerSecond': 123.0,
'TotalDataInMegaBytes': 123,
'DataTransferredInMegaBytes': 123,
'EstimatedTimeToCompletionInSeconds': 123,
'ElapsedTimeInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'EnhancedVpcRouting': True|False,
'IamRoles': [
{
'IamRoleArn': 'string',
'ApplyStatus': 'string'
},
],
'PendingActions': [
'string',
],
'MaintenanceTrackName': 'string',
'ElasticResizeNumberOfNodeOptions': 'string',
'DeferredMaintenanceWindows': [
{
'DeferMaintenanceIdentifier': 'string',
'DeferMaintenanceStartTime': datetime(2015, 1, 1),
'DeferMaintenanceEndTime': datetime(2015, 1, 1)
},
],
'SnapshotScheduleIdentifier': 'string',
'SnapshotScheduleState': 'MODIFYING'|'ACTIVE'|'FAILED',
'ExpectedNextSnapshotScheduleTime': datetime(2015, 1, 1),
'ExpectedNextSnapshotScheduleTimeStatus': 'string',
'NextMaintenanceWindowStartTime': datetime(2015, 1, 1),
'ResizeInfo': {
'ResizeType': 'string',
'AllowCancelResize': True|False
},
'AvailabilityZoneRelocationStatus': 'string',
'ClusterNamespaceArn': 'string',
'TotalStorageCapacityInMegaBytes': 123,
'AquaConfiguration': {
'AquaStatus': 'enabled'|'disabled'|'applying',
'AquaConfigurationStatus': 'enabled'|'disabled'|'auto'
},
'DefaultIamRoleArn': 'string',
'ReservedNodeExchangeStatus': {
'ReservedNodeExchangeRequestId': 'string',
'Status': 'REQUESTED'|'PENDING'|'IN_PROGRESS'|'RETRYING'|'SUCCEEDED'|'FAILED',
'RequestTime': datetime(2015, 1, 1),
'SourceReservedNodeId': 'string',
'SourceReservedNodeType': 'string',
'SourceReservedNodeCount': 123,
'TargetReservedNodeOfferingId': 'string',
'TargetReservedNodeType': 'string',
'TargetReservedNodeCount': 123
},
'CustomDomainName': 'string',
'CustomDomainCertificateArn': 'string',
'CustomDomainCertificateExpiryDate': datetime(2015, 1, 1),
'MasterPasswordSecretArn': 'string',
'MasterPasswordSecretKmsKeyId': 'string',
'IpAddressType': 'string'
}
}
Response Structure
(dict) --
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 the cluster. Possible values are the following:
available
available, prep-for-resize
available, resize-cleanup
cancelling-resize
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
paused
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
ClusterAvailabilityStatus (string) --
The availability status of the cluster for queries. Possible values are the following:
Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
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 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.
VpcEndpoints (list) --
Describes a connection endpoint.
(dict) --
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
VpcEndpointId (string) --
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
VpcId (string) --
The VPC identifier that the endpoint is associated.
NetworkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Describes a network interface.
NetworkInterfaceId (string) --
The network interface identifier.
SubnetId (string) --
The subnet identifier.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
AvailabilityZone (string) --
The Availability Zone.
Ipv6Address (string) --
The IPv6 address of the network interface within the subnet.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ManualSnapshotRetentionPeriod (integer) --
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
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 an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a cluster 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 Amazon Virtual Private Cloud (Amazon 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) --
The identifier of the VPC security group.
Status (string) --
The status of the VPC security group.
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 Universal Coordinated Time (UTC), during which system maintenance can occur.
PendingModifiedValues (dict) --
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the admin 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.
PubliclyAccessible (boolean) --
The pending or in-progress change of the ability to connect to the cluster from the public network.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
MaintenanceTrackName (string) --
The name of the maintenance track that the cluster will change to during the next maintenance window.
EncryptionType (string) --
The encryption type for a cluster. Possible values are: KMS and None.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
A boolean value that, if true , indicates that 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) --
A boolean value that, if true , indicates that the cluster can be accessed from a public network.
Encrypted (boolean) --
A boolean value that, if true , indicates that data in the cluster is encrypted at rest.
RestoreStatus (dict) --
A value that describes the status of a cluster restore action. This parameter 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. This field is only updated when you restore to DC2 and DS2 node types.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
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. This field is only updated when you restore to DC2 and DS2 node types.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
DataTransferProgress (dict) --
Status (string) --
Describes the status of the cluster. While the transfer is in progress the status is transferringdata .
CurrentRateInMegaBytesPerSecond (float) --
Describes the data transfer rate in MB's per second.
TotalDataInMegaBytes (integer) --
Describes the total amount of data to be transfered in megabytes.
DataTransferredInMegaBytes (integer) --
Describes the total amount of data that has been transfered in MB's.
EstimatedTimeToCompletionInSeconds (integer) --
Describes the estimated number of seconds remaining to complete the transfer.
ElapsedTimeInSeconds (integer) --
Describes the number of seconds that have elapsed during the data transfer.
HsmStatus (dict) --
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (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) --
A value that 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.
ManualSnapshotRetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in the 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) --
The status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
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 Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
IamRoles (list) --
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
(dict) --
An Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other Amazon Web Services services.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload .
ApplyStatus (string) --
A value that describes the status of the IAM role's association with an Amazon Redshift cluster.
The following are possible statuses and descriptions.
in-sync : The role is available for use by the cluster.
adding : The role is in the process of being associated with the cluster.
removing : The role is in the process of being disassociated with the cluster.
PendingActions (list) --
Cluster operations that are waiting to be started.
(string) --
MaintenanceTrackName (string) --
The name of the maintenance track for the cluster.
ElasticResizeNumberOfNodeOptions (string) --
The number of nodes that you can resize the cluster to with the elastic resize method.
DeferredMaintenanceWindows (list) --
Describes a group of DeferredMaintenanceWindow objects.
(dict) --
Describes a deferred maintenance window
DeferMaintenanceIdentifier (string) --
A unique identifier for the maintenance window.
DeferMaintenanceStartTime (datetime) --
A timestamp for the beginning of the time period when we defer maintenance.
DeferMaintenanceEndTime (datetime) --
A timestamp for the end of the time period when we defer maintenance.
SnapshotScheduleIdentifier (string) --
A unique identifier for the cluster snapshot schedule.
SnapshotScheduleState (string) --
The current state of the cluster snapshot schedule.
ExpectedNextSnapshotScheduleTime (datetime) --
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
ExpectedNextSnapshotScheduleTimeStatus (string) --
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
NextMaintenanceWindowStartTime (datetime) --
The date and time in UTC when system maintenance can begin.
ResizeInfo (dict) --
Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
ResizeType (string) --
Returns the value ClassicResize .
AllowCancelResize (boolean) --
A boolean value indicating if the resize operation can be cancelled.
AvailabilityZoneRelocationStatus (string) --
Describes the status of the Availability Zone relocation operation.
ClusterNamespaceArn (string) --
The namespace Amazon Resource Name (ARN) of the cluster.
TotalStorageCapacityInMegaBytes (integer) --
The total storage capacity of the cluster in megabytes.
AquaConfiguration (dict) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaConfigurationStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
DefaultIamRoleArn (string) --
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
ReservedNodeExchangeStatus (dict) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
ReservedNodeExchangeRequestId (string) --
The identifier of the reserved-node exchange request.
Status (string) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
RequestTime (datetime) --
A date and time that indicate when the reserved-node exchange was requested.
SourceReservedNodeId (string) --
The identifier of the source reserved node.
SourceReservedNodeType (string) --
The source reserved-node type, for example ds2.xlarge.
SourceReservedNodeCount (integer) --
The source reserved-node count in the cluster.
TargetReservedNodeOfferingId (string) --
The identifier of the target reserved node offering.
TargetReservedNodeType (string) --
The node type of the target reserved node, for example ra3.4xlarge.
TargetReservedNodeCount (integer) --
The count of target reserved nodes in the cluster.
CustomDomainName (string) --
The custom domain name associated with the cluster.
CustomDomainCertificateArn (string) --
The certificate Amazon Resource Name (ARN) for the custom domain name.
CustomDomainCertificateExpiryDate (datetime) --
The expiration date for the certificate associated with the custom domain name.
MasterPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
MasterPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
IpAddressType (string) --
The IP address type for the cluster. Possible values are ipv4 and dualstack .
{'Cluster': {'Endpoint': {'VpcEndpoints': {'NetworkInterfaces': {'Ipv6Address': 'string'}}},
'IpAddressType': '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 .
See also: AWS API Documentation
Request Syntax
client.reboot_cluster(
ClusterIdentifier='string'
)
string
[REQUIRED]
The cluster identifier.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ClusterAvailabilityStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'VpcEndpoints': [
{
'VpcEndpointId': 'string',
'VpcId': 'string',
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string',
'SubnetId': 'string',
'PrivateIpAddress': 'string',
'AvailabilityZone': 'string',
'Ipv6Address': 'string'
},
]
},
]
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'PubliclyAccessible': True|False,
'EnhancedVpcRouting': True|False,
'MaintenanceTrackName': 'string',
'EncryptionType': '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
},
'DataTransferProgress': {
'Status': 'string',
'CurrentRateInMegaBytesPerSecond': 123.0,
'TotalDataInMegaBytes': 123,
'DataTransferredInMegaBytes': 123,
'EstimatedTimeToCompletionInSeconds': 123,
'ElapsedTimeInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'EnhancedVpcRouting': True|False,
'IamRoles': [
{
'IamRoleArn': 'string',
'ApplyStatus': 'string'
},
],
'PendingActions': [
'string',
],
'MaintenanceTrackName': 'string',
'ElasticResizeNumberOfNodeOptions': 'string',
'DeferredMaintenanceWindows': [
{
'DeferMaintenanceIdentifier': 'string',
'DeferMaintenanceStartTime': datetime(2015, 1, 1),
'DeferMaintenanceEndTime': datetime(2015, 1, 1)
},
],
'SnapshotScheduleIdentifier': 'string',
'SnapshotScheduleState': 'MODIFYING'|'ACTIVE'|'FAILED',
'ExpectedNextSnapshotScheduleTime': datetime(2015, 1, 1),
'ExpectedNextSnapshotScheduleTimeStatus': 'string',
'NextMaintenanceWindowStartTime': datetime(2015, 1, 1),
'ResizeInfo': {
'ResizeType': 'string',
'AllowCancelResize': True|False
},
'AvailabilityZoneRelocationStatus': 'string',
'ClusterNamespaceArn': 'string',
'TotalStorageCapacityInMegaBytes': 123,
'AquaConfiguration': {
'AquaStatus': 'enabled'|'disabled'|'applying',
'AquaConfigurationStatus': 'enabled'|'disabled'|'auto'
},
'DefaultIamRoleArn': 'string',
'ReservedNodeExchangeStatus': {
'ReservedNodeExchangeRequestId': 'string',
'Status': 'REQUESTED'|'PENDING'|'IN_PROGRESS'|'RETRYING'|'SUCCEEDED'|'FAILED',
'RequestTime': datetime(2015, 1, 1),
'SourceReservedNodeId': 'string',
'SourceReservedNodeType': 'string',
'SourceReservedNodeCount': 123,
'TargetReservedNodeOfferingId': 'string',
'TargetReservedNodeType': 'string',
'TargetReservedNodeCount': 123
},
'CustomDomainName': 'string',
'CustomDomainCertificateArn': 'string',
'CustomDomainCertificateExpiryDate': datetime(2015, 1, 1),
'MasterPasswordSecretArn': 'string',
'MasterPasswordSecretKmsKeyId': 'string',
'IpAddressType': 'string'
}
}
Response Structure
(dict) --
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 the cluster. Possible values are the following:
available
available, prep-for-resize
available, resize-cleanup
cancelling-resize
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
paused
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
ClusterAvailabilityStatus (string) --
The availability status of the cluster for queries. Possible values are the following:
Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
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 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.
VpcEndpoints (list) --
Describes a connection endpoint.
(dict) --
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
VpcEndpointId (string) --
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
VpcId (string) --
The VPC identifier that the endpoint is associated.
NetworkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Describes a network interface.
NetworkInterfaceId (string) --
The network interface identifier.
SubnetId (string) --
The subnet identifier.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
AvailabilityZone (string) --
The Availability Zone.
Ipv6Address (string) --
The IPv6 address of the network interface within the subnet.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ManualSnapshotRetentionPeriod (integer) --
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
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 an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a cluster 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 Amazon Virtual Private Cloud (Amazon 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) --
The identifier of the VPC security group.
Status (string) --
The status of the VPC security group.
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 Universal Coordinated Time (UTC), during which system maintenance can occur.
PendingModifiedValues (dict) --
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the admin 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.
PubliclyAccessible (boolean) --
The pending or in-progress change of the ability to connect to the cluster from the public network.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
MaintenanceTrackName (string) --
The name of the maintenance track that the cluster will change to during the next maintenance window.
EncryptionType (string) --
The encryption type for a cluster. Possible values are: KMS and None.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
A boolean value that, if true , indicates that 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) --
A boolean value that, if true , indicates that the cluster can be accessed from a public network.
Encrypted (boolean) --
A boolean value that, if true , indicates that data in the cluster is encrypted at rest.
RestoreStatus (dict) --
A value that describes the status of a cluster restore action. This parameter 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. This field is only updated when you restore to DC2 and DS2 node types.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
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. This field is only updated when you restore to DC2 and DS2 node types.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
DataTransferProgress (dict) --
Status (string) --
Describes the status of the cluster. While the transfer is in progress the status is transferringdata .
CurrentRateInMegaBytesPerSecond (float) --
Describes the data transfer rate in MB's per second.
TotalDataInMegaBytes (integer) --
Describes the total amount of data to be transfered in megabytes.
DataTransferredInMegaBytes (integer) --
Describes the total amount of data that has been transfered in MB's.
EstimatedTimeToCompletionInSeconds (integer) --
Describes the estimated number of seconds remaining to complete the transfer.
ElapsedTimeInSeconds (integer) --
Describes the number of seconds that have elapsed during the data transfer.
HsmStatus (dict) --
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (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) --
A value that 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.
ManualSnapshotRetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in the 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) --
The status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
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 Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
IamRoles (list) --
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
(dict) --
An Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other Amazon Web Services services.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload .
ApplyStatus (string) --
A value that describes the status of the IAM role's association with an Amazon Redshift cluster.
The following are possible statuses and descriptions.
in-sync : The role is available for use by the cluster.
adding : The role is in the process of being associated with the cluster.
removing : The role is in the process of being disassociated with the cluster.
PendingActions (list) --
Cluster operations that are waiting to be started.
(string) --
MaintenanceTrackName (string) --
The name of the maintenance track for the cluster.
ElasticResizeNumberOfNodeOptions (string) --
The number of nodes that you can resize the cluster to with the elastic resize method.
DeferredMaintenanceWindows (list) --
Describes a group of DeferredMaintenanceWindow objects.
(dict) --
Describes a deferred maintenance window
DeferMaintenanceIdentifier (string) --
A unique identifier for the maintenance window.
DeferMaintenanceStartTime (datetime) --
A timestamp for the beginning of the time period when we defer maintenance.
DeferMaintenanceEndTime (datetime) --
A timestamp for the end of the time period when we defer maintenance.
SnapshotScheduleIdentifier (string) --
A unique identifier for the cluster snapshot schedule.
SnapshotScheduleState (string) --
The current state of the cluster snapshot schedule.
ExpectedNextSnapshotScheduleTime (datetime) --
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
ExpectedNextSnapshotScheduleTimeStatus (string) --
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
NextMaintenanceWindowStartTime (datetime) --
The date and time in UTC when system maintenance can begin.
ResizeInfo (dict) --
Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
ResizeType (string) --
Returns the value ClassicResize .
AllowCancelResize (boolean) --
A boolean value indicating if the resize operation can be cancelled.
AvailabilityZoneRelocationStatus (string) --
Describes the status of the Availability Zone relocation operation.
ClusterNamespaceArn (string) --
The namespace Amazon Resource Name (ARN) of the cluster.
TotalStorageCapacityInMegaBytes (integer) --
The total storage capacity of the cluster in megabytes.
AquaConfiguration (dict) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaConfigurationStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
DefaultIamRoleArn (string) --
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
ReservedNodeExchangeStatus (dict) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
ReservedNodeExchangeRequestId (string) --
The identifier of the reserved-node exchange request.
Status (string) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
RequestTime (datetime) --
A date and time that indicate when the reserved-node exchange was requested.
SourceReservedNodeId (string) --
The identifier of the source reserved node.
SourceReservedNodeType (string) --
The source reserved-node type, for example ds2.xlarge.
SourceReservedNodeCount (integer) --
The source reserved-node count in the cluster.
TargetReservedNodeOfferingId (string) --
The identifier of the target reserved node offering.
TargetReservedNodeType (string) --
The node type of the target reserved node, for example ra3.4xlarge.
TargetReservedNodeCount (integer) --
The count of target reserved nodes in the cluster.
CustomDomainName (string) --
The custom domain name associated with the cluster.
CustomDomainCertificateArn (string) --
The certificate Amazon Resource Name (ARN) for the custom domain name.
CustomDomainCertificateExpiryDate (datetime) --
The expiration date for the certificate associated with the custom domain name.
MasterPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
MasterPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
IpAddressType (string) --
The IP address type for the cluster. Possible values are ipv4 and dualstack .
{'Cluster': {'Endpoint': {'VpcEndpoints': {'NetworkInterfaces': {'Ipv6Address': 'string'}}},
'IpAddressType': 'string'}}
Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method.
Elastic resize operations have the following restrictions:
You can only resize clusters of the following types:
dc1.large (if your cluster is in a VPC)
dc1.8xlarge (if your cluster is in a VPC)
dc2.large
dc2.8xlarge
ds2.xlarge
ds2.8xlarge
ra3.xlplus
ra3.4xlarge
ra3.16xlarge
The type of nodes that you add must match the node type for the cluster.
See also: AWS API Documentation
Request Syntax
client.resize_cluster(
ClusterIdentifier='string',
ClusterType='string',
NodeType='string',
NumberOfNodes=123,
Classic=True|False,
ReservedNodeId='string',
TargetReservedNodeOfferingId='string'
)
string
[REQUIRED]
The unique identifier for the cluster to resize.
string
The new cluster type for the specified cluster.
string
The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.
integer
The new number of nodes for the cluster. If not specified, the cluster's current number of nodes is used.
boolean
A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic.
string
The identifier of the reserved node.
string
The identifier of the target reserved node offering.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ClusterAvailabilityStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'VpcEndpoints': [
{
'VpcEndpointId': 'string',
'VpcId': 'string',
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string',
'SubnetId': 'string',
'PrivateIpAddress': 'string',
'AvailabilityZone': 'string',
'Ipv6Address': 'string'
},
]
},
]
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'PubliclyAccessible': True|False,
'EnhancedVpcRouting': True|False,
'MaintenanceTrackName': 'string',
'EncryptionType': '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
},
'DataTransferProgress': {
'Status': 'string',
'CurrentRateInMegaBytesPerSecond': 123.0,
'TotalDataInMegaBytes': 123,
'DataTransferredInMegaBytes': 123,
'EstimatedTimeToCompletionInSeconds': 123,
'ElapsedTimeInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'EnhancedVpcRouting': True|False,
'IamRoles': [
{
'IamRoleArn': 'string',
'ApplyStatus': 'string'
},
],
'PendingActions': [
'string',
],
'MaintenanceTrackName': 'string',
'ElasticResizeNumberOfNodeOptions': 'string',
'DeferredMaintenanceWindows': [
{
'DeferMaintenanceIdentifier': 'string',
'DeferMaintenanceStartTime': datetime(2015, 1, 1),
'DeferMaintenanceEndTime': datetime(2015, 1, 1)
},
],
'SnapshotScheduleIdentifier': 'string',
'SnapshotScheduleState': 'MODIFYING'|'ACTIVE'|'FAILED',
'ExpectedNextSnapshotScheduleTime': datetime(2015, 1, 1),
'ExpectedNextSnapshotScheduleTimeStatus': 'string',
'NextMaintenanceWindowStartTime': datetime(2015, 1, 1),
'ResizeInfo': {
'ResizeType': 'string',
'AllowCancelResize': True|False
},
'AvailabilityZoneRelocationStatus': 'string',
'ClusterNamespaceArn': 'string',
'TotalStorageCapacityInMegaBytes': 123,
'AquaConfiguration': {
'AquaStatus': 'enabled'|'disabled'|'applying',
'AquaConfigurationStatus': 'enabled'|'disabled'|'auto'
},
'DefaultIamRoleArn': 'string',
'ReservedNodeExchangeStatus': {
'ReservedNodeExchangeRequestId': 'string',
'Status': 'REQUESTED'|'PENDING'|'IN_PROGRESS'|'RETRYING'|'SUCCEEDED'|'FAILED',
'RequestTime': datetime(2015, 1, 1),
'SourceReservedNodeId': 'string',
'SourceReservedNodeType': 'string',
'SourceReservedNodeCount': 123,
'TargetReservedNodeOfferingId': 'string',
'TargetReservedNodeType': 'string',
'TargetReservedNodeCount': 123
},
'CustomDomainName': 'string',
'CustomDomainCertificateArn': 'string',
'CustomDomainCertificateExpiryDate': datetime(2015, 1, 1),
'MasterPasswordSecretArn': 'string',
'MasterPasswordSecretKmsKeyId': 'string',
'IpAddressType': 'string'
}
}
Response Structure
(dict) --
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 the cluster. Possible values are the following:
available
available, prep-for-resize
available, resize-cleanup
cancelling-resize
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
paused
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
ClusterAvailabilityStatus (string) --
The availability status of the cluster for queries. Possible values are the following:
Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
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 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.
VpcEndpoints (list) --
Describes a connection endpoint.
(dict) --
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
VpcEndpointId (string) --
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
VpcId (string) --
The VPC identifier that the endpoint is associated.
NetworkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Describes a network interface.
NetworkInterfaceId (string) --
The network interface identifier.
SubnetId (string) --
The subnet identifier.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
AvailabilityZone (string) --
The Availability Zone.
Ipv6Address (string) --
The IPv6 address of the network interface within the subnet.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ManualSnapshotRetentionPeriod (integer) --
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
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 an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a cluster 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 Amazon Virtual Private Cloud (Amazon 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) --
The identifier of the VPC security group.
Status (string) --
The status of the VPC security group.
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 Universal Coordinated Time (UTC), during which system maintenance can occur.
PendingModifiedValues (dict) --
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the admin 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.
PubliclyAccessible (boolean) --
The pending or in-progress change of the ability to connect to the cluster from the public network.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
MaintenanceTrackName (string) --
The name of the maintenance track that the cluster will change to during the next maintenance window.
EncryptionType (string) --
The encryption type for a cluster. Possible values are: KMS and None.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
A boolean value that, if true , indicates that 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) --
A boolean value that, if true , indicates that the cluster can be accessed from a public network.
Encrypted (boolean) --
A boolean value that, if true , indicates that data in the cluster is encrypted at rest.
RestoreStatus (dict) --
A value that describes the status of a cluster restore action. This parameter 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. This field is only updated when you restore to DC2 and DS2 node types.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
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. This field is only updated when you restore to DC2 and DS2 node types.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
DataTransferProgress (dict) --
Status (string) --
Describes the status of the cluster. While the transfer is in progress the status is transferringdata .
CurrentRateInMegaBytesPerSecond (float) --
Describes the data transfer rate in MB's per second.
TotalDataInMegaBytes (integer) --
Describes the total amount of data to be transfered in megabytes.
DataTransferredInMegaBytes (integer) --
Describes the total amount of data that has been transfered in MB's.
EstimatedTimeToCompletionInSeconds (integer) --
Describes the estimated number of seconds remaining to complete the transfer.
ElapsedTimeInSeconds (integer) --
Describes the number of seconds that have elapsed during the data transfer.
HsmStatus (dict) --
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (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) --
A value that 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.
ManualSnapshotRetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in the 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) --
The status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
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 Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
IamRoles (list) --
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
(dict) --
An Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other Amazon Web Services services.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload .
ApplyStatus (string) --
A value that describes the status of the IAM role's association with an Amazon Redshift cluster.
The following are possible statuses and descriptions.
in-sync : The role is available for use by the cluster.
adding : The role is in the process of being associated with the cluster.
removing : The role is in the process of being disassociated with the cluster.
PendingActions (list) --
Cluster operations that are waiting to be started.
(string) --
MaintenanceTrackName (string) --
The name of the maintenance track for the cluster.
ElasticResizeNumberOfNodeOptions (string) --
The number of nodes that you can resize the cluster to with the elastic resize method.
DeferredMaintenanceWindows (list) --
Describes a group of DeferredMaintenanceWindow objects.
(dict) --
Describes a deferred maintenance window
DeferMaintenanceIdentifier (string) --
A unique identifier for the maintenance window.
DeferMaintenanceStartTime (datetime) --
A timestamp for the beginning of the time period when we defer maintenance.
DeferMaintenanceEndTime (datetime) --
A timestamp for the end of the time period when we defer maintenance.
SnapshotScheduleIdentifier (string) --
A unique identifier for the cluster snapshot schedule.
SnapshotScheduleState (string) --
The current state of the cluster snapshot schedule.
ExpectedNextSnapshotScheduleTime (datetime) --
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
ExpectedNextSnapshotScheduleTimeStatus (string) --
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
NextMaintenanceWindowStartTime (datetime) --
The date and time in UTC when system maintenance can begin.
ResizeInfo (dict) --
Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
ResizeType (string) --
Returns the value ClassicResize .
AllowCancelResize (boolean) --
A boolean value indicating if the resize operation can be cancelled.
AvailabilityZoneRelocationStatus (string) --
Describes the status of the Availability Zone relocation operation.
ClusterNamespaceArn (string) --
The namespace Amazon Resource Name (ARN) of the cluster.
TotalStorageCapacityInMegaBytes (integer) --
The total storage capacity of the cluster in megabytes.
AquaConfiguration (dict) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaConfigurationStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
DefaultIamRoleArn (string) --
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
ReservedNodeExchangeStatus (dict) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
ReservedNodeExchangeRequestId (string) --
The identifier of the reserved-node exchange request.
Status (string) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
RequestTime (datetime) --
A date and time that indicate when the reserved-node exchange was requested.
SourceReservedNodeId (string) --
The identifier of the source reserved node.
SourceReservedNodeType (string) --
The source reserved-node type, for example ds2.xlarge.
SourceReservedNodeCount (integer) --
The source reserved-node count in the cluster.
TargetReservedNodeOfferingId (string) --
The identifier of the target reserved node offering.
TargetReservedNodeType (string) --
The node type of the target reserved node, for example ra3.4xlarge.
TargetReservedNodeCount (integer) --
The count of target reserved nodes in the cluster.
CustomDomainName (string) --
The custom domain name associated with the cluster.
CustomDomainCertificateArn (string) --
The certificate Amazon Resource Name (ARN) for the custom domain name.
CustomDomainCertificateExpiryDate (datetime) --
The expiration date for the certificate associated with the custom domain name.
MasterPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
MasterPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
IpAddressType (string) --
The IP address type for the cluster. Possible values are ipv4 and dualstack .
{'IpAddressType': 'string'}
Response {'Cluster': {'Endpoint': {'VpcEndpoints': {'NetworkInterfaces': {'Ipv6Address': 'string'}}},
'IpAddressType': '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 .
See also: AWS API Documentation
Request Syntax
client.restore_from_cluster_snapshot(
ClusterIdentifier='string',
SnapshotIdentifier='string',
SnapshotArn='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,
ManualSnapshotRetentionPeriod=123,
KmsKeyId='string',
NodeType='string',
EnhancedVpcRouting=True|False,
AdditionalInfo='string',
IamRoles=[
'string',
],
MaintenanceTrackName='string',
SnapshotScheduleIdentifier='string',
NumberOfNodes=123,
AvailabilityZoneRelocation=True|False,
AquaConfigurationStatus='enabled'|'disabled'|'auto',
DefaultIamRoleArn='string',
ReservedNodeId='string',
TargetReservedNodeOfferingId='string',
Encrypted=True|False,
ManageMasterPassword=True|False,
MasterPasswordSecretKmsKeyId='string',
IpAddressType='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 Amazon Web Services account.
string
The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. You must specify this parameter or snapshotArn , but not both.
Example: my-snapshot-id
string
The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster. You must specify this parameter or snapshotIdentifier , but not both.
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-2a
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 Amazon Web Services 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. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on.
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 .
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
Default: The value selected for the cluster from which the snapshot was taken.
Constraints: Must be a value from 0 to 35.
integer
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
string
The Key Management Service (KMS) key ID of the encryption key that encrypts data in the cluster restored from a shared snapshot. You can also provide the key ID when you restore from an unencrypted snapshot to an encrypted cluster in the same account. Additionally, you can specify a new KMS key ID when you restore from an encrypted snapshot in the same account in order to change it. In that case, the restored cluster is encrypted with the new KMS key ID.
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 ds1.xlarge into ds2.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 or dc2.large instance type. You can't restore dc1.8xlarge to dc2.8xlarge. First restore to a dc1.8xlarge cluster, then resize to a dc2.8large cluster. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide .
boolean
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
string
Reserved.
list
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide .
(string) --
string
The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The snapshot might be on a different track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source cluster are on different tracks.
string
A unique identifier for the snapshot schedule.
integer
The number of nodes specified when provisioning the restored cluster.
boolean
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.
string
This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
string
The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified while it was restored from a snapshot.
string
The identifier of the target reserved node offering.
string
The identifier of the target reserved node offering.
boolean
Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service (KMS) and a customer managed key.
boolean
If true , Amazon Redshift uses Secrets Manager to manage the restored cluster's admin credentials. If ManageMasterPassword is false or not set, Amazon Redshift uses the admin credentials the cluster had at the time the snapshot was taken.
string
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter if ManageMasterPassword is true.
string
The IP address type for the cluster. Possible values are ipv4 and dualstack .
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ClusterAvailabilityStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'VpcEndpoints': [
{
'VpcEndpointId': 'string',
'VpcId': 'string',
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string',
'SubnetId': 'string',
'PrivateIpAddress': 'string',
'AvailabilityZone': 'string',
'Ipv6Address': 'string'
},
]
},
]
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'PubliclyAccessible': True|False,
'EnhancedVpcRouting': True|False,
'MaintenanceTrackName': 'string',
'EncryptionType': '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
},
'DataTransferProgress': {
'Status': 'string',
'CurrentRateInMegaBytesPerSecond': 123.0,
'TotalDataInMegaBytes': 123,
'DataTransferredInMegaBytes': 123,
'EstimatedTimeToCompletionInSeconds': 123,
'ElapsedTimeInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'EnhancedVpcRouting': True|False,
'IamRoles': [
{
'IamRoleArn': 'string',
'ApplyStatus': 'string'
},
],
'PendingActions': [
'string',
],
'MaintenanceTrackName': 'string',
'ElasticResizeNumberOfNodeOptions': 'string',
'DeferredMaintenanceWindows': [
{
'DeferMaintenanceIdentifier': 'string',
'DeferMaintenanceStartTime': datetime(2015, 1, 1),
'DeferMaintenanceEndTime': datetime(2015, 1, 1)
},
],
'SnapshotScheduleIdentifier': 'string',
'SnapshotScheduleState': 'MODIFYING'|'ACTIVE'|'FAILED',
'ExpectedNextSnapshotScheduleTime': datetime(2015, 1, 1),
'ExpectedNextSnapshotScheduleTimeStatus': 'string',
'NextMaintenanceWindowStartTime': datetime(2015, 1, 1),
'ResizeInfo': {
'ResizeType': 'string',
'AllowCancelResize': True|False
},
'AvailabilityZoneRelocationStatus': 'string',
'ClusterNamespaceArn': 'string',
'TotalStorageCapacityInMegaBytes': 123,
'AquaConfiguration': {
'AquaStatus': 'enabled'|'disabled'|'applying',
'AquaConfigurationStatus': 'enabled'|'disabled'|'auto'
},
'DefaultIamRoleArn': 'string',
'ReservedNodeExchangeStatus': {
'ReservedNodeExchangeRequestId': 'string',
'Status': 'REQUESTED'|'PENDING'|'IN_PROGRESS'|'RETRYING'|'SUCCEEDED'|'FAILED',
'RequestTime': datetime(2015, 1, 1),
'SourceReservedNodeId': 'string',
'SourceReservedNodeType': 'string',
'SourceReservedNodeCount': 123,
'TargetReservedNodeOfferingId': 'string',
'TargetReservedNodeType': 'string',
'TargetReservedNodeCount': 123
},
'CustomDomainName': 'string',
'CustomDomainCertificateArn': 'string',
'CustomDomainCertificateExpiryDate': datetime(2015, 1, 1),
'MasterPasswordSecretArn': 'string',
'MasterPasswordSecretKmsKeyId': 'string',
'IpAddressType': 'string'
}
}
Response Structure
(dict) --
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 the cluster. Possible values are the following:
available
available, prep-for-resize
available, resize-cleanup
cancelling-resize
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
paused
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
ClusterAvailabilityStatus (string) --
The availability status of the cluster for queries. Possible values are the following:
Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
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 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.
VpcEndpoints (list) --
Describes a connection endpoint.
(dict) --
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
VpcEndpointId (string) --
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
VpcId (string) --
The VPC identifier that the endpoint is associated.
NetworkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Describes a network interface.
NetworkInterfaceId (string) --
The network interface identifier.
SubnetId (string) --
The subnet identifier.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
AvailabilityZone (string) --
The Availability Zone.
Ipv6Address (string) --
The IPv6 address of the network interface within the subnet.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ManualSnapshotRetentionPeriod (integer) --
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
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 an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a cluster 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 Amazon Virtual Private Cloud (Amazon 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) --
The identifier of the VPC security group.
Status (string) --
The status of the VPC security group.
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 Universal Coordinated Time (UTC), during which system maintenance can occur.
PendingModifiedValues (dict) --
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the admin 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.
PubliclyAccessible (boolean) --
The pending or in-progress change of the ability to connect to the cluster from the public network.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
MaintenanceTrackName (string) --
The name of the maintenance track that the cluster will change to during the next maintenance window.
EncryptionType (string) --
The encryption type for a cluster. Possible values are: KMS and None.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
A boolean value that, if true , indicates that 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) --
A boolean value that, if true , indicates that the cluster can be accessed from a public network.
Encrypted (boolean) --
A boolean value that, if true , indicates that data in the cluster is encrypted at rest.
RestoreStatus (dict) --
A value that describes the status of a cluster restore action. This parameter 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. This field is only updated when you restore to DC2 and DS2 node types.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
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. This field is only updated when you restore to DC2 and DS2 node types.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
DataTransferProgress (dict) --
Status (string) --
Describes the status of the cluster. While the transfer is in progress the status is transferringdata .
CurrentRateInMegaBytesPerSecond (float) --
Describes the data transfer rate in MB's per second.
TotalDataInMegaBytes (integer) --
Describes the total amount of data to be transfered in megabytes.
DataTransferredInMegaBytes (integer) --
Describes the total amount of data that has been transfered in MB's.
EstimatedTimeToCompletionInSeconds (integer) --
Describes the estimated number of seconds remaining to complete the transfer.
ElapsedTimeInSeconds (integer) --
Describes the number of seconds that have elapsed during the data transfer.
HsmStatus (dict) --
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (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) --
A value that 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.
ManualSnapshotRetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in the 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) --
The status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
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 Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
IamRoles (list) --
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
(dict) --
An Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other Amazon Web Services services.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload .
ApplyStatus (string) --
A value that describes the status of the IAM role's association with an Amazon Redshift cluster.
The following are possible statuses and descriptions.
in-sync : The role is available for use by the cluster.
adding : The role is in the process of being associated with the cluster.
removing : The role is in the process of being disassociated with the cluster.
PendingActions (list) --
Cluster operations that are waiting to be started.
(string) --
MaintenanceTrackName (string) --
The name of the maintenance track for the cluster.
ElasticResizeNumberOfNodeOptions (string) --
The number of nodes that you can resize the cluster to with the elastic resize method.
DeferredMaintenanceWindows (list) --
Describes a group of DeferredMaintenanceWindow objects.
(dict) --
Describes a deferred maintenance window
DeferMaintenanceIdentifier (string) --
A unique identifier for the maintenance window.
DeferMaintenanceStartTime (datetime) --
A timestamp for the beginning of the time period when we defer maintenance.
DeferMaintenanceEndTime (datetime) --
A timestamp for the end of the time period when we defer maintenance.
SnapshotScheduleIdentifier (string) --
A unique identifier for the cluster snapshot schedule.
SnapshotScheduleState (string) --
The current state of the cluster snapshot schedule.
ExpectedNextSnapshotScheduleTime (datetime) --
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
ExpectedNextSnapshotScheduleTimeStatus (string) --
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
NextMaintenanceWindowStartTime (datetime) --
The date and time in UTC when system maintenance can begin.
ResizeInfo (dict) --
Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
ResizeType (string) --
Returns the value ClassicResize .
AllowCancelResize (boolean) --
A boolean value indicating if the resize operation can be cancelled.
AvailabilityZoneRelocationStatus (string) --
Describes the status of the Availability Zone relocation operation.
ClusterNamespaceArn (string) --
The namespace Amazon Resource Name (ARN) of the cluster.
TotalStorageCapacityInMegaBytes (integer) --
The total storage capacity of the cluster in megabytes.
AquaConfiguration (dict) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaConfigurationStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
DefaultIamRoleArn (string) --
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
ReservedNodeExchangeStatus (dict) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
ReservedNodeExchangeRequestId (string) --
The identifier of the reserved-node exchange request.
Status (string) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
RequestTime (datetime) --
A date and time that indicate when the reserved-node exchange was requested.
SourceReservedNodeId (string) --
The identifier of the source reserved node.
SourceReservedNodeType (string) --
The source reserved-node type, for example ds2.xlarge.
SourceReservedNodeCount (integer) --
The source reserved-node count in the cluster.
TargetReservedNodeOfferingId (string) --
The identifier of the target reserved node offering.
TargetReservedNodeType (string) --
The node type of the target reserved node, for example ra3.4xlarge.
TargetReservedNodeCount (integer) --
The count of target reserved nodes in the cluster.
CustomDomainName (string) --
The custom domain name associated with the cluster.
CustomDomainCertificateArn (string) --
The certificate Amazon Resource Name (ARN) for the custom domain name.
CustomDomainCertificateExpiryDate (datetime) --
The expiration date for the certificate associated with the custom domain name.
MasterPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
MasterPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
IpAddressType (string) --
The IP address type for the cluster. Possible values are ipv4 and dualstack .
{'Cluster': {'Endpoint': {'VpcEndpoints': {'NetworkInterfaces': {'Ipv6Address': 'string'}}},
'IpAddressType': 'string'}}
Resumes a paused cluster.
See also: AWS API Documentation
Request Syntax
client.resume_cluster(
ClusterIdentifier='string'
)
string
[REQUIRED]
The identifier of the cluster to be resumed.
dict
Response Syntax
{
'Cluster': {
'ClusterIdentifier': 'string',
'NodeType': 'string',
'ClusterStatus': 'string',
'ClusterAvailabilityStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'VpcEndpoints': [
{
'VpcEndpointId': 'string',
'VpcId': 'string',
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string',
'SubnetId': 'string',
'PrivateIpAddress': 'string',
'AvailabilityZone': 'string',
'Ipv6Address': 'string'
},
]
},
]
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'PubliclyAccessible': True|False,
'EnhancedVpcRouting': True|False,
'MaintenanceTrackName': 'string',
'EncryptionType': '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
},
'DataTransferProgress': {
'Status': 'string',
'CurrentRateInMegaBytesPerSecond': 123.0,
'TotalDataInMegaBytes': 123,
'DataTransferredInMegaBytes': 123,
'EstimatedTimeToCompletionInSeconds': 123,
'ElapsedTimeInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'EnhancedVpcRouting': True|False,
'IamRoles': [
{
'IamRoleArn': 'string',
'ApplyStatus': 'string'
},
],
'PendingActions': [
'string',
],
'MaintenanceTrackName': 'string',
'ElasticResizeNumberOfNodeOptions': 'string',
'DeferredMaintenanceWindows': [
{
'DeferMaintenanceIdentifier': 'string',
'DeferMaintenanceStartTime': datetime(2015, 1, 1),
'DeferMaintenanceEndTime': datetime(2015, 1, 1)
},
],
'SnapshotScheduleIdentifier': 'string',
'SnapshotScheduleState': 'MODIFYING'|'ACTIVE'|'FAILED',
'ExpectedNextSnapshotScheduleTime': datetime(2015, 1, 1),
'ExpectedNextSnapshotScheduleTimeStatus': 'string',
'NextMaintenanceWindowStartTime': datetime(2015, 1, 1),
'ResizeInfo': {
'ResizeType': 'string',
'AllowCancelResize': True|False
},
'AvailabilityZoneRelocationStatus': 'string',
'ClusterNamespaceArn': 'string',
'TotalStorageCapacityInMegaBytes': 123,
'AquaConfiguration': {
'AquaStatus': 'enabled'|'disabled'|'applying',
'AquaConfigurationStatus': 'enabled'|'disabled'|'auto'
},
'DefaultIamRoleArn': 'string',
'ReservedNodeExchangeStatus': {
'ReservedNodeExchangeRequestId': 'string',
'Status': 'REQUESTED'|'PENDING'|'IN_PROGRESS'|'RETRYING'|'SUCCEEDED'|'FAILED',
'RequestTime': datetime(2015, 1, 1),
'SourceReservedNodeId': 'string',
'SourceReservedNodeType': 'string',
'SourceReservedNodeCount': 123,
'TargetReservedNodeOfferingId': 'string',
'TargetReservedNodeType': 'string',
'TargetReservedNodeCount': 123
},
'CustomDomainName': 'string',
'CustomDomainCertificateArn': 'string',
'CustomDomainCertificateExpiryDate': datetime(2015, 1, 1),
'MasterPasswordSecretArn': 'string',
'MasterPasswordSecretKmsKeyId': 'string',
'IpAddressType': 'string'
}
}
Response Structure
(dict) --
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 the cluster. Possible values are the following:
available
available, prep-for-resize
available, resize-cleanup
cancelling-resize
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
paused
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
ClusterAvailabilityStatus (string) --
The availability status of the cluster for queries. Possible values are the following:
Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
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 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.
VpcEndpoints (list) --
Describes a connection endpoint.
(dict) --
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
VpcEndpointId (string) --
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
VpcId (string) --
The VPC identifier that the endpoint is associated.
NetworkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Describes a network interface.
NetworkInterfaceId (string) --
The network interface identifier.
SubnetId (string) --
The subnet identifier.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
AvailabilityZone (string) --
The Availability Zone.
Ipv6Address (string) --
The IPv6 address of the network interface within the subnet.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ManualSnapshotRetentionPeriod (integer) --
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
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 an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a cluster 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 Amazon Virtual Private Cloud (Amazon 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) --
The identifier of the VPC security group.
Status (string) --
The status of the VPC security group.
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 Universal Coordinated Time (UTC), during which system maintenance can occur.
PendingModifiedValues (dict) --
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the admin 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.
PubliclyAccessible (boolean) --
The pending or in-progress change of the ability to connect to the cluster from the public network.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
MaintenanceTrackName (string) --
The name of the maintenance track that the cluster will change to during the next maintenance window.
EncryptionType (string) --
The encryption type for a cluster. Possible values are: KMS and None.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
A boolean value that, if true , indicates that 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) --
A boolean value that, if true , indicates that the cluster can be accessed from a public network.
Encrypted (boolean) --
A boolean value that, if true , indicates that data in the cluster is encrypted at rest.
RestoreStatus (dict) --
A value that describes the status of a cluster restore action. This parameter 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. This field is only updated when you restore to DC2 and DS2 node types.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
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. This field is only updated when you restore to DC2 and DS2 node types.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
DataTransferProgress (dict) --
Status (string) --
Describes the status of the cluster. While the transfer is in progress the status is transferringdata .
CurrentRateInMegaBytesPerSecond (float) --
Describes the data transfer rate in MB's per second.
TotalDataInMegaBytes (integer) --
Describes the total amount of data to be transfered in megabytes.
DataTransferredInMegaBytes (integer) --
Describes the total amount of data that has been transfered in MB's.
EstimatedTimeToCompletionInSeconds (integer) --
Describes the estimated number of seconds remaining to complete the transfer.
ElapsedTimeInSeconds (integer) --
Describes the number of seconds that have elapsed during the data transfer.
HsmStatus (dict) --
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (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) --
A value that 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.
ManualSnapshotRetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in the 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) --
The status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
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 Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
IamRoles (list) --
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
(dict) --
An Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other Amazon Web Services services.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload .
ApplyStatus (string) --
A value that describes the status of the IAM role's association with an Amazon Redshift cluster.
The following are possible statuses and descriptions.
in-sync : The role is available for use by the cluster.
adding : The role is in the process of being associated with the cluster.
removing : The role is in the process of being disassociated with the cluster.
PendingActions (list) --
Cluster operations that are waiting to be started.
(string) --
MaintenanceTrackName (string) --
The name of the maintenance track for the cluster.
ElasticResizeNumberOfNodeOptions (string) --
The number of nodes that you can resize the cluster to with the elastic resize method.
DeferredMaintenanceWindows (list) --
Describes a group of DeferredMaintenanceWindow objects.
(dict) --
Describes a deferred maintenance window
DeferMaintenanceIdentifier (string) --
A unique identifier for the maintenance window.
DeferMaintenanceStartTime (datetime) --
A timestamp for the beginning of the time period when we defer maintenance.
DeferMaintenanceEndTime (datetime) --
A timestamp for the end of the time period when we defer maintenance.
SnapshotScheduleIdentifier (string) --
A unique identifier for the cluster snapshot schedule.
SnapshotScheduleState (string) --
The current state of the cluster snapshot schedule.
ExpectedNextSnapshotScheduleTime (datetime) --
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
ExpectedNextSnapshotScheduleTimeStatus (string) --
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
NextMaintenanceWindowStartTime (datetime) --
The date and time in UTC when system maintenance can begin.
ResizeInfo (dict) --
Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
ResizeType (string) --
Returns the value ClassicResize .
AllowCancelResize (boolean) --
A boolean value indicating if the resize operation can be cancelled.
AvailabilityZoneRelocationStatus (string) --
Describes the status of the Availability Zone relocation operation.
ClusterNamespaceArn (string) --
The namespace Amazon Resource Name (ARN) of the cluster.
TotalStorageCapacityInMegaBytes (integer) --
The total storage capacity of the cluster in megabytes.
AquaConfiguration (dict) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaConfigurationStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
DefaultIamRoleArn (string) --
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
ReservedNodeExchangeStatus (dict) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
ReservedNodeExchangeRequestId (string) --
The identifier of the reserved-node exchange request.
Status (string) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
RequestTime (datetime) --
A date and time that indicate when the reserved-node exchange was requested.
SourceReservedNodeId (string) --
The identifier of the source reserved node.
SourceReservedNodeType (string) --
The source reserved-node type, for example ds2.xlarge.
SourceReservedNodeCount (integer) --
The source reserved-node count in the cluster.
TargetReservedNodeOfferingId (string) --
The identifier of the target reserved node offering.
TargetReservedNodeType (string) --
The node type of the target reserved node, for example ra3.4xlarge.
TargetReservedNodeCount (integer) --
The count of target reserved nodes in the cluster.
CustomDomainName (string) --
The custom domain name associated with the cluster.
CustomDomainCertificateArn (string) --
The certificate Amazon Resource Name (ARN) for the custom domain name.
CustomDomainCertificateExpiryDate (datetime) --
The expiration date for the certificate associated with the custom domain name.
MasterPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
MasterPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
IpAddressType (string) --
The IP address type for the cluster. Possible values are ipv4 and dualstack .
{'Cluster': {'Endpoint': {'VpcEndpoints': {'NetworkInterfaces': {'Ipv6Address': 'string'}}},
'IpAddressType': 'string'}}
Rotates the encryption keys for a cluster.
See also: AWS API Documentation
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',
'ClusterAvailabilityStatus': 'string',
'ModifyStatus': 'string',
'MasterUsername': 'string',
'DBName': 'string',
'Endpoint': {
'Address': 'string',
'Port': 123,
'VpcEndpoints': [
{
'VpcEndpointId': 'string',
'VpcId': 'string',
'NetworkInterfaces': [
{
'NetworkInterfaceId': 'string',
'SubnetId': 'string',
'PrivateIpAddress': 'string',
'AvailabilityZone': 'string',
'Ipv6Address': 'string'
},
]
},
]
},
'ClusterCreateTime': datetime(2015, 1, 1),
'AutomatedSnapshotRetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'PubliclyAccessible': True|False,
'EnhancedVpcRouting': True|False,
'MaintenanceTrackName': 'string',
'EncryptionType': '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
},
'DataTransferProgress': {
'Status': 'string',
'CurrentRateInMegaBytesPerSecond': 123.0,
'TotalDataInMegaBytes': 123,
'DataTransferredInMegaBytes': 123,
'EstimatedTimeToCompletionInSeconds': 123,
'ElapsedTimeInSeconds': 123
},
'HsmStatus': {
'HsmClientCertificateIdentifier': 'string',
'HsmConfigurationIdentifier': 'string',
'Status': 'string'
},
'ClusterSnapshotCopyStatus': {
'DestinationRegion': 'string',
'RetentionPeriod': 123,
'ManualSnapshotRetentionPeriod': 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',
'EnhancedVpcRouting': True|False,
'IamRoles': [
{
'IamRoleArn': 'string',
'ApplyStatus': 'string'
},
],
'PendingActions': [
'string',
],
'MaintenanceTrackName': 'string',
'ElasticResizeNumberOfNodeOptions': 'string',
'DeferredMaintenanceWindows': [
{
'DeferMaintenanceIdentifier': 'string',
'DeferMaintenanceStartTime': datetime(2015, 1, 1),
'DeferMaintenanceEndTime': datetime(2015, 1, 1)
},
],
'SnapshotScheduleIdentifier': 'string',
'SnapshotScheduleState': 'MODIFYING'|'ACTIVE'|'FAILED',
'ExpectedNextSnapshotScheduleTime': datetime(2015, 1, 1),
'ExpectedNextSnapshotScheduleTimeStatus': 'string',
'NextMaintenanceWindowStartTime': datetime(2015, 1, 1),
'ResizeInfo': {
'ResizeType': 'string',
'AllowCancelResize': True|False
},
'AvailabilityZoneRelocationStatus': 'string',
'ClusterNamespaceArn': 'string',
'TotalStorageCapacityInMegaBytes': 123,
'AquaConfiguration': {
'AquaStatus': 'enabled'|'disabled'|'applying',
'AquaConfigurationStatus': 'enabled'|'disabled'|'auto'
},
'DefaultIamRoleArn': 'string',
'ReservedNodeExchangeStatus': {
'ReservedNodeExchangeRequestId': 'string',
'Status': 'REQUESTED'|'PENDING'|'IN_PROGRESS'|'RETRYING'|'SUCCEEDED'|'FAILED',
'RequestTime': datetime(2015, 1, 1),
'SourceReservedNodeId': 'string',
'SourceReservedNodeType': 'string',
'SourceReservedNodeCount': 123,
'TargetReservedNodeOfferingId': 'string',
'TargetReservedNodeType': 'string',
'TargetReservedNodeCount': 123
},
'CustomDomainName': 'string',
'CustomDomainCertificateArn': 'string',
'CustomDomainCertificateExpiryDate': datetime(2015, 1, 1),
'MasterPasswordSecretArn': 'string',
'MasterPasswordSecretKmsKeyId': 'string',
'IpAddressType': 'string'
}
}
Response Structure
(dict) --
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 the cluster. Possible values are the following:
available
available, prep-for-resize
available, resize-cleanup
cancelling-resize
creating
deleting
final-snapshot
hardware-failure
incompatible-hsm
incompatible-network
incompatible-parameters
incompatible-restore
modifying
paused
rebooting
renaming
resizing
rotating-keys
storage-full
updating-hsm
ClusterAvailabilityStatus (string) --
The availability status of the cluster for queries. Possible values are the following:
Available - The cluster is available for queries.
Unavailable - The cluster is not available for queries.
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
Failed - The cluster failed and is not available for queries.
ModifyStatus (string) --
The status of a modify operation, if any, initiated for the cluster.
MasterUsername (string) --
The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
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 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.
VpcEndpoints (list) --
Describes a connection endpoint.
(dict) --
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.
VpcEndpointId (string) --
The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.
VpcId (string) --
The VPC identifier that the endpoint is associated.
NetworkInterfaces (list) --
One or more network interfaces of the endpoint. Also known as an interface endpoint.
(dict) --
Describes a network interface.
NetworkInterfaceId (string) --
The network interface identifier.
SubnetId (string) --
The subnet identifier.
PrivateIpAddress (string) --
The IPv4 address of the network interface within the subnet.
AvailabilityZone (string) --
The Availability Zone.
Ipv6Address (string) --
The IPv6 address of the network interface within the subnet.
ClusterCreateTime (datetime) --
The date and time that the cluster was created.
AutomatedSnapshotRetentionPeriod (integer) --
The number of days that automatic cluster snapshots are retained.
ManualSnapshotRetentionPeriod (integer) --
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
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 an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
(dict) --
Describes a cluster 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 Amazon Virtual Private Cloud (Amazon 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) --
The identifier of the VPC security group.
Status (string) --
The status of the VPC security group.
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 Universal Coordinated Time (UTC), during which system maintenance can occur.
PendingModifiedValues (dict) --
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
MasterUserPassword (string) --
The pending or in-progress change of the admin 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.
PubliclyAccessible (boolean) --
The pending or in-progress change of the ability to connect to the cluster from the public network.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
MaintenanceTrackName (string) --
The name of the maintenance track that the cluster will change to during the next maintenance window.
EncryptionType (string) --
The encryption type for a cluster. Possible values are: KMS and None.
ClusterVersion (string) --
The version ID of the Amazon Redshift engine that is running on the cluster.
AllowVersionUpgrade (boolean) --
A boolean value that, if true , indicates that 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) --
A boolean value that, if true , indicates that the cluster can be accessed from a public network.
Encrypted (boolean) --
A boolean value that, if true , indicates that data in the cluster is encrypted at rest.
RestoreStatus (dict) --
A value that describes the status of a cluster restore action. This parameter 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. This field is only updated when you restore to DC2 and DS2 node types.
SnapshotSizeInMegaBytes (integer) --
The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
ProgressInMegaBytes (integer) --
The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
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. This field is only updated when you restore to DC2 and DS2 node types.
EstimatedTimeToCompletionInSeconds (integer) --
The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
DataTransferProgress (dict) --
Status (string) --
Describes the status of the cluster. While the transfer is in progress the status is transferringdata .
CurrentRateInMegaBytesPerSecond (float) --
Describes the data transfer rate in MB's per second.
TotalDataInMegaBytes (integer) --
Describes the total amount of data to be transfered in megabytes.
DataTransferredInMegaBytes (integer) --
Describes the total amount of data that has been transfered in MB's.
EstimatedTimeToCompletionInSeconds (integer) --
Describes the estimated number of seconds remaining to complete the transfer.
ElapsedTimeInSeconds (integer) --
Describes the number of seconds that have elapsed during the data transfer.
HsmStatus (dict) --
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (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) --
A value that 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.
ManualSnapshotRetentionPeriod (integer) --
The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
SnapshotCopyGrantName (string) --
The name of the snapshot copy grant.
ClusterPublicKey (string) --
The public key for the cluster.
ClusterNodes (list) --
The nodes in the 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) --
The status of the elastic IP (EIP) address.
ElasticIp (string) --
The elastic IP (EIP) address for the cluster.
Status (string) --
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 Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
EnhancedVpcRouting (boolean) --
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true , enhanced VPC routing is enabled.
Default: false
IamRoles (list) --
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
(dict) --
An Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other Amazon Web Services services.
IamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload .
ApplyStatus (string) --
A value that describes the status of the IAM role's association with an Amazon Redshift cluster.
The following are possible statuses and descriptions.
in-sync : The role is available for use by the cluster.
adding : The role is in the process of being associated with the cluster.
removing : The role is in the process of being disassociated with the cluster.
PendingActions (list) --
Cluster operations that are waiting to be started.
(string) --
MaintenanceTrackName (string) --
The name of the maintenance track for the cluster.
ElasticResizeNumberOfNodeOptions (string) --
The number of nodes that you can resize the cluster to with the elastic resize method.
DeferredMaintenanceWindows (list) --
Describes a group of DeferredMaintenanceWindow objects.
(dict) --
Describes a deferred maintenance window
DeferMaintenanceIdentifier (string) --
A unique identifier for the maintenance window.
DeferMaintenanceStartTime (datetime) --
A timestamp for the beginning of the time period when we defer maintenance.
DeferMaintenanceEndTime (datetime) --
A timestamp for the end of the time period when we defer maintenance.
SnapshotScheduleIdentifier (string) --
A unique identifier for the cluster snapshot schedule.
SnapshotScheduleState (string) --
The current state of the cluster snapshot schedule.
ExpectedNextSnapshotScheduleTime (datetime) --
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
ExpectedNextSnapshotScheduleTimeStatus (string) --
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
NextMaintenanceWindowStartTime (datetime) --
The date and time in UTC when system maintenance can begin.
ResizeInfo (dict) --
Returns the following:
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
ResizeType: Returns ClassicResize
ResizeType (string) --
Returns the value ClassicResize .
AllowCancelResize (boolean) --
A boolean value indicating if the resize operation can be cancelled.
AvailabilityZoneRelocationStatus (string) --
Describes the status of the Availability Zone relocation operation.
ClusterNamespaceArn (string) --
The namespace Amazon Resource Name (ARN) of the cluster.
TotalStorageCapacityInMegaBytes (integer) --
The total storage capacity of the cluster in megabytes.
AquaConfiguration (dict) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaConfigurationStatus (string) --
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
DefaultIamRoleArn (string) --
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
ReservedNodeExchangeStatus (dict) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
ReservedNodeExchangeRequestId (string) --
The identifier of the reserved-node exchange request.
Status (string) --
The status of the reserved-node exchange request. Statuses include in-progress and requested.
RequestTime (datetime) --
A date and time that indicate when the reserved-node exchange was requested.
SourceReservedNodeId (string) --
The identifier of the source reserved node.
SourceReservedNodeType (string) --
The source reserved-node type, for example ds2.xlarge.
SourceReservedNodeCount (integer) --
The source reserved-node count in the cluster.
TargetReservedNodeOfferingId (string) --
The identifier of the target reserved node offering.
TargetReservedNodeType (string) --
The node type of the target reserved node, for example ra3.4xlarge.
TargetReservedNodeCount (integer) --
The count of target reserved nodes in the cluster.
CustomDomainName (string) --
The custom domain name associated with the cluster.
CustomDomainCertificateArn (string) --
The certificate Amazon Resource Name (ARN) for the custom domain name.
CustomDomainCertificateExpiryDate (datetime) --
The expiration date for the certificate associated with the custom domain name.
MasterPasswordSecretArn (string) --
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
MasterPasswordSecretKmsKeyId (string) --
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
IpAddressType (string) --
The IP address type for the cluster. Possible values are ipv4 and dualstack .