AWS API Changes

2018/09/10 - Amazon Redshift - 14 updated api methods

Changes Adding support to Redshift to change the encryption type after cluster creation completes.

CreateCluster (updated)

Link ¶
Changes (response)

{'Cluster': {'PendingModifiedValues': {'EncryptionType': 'string'}}}

Creates a new cluster.

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,
    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'
)

type DBName

string

param DBName

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.

type ClusterIdentifier

string

param ClusterIdentifier

[REQUIRED]

A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.

Example: myexamplecluster

type ClusterType

string

param ClusterType

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

type NodeType

string

param NodeType

[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 .

type MasterUsername

string

param MasterUsername

[REQUIRED]

The user name associated with the master user account for the cluster that is being created.

Constraints:

Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC .
First character must be a letter.
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

type MasterUserPassword

string

param MasterUserPassword

[REQUIRED]

The password associated with the master user account for the cluster that is being created.

Constraints:

Must be between 8 and 64 characters in length.
Must contain at least one uppercase letter.
Must contain at least one lowercase letter.
Must contain one number.
Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), , /, @, or space.

type ClusterSecurityGroups

list

param ClusterSecurityGroups

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

(string) --

type VpcSecurityGroupIds

list

param VpcSecurityGroupIds

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) --

type ClusterSubnetGroupName

string

param ClusterSubnetGroupName

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).

type AvailabilityZone

string

param AvailabilityZone

The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

Example: us-east-1d

Constraint: The specified Availability Zone must be in the same region as the current endpoint.

type PreferredMaintenanceWindow

string

param PreferredMaintenanceWindow

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.

type ClusterParameterGroupName

string

param ClusterParameterGroupName

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.

type AutomatedSnapshotRetentionPeriod

integer

param AutomatedSnapshotRetentionPeriod

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot .

Default: 1

Constraints: Must be a value from 0 to 35.

type Port

integer

param Port

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

type ClusterVersion

string

param ClusterVersion

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

type AllowVersionUpgrade

boolean

param AllowVersionUpgrade

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

type NumberOfNodes

integer

param NumberOfNodes

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.

type PubliclyAccessible

boolean

param PubliclyAccessible

If true , the cluster can be accessed from a public network.

type Encrypted

boolean

param Encrypted

If true , the data in the cluster is encrypted at rest.

Default: false

type HsmClientCertificateIdentifier

string

param HsmClientCertificateIdentifier

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

type HsmConfigurationIdentifier

string

param HsmConfigurationIdentifier

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.

type ElasticIp

string

param ElasticIp

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.

type Tags

list

param Tags

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.

type KmsKeyId

string

param KmsKeyId

The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

type EnhancedVpcRouting

boolean

param EnhancedVpcRouting

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

type AdditionalInfo

string

param AdditionalInfo

Reserved.

type IamRoles

list

param IamRoles

A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.

A cluster can have up to 10 IAM roles associated with it at any time.

(string) --

type MaintenanceTrackName

string

param MaintenanceTrackName

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.

rtype

dict

returns

Response Syntax

{
    'Cluster': {
        'ClusterIdentifier': 'string',
        'NodeType': 'string',
        'ClusterStatus': 'string',
        'ModifyStatus': 'string',
        'MasterUsername': 'string',
        'DBName': 'string',
        'Endpoint': {
            'Address': 'string',
            'Port': 123
        },
        'ClusterCreateTime': datetime(2015, 1, 1),
        'AutomatedSnapshotRetentionPeriod': 123,
        'ClusterSecurityGroups': [
            {
                'ClusterSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'ClusterParameterGroups': [
            {
                'ParameterGroupName': 'string',
                'ParameterApplyStatus': 'string',
                'ClusterParameterStatusList': [
                    {
                        'ParameterName': 'string',
                        'ParameterApplyStatus': 'string',
                        'ParameterApplyErrorDescription': 'string'
                    },
                ]
            },
        ],
        'ClusterSubnetGroupName': 'string',
        'VpcId': 'string',
        'AvailabilityZone': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PendingModifiedValues': {
            'MasterUserPassword': 'string',
            'NodeType': 'string',
            'NumberOfNodes': 123,
            'ClusterType': 'string',
            'ClusterVersion': 'string',
            'AutomatedSnapshotRetentionPeriod': 123,
            'ClusterIdentifier': 'string',
            '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
        },
        'HsmStatus': {
            'HsmClientCertificateIdentifier': 'string',
            'HsmConfigurationIdentifier': 'string',
            'Status': 'string'
        },
        'ClusterSnapshotCopyStatus': {
            'DestinationRegion': 'string',
            'RetentionPeriod': 123,
            'SnapshotCopyGrantName': 'string'
        },
        'ClusterPublicKey': 'string',
        'ClusterNodes': [
            {
                'NodeRole': 'string',
                'PrivateIPAddress': 'string',
                'PublicIPAddress': 'string'
            },
        ],
        'ElasticIpStatus': {
            'ElasticIp': 'string',
            'Status': 'string'
        },
        'ClusterRevisionNumber': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'KmsKeyId': 'string',
        'EnhancedVpcRouting': True|False,
        'IamRoles': [
            {
                'IamRoleArn': 'string',
                'ApplyStatus': 'string'
            },
        ],
        'PendingActions': [
            'string',
        ],
        'MaintenanceTrackName': 'string',
        'ElasticResizeNumberOfNodeOptions': '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
    - creating
    - deleting
    - final-snapshot
    - hardware-failure
    - incompatible-hsm
    - incompatible-network
    - incompatible-parameters
    - incompatible-restore
    - modifying
    - rebooting
    - renaming
    - resizing
    - rotating-keys
    - storage-full
    - updating-hsm
  - ModifyStatus (string) --
    
    The status of a modify operation, if any, initiated for the cluster.
  - MasterUsername (string) --
    
    The master user name for the cluster. This name is used to connect to the database that is specified in 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.
  - ClusterCreateTime (datetime) --
    
    The date and time that the cluster was created.
  - AutomatedSnapshotRetentionPeriod (integer) --
    
    The number of days that automatic cluster snapshots are retained.
  - ClusterSecurityGroups (list) --
    
    A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
    
    Cluster security groups are used when the cluster is not created in 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 master user password for the cluster.
    - NodeType (string) --
      
      The pending or in-progress change of the cluster's node type.
    - NumberOfNodes (integer) --
      
      The pending or in-progress change of the number of nodes in the cluster.
    - ClusterType (string) --
      
      The pending or in-progress change of the cluster type.
    - ClusterVersion (string) --
      
      The pending or in-progress change of the service version.
    - AutomatedSnapshotRetentionPeriod (integer) --
      
      The pending or in-progress change of the automated snapshot retention period.
    - ClusterIdentifier (string) --
      
      The pending or in-progress change of the new identifier for the cluster.
    - 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. For the China region the possible values are None, and Legacy.
  - 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.
    - SnapshotSizeInMegaBytes (integer) --
      
      The size of the set of snapshot data used to restore the cluster.
    - ProgressInMegaBytes (integer) --
      
      The number of megabytes that have been transferred from snapshot storage.
    - ElapsedTimeInSeconds (integer) --
      
      The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
    - EstimatedTimeToCompletionInSeconds (integer) --
      
      The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
  - HsmStatus (dict) --
    
    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.
    - 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 AWS Key Management Service (AWS 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 AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
    - (dict) --
      
      An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS 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) --
    
    Indicates the number of nodes the cluster can be resized to with the elastic resize method.

DeleteCluster (updated)

Link ¶
Changes (response)

{'Cluster': {'PendingModifiedValues': {'EncryptionType': 'string'}}}

Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide .

If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to false and specify a name for FinalClusterSnapshotIdentifier . You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster.

For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide .

See also: AWS API Documentation

Request Syntax

client.delete_cluster(
    ClusterIdentifier='string',
    SkipFinalClusterSnapshot=True|False,
    FinalClusterSnapshotIdentifier='string'
)

type ClusterIdentifier

string

param ClusterIdentifier

[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.

type SkipFinalClusterSnapshot

boolean

param SkipFinalClusterSnapshot

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

type FinalClusterSnapshotIdentifier

string

param FinalClusterSnapshotIdentifier

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.

rtype

dict

returns

Response Syntax

{
    'Cluster': {
        'ClusterIdentifier': 'string',
        'NodeType': 'string',
        'ClusterStatus': 'string',
        'ModifyStatus': 'string',
        'MasterUsername': 'string',
        'DBName': 'string',
        'Endpoint': {
            'Address': 'string',
            'Port': 123
        },
        'ClusterCreateTime': datetime(2015, 1, 1),
        'AutomatedSnapshotRetentionPeriod': 123,
        'ClusterSecurityGroups': [
            {
                'ClusterSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'ClusterParameterGroups': [
            {
                'ParameterGroupName': 'string',
                'ParameterApplyStatus': 'string',
                'ClusterParameterStatusList': [
                    {
                        'ParameterName': 'string',
                        'ParameterApplyStatus': 'string',
                        'ParameterApplyErrorDescription': 'string'
                    },
                ]
            },
        ],
        'ClusterSubnetGroupName': 'string',
        'VpcId': 'string',
        'AvailabilityZone': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PendingModifiedValues': {
            'MasterUserPassword': 'string',
            'NodeType': 'string',
            'NumberOfNodes': 123,
            'ClusterType': 'string',
            'ClusterVersion': 'string',
            'AutomatedSnapshotRetentionPeriod': 123,
            'ClusterIdentifier': 'string',
            '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
        },
        'HsmStatus': {
            'HsmClientCertificateIdentifier': 'string',
            'HsmConfigurationIdentifier': 'string',
            'Status': 'string'
        },
        'ClusterSnapshotCopyStatus': {
            'DestinationRegion': 'string',
            'RetentionPeriod': 123,
            'SnapshotCopyGrantName': 'string'
        },
        'ClusterPublicKey': 'string',
        'ClusterNodes': [
            {
                'NodeRole': 'string',
                'PrivateIPAddress': 'string',
                'PublicIPAddress': 'string'
            },
        ],
        'ElasticIpStatus': {
            'ElasticIp': 'string',
            'Status': 'string'
        },
        'ClusterRevisionNumber': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'KmsKeyId': 'string',
        'EnhancedVpcRouting': True|False,
        'IamRoles': [
            {
                'IamRoleArn': 'string',
                'ApplyStatus': 'string'
            },
        ],
        'PendingActions': [
            'string',
        ],
        'MaintenanceTrackName': 'string',
        'ElasticResizeNumberOfNodeOptions': '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
    - creating
    - deleting
    - final-snapshot
    - hardware-failure
    - incompatible-hsm
    - incompatible-network
    - incompatible-parameters
    - incompatible-restore
    - modifying
    - rebooting
    - renaming
    - resizing
    - rotating-keys
    - storage-full
    - updating-hsm
  - ModifyStatus (string) --
    
    The status of a modify operation, if any, initiated for the cluster.
  - MasterUsername (string) --
    
    The master user name for the cluster. This name is used to connect to the database that is specified in 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.
  - ClusterCreateTime (datetime) --
    
    The date and time that the cluster was created.
  - AutomatedSnapshotRetentionPeriod (integer) --
    
    The number of days that automatic cluster snapshots are retained.
  - ClusterSecurityGroups (list) --
    
    A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
    
    Cluster security groups are used when the cluster is not created in 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 master user password for the cluster.
    - NodeType (string) --
      
      The pending or in-progress change of the cluster's node type.
    - NumberOfNodes (integer) --
      
      The pending or in-progress change of the number of nodes in the cluster.
    - ClusterType (string) --
      
      The pending or in-progress change of the cluster type.
    - ClusterVersion (string) --
      
      The pending or in-progress change of the service version.
    - AutomatedSnapshotRetentionPeriod (integer) --
      
      The pending or in-progress change of the automated snapshot retention period.
    - ClusterIdentifier (string) --
      
      The pending or in-progress change of the new identifier for the cluster.
    - 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. For the China region the possible values are None, and Legacy.
  - 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.
    - SnapshotSizeInMegaBytes (integer) --
      
      The size of the set of snapshot data used to restore the cluster.
    - ProgressInMegaBytes (integer) --
      
      The number of megabytes that have been transferred from snapshot storage.
    - ElapsedTimeInSeconds (integer) --
      
      The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
    - EstimatedTimeToCompletionInSeconds (integer) --
      
      The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
  - HsmStatus (dict) --
    
    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.
    - 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 AWS Key Management Service (AWS 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 AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
    - (dict) --
      
      An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS 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) --
    
    Indicates the number of nodes the cluster can be resized to with the elastic resize method.

DescribeClusters (updated)

Link ¶
Changes (response)

{'Clusters': {'PendingModifiedValues': {'EncryptionType': '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',
    ]
)

type ClusterIdentifier

string

param ClusterIdentifier

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.

type MaxRecords

integer

param MaxRecords

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.

type Marker

string

param Marker

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords , AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

type TagKeys

list

param TagKeys

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) --

type TagValues

list

param TagValues

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) --

rtype

dict

returns

Response Syntax

{
    'Marker': 'string',
    'Clusters': [
        {
            'ClusterIdentifier': 'string',
            'NodeType': 'string',
            'ClusterStatus': 'string',
            'ModifyStatus': 'string',
            'MasterUsername': 'string',
            'DBName': 'string',
            'Endpoint': {
                'Address': 'string',
                'Port': 123
            },
            'ClusterCreateTime': datetime(2015, 1, 1),
            'AutomatedSnapshotRetentionPeriod': 123,
            'ClusterSecurityGroups': [
                {
                    'ClusterSecurityGroupName': 'string',
                    'Status': 'string'
                },
            ],
            'VpcSecurityGroups': [
                {
                    'VpcSecurityGroupId': 'string',
                    'Status': 'string'
                },
            ],
            'ClusterParameterGroups': [
                {
                    'ParameterGroupName': 'string',
                    'ParameterApplyStatus': 'string',
                    'ClusterParameterStatusList': [
                        {
                            'ParameterName': 'string',
                            'ParameterApplyStatus': 'string',
                            'ParameterApplyErrorDescription': 'string'
                        },
                    ]
                },
            ],
            'ClusterSubnetGroupName': 'string',
            'VpcId': 'string',
            'AvailabilityZone': 'string',
            'PreferredMaintenanceWindow': 'string',
            'PendingModifiedValues': {
                'MasterUserPassword': 'string',
                'NodeType': 'string',
                'NumberOfNodes': 123,
                'ClusterType': 'string',
                'ClusterVersion': 'string',
                'AutomatedSnapshotRetentionPeriod': 123,
                'ClusterIdentifier': 'string',
                '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
            },
            'HsmStatus': {
                'HsmClientCertificateIdentifier': 'string',
                'HsmConfigurationIdentifier': 'string',
                'Status': 'string'
            },
            'ClusterSnapshotCopyStatus': {
                'DestinationRegion': 'string',
                'RetentionPeriod': 123,
                'SnapshotCopyGrantName': 'string'
            },
            'ClusterPublicKey': 'string',
            'ClusterNodes': [
                {
                    'NodeRole': 'string',
                    'PrivateIPAddress': 'string',
                    'PublicIPAddress': 'string'
                },
            ],
            'ElasticIpStatus': {
                'ElasticIp': 'string',
                'Status': 'string'
            },
            'ClusterRevisionNumber': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'KmsKeyId': 'string',
            'EnhancedVpcRouting': True|False,
            'IamRoles': [
                {
                    'IamRoleArn': 'string',
                    'ApplyStatus': 'string'
                },
            ],
            'PendingActions': [
                'string',
            ],
            'MaintenanceTrackName': 'string',
            'ElasticResizeNumberOfNodeOptions': '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
      - creating
      - deleting
      - final-snapshot
      - hardware-failure
      - incompatible-hsm
      - incompatible-network
      - incompatible-parameters
      - incompatible-restore
      - modifying
      - rebooting
      - renaming
      - resizing
      - rotating-keys
      - storage-full
      - updating-hsm
    - ModifyStatus (string) --
      
      The status of a modify operation, if any, initiated for the cluster.
    - MasterUsername (string) --
      
      The master user name for the cluster. This name is used to connect to the database that is specified in 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.
    - ClusterCreateTime (datetime) --
      
      The date and time that the cluster was created.
    - AutomatedSnapshotRetentionPeriod (integer) --
      
      The number of days that automatic cluster snapshots are retained.
    - ClusterSecurityGroups (list) --
      
      A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
      
      Cluster security groups are used when the cluster is not created in 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 master user password for the cluster.
      - NodeType (string) --
        
        The pending or in-progress change of the cluster's node type.
      - NumberOfNodes (integer) --
        
        The pending or in-progress change of the number of nodes in the cluster.
      - ClusterType (string) --
        
        The pending or in-progress change of the cluster type.
      - ClusterVersion (string) --
        
        The pending or in-progress change of the service version.
      - AutomatedSnapshotRetentionPeriod (integer) --
        
        The pending or in-progress change of the automated snapshot retention period.
      - ClusterIdentifier (string) --
        
        The pending or in-progress change of the new identifier for the cluster.
      - 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. For the China region the possible values are None, and Legacy.
    - 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.
      - SnapshotSizeInMegaBytes (integer) --
        
        The size of the set of snapshot data used to restore the cluster.
      - ProgressInMegaBytes (integer) --
        
        The number of megabytes that have been transferred from snapshot storage.
      - ElapsedTimeInSeconds (integer) --
        
        The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
      - EstimatedTimeToCompletionInSeconds (integer) --
        
        The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
    - HsmStatus (dict) --
      
      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.
      - 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 AWS Key Management Service (AWS 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 AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
      - (dict) --
        
        An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS 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) --
      
      Indicates the number of nodes the cluster can be resized to with the elastic resize method.

DescribeResize (updated)

Link ¶
Changes (response)

{'TargetEncryptionType': 'string'}

Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a HTTP 404 error is returned. If a resize operation was initiated and completed, the status of the resize remains as SUCCEEDED until the next resize.

A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.

See also: AWS API Documentation

Request Syntax

client.describe_resize(
    ClusterIdentifier='string'
)

type ClusterIdentifier

string

param ClusterIdentifier

[REQUIRED]

The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive.

By default, resize operations for all clusters defined for an AWS account are returned.

rtype

dict

returns

Response Syntax

{
    'TargetNodeType': 'string',
    'TargetNumberOfNodes': 123,
    'TargetClusterType': 'string',
    'Status': 'string',
    'ImportTablesCompleted': [
        'string',
    ],
    'ImportTablesInProgress': [
        'string',
    ],
    'ImportTablesNotStarted': [
        'string',
    ],
    'AvgResizeRateInMegaBytesPerSecond': 123.0,
    'TotalResizeDataInMegaBytes': 123,
    'ProgressInMegaBytes': 123,
    'ElapsedTimeInSeconds': 123,
    'EstimatedTimeToCompletionInSeconds': 123,
    'ResizeType': 'string',
    'Message': 'string',
    'TargetEncryptionType': 'string'
}

Response Structure

(dict) --

Describes the result of a cluster resize operation.
- TargetNodeType (string) --
  
  The node type that the cluster will have after the resize operation is complete.
- TargetNumberOfNodes (integer) --
  
  The number of nodes that the cluster will have after the resize operation is complete.
- TargetClusterType (string) --
  
  The cluster type after the resize operation is complete.
  
  Valid Values: multi-node | single-node
- Status (string) --
  
  The status of the resize operation.
  
  Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED
- ImportTablesCompleted (list) --
  
  The names of tables that have been completely imported .
  
  Valid Values: List of table names.
  - (string) --
- ImportTablesInProgress (list) --
  
  The names of tables that are being currently imported.
  
  Valid Values: List of table names.
  - (string) --
- ImportTablesNotStarted (list) --
  
  The names of tables that have not been yet imported.
  
  Valid Values: List of table names
  - (string) --
- AvgResizeRateInMegaBytesPerSecond (float) --
  
  The average rate of the resize operation over the last few minutes, measured in megabytes per second. After the resize operation completes, this value shows the average rate of the entire resize operation.
- TotalResizeDataInMegaBytes (integer) --
  
  The estimated total amount of data, in megabytes, on the cluster before the resize operation began.
- ProgressInMegaBytes (integer) --
  
  While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize).
- ElapsedTimeInSeconds (integer) --
  
  The amount of seconds that have elapsed since the resize operation began. After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation.
- EstimatedTimeToCompletionInSeconds (integer) --
  
  The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0.
- ResizeType (string) --
  
  An enum with possible values of ClassicResize and ElasticResize. These values describe the type of resize operation being performed.
- Message (string) --
  
  An optional string to provide additional details about the resize action.
- TargetEncryptionType (string) --
  
  The type of encryption for the cluster after the resize is complete.
  
  Possible values are KMS and None . In the China region possible values are: Legacy and None .

DisableSnapshotCopy (updated)

Link ¶
Changes (response)

{'Cluster': {'PendingModifiedValues': {'EncryptionType': 'string'}}}

Disables the automatic copying of snapshots from one region to another region for a specified cluster.

If your cluster and its snapshots are encrypted using a customer master key (CMK) from AWS KMS, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the CMK in the destination region.

See also: AWS API Documentation

Request Syntax

client.disable_snapshot_copy(
    ClusterIdentifier='string'
)

type ClusterIdentifier

string

param ClusterIdentifier

[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.

rtype

dict

returns

Response Syntax

{
    'Cluster': {
        'ClusterIdentifier': 'string',
        'NodeType': 'string',
        'ClusterStatus': 'string',
        'ModifyStatus': 'string',
        'MasterUsername': 'string',
        'DBName': 'string',
        'Endpoint': {
            'Address': 'string',
            'Port': 123
        },
        'ClusterCreateTime': datetime(2015, 1, 1),
        'AutomatedSnapshotRetentionPeriod': 123,
        'ClusterSecurityGroups': [
            {
                'ClusterSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'ClusterParameterGroups': [
            {
                'ParameterGroupName': 'string',
                'ParameterApplyStatus': 'string',
                'ClusterParameterStatusList': [
                    {
                        'ParameterName': 'string',
                        'ParameterApplyStatus': 'string',
                        'ParameterApplyErrorDescription': 'string'
                    },
                ]
            },
        ],
        'ClusterSubnetGroupName': 'string',
        'VpcId': 'string',
        'AvailabilityZone': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PendingModifiedValues': {
            'MasterUserPassword': 'string',
            'NodeType': 'string',
            'NumberOfNodes': 123,
            'ClusterType': 'string',
            'ClusterVersion': 'string',
            'AutomatedSnapshotRetentionPeriod': 123,
            'ClusterIdentifier': 'string',
            '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
        },
        'HsmStatus': {
            'HsmClientCertificateIdentifier': 'string',
            'HsmConfigurationIdentifier': 'string',
            'Status': 'string'
        },
        'ClusterSnapshotCopyStatus': {
            'DestinationRegion': 'string',
            'RetentionPeriod': 123,
            'SnapshotCopyGrantName': 'string'
        },
        'ClusterPublicKey': 'string',
        'ClusterNodes': [
            {
                'NodeRole': 'string',
                'PrivateIPAddress': 'string',
                'PublicIPAddress': 'string'
            },
        ],
        'ElasticIpStatus': {
            'ElasticIp': 'string',
            'Status': 'string'
        },
        'ClusterRevisionNumber': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'KmsKeyId': 'string',
        'EnhancedVpcRouting': True|False,
        'IamRoles': [
            {
                'IamRoleArn': 'string',
                'ApplyStatus': 'string'
            },
        ],
        'PendingActions': [
            'string',
        ],
        'MaintenanceTrackName': 'string',
        'ElasticResizeNumberOfNodeOptions': '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
    - creating
    - deleting
    - final-snapshot
    - hardware-failure
    - incompatible-hsm
    - incompatible-network
    - incompatible-parameters
    - incompatible-restore
    - modifying
    - rebooting
    - renaming
    - resizing
    - rotating-keys
    - storage-full
    - updating-hsm
  - ModifyStatus (string) --
    
    The status of a modify operation, if any, initiated for the cluster.
  - MasterUsername (string) --
    
    The master user name for the cluster. This name is used to connect to the database that is specified in 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.
  - ClusterCreateTime (datetime) --
    
    The date and time that the cluster was created.
  - AutomatedSnapshotRetentionPeriod (integer) --
    
    The number of days that automatic cluster snapshots are retained.
  - ClusterSecurityGroups (list) --
    
    A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
    
    Cluster security groups are used when the cluster is not created in 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 master user password for the cluster.
    - NodeType (string) --
      
      The pending or in-progress change of the cluster's node type.
    - NumberOfNodes (integer) --
      
      The pending or in-progress change of the number of nodes in the cluster.
    - ClusterType (string) --
      
      The pending or in-progress change of the cluster type.
    - ClusterVersion (string) --
      
      The pending or in-progress change of the service version.
    - AutomatedSnapshotRetentionPeriod (integer) --
      
      The pending or in-progress change of the automated snapshot retention period.
    - ClusterIdentifier (string) --
      
      The pending or in-progress change of the new identifier for the cluster.
    - 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. For the China region the possible values are None, and Legacy.
  - 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.
    - SnapshotSizeInMegaBytes (integer) --
      
      The size of the set of snapshot data used to restore the cluster.
    - ProgressInMegaBytes (integer) --
      
      The number of megabytes that have been transferred from snapshot storage.
    - ElapsedTimeInSeconds (integer) --
      
      The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
    - EstimatedTimeToCompletionInSeconds (integer) --
      
      The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
  - HsmStatus (dict) --
    
    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.
    - 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 AWS Key Management Service (AWS 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 AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
    - (dict) --
      
      An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS 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) --
    
    Indicates the number of nodes the cluster can be resized to with the elastic resize method.

EnableSnapshotCopy (updated)

Link ¶
Changes (response)

{'Cluster': {'PendingModifiedValues': {'EncryptionType': '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'
)

type ClusterIdentifier

string

param ClusterIdentifier

[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.

type DestinationRegion

string

param DestinationRegion

[REQUIRED]

The destination region that you want to copy snapshots to.

Constraints: Must be the name of a valid region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.

type RetentionPeriod

integer

param RetentionPeriod

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.

type SnapshotCopyGrantName

string

param SnapshotCopyGrantName

The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

rtype

dict

returns

Response Syntax

{
    'Cluster': {
        'ClusterIdentifier': 'string',
        'NodeType': 'string',
        'ClusterStatus': 'string',
        'ModifyStatus': 'string',
        'MasterUsername': 'string',
        'DBName': 'string',
        'Endpoint': {
            'Address': 'string',
            'Port': 123
        },
        'ClusterCreateTime': datetime(2015, 1, 1),
        'AutomatedSnapshotRetentionPeriod': 123,
        'ClusterSecurityGroups': [
            {
                'ClusterSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'ClusterParameterGroups': [
            {
                'ParameterGroupName': 'string',
                'ParameterApplyStatus': 'string',
                'ClusterParameterStatusList': [
                    {
                        'ParameterName': 'string',
                        'ParameterApplyStatus': 'string',
                        'ParameterApplyErrorDescription': 'string'
                    },
                ]
            },
        ],
        'ClusterSubnetGroupName': 'string',
        'VpcId': 'string',
        'AvailabilityZone': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PendingModifiedValues': {
            'MasterUserPassword': 'string',
            'NodeType': 'string',
            'NumberOfNodes': 123,
            'ClusterType': 'string',
            'ClusterVersion': 'string',
            'AutomatedSnapshotRetentionPeriod': 123,
            'ClusterIdentifier': 'string',
            '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
        },
        'HsmStatus': {
            'HsmClientCertificateIdentifier': 'string',
            'HsmConfigurationIdentifier': 'string',
            'Status': 'string'
        },
        'ClusterSnapshotCopyStatus': {
            'DestinationRegion': 'string',
            'RetentionPeriod': 123,
            'SnapshotCopyGrantName': 'string'
        },
        'ClusterPublicKey': 'string',
        'ClusterNodes': [
            {
                'NodeRole': 'string',
                'PrivateIPAddress': 'string',
                'PublicIPAddress': 'string'
            },
        ],
        'ElasticIpStatus': {
            'ElasticIp': 'string',
            'Status': 'string'
        },
        'ClusterRevisionNumber': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'KmsKeyId': 'string',
        'EnhancedVpcRouting': True|False,
        'IamRoles': [
            {
                'IamRoleArn': 'string',
                'ApplyStatus': 'string'
            },
        ],
        'PendingActions': [
            'string',
        ],
        'MaintenanceTrackName': 'string',
        'ElasticResizeNumberOfNodeOptions': '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
    - creating
    - deleting
    - final-snapshot
    - hardware-failure
    - incompatible-hsm
    - incompatible-network
    - incompatible-parameters
    - incompatible-restore
    - modifying
    - rebooting
    - renaming
    - resizing
    - rotating-keys
    - storage-full
    - updating-hsm
  - ModifyStatus (string) --
    
    The status of a modify operation, if any, initiated for the cluster.
  - MasterUsername (string) --
    
    The master user name for the cluster. This name is used to connect to the database that is specified in 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.
  - ClusterCreateTime (datetime) --
    
    The date and time that the cluster was created.
  - AutomatedSnapshotRetentionPeriod (integer) --
    
    The number of days that automatic cluster snapshots are retained.
  - ClusterSecurityGroups (list) --
    
    A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
    
    Cluster security groups are used when the cluster is not created in 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 master user password for the cluster.
    - NodeType (string) --
      
      The pending or in-progress change of the cluster's node type.
    - NumberOfNodes (integer) --
      
      The pending or in-progress change of the number of nodes in the cluster.
    - ClusterType (string) --
      
      The pending or in-progress change of the cluster type.
    - ClusterVersion (string) --
      
      The pending or in-progress change of the service version.
    - AutomatedSnapshotRetentionPeriod (integer) --
      
      The pending or in-progress change of the automated snapshot retention period.
    - ClusterIdentifier (string) --
      
      The pending or in-progress change of the new identifier for the cluster.
    - 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. For the China region the possible values are None, and Legacy.
  - 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.
    - SnapshotSizeInMegaBytes (integer) --
      
      The size of the set of snapshot data used to restore the cluster.
    - ProgressInMegaBytes (integer) --
      
      The number of megabytes that have been transferred from snapshot storage.
    - ElapsedTimeInSeconds (integer) --
      
      The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
    - EstimatedTimeToCompletionInSeconds (integer) --
      
      The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
  - HsmStatus (dict) --
    
    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.
    - 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 AWS Key Management Service (AWS 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 AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
    - (dict) --
      
      An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS 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) --
    
    Indicates the number of nodes the cluster can be resized to with the elastic resize method.

ModifyCluster (updated)

Link ¶
Changes (request, response)
Request

{'Encrypted': 'boolean', 'KmsKeyId': 'string'}

Response

{'Cluster': {'PendingModifiedValues': {'EncryptionType': 'string'}}}

Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide .

You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change.

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,
    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'
)

type ClusterIdentifier

string

param ClusterIdentifier

[REQUIRED]

The unique identifier of the cluster to be modified.

Example: examplecluster

type ClusterType

string

param ClusterType

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

type NodeType

string

param NodeType

The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.

When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.

type NumberOfNodes

integer

param NumberOfNodes

The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter.

Valid Values: Integer greater than 0 .

type ClusterSecurityGroups

list

param ClusterSecurityGroups

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) --

type VpcSecurityGroupIds

list

param VpcSecurityGroupIds

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) --

type MasterUserPassword

string

param MasterUserPassword

The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Note

Operations never return the password, so this operation provides a way to regain access to the master 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 to 126) except ' (single quote), " (double quote), , /, @, or space.

type ClusterParameterGroupName

string

param ClusterParameterGroupName

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.

type AutomatedSnapshotRetentionPeriod

integer

param AutomatedSnapshotRetentionPeriod

If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.

Default: Uses existing setting.

Constraints: Must be a value from 0 to 35.

type PreferredMaintenanceWindow

string

param PreferredMaintenanceWindow

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.

type ClusterVersion

string

param ClusterVersion

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

type AllowVersionUpgrade

boolean

param AllowVersionUpgrade

If true , major version upgrades will be applied automatically to the cluster during the maintenance window.

Default: false

type HsmClientCertificateIdentifier

string

param HsmClientCertificateIdentifier

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

type HsmConfigurationIdentifier

string

param HsmConfigurationIdentifier

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.

type NewClusterIdentifier

string

param NewClusterIdentifier

The new identifier for the cluster.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.

Example: examplecluster

type PubliclyAccessible

boolean

param PubliclyAccessible

If true , the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.

type ElasticIp

string

param ElasticIp

The Elastic IP (EIP) address for the cluster.

type EnhancedVpcRouting

boolean

param EnhancedVpcRouting

If this option is true , enhanced VPC routing is enabled.

Default: false

type MaintenanceTrackName

string

param MaintenanceTrackName

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.

type Encrypted

boolean

param Encrypted

Indicates whether the cluster is encrypted. If the cluster is encrypted and you provide a value for the KmsKeyId parameter, we will encrypt the cluster with the provided KmsKeyId . If you don't provide a KmsKeyId , we will encrypt with the default key. In the China region we will use legacy encryption if you specify that the cluster is encrypted.

type KmsKeyId

string

param KmsKeyId

The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

rtype

dict

returns

Response Syntax

{
    'Cluster': {
        'ClusterIdentifier': 'string',
        'NodeType': 'string',
        'ClusterStatus': 'string',
        'ModifyStatus': 'string',
        'MasterUsername': 'string',
        'DBName': 'string',
        'Endpoint': {
            'Address': 'string',
            'Port': 123
        },
        'ClusterCreateTime': datetime(2015, 1, 1),
        'AutomatedSnapshotRetentionPeriod': 123,
        'ClusterSecurityGroups': [
            {
                'ClusterSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'ClusterParameterGroups': [
            {
                'ParameterGroupName': 'string',
                'ParameterApplyStatus': 'string',
                'ClusterParameterStatusList': [
                    {
                        'ParameterName': 'string',
                        'ParameterApplyStatus': 'string',
                        'ParameterApplyErrorDescription': 'string'
                    },
                ]
            },
        ],
        'ClusterSubnetGroupName': 'string',
        'VpcId': 'string',
        'AvailabilityZone': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PendingModifiedValues': {
            'MasterUserPassword': 'string',
            'NodeType': 'string',
            'NumberOfNodes': 123,
            'ClusterType': 'string',
            'ClusterVersion': 'string',
            'AutomatedSnapshotRetentionPeriod': 123,
            'ClusterIdentifier': 'string',
            '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
        },
        'HsmStatus': {
            'HsmClientCertificateIdentifier': 'string',
            'HsmConfigurationIdentifier': 'string',
            'Status': 'string'
        },
        'ClusterSnapshotCopyStatus': {
            'DestinationRegion': 'string',
            'RetentionPeriod': 123,
            'SnapshotCopyGrantName': 'string'
        },
        'ClusterPublicKey': 'string',
        'ClusterNodes': [
            {
                'NodeRole': 'string',
                'PrivateIPAddress': 'string',
                'PublicIPAddress': 'string'
            },
        ],
        'ElasticIpStatus': {
            'ElasticIp': 'string',
            'Status': 'string'
        },
        'ClusterRevisionNumber': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'KmsKeyId': 'string',
        'EnhancedVpcRouting': True|False,
        'IamRoles': [
            {
                'IamRoleArn': 'string',
                'ApplyStatus': 'string'
            },
        ],
        'PendingActions': [
            'string',
        ],
        'MaintenanceTrackName': 'string',
        'ElasticResizeNumberOfNodeOptions': '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
    - creating
    - deleting
    - final-snapshot
    - hardware-failure
    - incompatible-hsm
    - incompatible-network
    - incompatible-parameters
    - incompatible-restore
    - modifying
    - rebooting
    - renaming
    - resizing
    - rotating-keys
    - storage-full
    - updating-hsm
  - ModifyStatus (string) --
    
    The status of a modify operation, if any, initiated for the cluster.
  - MasterUsername (string) --
    
    The master user name for the cluster. This name is used to connect to the database that is specified in 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.
  - ClusterCreateTime (datetime) --
    
    The date and time that the cluster was created.
  - AutomatedSnapshotRetentionPeriod (integer) --
    
    The number of days that automatic cluster snapshots are retained.
  - ClusterSecurityGroups (list) --
    
    A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
    
    Cluster security groups are used when the cluster is not created in 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 master user password for the cluster.
    - NodeType (string) --
      
      The pending or in-progress change of the cluster's node type.
    - NumberOfNodes (integer) --
      
      The pending or in-progress change of the number of nodes in the cluster.
    - ClusterType (string) --
      
      The pending or in-progress change of the cluster type.
    - ClusterVersion (string) --
      
      The pending or in-progress change of the service version.
    - AutomatedSnapshotRetentionPeriod (integer) --
      
      The pending or in-progress change of the automated snapshot retention period.
    - ClusterIdentifier (string) --
      
      The pending or in-progress change of the new identifier for the cluster.
    - 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. For the China region the possible values are None, and Legacy.
  - 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.
    - SnapshotSizeInMegaBytes (integer) --
      
      The size of the set of snapshot data used to restore the cluster.
    - ProgressInMegaBytes (integer) --
      
      The number of megabytes that have been transferred from snapshot storage.
    - ElapsedTimeInSeconds (integer) --
      
      The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
    - EstimatedTimeToCompletionInSeconds (integer) --
      
      The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
  - HsmStatus (dict) --
    
    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.
    - 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 AWS Key Management Service (AWS 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 AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
    - (dict) --
      
      An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS 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) --
    
    Indicates the number of nodes the cluster can be resized to with the elastic resize method.

ModifyClusterDbRevision (updated)

Link ¶
Changes (response)

{'Cluster': {'PendingModifiedValues': {'EncryptionType': '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'
)

type ClusterIdentifier

string

param ClusterIdentifier

[REQUIRED]

The unique identifier of a cluster whose database revision you want to modify.

Example: examplecluster

type RevisionTarget

string

param RevisionTarget

[REQUIRED]

The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.

rtype

dict

returns

Response Syntax

{
    'Cluster': {
        'ClusterIdentifier': 'string',
        'NodeType': 'string',
        'ClusterStatus': 'string',
        'ModifyStatus': 'string',
        'MasterUsername': 'string',
        'DBName': 'string',
        'Endpoint': {
            'Address': 'string',
            'Port': 123
        },
        'ClusterCreateTime': datetime(2015, 1, 1),
        'AutomatedSnapshotRetentionPeriod': 123,
        'ClusterSecurityGroups': [
            {
                'ClusterSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'ClusterParameterGroups': [
            {
                'ParameterGroupName': 'string',
                'ParameterApplyStatus': 'string',
                'ClusterParameterStatusList': [
                    {
                        'ParameterName': 'string',
                        'ParameterApplyStatus': 'string',
                        'ParameterApplyErrorDescription': 'string'
                    },
                ]
            },
        ],
        'ClusterSubnetGroupName': 'string',
        'VpcId': 'string',
        'AvailabilityZone': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PendingModifiedValues': {
            'MasterUserPassword': 'string',
            'NodeType': 'string',
            'NumberOfNodes': 123,
            'ClusterType': 'string',
            'ClusterVersion': 'string',
            'AutomatedSnapshotRetentionPeriod': 123,
            'ClusterIdentifier': 'string',
            '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
        },
        'HsmStatus': {
            'HsmClientCertificateIdentifier': 'string',
            'HsmConfigurationIdentifier': 'string',
            'Status': 'string'
        },
        'ClusterSnapshotCopyStatus': {
            'DestinationRegion': 'string',
            'RetentionPeriod': 123,
            'SnapshotCopyGrantName': 'string'
        },
        'ClusterPublicKey': 'string',
        'ClusterNodes': [
            {
                'NodeRole': 'string',
                'PrivateIPAddress': 'string',
                'PublicIPAddress': 'string'
            },
        ],
        'ElasticIpStatus': {
            'ElasticIp': 'string',
            'Status': 'string'
        },
        'ClusterRevisionNumber': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'KmsKeyId': 'string',
        'EnhancedVpcRouting': True|False,
        'IamRoles': [
            {
                'IamRoleArn': 'string',
                'ApplyStatus': 'string'
            },
        ],
        'PendingActions': [
            'string',
        ],
        'MaintenanceTrackName': 'string',
        'ElasticResizeNumberOfNodeOptions': '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
    - creating
    - deleting
    - final-snapshot
    - hardware-failure
    - incompatible-hsm
    - incompatible-network
    - incompatible-parameters
    - incompatible-restore
    - modifying
    - rebooting
    - renaming
    - resizing
    - rotating-keys
    - storage-full
    - updating-hsm
  - ModifyStatus (string) --
    
    The status of a modify operation, if any, initiated for the cluster.
  - MasterUsername (string) --
    
    The master user name for the cluster. This name is used to connect to the database that is specified in 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.
  - ClusterCreateTime (datetime) --
    
    The date and time that the cluster was created.
  - AutomatedSnapshotRetentionPeriod (integer) --
    
    The number of days that automatic cluster snapshots are retained.
  - ClusterSecurityGroups (list) --
    
    A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
    
    Cluster security groups are used when the cluster is not created in 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 master user password for the cluster.
    - NodeType (string) --
      
      The pending or in-progress change of the cluster's node type.
    - NumberOfNodes (integer) --
      
      The pending or in-progress change of the number of nodes in the cluster.
    - ClusterType (string) --
      
      The pending or in-progress change of the cluster type.
    - ClusterVersion (string) --
      
      The pending or in-progress change of the service version.
    - AutomatedSnapshotRetentionPeriod (integer) --
      
      The pending or in-progress change of the automated snapshot retention period.
    - ClusterIdentifier (string) --
      
      The pending or in-progress change of the new identifier for the cluster.
    - 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. For the China region the possible values are None, and Legacy.
  - 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.
    - SnapshotSizeInMegaBytes (integer) --
      
      The size of the set of snapshot data used to restore the cluster.
    - ProgressInMegaBytes (integer) --
      
      The number of megabytes that have been transferred from snapshot storage.
    - ElapsedTimeInSeconds (integer) --
      
      The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
    - EstimatedTimeToCompletionInSeconds (integer) --
      
      The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
  - HsmStatus (dict) --
    
    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.
    - 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 AWS Key Management Service (AWS 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 AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
    - (dict) --
      
      An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS 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) --
    
    Indicates the number of nodes the cluster can be resized to with the elastic resize method.

ModifyClusterIamRoles (updated)

Link ¶
Changes (response)

{'Cluster': {'PendingModifiedValues': {'EncryptionType': 'string'}}}

Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.

A cluster can have up to 10 IAM roles associated at any time.

See also: AWS API Documentation

Request Syntax

client.modify_cluster_iam_roles(
    ClusterIdentifier='string',
    AddIamRoles=[
        'string',
    ],
    RemoveIamRoles=[
        'string',
    ]
)

type ClusterIdentifier

string

param ClusterIdentifier

[REQUIRED]

The unique identifier of the cluster for which you want to associate or disassociate IAM roles.

type AddIamRoles

list

param AddIamRoles

Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single cluster in a single request.

(string) --

type RemoveIamRoles

list

param RemoveIamRoles

Zero or more IAM roles in ARN format to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request.

(string) --

rtype

dict

returns

Response Syntax

{
    'Cluster': {
        'ClusterIdentifier': 'string',
        'NodeType': 'string',
        'ClusterStatus': 'string',
        'ModifyStatus': 'string',
        'MasterUsername': 'string',
        'DBName': 'string',
        'Endpoint': {
            'Address': 'string',
            'Port': 123
        },
        'ClusterCreateTime': datetime(2015, 1, 1),
        'AutomatedSnapshotRetentionPeriod': 123,
        'ClusterSecurityGroups': [
            {
                'ClusterSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'ClusterParameterGroups': [
            {
                'ParameterGroupName': 'string',
                'ParameterApplyStatus': 'string',
                'ClusterParameterStatusList': [
                    {
                        'ParameterName': 'string',
                        'ParameterApplyStatus': 'string',
                        'ParameterApplyErrorDescription': 'string'
                    },
                ]
            },
        ],
        'ClusterSubnetGroupName': 'string',
        'VpcId': 'string',
        'AvailabilityZone': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PendingModifiedValues': {
            'MasterUserPassword': 'string',
            'NodeType': 'string',
            'NumberOfNodes': 123,
            'ClusterType': 'string',
            'ClusterVersion': 'string',
            'AutomatedSnapshotRetentionPeriod': 123,
            'ClusterIdentifier': 'string',
            '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
        },
        'HsmStatus': {
            'HsmClientCertificateIdentifier': 'string',
            'HsmConfigurationIdentifier': 'string',
            'Status': 'string'
        },
        'ClusterSnapshotCopyStatus': {
            'DestinationRegion': 'string',
            'RetentionPeriod': 123,
            'SnapshotCopyGrantName': 'string'
        },
        'ClusterPublicKey': 'string',
        'ClusterNodes': [
            {
                'NodeRole': 'string',
                'PrivateIPAddress': 'string',
                'PublicIPAddress': 'string'
            },
        ],
        'ElasticIpStatus': {
            'ElasticIp': 'string',
            'Status': 'string'
        },
        'ClusterRevisionNumber': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'KmsKeyId': 'string',
        'EnhancedVpcRouting': True|False,
        'IamRoles': [
            {
                'IamRoleArn': 'string',
                'ApplyStatus': 'string'
            },
        ],
        'PendingActions': [
            'string',
        ],
        'MaintenanceTrackName': 'string',
        'ElasticResizeNumberOfNodeOptions': '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
    - creating
    - deleting
    - final-snapshot
    - hardware-failure
    - incompatible-hsm
    - incompatible-network
    - incompatible-parameters
    - incompatible-restore
    - modifying
    - rebooting
    - renaming
    - resizing
    - rotating-keys
    - storage-full
    - updating-hsm
  - ModifyStatus (string) --
    
    The status of a modify operation, if any, initiated for the cluster.
  - MasterUsername (string) --
    
    The master user name for the cluster. This name is used to connect to the database that is specified in 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.
  - ClusterCreateTime (datetime) --
    
    The date and time that the cluster was created.
  - AutomatedSnapshotRetentionPeriod (integer) --
    
    The number of days that automatic cluster snapshots are retained.
  - ClusterSecurityGroups (list) --
    
    A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
    
    Cluster security groups are used when the cluster is not created in 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 master user password for the cluster.
    - NodeType (string) --
      
      The pending or in-progress change of the cluster's node type.
    - NumberOfNodes (integer) --
      
      The pending or in-progress change of the number of nodes in the cluster.
    - ClusterType (string) --
      
      The pending or in-progress change of the cluster type.
    - ClusterVersion (string) --
      
      The pending or in-progress change of the service version.
    - AutomatedSnapshotRetentionPeriod (integer) --
      
      The pending or in-progress change of the automated snapshot retention period.
    - ClusterIdentifier (string) --
      
      The pending or in-progress change of the new identifier for the cluster.
    - 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. For the China region the possible values are None, and Legacy.
  - 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.
    - SnapshotSizeInMegaBytes (integer) --
      
      The size of the set of snapshot data used to restore the cluster.
    - ProgressInMegaBytes (integer) --
      
      The number of megabytes that have been transferred from snapshot storage.
    - ElapsedTimeInSeconds (integer) --
      
      The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
    - EstimatedTimeToCompletionInSeconds (integer) --
      
      The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
  - HsmStatus (dict) --
    
    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.
    - 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 AWS Key Management Service (AWS 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 AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
    - (dict) --
      
      An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS 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) --
    
    Indicates the number of nodes the cluster can be resized to with the elastic resize method.

ModifySnapshotCopyRetentionPeriod (updated)

Link ¶
Changes (response)

{'Cluster': {'PendingModifiedValues': {'EncryptionType': 'string'}}}

Modifies the number of days to retain automated snapshots in the destination region after they are copied from the source region.

See also: AWS API Documentation

Request Syntax

client.modify_snapshot_copy_retention_period(
    ClusterIdentifier='string',
    RetentionPeriod=123
)

type ClusterIdentifier

string

param ClusterIdentifier

[REQUIRED]

The unique identifier of the cluster for which you want to change the retention period for automated snapshots that are copied to a destination region.

Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

type RetentionPeriod

integer

param RetentionPeriod

[REQUIRED]

The number of days to retain automated snapshots in the destination region after they are copied from the source region.

If you decrease the retention period for automated snapshots that are copied to a destination region, Amazon Redshift will delete any existing automated snapshots that were copied to the destination region and that fall outside of the new retention period.

Constraints: Must be at least 1 and no more than 35.

rtype

dict

returns

Response Syntax

{
    'Cluster': {
        'ClusterIdentifier': 'string',
        'NodeType': 'string',
        'ClusterStatus': 'string',
        'ModifyStatus': 'string',
        'MasterUsername': 'string',
        'DBName': 'string',
        'Endpoint': {
            'Address': 'string',
            'Port': 123
        },
        'ClusterCreateTime': datetime(2015, 1, 1),
        'AutomatedSnapshotRetentionPeriod': 123,
        'ClusterSecurityGroups': [
            {
                'ClusterSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'ClusterParameterGroups': [
            {
                'ParameterGroupName': 'string',
                'ParameterApplyStatus': 'string',
                'ClusterParameterStatusList': [
                    {
                        'ParameterName': 'string',
                        'ParameterApplyStatus': 'string',
                        'ParameterApplyErrorDescription': 'string'
                    },
                ]
            },
        ],
        'ClusterSubnetGroupName': 'string',
        'VpcId': 'string',
        'AvailabilityZone': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PendingModifiedValues': {
            'MasterUserPassword': 'string',
            'NodeType': 'string',
            'NumberOfNodes': 123,
            'ClusterType': 'string',
            'ClusterVersion': 'string',
            'AutomatedSnapshotRetentionPeriod': 123,
            'ClusterIdentifier': 'string',
            '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
        },
        'HsmStatus': {
            'HsmClientCertificateIdentifier': 'string',
            'HsmConfigurationIdentifier': 'string',
            'Status': 'string'
        },
        'ClusterSnapshotCopyStatus': {
            'DestinationRegion': 'string',
            'RetentionPeriod': 123,
            'SnapshotCopyGrantName': 'string'
        },
        'ClusterPublicKey': 'string',
        'ClusterNodes': [
            {
                'NodeRole': 'string',
                'PrivateIPAddress': 'string',
                'PublicIPAddress': 'string'
            },
        ],
        'ElasticIpStatus': {
            'ElasticIp': 'string',
            'Status': 'string'
        },
        'ClusterRevisionNumber': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'KmsKeyId': 'string',
        'EnhancedVpcRouting': True|False,
        'IamRoles': [
            {
                'IamRoleArn': 'string',
                'ApplyStatus': 'string'
            },
        ],
        'PendingActions': [
            'string',
        ],
        'MaintenanceTrackName': 'string',
        'ElasticResizeNumberOfNodeOptions': '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
    - creating
    - deleting
    - final-snapshot
    - hardware-failure
    - incompatible-hsm
    - incompatible-network
    - incompatible-parameters
    - incompatible-restore
    - modifying
    - rebooting
    - renaming
    - resizing
    - rotating-keys
    - storage-full
    - updating-hsm
  - ModifyStatus (string) --
    
    The status of a modify operation, if any, initiated for the cluster.
  - MasterUsername (string) --
    
    The master user name for the cluster. This name is used to connect to the database that is specified in 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.
  - ClusterCreateTime (datetime) --
    
    The date and time that the cluster was created.
  - AutomatedSnapshotRetentionPeriod (integer) --
    
    The number of days that automatic cluster snapshots are retained.
  - ClusterSecurityGroups (list) --
    
    A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
    
    Cluster security groups are used when the cluster is not created in 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 master user password for the cluster.
    - NodeType (string) --
      
      The pending or in-progress change of the cluster's node type.
    - NumberOfNodes (integer) --
      
      The pending or in-progress change of the number of nodes in the cluster.
    - ClusterType (string) --
      
      The pending or in-progress change of the cluster type.
    - ClusterVersion (string) --
      
      The pending or in-progress change of the service version.
    - AutomatedSnapshotRetentionPeriod (integer) --
      
      The pending or in-progress change of the automated snapshot retention period.
    - ClusterIdentifier (string) --
      
      The pending or in-progress change of the new identifier for the cluster.
    - 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. For the China region the possible values are None, and Legacy.
  - 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.
    - SnapshotSizeInMegaBytes (integer) --
      
      The size of the set of snapshot data used to restore the cluster.
    - ProgressInMegaBytes (integer) --
      
      The number of megabytes that have been transferred from snapshot storage.
    - ElapsedTimeInSeconds (integer) --
      
      The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
    - EstimatedTimeToCompletionInSeconds (integer) --
      
      The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
  - HsmStatus (dict) --
    
    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.
    - 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 AWS Key Management Service (AWS 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 AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
    - (dict) --
      
      An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS 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) --
    
    Indicates the number of nodes the cluster can be resized to with the elastic resize method.

RebootCluster (updated)

Link ¶
Changes (response)

{'Cluster': {'PendingModifiedValues': {'EncryptionType': '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'
)

type ClusterIdentifier

string

param ClusterIdentifier

[REQUIRED]

The cluster identifier.

rtype

dict

returns

Response Syntax

{
    'Cluster': {
        'ClusterIdentifier': 'string',
        'NodeType': 'string',
        'ClusterStatus': 'string',
        'ModifyStatus': 'string',
        'MasterUsername': 'string',
        'DBName': 'string',
        'Endpoint': {
            'Address': 'string',
            'Port': 123
        },
        'ClusterCreateTime': datetime(2015, 1, 1),
        'AutomatedSnapshotRetentionPeriod': 123,
        'ClusterSecurityGroups': [
            {
                'ClusterSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'ClusterParameterGroups': [
            {
                'ParameterGroupName': 'string',
                'ParameterApplyStatus': 'string',
                'ClusterParameterStatusList': [
                    {
                        'ParameterName': 'string',
                        'ParameterApplyStatus': 'string',
                        'ParameterApplyErrorDescription': 'string'
                    },
                ]
            },
        ],
        'ClusterSubnetGroupName': 'string',
        'VpcId': 'string',
        'AvailabilityZone': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PendingModifiedValues': {
            'MasterUserPassword': 'string',
            'NodeType': 'string',
            'NumberOfNodes': 123,
            'ClusterType': 'string',
            'ClusterVersion': 'string',
            'AutomatedSnapshotRetentionPeriod': 123,
            'ClusterIdentifier': 'string',
            '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
        },
        'HsmStatus': {
            'HsmClientCertificateIdentifier': 'string',
            'HsmConfigurationIdentifier': 'string',
            'Status': 'string'
        },
        'ClusterSnapshotCopyStatus': {
            'DestinationRegion': 'string',
            'RetentionPeriod': 123,
            'SnapshotCopyGrantName': 'string'
        },
        'ClusterPublicKey': 'string',
        'ClusterNodes': [
            {
                'NodeRole': 'string',
                'PrivateIPAddress': 'string',
                'PublicIPAddress': 'string'
            },
        ],
        'ElasticIpStatus': {
            'ElasticIp': 'string',
            'Status': 'string'
        },
        'ClusterRevisionNumber': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'KmsKeyId': 'string',
        'EnhancedVpcRouting': True|False,
        'IamRoles': [
            {
                'IamRoleArn': 'string',
                'ApplyStatus': 'string'
            },
        ],
        'PendingActions': [
            'string',
        ],
        'MaintenanceTrackName': 'string',
        'ElasticResizeNumberOfNodeOptions': '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
    - creating
    - deleting
    - final-snapshot
    - hardware-failure
    - incompatible-hsm
    - incompatible-network
    - incompatible-parameters
    - incompatible-restore
    - modifying
    - rebooting
    - renaming
    - resizing
    - rotating-keys
    - storage-full
    - updating-hsm
  - ModifyStatus (string) --
    
    The status of a modify operation, if any, initiated for the cluster.
  - MasterUsername (string) --
    
    The master user name for the cluster. This name is used to connect to the database that is specified in 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.
  - ClusterCreateTime (datetime) --
    
    The date and time that the cluster was created.
  - AutomatedSnapshotRetentionPeriod (integer) --
    
    The number of days that automatic cluster snapshots are retained.
  - ClusterSecurityGroups (list) --
    
    A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
    
    Cluster security groups are used when the cluster is not created in 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 master user password for the cluster.
    - NodeType (string) --
      
      The pending or in-progress change of the cluster's node type.
    - NumberOfNodes (integer) --
      
      The pending or in-progress change of the number of nodes in the cluster.
    - ClusterType (string) --
      
      The pending or in-progress change of the cluster type.
    - ClusterVersion (string) --
      
      The pending or in-progress change of the service version.
    - AutomatedSnapshotRetentionPeriod (integer) --
      
      The pending or in-progress change of the automated snapshot retention period.
    - ClusterIdentifier (string) --
      
      The pending or in-progress change of the new identifier for the cluster.
    - 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. For the China region the possible values are None, and Legacy.
  - 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.
    - SnapshotSizeInMegaBytes (integer) --
      
      The size of the set of snapshot data used to restore the cluster.
    - ProgressInMegaBytes (integer) --
      
      The number of megabytes that have been transferred from snapshot storage.
    - ElapsedTimeInSeconds (integer) --
      
      The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
    - EstimatedTimeToCompletionInSeconds (integer) --
      
      The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
  - HsmStatus (dict) --
    
    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.
    - 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 AWS Key Management Service (AWS 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 AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
    - (dict) --
      
      An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS 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) --
    
    Indicates the number of nodes the cluster can be resized to with the elastic resize method.

ResizeCluster (updated)

Link ¶
Changes (response)

{'Cluster': {'PendingModifiedValues': {'EncryptionType': '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 avaialble 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:
- dc2.large
- dc2.8xlarge
- ds2.xlarge
- ds2.8xlarge
The type of nodes 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
)

type ClusterIdentifier

string

param ClusterIdentifier

[REQUIRED]

The unique identifier for the cluster to resize.

type ClusterType

string

param ClusterType

The new cluster type for the specified cluster.

type NodeType

string

param NodeType

The new node type for the nodes you are adding.

type NumberOfNodes

integer

param NumberOfNodes

[REQUIRED]

The new number of nodes for the cluster.

type Classic

boolean

param Classic

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.

rtype

dict

returns

Response Syntax

{
    'Cluster': {
        'ClusterIdentifier': 'string',
        'NodeType': 'string',
        'ClusterStatus': 'string',
        'ModifyStatus': 'string',
        'MasterUsername': 'string',
        'DBName': 'string',
        'Endpoint': {
            'Address': 'string',
            'Port': 123
        },
        'ClusterCreateTime': datetime(2015, 1, 1),
        'AutomatedSnapshotRetentionPeriod': 123,
        'ClusterSecurityGroups': [
            {
                'ClusterSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'ClusterParameterGroups': [
            {
                'ParameterGroupName': 'string',
                'ParameterApplyStatus': 'string',
                'ClusterParameterStatusList': [
                    {
                        'ParameterName': 'string',
                        'ParameterApplyStatus': 'string',
                        'ParameterApplyErrorDescription': 'string'
                    },
                ]
            },
        ],
        'ClusterSubnetGroupName': 'string',
        'VpcId': 'string',
        'AvailabilityZone': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PendingModifiedValues': {
            'MasterUserPassword': 'string',
            'NodeType': 'string',
            'NumberOfNodes': 123,
            'ClusterType': 'string',
            'ClusterVersion': 'string',
            'AutomatedSnapshotRetentionPeriod': 123,
            'ClusterIdentifier': 'string',
            '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
        },
        'HsmStatus': {
            'HsmClientCertificateIdentifier': 'string',
            'HsmConfigurationIdentifier': 'string',
            'Status': 'string'
        },
        'ClusterSnapshotCopyStatus': {
            'DestinationRegion': 'string',
            'RetentionPeriod': 123,
            'SnapshotCopyGrantName': 'string'
        },
        'ClusterPublicKey': 'string',
        'ClusterNodes': [
            {
                'NodeRole': 'string',
                'PrivateIPAddress': 'string',
                'PublicIPAddress': 'string'
            },
        ],
        'ElasticIpStatus': {
            'ElasticIp': 'string',
            'Status': 'string'
        },
        'ClusterRevisionNumber': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'KmsKeyId': 'string',
        'EnhancedVpcRouting': True|False,
        'IamRoles': [
            {
                'IamRoleArn': 'string',
                'ApplyStatus': 'string'
            },
        ],
        'PendingActions': [
            'string',
        ],
        'MaintenanceTrackName': 'string',
        'ElasticResizeNumberOfNodeOptions': '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
    - creating
    - deleting
    - final-snapshot
    - hardware-failure
    - incompatible-hsm
    - incompatible-network
    - incompatible-parameters
    - incompatible-restore
    - modifying
    - rebooting
    - renaming
    - resizing
    - rotating-keys
    - storage-full
    - updating-hsm
  - ModifyStatus (string) --
    
    The status of a modify operation, if any, initiated for the cluster.
  - MasterUsername (string) --
    
    The master user name for the cluster. This name is used to connect to the database that is specified in 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.
  - ClusterCreateTime (datetime) --
    
    The date and time that the cluster was created.
  - AutomatedSnapshotRetentionPeriod (integer) --
    
    The number of days that automatic cluster snapshots are retained.
  - ClusterSecurityGroups (list) --
    
    A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
    
    Cluster security groups are used when the cluster is not created in 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 master user password for the cluster.
    - NodeType (string) --
      
      The pending or in-progress change of the cluster's node type.
    - NumberOfNodes (integer) --
      
      The pending or in-progress change of the number of nodes in the cluster.
    - ClusterType (string) --
      
      The pending or in-progress change of the cluster type.
    - ClusterVersion (string) --
      
      The pending or in-progress change of the service version.
    - AutomatedSnapshotRetentionPeriod (integer) --
      
      The pending or in-progress change of the automated snapshot retention period.
    - ClusterIdentifier (string) --
      
      The pending or in-progress change of the new identifier for the cluster.
    - 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. For the China region the possible values are None, and Legacy.
  - 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.
    - SnapshotSizeInMegaBytes (integer) --
      
      The size of the set of snapshot data used to restore the cluster.
    - ProgressInMegaBytes (integer) --
      
      The number of megabytes that have been transferred from snapshot storage.
    - ElapsedTimeInSeconds (integer) --
      
      The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
    - EstimatedTimeToCompletionInSeconds (integer) --
      
      The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
  - HsmStatus (dict) --
    
    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.
    - 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 AWS Key Management Service (AWS 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 AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
    - (dict) --
      
      An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS 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) --
    
    Indicates the number of nodes the cluster can be resized to with the elastic resize method.

RestoreFromClusterSnapshot (updated)

Link ¶
Changes (response)

{'Cluster': {'PendingModifiedValues': {'EncryptionType': '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',
    SnapshotClusterIdentifier='string',
    Port=123,
    AvailabilityZone='string',
    AllowVersionUpgrade=True|False,
    ClusterSubnetGroupName='string',
    PubliclyAccessible=True|False,
    OwnerAccount='string',
    HsmClientCertificateIdentifier='string',
    HsmConfigurationIdentifier='string',
    ElasticIp='string',
    ClusterParameterGroupName='string',
    ClusterSecurityGroups=[
        'string',
    ],
    VpcSecurityGroupIds=[
        'string',
    ],
    PreferredMaintenanceWindow='string',
    AutomatedSnapshotRetentionPeriod=123,
    KmsKeyId='string',
    NodeType='string',
    EnhancedVpcRouting=True|False,
    AdditionalInfo='string',
    IamRoles=[
        'string',
    ],
    MaintenanceTrackName='string'
)

type ClusterIdentifier

string

param ClusterIdentifier

[REQUIRED]

The identifier of the cluster that will be created from restoring the snapshot.

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an AWS account.

type SnapshotIdentifier

string

param SnapshotIdentifier

[REQUIRED]

The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.

Example: my-snapshot-id

type SnapshotClusterIdentifier

string

param SnapshotClusterIdentifier

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.

type Port

integer

param Port

The port number on which the cluster accepts connections.

Default: The same port as the original cluster.

Constraints: Must be between 1115 and 65535 .

type AvailabilityZone

string

param AvailabilityZone

The Amazon EC2 Availability Zone in which to restore the cluster.

Default: A random, system-chosen Availability Zone.

Example: us-east-1a

type AllowVersionUpgrade

boolean

param AllowVersionUpgrade

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

type ClusterSubnetGroupName

string

param ClusterSubnetGroupName

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.

type PubliclyAccessible

boolean

param PubliclyAccessible

If true , the cluster can be accessed from a public network.

type OwnerAccount

string

param OwnerAccount

The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.

type HsmClientCertificateIdentifier

string

param HsmClientCertificateIdentifier

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

type HsmConfigurationIdentifier

string

param HsmConfigurationIdentifier

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.

type ElasticIp

string

param ElasticIp

The elastic IP (EIP) address for the cluster.

type ClusterParameterGroupName

string

param ClusterParameterGroupName

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.

type ClusterSecurityGroups

list

param ClusterSecurityGroups

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) --

type VpcSecurityGroupIds

list

param VpcSecurityGroupIds

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) --

type PreferredMaintenanceWindow

string

param PreferredMaintenanceWindow

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.

type AutomatedSnapshotRetentionPeriod

integer

param AutomatedSnapshotRetentionPeriod

Default: The value selected for the cluster from which the snapshot was taken.

Constraints: Must be a value from 0 to 35.

type KmsKeyId

string

param KmsKeyId

The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot.

type NodeType

string

param NodeType

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.8xlareg 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 .

type EnhancedVpcRouting

boolean

param EnhancedVpcRouting

If this option is true , enhanced VPC routing is enabled.

Default: false

type AdditionalInfo

string

param AdditionalInfo

Reserved.

type IamRoles

list

param IamRoles

A cluster can have up to 10 IAM roles associated at any time.

(string) --

type MaintenanceTrackName

string

param MaintenanceTrackName

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.

rtype

dict

returns

Response Syntax

{
    'Cluster': {
        'ClusterIdentifier': 'string',
        'NodeType': 'string',
        'ClusterStatus': 'string',
        'ModifyStatus': 'string',
        'MasterUsername': 'string',
        'DBName': 'string',
        'Endpoint': {
            'Address': 'string',
            'Port': 123
        },
        'ClusterCreateTime': datetime(2015, 1, 1),
        'AutomatedSnapshotRetentionPeriod': 123,
        'ClusterSecurityGroups': [
            {
                'ClusterSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'ClusterParameterGroups': [
            {
                'ParameterGroupName': 'string',
                'ParameterApplyStatus': 'string',
                'ClusterParameterStatusList': [
                    {
                        'ParameterName': 'string',
                        'ParameterApplyStatus': 'string',
                        'ParameterApplyErrorDescription': 'string'
                    },
                ]
            },
        ],
        'ClusterSubnetGroupName': 'string',
        'VpcId': 'string',
        'AvailabilityZone': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PendingModifiedValues': {
            'MasterUserPassword': 'string',
            'NodeType': 'string',
            'NumberOfNodes': 123,
            'ClusterType': 'string',
            'ClusterVersion': 'string',
            'AutomatedSnapshotRetentionPeriod': 123,
            'ClusterIdentifier': 'string',
            '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
        },
        'HsmStatus': {
            'HsmClientCertificateIdentifier': 'string',
            'HsmConfigurationIdentifier': 'string',
            'Status': 'string'
        },
        'ClusterSnapshotCopyStatus': {
            'DestinationRegion': 'string',
            'RetentionPeriod': 123,
            'SnapshotCopyGrantName': 'string'
        },
        'ClusterPublicKey': 'string',
        'ClusterNodes': [
            {
                'NodeRole': 'string',
                'PrivateIPAddress': 'string',
                'PublicIPAddress': 'string'
            },
        ],
        'ElasticIpStatus': {
            'ElasticIp': 'string',
            'Status': 'string'
        },
        'ClusterRevisionNumber': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'KmsKeyId': 'string',
        'EnhancedVpcRouting': True|False,
        'IamRoles': [
            {
                'IamRoleArn': 'string',
                'ApplyStatus': 'string'
            },
        ],
        'PendingActions': [
            'string',
        ],
        'MaintenanceTrackName': 'string',
        'ElasticResizeNumberOfNodeOptions': '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
    - creating
    - deleting
    - final-snapshot
    - hardware-failure
    - incompatible-hsm
    - incompatible-network
    - incompatible-parameters
    - incompatible-restore
    - modifying
    - rebooting
    - renaming
    - resizing
    - rotating-keys
    - storage-full
    - updating-hsm
  - ModifyStatus (string) --
    
    The status of a modify operation, if any, initiated for the cluster.
  - MasterUsername (string) --
    
    The master user name for the cluster. This name is used to connect to the database that is specified in 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.
  - ClusterCreateTime (datetime) --
    
    The date and time that the cluster was created.
  - AutomatedSnapshotRetentionPeriod (integer) --
    
    The number of days that automatic cluster snapshots are retained.
  - ClusterSecurityGroups (list) --
    
    A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
    
    Cluster security groups are used when the cluster is not created in 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 master user password for the cluster.
    - NodeType (string) --
      
      The pending or in-progress change of the cluster's node type.
    - NumberOfNodes (integer) --
      
      The pending or in-progress change of the number of nodes in the cluster.
    - ClusterType (string) --
      
      The pending or in-progress change of the cluster type.
    - ClusterVersion (string) --
      
      The pending or in-progress change of the service version.
    - AutomatedSnapshotRetentionPeriod (integer) --
      
      The pending or in-progress change of the automated snapshot retention period.
    - ClusterIdentifier (string) --
      
      The pending or in-progress change of the new identifier for the cluster.
    - 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. For the China region the possible values are None, and Legacy.
  - 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.
    - SnapshotSizeInMegaBytes (integer) --
      
      The size of the set of snapshot data used to restore the cluster.
    - ProgressInMegaBytes (integer) --
      
      The number of megabytes that have been transferred from snapshot storage.
    - ElapsedTimeInSeconds (integer) --
      
      The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
    - EstimatedTimeToCompletionInSeconds (integer) --
      
      The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
  - HsmStatus (dict) --
    
    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.
    - 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 AWS Key Management Service (AWS 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 AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
    - (dict) --
      
      An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS 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) --
    
    Indicates the number of nodes the cluster can be resized to with the elastic resize method.

RotateEncryptionKey (updated)

Link ¶
Changes (response)

{'Cluster': {'PendingModifiedValues': {'EncryptionType': 'string'}}}

Rotates the encryption keys for a cluster.

See also: AWS API Documentation

Request Syntax

client.rotate_encryption_key(
    ClusterIdentifier='string'
)

type ClusterIdentifier

string

param ClusterIdentifier

[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.

rtype

dict

returns

Response Syntax

{
    'Cluster': {
        'ClusterIdentifier': 'string',
        'NodeType': 'string',
        'ClusterStatus': 'string',
        'ModifyStatus': 'string',
        'MasterUsername': 'string',
        'DBName': 'string',
        'Endpoint': {
            'Address': 'string',
            'Port': 123
        },
        'ClusterCreateTime': datetime(2015, 1, 1),
        'AutomatedSnapshotRetentionPeriod': 123,
        'ClusterSecurityGroups': [
            {
                'ClusterSecurityGroupName': 'string',
                'Status': 'string'
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'ClusterParameterGroups': [
            {
                'ParameterGroupName': 'string',
                'ParameterApplyStatus': 'string',
                'ClusterParameterStatusList': [
                    {
                        'ParameterName': 'string',
                        'ParameterApplyStatus': 'string',
                        'ParameterApplyErrorDescription': 'string'
                    },
                ]
            },
        ],
        'ClusterSubnetGroupName': 'string',
        'VpcId': 'string',
        'AvailabilityZone': 'string',
        'PreferredMaintenanceWindow': 'string',
        'PendingModifiedValues': {
            'MasterUserPassword': 'string',
            'NodeType': 'string',
            'NumberOfNodes': 123,
            'ClusterType': 'string',
            'ClusterVersion': 'string',
            'AutomatedSnapshotRetentionPeriod': 123,
            'ClusterIdentifier': 'string',
            '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
        },
        'HsmStatus': {
            'HsmClientCertificateIdentifier': 'string',
            'HsmConfigurationIdentifier': 'string',
            'Status': 'string'
        },
        'ClusterSnapshotCopyStatus': {
            'DestinationRegion': 'string',
            'RetentionPeriod': 123,
            'SnapshotCopyGrantName': 'string'
        },
        'ClusterPublicKey': 'string',
        'ClusterNodes': [
            {
                'NodeRole': 'string',
                'PrivateIPAddress': 'string',
                'PublicIPAddress': 'string'
            },
        ],
        'ElasticIpStatus': {
            'ElasticIp': 'string',
            'Status': 'string'
        },
        'ClusterRevisionNumber': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'KmsKeyId': 'string',
        'EnhancedVpcRouting': True|False,
        'IamRoles': [
            {
                'IamRoleArn': 'string',
                'ApplyStatus': 'string'
            },
        ],
        'PendingActions': [
            'string',
        ],
        'MaintenanceTrackName': 'string',
        'ElasticResizeNumberOfNodeOptions': '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
    - creating
    - deleting
    - final-snapshot
    - hardware-failure
    - incompatible-hsm
    - incompatible-network
    - incompatible-parameters
    - incompatible-restore
    - modifying
    - rebooting
    - renaming
    - resizing
    - rotating-keys
    - storage-full
    - updating-hsm
  - ModifyStatus (string) --
    
    The status of a modify operation, if any, initiated for the cluster.
  - MasterUsername (string) --
    
    The master user name for the cluster. This name is used to connect to the database that is specified in 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.
  - ClusterCreateTime (datetime) --
    
    The date and time that the cluster was created.
  - AutomatedSnapshotRetentionPeriod (integer) --
    
    The number of days that automatic cluster snapshots are retained.
  - ClusterSecurityGroups (list) --
    
    A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.
    
    Cluster security groups are used when the cluster is not created in 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 master user password for the cluster.
    - NodeType (string) --
      
      The pending or in-progress change of the cluster's node type.
    - NumberOfNodes (integer) --
      
      The pending or in-progress change of the number of nodes in the cluster.
    - ClusterType (string) --
      
      The pending or in-progress change of the cluster type.
    - ClusterVersion (string) --
      
      The pending or in-progress change of the service version.
    - AutomatedSnapshotRetentionPeriod (integer) --
      
      The pending or in-progress change of the automated snapshot retention period.
    - ClusterIdentifier (string) --
      
      The pending or in-progress change of the new identifier for the cluster.
    - 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. For the China region the possible values are None, and Legacy.
  - 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.
    - SnapshotSizeInMegaBytes (integer) --
      
      The size of the set of snapshot data used to restore the cluster.
    - ProgressInMegaBytes (integer) --
      
      The number of megabytes that have been transferred from snapshot storage.
    - ElapsedTimeInSeconds (integer) --
      
      The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.
    - EstimatedTimeToCompletionInSeconds (integer) --
      
      The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.
  - HsmStatus (dict) --
    
    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.
    - 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 AWS Key Management Service (AWS 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 AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.
    - (dict) --
      
      An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS 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) --
    
    Indicates the number of nodes the cluster can be resized to with the elastic resize method.