You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.Redshift

Inherits:
AWS.Service show all
Identifier:
redshift
API Version:
2012-12-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Overview

This is an interface reference for Amazon Redshift. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift clusters. Note that Amazon Redshift is asynchronous, which means that some interfaces may require techniques, such as polling or asynchronous callback handlers, to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a change is applied immediately, on the next instance reboot, or during the next maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to Using the Amazon Redshift Management Interfaces.

Amazon Redshift manages all the work of setting up, operating, and scaling a data warehouse: provisioning capacity, monitoring and backing up the cluster, and applying patches and upgrades to the Amazon Redshift engine. You can focus on using your data to acquire new insights for your business and customers.

If you are a first-time user of Amazon Redshift, we recommend that you begin by reading the Amazon Redshift Getting Started Guide.

If you are a database developer, the Amazon Redshift Database Developer Guide explains how to design, build, query, and maintain the databases that make up your data warehouse.

Sending a Request Using Redshift

var redshift = new AWS.Redshift();
redshift.acceptReservedNodeExchange(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Redshift object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var redshift = new AWS.Redshift({apiVersion: '2012-12-01'});

You can also set the API version globally in AWS.config.apiVersions using the redshift service identifier:

AWS.config.apiVersions = {
  redshift: '2012-12-01',
  // other service API versions
};

var redshift = new AWS.Redshift();

Version:

  • 2012-12-01

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

clusterAvailable, clusterDeleted, clusterRestored, snapshotAvailable

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.Redshift(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a Redshift object

var redshift = new AWS.Redshift({apiVersion: '2012-12-01'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.Redshift.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.Redshift.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.Redshift.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

acceptReservedNodeExchange(params = {}, callback) ⇒ AWS.Request

Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs.

Service Reference:

Examples:

Calling the acceptReservedNodeExchange operation

var params = {
  ReservedNodeId: 'STRING_VALUE', /* required */
  TargetReservedNodeOfferingId: 'STRING_VALUE' /* required */
};
redshift.acceptReservedNodeExchange(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ReservedNodeId — (String)

      A string representing the node identifier of the DC1 Reserved Node to be exchanged.

    • TargetReservedNodeOfferingId — (String)

      The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling GetReservedNodeExchangeOfferings

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ExchangedReservedNode — (map)

        • ReservedNodeId — (String)

          The unique identifier for the reservation.

        • ReservedNodeOfferingId — (String)

          The identifier for the reserved node offering.

        • NodeType — (String)

          The node type of the reserved node.

        • StartTime — (Date)

          The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.

        • Duration — (Integer)

          The duration of the node reservation in seconds.

        • FixedPrice — (Float)

          The fixed cost Amazon Redshift charges you for this reserved node.

        • UsagePrice — (Float)

          The hourly rate Amazon Redshift charges you for this reserved node.

        • CurrencyCode — (String)

          The currency code for the reserved cluster.

        • NodeCount — (Integer)

          The number of reserved compute nodes.

        • State — (String)

          The state of the reserved compute node.

          Possible Values:

          • pending-payment-This reserved node has recently been purchased, and the sale has been approved, but payment has not yet been confirmed.

          • active-This reserved node is owned by the caller and is available for use.

          • payment-failed-Payment failed for the purchase attempt.

          • retired-The reserved node is no longer available.

          • exchanging-The owner is exchanging the reserved node for another reserved node.

        • OfferingType — (String)

          The anticipated utilization of the reserved node, as defined in the reserved node offering.

        • RecurringCharges — (Array<map>)

          The recurring charges for the reserved node.

          • RecurringChargeAmount — (Float)

            The amount charged per the period of time specified by the recurring charge frequency.

          • RecurringChargeFrequency — (String)

            The frequency at which the recurring charge amount is applied.

        • ReservedNodeOfferingType — (String)

          Possible values include:

          • "Regular"
          • "Upgradable"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

addPartner(params = {}, callback) ⇒ AWS.Request

Adds a partner integration to a cluster. This operation authorizes a partner to push status updates for the specified database. To complete the integration, you also set up the integration on the partner website.

Service Reference:

Examples:

Calling the addPartner operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ClusterIdentifier: 'STRING_VALUE', /* required */
  DatabaseName: 'STRING_VALUE', /* required */
  PartnerName: 'STRING_VALUE' /* required */
};
redshift.addPartner(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AccountId — (String)

      The Amazon Web Services account ID that owns the cluster.

    • ClusterIdentifier — (String)

      The cluster identifier of the cluster that receives data from the partner.

    • DatabaseName — (String)

      The name of the database that receives data from the partner.

    • PartnerName — (String)

      The name of the partner that is authorized to send data.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DatabaseName — (String)

        The name of the database that receives data from the partner.

      • PartnerName — (String)

        The name of the partner that is authorized to send data.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

associateDataShareConsumer(params = {}, callback) ⇒ AWS.Request

From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn). If you make this association, the consumer can consume the datashare.

Service Reference:

Examples:

Calling the associateDataShareConsumer operation

var params = {
  DataShareArn: 'STRING_VALUE', /* required */
  AssociateEntireAccount: true || false,
  ConsumerArn: 'STRING_VALUE'
};
redshift.associateDataShareConsumer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DataShareArn — (String)

      The Amazon Resource Name (ARN) of the datashare that the consumer is to use with the account or the namespace.

    • AssociateEntireAccount — (Boolean)

      A value that specifies whether the datashare is associated with the entire account.

    • ConsumerArn — (String)

      The Amazon Resource Name (ARN) of the consumer that is associated with the datashare.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DataShareArn — (String)

        An Amazon Resource Name (ARN) that references the datashare that is owned by a specific namespace of the producer cluster. A datashare ARN is in the arn:aws:redshift:{region}:{account-id}:{datashare}:{namespace-guid}/{datashare-name} format.

      • ProducerArn — (String)

        The Amazon Resource Name (ARN) of the producer.

      • AllowPubliclyAccessibleConsumers — (Boolean)

        A value that specifies whether the datashare can be shared to a publicly accessible cluster.

      • DataShareAssociations — (Array<map>)

        A value that specifies when the datashare has an association between a producer and data consumers.

        • ConsumerIdentifier — (String)

          The name of the consumer accounts that have an association with a producer datashare.

        • Status — (String)

          The status of the datashare that is associated.

          Possible values include:
          • "ACTIVE"
          • "PENDING_AUTHORIZATION"
          • "AUTHORIZED"
          • "DEAUTHORIZED"
          • "REJECTED"
          • "AVAILABLE"
        • CreatedDate — (Date)

          The creation date of the datashare that is associated.

        • StatusChangeDate — (Date)

          The status change data of the datashare that is associated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

authorizeClusterSecurityGroupIngress(params = {}, callback) ⇒ AWS.Request

Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.

If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same Amazon Web Services Region.

If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing.

You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide.

Service Reference:

Examples:

Calling the authorizeClusterSecurityGroupIngress operation

var params = {
  ClusterSecurityGroupName: 'STRING_VALUE', /* required */
  CIDRIP: 'STRING_VALUE',
  EC2SecurityGroupName: 'STRING_VALUE',
  EC2SecurityGroupOwnerId: 'STRING_VALUE'
};
redshift.authorizeClusterSecurityGroupIngress(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterSecurityGroupName — (String)

      The name of the security group to which the ingress rule is added.

    • CIDRIP — (String)

      The IP range to be added the Amazon Redshift security group.

    • EC2SecurityGroupName — (String)

      The EC2 security group to be added the Amazon Redshift security group.

    • EC2SecurityGroupOwnerId — (String)

      The Amazon Web Services account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The Amazon Web Services Access Key ID is not an acceptable value.

      Example: 111122223333

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ClusterSecurityGroup — (map)

        Describes a security group.

        • ClusterSecurityGroupName — (String)

          The name of the cluster security group to which the operation was applied.

        • Description — (String)

          A description of the security group.

        • EC2SecurityGroups — (Array<map>)

          A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.

          • Status — (String)

            The status of the EC2 security group.

          • EC2SecurityGroupName — (String)

            The name of the EC2 Security Group.

          • EC2SecurityGroupOwnerId — (String)

            The Amazon Web Services account ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

          • Tags — (Array<map>)

            The list of tags for the EC2 security group.

            • Key — (String)

              The key, or name, for the resource tag.

            • Value — (String)

              The value for the resource tag.

        • IPRanges — (Array<map>)

          A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.

          • Status — (String)

            The status of the IP range, for example, "authorized".

          • CIDRIP — (String)

            The IP range in Classless Inter-Domain Routing (CIDR) notation.

          • Tags — (Array<map>)

            The list of tags for the IP range.

            • Key — (String)

              The key, or name, for the resource tag.

            • Value — (String)

              The value for the resource tag.

        • Tags — (Array<map>)

          The list of tags for the cluster security group.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

authorizeDataShare(params = {}, callback) ⇒ AWS.Request

From a data producer account, authorizes the sharing of a datashare with one or more consumer accounts. To authorize a datashare for a data consumer, the producer account must have the correct access privileges.

Service Reference:

Examples:

Calling the authorizeDataShare operation

var params = {
  ConsumerIdentifier: 'STRING_VALUE', /* required */
  DataShareArn: 'STRING_VALUE' /* required */
};
redshift.authorizeDataShare(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DataShareArn — (String)

      The Amazon Resource Name (ARN) of the datashare that producers are to authorize sharing for.

    • ConsumerIdentifier — (String)

      The identifier of the data consumer that is authorized to access the datashare. This identifier is an AWS account ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DataShareArn — (String)

        An Amazon Resource Name (ARN) that references the datashare that is owned by a specific namespace of the producer cluster. A datashare ARN is in the arn:aws:redshift:{region}:{account-id}:{datashare}:{namespace-guid}/{datashare-name} format.

      • ProducerArn — (String)

        The Amazon Resource Name (ARN) of the producer.

      • AllowPubliclyAccessibleConsumers — (Boolean)

        A value that specifies whether the datashare can be shared to a publicly accessible cluster.

      • DataShareAssociations — (Array<map>)

        A value that specifies when the datashare has an association between a producer and data consumers.

        • ConsumerIdentifier — (String)

          The name of the consumer accounts that have an association with a producer datashare.

        • Status — (String)

          The status of the datashare that is associated.

          Possible values include:
          • "ACTIVE"
          • "PENDING_AUTHORIZATION"
          • "AUTHORIZED"
          • "DEAUTHORIZED"
          • "REJECTED"
          • "AVAILABLE"
        • CreatedDate — (Date)

          The creation date of the datashare that is associated.

        • StatusChangeDate — (Date)

          The status change data of the datashare that is associated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

authorizeEndpointAccess(params = {}, callback) ⇒ AWS.Request

Grants access to a cluster.

Service Reference:

Examples:

Calling the authorizeEndpointAccess operation

var params = {
  Account: 'STRING_VALUE', /* required */
  ClusterIdentifier: 'STRING_VALUE',
  VpcIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
redshift.authorizeEndpointAccess(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      The cluster identifier of the cluster to grant access to.

    • Account — (String)

      The Amazon Web Services account ID to grant access to.

    • VpcIds — (Array<String>)

      The virtual private cloud (VPC) identifiers to grant access to.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Grantor — (String)

        The Amazon Web Services account ID of the cluster owner.

      • Grantee — (String)

        The Amazon Web Services account ID of the grantee of the cluster.

      • ClusterIdentifier — (String)

        The cluster identifier.

      • AuthorizeTime — (Date)

        The time (UTC) when the authorization was created.

      • ClusterStatus — (String)

        The status of the cluster.

      • Status — (String)

        The status of the authorization action.

        Possible values include:
        • "Authorized"
        • "Revoking"
      • AllowedAllVPCs — (Boolean)

        Indicates whether all VPCs in the grantee account are allowed access to the cluster.

      • AllowedVPCs — (Array<String>)

        The VPCs allowed access to the cluster.

      • EndpointCount — (Integer)

        The number of Redshift-managed VPC endpoints created for the authorization.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

authorizeSnapshotAccess(params = {}, callback) ⇒ AWS.Request

Authorizes the specified Amazon Web Services account to restore the specified snapshot.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

Service Reference:

Examples:

Calling the authorizeSnapshotAccess operation

var params = {
  AccountWithRestoreAccess: 'STRING_VALUE', /* required */
  SnapshotIdentifier: 'STRING_VALUE', /* required */
  SnapshotClusterIdentifier: 'STRING_VALUE'
};
redshift.authorizeSnapshotAccess(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SnapshotIdentifier — (String)

      The identifier of the snapshot the account is authorized to restore.

    • SnapshotClusterIdentifier — (String)

      The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

    • AccountWithRestoreAccess — (String)

      The identifier of the Amazon Web Services account authorized to restore the specified snapshot.

      To share a snapshot with Amazon Web Services Support, specify amazon-redshift-support.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Snapshot — (map)

        Describes a snapshot.

        • SnapshotIdentifier — (String)

          The snapshot identifier that is provided in the request.

        • ClusterIdentifier — (String)

          The identifier of the cluster for which the snapshot was taken.

        • SnapshotCreateTime — (Date)

          The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

        • Status — (String)

          The snapshot status. The value of the status depends on the API operation used:

        • Port — (Integer)

          The port that the cluster is listening on.

        • AvailabilityZone — (String)

          The Availability Zone in which the cluster was created.

        • ClusterCreateTime — (Date)

          The time (UTC) when the cluster was originally created.

        • MasterUsername — (String)

          The admin user name for the cluster.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • EngineFullVersion — (String)

          The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

        • SnapshotType — (String)

          The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

        • NodeType — (String)

          The node type of the nodes in the cluster.

        • NumberOfNodes — (Integer)

          The number of nodes in the cluster.

        • DBName — (String)

          The name of the database that was created when the cluster was created.

        • VpcId — (String)

          The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

        • Encrypted — (Boolean)

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

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

        • EncryptedWithHSM — (Boolean)

          A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

        • AccountsWithRestoreAccess — (Array<map>)

          A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

          • AccountId — (String)

            The identifier of an Amazon Web Services account authorized to restore a snapshot.

          • AccountAlias — (String)

            The identifier of an Amazon Web Services support account authorized to restore a snapshot. For Amazon Web Services Support, the identifier is amazon-redshift-support.

        • OwnerAccount — (String)

          For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

        • TotalBackupSizeInMegaBytes — (Float)

          The size of the complete set of backup data that would be used to restore the cluster.

        • ActualIncrementalBackupSizeInMegaBytes — (Float)

          The size of the incremental backup.

        • BackupProgressInMegaBytes — (Float)

          The number of megabytes that have been transferred to the snapshot backup.

        • CurrentBackupRateInMegaBytesPerSecond — (Float)

          The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

        • EstimatedSecondsToCompletion — (Integer)

          The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

        • ElapsedTimeInSeconds — (Integer)

          The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

        • SourceRegion — (String)

          The source region from which the snapshot was copied.

        • Tags — (Array<map>)

          The list of tags for the cluster snapshot.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • RestorableNodeTypes — (Array<String>)

          The list of node types that this cluster snapshot is able to restore into.

        • 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 for the snapshot.

        • ManualSnapshotRetentionPeriod — (Integer)

          The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

          The value must be either -1 or an integer between 1 and 3,653.

        • ManualSnapshotRemainingDays — (Integer)

          The number of days until a manual snapshot will pass its retention period.

        • SnapshotRetentionStartTime — (Date)

          A timestamp representing the start of the retention period for the snapshot.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

batchDeleteClusterSnapshots(params = {}, callback) ⇒ AWS.Request

Deletes a set of cluster snapshots.

Service Reference:

Examples:

Calling the batchDeleteClusterSnapshots operation

var params = {
  Identifiers: [ /* required */
    {
      SnapshotIdentifier: 'STRING_VALUE', /* required */
      SnapshotClusterIdentifier: 'STRING_VALUE'
    },
    /* more items */
  ]
};
redshift.batchDeleteClusterSnapshots(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Identifiers — (Array<map>)

      A list of identifiers for the snapshots that you want to delete.

      • SnapshotIdentifier — required — (String)

        The unique identifier of the manual snapshot to be deleted.

        Constraints: Must be the name of an existing snapshot that is in the available, failed, or cancelled state.

      • SnapshotClusterIdentifier — (String)

        The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

        Constraints: Must be the name of valid cluster.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Resources — (Array<String>)

        A list of the snapshot identifiers that were deleted.

      • Errors — (Array<map>)

        A list of any errors returned.

        • SnapshotIdentifier — (String)

          A unique identifier for the snapshot returning the error.

        • SnapshotClusterIdentifier — (String)

          A unique identifier for the cluster.

        • FailureCode — (String)

          The failure code for the error.

        • FailureReason — (String)

          The text message describing the error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

batchModifyClusterSnapshots(params = {}, callback) ⇒ AWS.Request

Modifies the settings for a set of cluster snapshots.

Service Reference:

Examples:

Calling the batchModifyClusterSnapshots operation

var params = {
  SnapshotIdentifierList: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Force: true || false,
  ManualSnapshotRetentionPeriod: 'NUMBER_VALUE'
};
redshift.batchModifyClusterSnapshots(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SnapshotIdentifierList — (Array<String>)

      A list of snapshot identifiers you want to modify.

    • ManualSnapshotRetentionPeriod — (Integer)

      The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely.

      The number must be either -1 or an integer between 1 and 3,653.

      If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option.

    • Force — (Boolean)

      A boolean value indicating whether to override an exception if the retention period has passed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Resources — (Array<String>)

        A list of the snapshots that were modified.

      • Errors — (Array<map>)

        A list of any errors returned.

        • SnapshotIdentifier — (String)

          A unique identifier for the snapshot returning the error.

        • SnapshotClusterIdentifier — (String)

          A unique identifier for the cluster.

        • FailureCode — (String)

          The failure code for the error.

        • FailureReason — (String)

          The text message describing the error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

cancelResize(params = {}, callback) ⇒ AWS.Request

Cancels a resize operation for a cluster.

Service Reference:

Examples:

Calling the cancelResize operation

var params = {
  ClusterIdentifier: 'STRING_VALUE' /* required */
};
redshift.cancelResize(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      The unique identifier for the cluster that you want to cancel a resize operation for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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 | CANCELLING

      • ImportTablesCompleted — (Array<String>)

        The names of tables that have been completely imported .

        Valid Values: List of table names.

      • ImportTablesInProgress — (Array<String>)

        The names of tables that are being currently imported.

        Valid Values: List of table names.

      • ImportTablesNotStarted — (Array<String>)

        The names of tables that have not been yet imported.

        Valid Values: List of table names

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

      • DataTransferProgressPercent — (Float)

        The percent of data transferred from source cluster to target cluster.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

copyClusterSnapshot(params = {}, callback) ⇒ AWS.Request

Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state.

When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

Service Reference:

Examples:

Calling the copyClusterSnapshot operation

var params = {
  SourceSnapshotIdentifier: 'STRING_VALUE', /* required */
  TargetSnapshotIdentifier: 'STRING_VALUE', /* required */
  ManualSnapshotRetentionPeriod: 'NUMBER_VALUE',
  SourceSnapshotClusterIdentifier: 'STRING_VALUE'
};
redshift.copyClusterSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SourceSnapshotIdentifier — (String)

      The identifier for the source snapshot.

      Constraints:

      • Must be the identifier for a valid automated snapshot whose state is available.

    • SourceSnapshotClusterIdentifier — (String)

      The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

      Constraints:

      • Must be the identifier for a valid cluster.

    • TargetSnapshotIdentifier — (String)

      The identifier given to the new manual snapshot.

      Constraints:

      • Cannot be null, empty, or blank.

      • Must contain from 1 to 255 alphanumeric characters or hyphens.

      • First character must be a letter.

      • Cannot end with a hyphen or contain two consecutive hyphens.

      • Must be unique for the Amazon Web Services account that is making the request.

    • ManualSnapshotRetentionPeriod — (Integer)

      The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

      The value must be either -1 or an integer between 1 and 3,653.

      The default value is -1.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Snapshot — (map)

        Describes a snapshot.

        • SnapshotIdentifier — (String)

          The snapshot identifier that is provided in the request.

        • ClusterIdentifier — (String)

          The identifier of the cluster for which the snapshot was taken.

        • SnapshotCreateTime — (Date)

          The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

        • Status — (String)

          The snapshot status. The value of the status depends on the API operation used:

        • Port — (Integer)

          The port that the cluster is listening on.

        • AvailabilityZone — (String)

          The Availability Zone in which the cluster was created.

        • ClusterCreateTime — (Date)

          The time (UTC) when the cluster was originally created.

        • MasterUsername — (String)

          The admin user name for the cluster.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • EngineFullVersion — (String)

          The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

        • SnapshotType — (String)

          The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

        • NodeType — (String)

          The node type of the nodes in the cluster.

        • NumberOfNodes — (Integer)

          The number of nodes in the cluster.

        • DBName — (String)

          The name of the database that was created when the cluster was created.

        • VpcId — (String)

          The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

        • Encrypted — (Boolean)

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

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

        • EncryptedWithHSM — (Boolean)

          A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

        • AccountsWithRestoreAccess — (Array<map>)

          A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

          • AccountId — (String)

            The identifier of an Amazon Web Services account authorized to restore a snapshot.

          • AccountAlias — (String)

            The identifier of an Amazon Web Services support account authorized to restore a snapshot. For Amazon Web Services Support, the identifier is amazon-redshift-support.

        • OwnerAccount — (String)

          For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

        • TotalBackupSizeInMegaBytes — (Float)

          The size of the complete set of backup data that would be used to restore the cluster.

        • ActualIncrementalBackupSizeInMegaBytes — (Float)

          The size of the incremental backup.

        • BackupProgressInMegaBytes — (Float)

          The number of megabytes that have been transferred to the snapshot backup.

        • CurrentBackupRateInMegaBytesPerSecond — (Float)

          The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

        • EstimatedSecondsToCompletion — (Integer)

          The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

        • ElapsedTimeInSeconds — (Integer)

          The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

        • SourceRegion — (String)

          The source region from which the snapshot was copied.

        • Tags — (Array<map>)

          The list of tags for the cluster snapshot.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • RestorableNodeTypes — (Array<String>)

          The list of node types that this cluster snapshot is able to restore into.

        • 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 for the snapshot.

        • ManualSnapshotRetentionPeriod — (Integer)

          The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

          The value must be either -1 or an integer between 1 and 3,653.

        • ManualSnapshotRemainingDays — (Integer)

          The number of days until a manual snapshot will pass its retention period.

        • SnapshotRetentionStartTime — (Date)

          A timestamp representing the start of the retention period for the snapshot.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createAuthenticationProfile(params = {}, callback) ⇒ AWS.Request

Creates an authentication profile with the specified parameters.

Service Reference:

Examples:

Calling the createAuthenticationProfile operation

var params = {
  AuthenticationProfileContent: 'STRING_VALUE', /* required */
  AuthenticationProfileName: 'STRING_VALUE' /* required */
};
redshift.createAuthenticationProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AuthenticationProfileName — (String)

      The name of the authentication profile to be created.

    • AuthenticationProfileContent — (String)

      The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AuthenticationProfileName — (String)

        The name of the authentication profile that was created.

      • AuthenticationProfileContent — (String)

        The content of the authentication profile in JSON format.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createCluster(params = {}, callback) ⇒ AWS.Request

Creates a new cluster with the specified parameters.

To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Service Reference:

Examples:

Calling the createCluster operation

var params = {
  ClusterIdentifier: 'STRING_VALUE', /* required */
  MasterUserPassword: 'STRING_VALUE', /* required */
  MasterUsername: 'STRING_VALUE', /* required */
  NodeType: 'STRING_VALUE', /* required */
  AdditionalInfo: 'STRING_VALUE',
  AllowVersionUpgrade: true || false,
  AquaConfigurationStatus: enabled | disabled | auto,
  AutomatedSnapshotRetentionPeriod: 'NUMBER_VALUE',
  AvailabilityZone: 'STRING_VALUE',
  AvailabilityZoneRelocation: true || false,
  ClusterParameterGroupName: 'STRING_VALUE',
  ClusterSecurityGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  ClusterSubnetGroupName: 'STRING_VALUE',
  ClusterType: 'STRING_VALUE',
  ClusterVersion: 'STRING_VALUE',
  DBName: 'STRING_VALUE',
  ElasticIp: 'STRING_VALUE',
  Encrypted: true || false,
  EnhancedVpcRouting: true || false,
  HsmClientCertificateIdentifier: 'STRING_VALUE',
  HsmConfigurationIdentifier: 'STRING_VALUE',
  IamRoles: [
    'STRING_VALUE',
    /* more items */
  ],
  KmsKeyId: 'STRING_VALUE',
  MaintenanceTrackName: 'STRING_VALUE',
  ManualSnapshotRetentionPeriod: 'NUMBER_VALUE',
  NumberOfNodes: 'NUMBER_VALUE',
  Port: 'NUMBER_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  PubliclyAccessible: true || false,
  SnapshotScheduleIdentifier: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ],
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
redshift.createCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DBName — (String)

      The name of the first database to be created when the cluster is created.

      To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.

      Default: 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.

    • ClusterIdentifier — (String)

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

      Constraints:

      • Must contain from 1 to 63 alphanumeric characters or hyphens.

      • Alphabetic characters must be lowercase.

      • First character must be a letter.

      • Cannot end with a hyphen or contain two consecutive hyphens.

      • Must be unique for all clusters within an Amazon Web Services account.

      Example: myexamplecluster

    • ClusterType — (String)

      The type of the cluster. When cluster type is specified as

      • single-node, the NumberOfNodes parameter is not required.

      • multi-node, the NumberOfNodes parameter is required.

      Valid Values: multi-node | single-node

      Default: multi-node

    • NodeType — (String)

      The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.

      Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge

    • MasterUsername — (String)

      The user name associated with the admin 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.

    • MasterUserPassword — (String)

      The password associated with the admin 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.

    • ClusterSecurityGroups — (Array<String>)

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

      Default: The default cluster security group for Amazon Redshift.

    • VpcSecurityGroupIds — (Array<String>)

      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.

    • ClusterSubnetGroupName — (String)

      The name of a cluster subnet group to be associated with this cluster.

      If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

    • AvailabilityZone — (String)

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

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

      Example: us-east-2d

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

    • PreferredMaintenanceWindow — (String)

      The weekly time range (in UTC) during which automated cluster maintenance can occur.

      Format: ddd:hh24:mi-ddd:hh24:mi

      Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

      Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

      Constraints: Minimum 30-minute window.

    • ClusterParameterGroupName — (String)

      The name of the parameter group to be associated with this cluster.

      Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

      Constraints:

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

    • AutomatedSnapshotRetentionPeriod — (Integer)

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

      You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.

      Default: 1

      Constraints: Must be a value from 0 to 35.

    • ManualSnapshotRetentionPeriod — (Integer)

      The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

      The value must be either -1 or an integer between 1 and 3,653.

    • Port — (Integer)

      The port number on which the cluster accepts incoming connections.

      The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.

      Default: 5439

      Valid Values: 1150-65535

    • ClusterVersion — (String)

      The version of the Amazon Redshift engine software that you want to deploy on the cluster.

      The version selected runs on all the nodes in the cluster.

      Constraints: Only version 1.0 is currently available.

      Example: 1.0

    • AllowVersionUpgrade — (Boolean)

      If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

      When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

      Default: true

    • NumberOfNodes — (Integer)

      The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

      For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.

      If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

      Default: 1

      Constraints: Value must be at least 1 and no more than 100.

    • PubliclyAccessible — (Boolean)

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

    • Encrypted — (Boolean)

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

      Default: false

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

    • ElasticIp — (String)

      The Elastic IP (EIP) address for the cluster.

      Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

    • Tags — (Array<map>)

      A list of tag instances.

      • Key — (String)

        The key, or name, for the resource tag.

      • Value — (String)

        The value for the resource tag.

    • KmsKeyId — (String)

      The Key Management Service (KMS) key ID of the encryption key that you want to use 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

    • AdditionalInfo — (String)

      Reserved.

    • IamRoles — (Array<String>)

      A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. 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.

    • MaintenanceTrackName — (String)

      An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track.

    • SnapshotScheduleIdentifier — (String)

      A unique identifier for the snapshot schedule.

    • AvailabilityZoneRelocation — (Boolean)

      The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

    • AquaConfigurationStatus — (String)

      The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) when it is created. Possible values include the following.

      • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

      • disabled - Don't use AQUA.

      • auto - Amazon Redshift determines whether to use AQUA.

      Possible values include:
      • "enabled"
      • "disabled"
      • "auto"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        Describes a cluster.

        • ClusterIdentifier — (String)

          The unique identifier of the cluster.

        • NodeType — (String)

          The node type for the nodes in the cluster.

        • ClusterStatus — (String)

          The current state of the cluster. Possible values are the following:

          • available

          • available, prep-for-resize

          • available, resize-cleanup

          • cancelling-resize

          • creating

          • deleting

          • final-snapshot

          • hardware-failure

          • incompatible-hsm

          • incompatible-network

          • incompatible-parameters

          • incompatible-restore

          • modifying

          • paused

          • rebooting

          • renaming

          • resizing

          • rotating-keys

          • storage-full

          • updating-hsm

        • ClusterAvailabilityStatus — (String)

          The availability status of the cluster for queries. Possible values are the following:

          • Available - The cluster is available for queries.

          • Unavailable - The cluster is not available for queries.

          • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

          • Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.

          • Failed - The cluster failed and is not available for queries.

        • ModifyStatus — (String)

          The status of a modify operation, if any, initiated for the cluster.

        • MasterUsername — (String)

          The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

        • DBName — (String)

          The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

        • Endpoint — (map)

          The connection endpoint.

          • Address — (String)

            The DNS address of the Cluster.

          • Port — (Integer)

            The port that the database engine is listening on.

          • VpcEndpoints — (Array<map>)

            Describes a connection endpoint.

            • VpcEndpointId — (String)

              The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

            • VpcId — (String)

              The VPC identifier that the endpoint is associated.

            • NetworkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • NetworkInterfaceId — (String)

                The network interface identifier.

              • SubnetId — (String)

                The subnet identifier.

              • PrivateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • AvailabilityZone — (String)

                The Availability Zone.

        • ClusterCreateTime — (Date)

          The date and time that the cluster was created.

        • AutomatedSnapshotRetentionPeriod — (Integer)

          The number of days that automatic cluster snapshots are retained.

        • ManualSnapshotRetentionPeriod — (Integer)

          The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

          The value must be either -1 or an integer between 1 and 3,653.

        • ClusterSecurityGroups — (Array<map>)

          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.

          • ClusterSecurityGroupName — (String)

            The name of the cluster security group.

          • Status — (String)

            The status of the cluster security group.

        • VpcSecurityGroups — (Array<map>)

          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.

          • VpcSecurityGroupId — (String)

            The identifier of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • ClusterParameterGroups — (Array<map>)

          The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

          • ParameterGroupName — (String)

            The name of the cluster parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • ClusterParameterStatusList — (Array<map>)

            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.

            • 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 — (map)

          A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

          • MasterUserPassword — (String)

            The pending or in-progress change of the admin user password for the cluster.

          • NodeType — (String)

            The pending or in-progress change of the cluster's node type.

          • NumberOfNodes — (Integer)

            The pending or in-progress change of the number of nodes in the cluster.

          • ClusterType — (String)

            The pending or in-progress change of the cluster type.

          • ClusterVersion — (String)

            The pending or in-progress change of the service version.

          • AutomatedSnapshotRetentionPeriod — (Integer)

            The pending or in-progress change of the automated snapshot retention period.

          • ClusterIdentifier — (String)

            The pending or in-progress change of the new identifier for the cluster.

          • PubliclyAccessible — (Boolean)

            The pending or in-progress change of the ability to connect to the cluster from the public network.

          • EnhancedVpcRouting — (Boolean)

            An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

            Default: false

          • MaintenanceTrackName — (String)

            The name of the maintenance track that the cluster will change to during the next maintenance window.

          • EncryptionType — (String)

            The encryption type for a cluster. Possible values are: KMS and None.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • AllowVersionUpgrade — (Boolean)

          A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

        • NumberOfNodes — (Integer)

          The number of compute nodes in the cluster.

        • PubliclyAccessible — (Boolean)

          A boolean value that, if true, indicates that the cluster can be accessed from a public network.

        • Encrypted — (Boolean)

          A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

        • RestoreStatus — (map)

          A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

          • Status — (String)

            The status of the restore action. Returns starting, restoring, completed, or failed.

          • CurrentRestoreRateInMegaBytesPerSecond — (Float)

            The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.

          • SnapshotSizeInMegaBytes — (Integer)

            The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

          • ProgressInMegaBytes — (Integer)

            The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

          • ElapsedTimeInSeconds — (Integer)

            The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.

        • DataTransferProgress — (map)

          • Status — (String)

            Describes the status of the cluster. While the transfer is in progress the status is transferringdata.

          • CurrentRateInMegaBytesPerSecond — (Float)

            Describes the data transfer rate in MB's per second.

          • TotalDataInMegaBytes — (Integer)

            Describes the total amount of data to be transfered in megabytes.

          • DataTransferredInMegaBytes — (Integer)

            Describes the total amount of data that has been transfered in MB's.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            Describes the estimated number of seconds remaining to complete the transfer.

          • ElapsedTimeInSeconds — (Integer)

            Describes the number of seconds that have elapsed during the data transfer.

        • HsmStatus — (map)

          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 — (map)

          A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

          • DestinationRegion — (String)

            The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

          • RetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

          • ManualSnapshotRetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.

            The value must be either -1 or an integer between 1 and 3,653.

          • SnapshotCopyGrantName — (String)

            The name of the snapshot copy grant.

        • ClusterPublicKey — (String)

          The public key for the cluster.

        • ClusterNodes — (Array<map>)

          The nodes in the 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 — (map)

          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 — (Array<map>)

          The list of tags for the cluster.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

        • EnhancedVpcRouting — (Boolean)

          An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

          Default: false

        • IamRoles — (Array<map>)

          A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

          • IamRoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

          • ApplyStatus — (String)

            A value that describes the status of the IAM role's association with an Amazon Redshift cluster.

            The following are possible statuses and descriptions.

            • in-sync: The role is available for use by the cluster.

            • adding: The role is in the process of being associated with the cluster.

            • removing: The role is in the process of being disassociated with the cluster.

        • PendingActions — (Array<String>)

          Cluster operations that are waiting to be started.

        • MaintenanceTrackName — (String)

          The name of the maintenance track for the cluster.

        • ElasticResizeNumberOfNodeOptions — (String)

          The number of nodes that you can resize the cluster to with the elastic resize method.

        • DeferredMaintenanceWindows — (Array<map>)

          Describes a group of DeferredMaintenanceWindow objects.

          • DeferMaintenanceIdentifier — (String)

            A unique identifier for the maintenance window.

          • DeferMaintenanceStartTime — (Date)

            A timestamp for the beginning of the time period when we defer maintenance.

          • DeferMaintenanceEndTime — (Date)

            A timestamp for the end of the time period when we defer maintenance.

        • SnapshotScheduleIdentifier — (String)

          A unique identifier for the cluster snapshot schedule.

        • SnapshotScheduleState — (String)

          The current state of the cluster snapshot schedule.

          Possible values include:
          • "MODIFYING"
          • "ACTIVE"
          • "FAILED"
        • ExpectedNextSnapshotScheduleTime — (Date)

          The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

        • ExpectedNextSnapshotScheduleTimeStatus — (String)

          The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

          • OnTrack - The next snapshot is expected to be taken on time.

          • Pending - The next snapshot is pending to be taken.

        • NextMaintenanceWindowStartTime — (Date)

          The date and time in UTC when system maintenance can begin.

        • ResizeInfo — (map)

          Returns the following:

          • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

          • ResizeType: Returns ClassicResize

          • ResizeType — (String)

            Returns the value ClassicResize.

          • AllowCancelResize — (Boolean)

            A boolean value indicating if the resize operation can be cancelled.

        • AvailabilityZoneRelocationStatus — (String)

          Describes the status of the Availability Zone relocation operation.

        • ClusterNamespaceArn — (String)

          The namespace Amazon Resource Name (ARN) of the cluster.

        • TotalStorageCapacityInMegaBytes — (Integer)

          The total storage capacity of the cluster in megabytes.

        • AquaConfiguration — (map)

          The AQUA (Advanced Query Accelerator) configuration of the cluster.

          • AquaStatus — (String)

            The value indicates the status of AQUA on the cluster. Possible values include the following.

            • enabled - AQUA is enabled.

            • disabled - AQUA is not enabled.

            • applying - AQUA status is being applied.

            Possible values include:
            • "enabled"
            • "disabled"
            • "applying"
          • AquaConfigurationStatus — (String)

            The value represents how the cluster is configured to use AQUA. Possible values include the following.

            • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

            • disabled - Don't use AQUA.

            • auto - Amazon Redshift determines whether to use AQUA.

            Possible values include:
            • "enabled"
            • "disabled"
            • "auto"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createClusterParameterGroup(params = {}, callback) ⇒ AWS.Request

Creates an Amazon Redshift parameter group.

Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster.

Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Service Reference:

Examples:

Calling the createClusterParameterGroup operation

var params = {
  Description: 'STRING_VALUE', /* required */
  ParameterGroupFamily: 'STRING_VALUE', /* required */
  ParameterGroupName: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
redshift.createClusterParameterGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ParameterGroupName — (String)

      The name of the cluster parameter group.

      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.

      • Must be unique withing your Amazon Web Services account.

      Note: This value is stored as a lower-case string.
    • ParameterGroupFamily — (String)

      The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.

      To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your Amazon Web Services account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is "redshift-1.0".

    • Description — (String)

      A description of the parameter group.

    • Tags — (Array<map>)

      A list of tag instances.

      • Key — (String)

        The key, or name, for the resource tag.

      • Value — (String)

        The value for the resource tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ClusterParameterGroup — (map)

        Describes a parameter group.

        • ParameterGroupName — (String)

          The name of the cluster parameter group.

        • ParameterGroupFamily — (String)

          The name of the cluster parameter group family that this cluster parameter group is compatible with.

        • Description — (String)

          The description of the parameter group.

        • Tags — (Array<map>)

          The list of tags for the cluster parameter group.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createClusterSecurityGroup(params = {}, callback) ⇒ AWS.Request

Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters.

For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

Service Reference:

Examples:

Calling the createClusterSecurityGroup operation

var params = {
  ClusterSecurityGroupName: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
redshift.createClusterSecurityGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterSecurityGroupName — (String)

      The name for the security group. Amazon Redshift stores the value as a lowercase string.

      Constraints:

      • Must contain no more than 255 alphanumeric characters or hyphens.

      • Must not be "Default".

      • Must be unique for all security groups that are created by your Amazon Web Services account.

      Example: examplesecuritygroup

    • Description — (String)

      A description for the security group.

    • Tags — (Array<map>)

      A list of tag instances.

      • Key — (String)

        The key, or name, for the resource tag.

      • Value — (String)

        The value for the resource tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ClusterSecurityGroup — (map)

        Describes a security group.

        • ClusterSecurityGroupName — (String)

          The name of the cluster security group to which the operation was applied.

        • Description — (String)

          A description of the security group.

        • EC2SecurityGroups — (Array<map>)

          A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.

          • Status — (String)

            The status of the EC2 security group.

          • EC2SecurityGroupName — (String)

            The name of the EC2 Security Group.

          • EC2SecurityGroupOwnerId — (String)

            The Amazon Web Services account ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

          • Tags — (Array<map>)

            The list of tags for the EC2 security group.

            • Key — (String)

              The key, or name, for the resource tag.

            • Value — (String)

              The value for the resource tag.

        • IPRanges — (Array<map>)

          A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.

          • Status — (String)

            The status of the IP range, for example, "authorized".

          • CIDRIP — (String)

            The IP range in Classless Inter-Domain Routing (CIDR) notation.

          • Tags — (Array<map>)

            The list of tags for the IP range.

            • Key — (String)

              The key, or name, for the resource tag.

            • Value — (String)

              The value for the resource tag.

        • Tags — (Array<map>)

          The list of tags for the cluster security group.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createClusterSnapshot(params = {}, callback) ⇒ AWS.Request

Creates a manual snapshot of the specified cluster. The cluster must be in the available state.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

Service Reference:

Examples:

Calling the createClusterSnapshot operation

var params = {
  ClusterIdentifier: 'STRING_VALUE', /* required */
  SnapshotIdentifier: 'STRING_VALUE', /* required */
  ManualSnapshotRetentionPeriod: 'NUMBER_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
redshift.createClusterSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SnapshotIdentifier — (String)

      A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the Amazon Web Services account.

      Constraints:

      • Cannot be null, empty, or blank

      • Must contain from 1 to 255 alphanumeric characters or hyphens

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

      Example: my-snapshot-id

    • ClusterIdentifier — (String)

      The cluster identifier for which you want a snapshot.

    • ManualSnapshotRetentionPeriod — (Integer)

      The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

      The value must be either -1 or an integer between 1 and 3,653.

      The default value is -1.

    • Tags — (Array<map>)

      A list of tag instances.

      • Key — (String)

        The key, or name, for the resource tag.

      • Value — (String)

        The value for the resource tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Snapshot — (map)

        Describes a snapshot.

        • SnapshotIdentifier — (String)

          The snapshot identifier that is provided in the request.

        • ClusterIdentifier — (String)

          The identifier of the cluster for which the snapshot was taken.

        • SnapshotCreateTime — (Date)

          The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

        • Status — (String)

          The snapshot status. The value of the status depends on the API operation used:

        • Port — (Integer)

          The port that the cluster is listening on.

        • AvailabilityZone — (String)

          The Availability Zone in which the cluster was created.

        • ClusterCreateTime — (Date)

          The time (UTC) when the cluster was originally created.

        • MasterUsername — (String)

          The admin user name for the cluster.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • EngineFullVersion — (String)

          The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

        • SnapshotType — (String)

          The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

        • NodeType — (String)

          The node type of the nodes in the cluster.

        • NumberOfNodes — (Integer)

          The number of nodes in the cluster.

        • DBName — (String)

          The name of the database that was created when the cluster was created.

        • VpcId — (String)

          The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

        • Encrypted — (Boolean)

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

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

        • EncryptedWithHSM — (Boolean)

          A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

        • AccountsWithRestoreAccess — (Array<map>)

          A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

          • AccountId — (String)

            The identifier of an Amazon Web Services account authorized to restore a snapshot.

          • AccountAlias — (String)

            The identifier of an Amazon Web Services support account authorized to restore a snapshot. For Amazon Web Services Support, the identifier is amazon-redshift-support.

        • OwnerAccount — (String)

          For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

        • TotalBackupSizeInMegaBytes — (Float)

          The size of the complete set of backup data that would be used to restore the cluster.

        • ActualIncrementalBackupSizeInMegaBytes — (Float)

          The size of the incremental backup.

        • BackupProgressInMegaBytes — (Float)

          The number of megabytes that have been transferred to the snapshot backup.

        • CurrentBackupRateInMegaBytesPerSecond — (Float)

          The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

        • EstimatedSecondsToCompletion — (Integer)

          The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

        • ElapsedTimeInSeconds — (Integer)

          The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

        • SourceRegion — (String)

          The source region from which the snapshot was copied.

        • Tags — (Array<map>)

          The list of tags for the cluster snapshot.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • RestorableNodeTypes — (Array<String>)

          The list of node types that this cluster snapshot is able to restore into.

        • 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 for the snapshot.

        • ManualSnapshotRetentionPeriod — (Integer)

          The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

          The value must be either -1 or an integer between 1 and 3,653.

        • ManualSnapshotRemainingDays — (Integer)

          The number of days until a manual snapshot will pass its retention period.

        • SnapshotRetentionStartTime — (Date)

          A timestamp representing the start of the retention period for the snapshot.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createClusterSubnetGroup(params = {}, callback) ⇒ AWS.Request

Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.

For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Cluster Management Guide.

Service Reference:

Examples:

Calling the createClusterSubnetGroup operation

var params = {
  ClusterSubnetGroupName: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE', /* required */
  SubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
redshift.createClusterSubnetGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterSubnetGroupName — (String)

      The name for the subnet group. Amazon Redshift stores the value as a lowercase string.

      Constraints:

      • Must contain no more than 255 alphanumeric characters or hyphens.

      • Must not be "Default".

      • Must be unique for all subnet groups that are created by your Amazon Web Services account.

      Example: examplesubnetgroup

    • Description — (String)

      A description for the subnet group.

    • SubnetIds — (Array<String>)

      An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

    • Tags — (Array<map>)

      A list of tag instances.

      • Key — (String)

        The key, or name, for the resource tag.

      • Value — (String)

        The value for the resource tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ClusterSubnetGroup — (map)

        Describes a subnet group.

        • ClusterSubnetGroupName — (String)

          The name of the cluster subnet group.

        • Description — (String)

          The description of the cluster subnet group.

        • VpcId — (String)

          The VPC ID of the cluster subnet group.

        • SubnetGroupStatus — (String)

          The status of the cluster subnet group. Possible values are Complete, Incomplete and Invalid.

        • Subnets — (Array<map>)

          A list of the VPC Subnet elements.

          • SubnetIdentifier — (String)

            The identifier of the subnet.

          • SubnetAvailabilityZone — (map)

            • Name — (String)

              The name of the availability zone.

            • SupportedPlatforms — (Array<map>)

              • Name — (String)

          • SubnetStatus — (String)

            The status of the subnet.

        • Tags — (Array<map>)

          The list of tags for the cluster subnet group.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createEndpointAccess(params = {}, callback) ⇒ AWS.Request

Creates a Redshift-managed VPC endpoint.

Service Reference:

Examples:

Calling the createEndpointAccess operation

var params = {
  EndpointName: 'STRING_VALUE', /* required */
  SubnetGroupName: 'STRING_VALUE', /* required */
  ClusterIdentifier: 'STRING_VALUE',
  ResourceOwner: 'STRING_VALUE',
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
redshift.createEndpointAccess(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      The cluster identifier of the cluster to access.

    • ResourceOwner — (String)

      The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.

    • EndpointName — (String)

      The Redshift-managed VPC endpoint name.

      An endpoint name must contain 1-30 characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be a letter. The name can't contain two consecutive hyphens or end with a hyphen.

    • SubnetGroupName — (String)

      The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.

    • VpcSecurityGroupIds — (Array<String>)

      The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ClusterIdentifier — (String)

        The cluster identifier of the cluster associated with the endpoint.

      • ResourceOwner — (String)

        The Amazon Web Services account ID of the owner of the cluster.

      • SubnetGroupName — (String)

        The subnet group name where Amazon Redshift chooses to deploy the endpoint.

      • EndpointStatus — (String)

        The status of the endpoint.

      • EndpointName — (String)

        The name of the endpoint.

      • EndpointCreateTime — (Date)

        The time (UTC) that the endpoint was created.

      • Port — (Integer)

        The port number on which the cluster accepts incoming connections.

      • Address — (String)

        The DNS address of the endpoint.

      • VpcSecurityGroups — (Array<map>)

        The security groups associated with the endpoint.

        • VpcSecurityGroupId — (String)

          The identifier of the VPC security group.

        • Status — (String)

          The status of the VPC security group.

      • VpcEndpoint — (map)

        The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.

        • VpcEndpointId — (String)

          The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

        • VpcId — (String)

          The VPC identifier that the endpoint is associated.

        • NetworkInterfaces — (Array<map>)

          One or more network interfaces of the endpoint. Also known as an interface endpoint.

          • NetworkInterfaceId — (String)

            The network interface identifier.

          • SubnetId — (String)

            The subnet identifier.

          • PrivateIpAddress — (String)

            The IPv4 address of the network interface within the subnet.

          • AvailabilityZone — (String)

            The Availability Zone.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createEventSubscription(params = {}, callback) ⇒ AWS.Request

Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters.

If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your Amazon Web Services account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your Amazon Web Services account. You must specify a source type if you specify a source ID.

Service Reference:

Examples:

Calling the createEventSubscription operation

var params = {
  SnsTopicArn: 'STRING_VALUE', /* required */
  SubscriptionName: 'STRING_VALUE', /* required */
  Enabled: true || false,
  EventCategories: [
    'STRING_VALUE',
    /* more items */
  ],
  Severity: 'STRING_VALUE',
  SourceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  SourceType: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
redshift.createEventSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SubscriptionName — (String)

      The name of the event subscription to be created.

      Constraints:

      • Cannot be null, empty, or blank.

      • Must contain from 1 to 255 alphanumeric characters or hyphens.

      • First character must be a letter.

      • Cannot end with a hyphen or contain two consecutive hyphens.

    • SnsTopicArn — (String)

      The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    • SourceType — (String)

      The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your Amazon Web Services account. You must specify a source type in order to specify source IDs.

      Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.

    • SourceIds — (Array<String>)

      A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

      Example: my-cluster-1, my-cluster-2

      Example: my-snapshot-20131010

    • EventCategories — (Array<String>)

      Specifies the Amazon Redshift event categories to be published by the event notification subscription.

      Values: configuration, management, monitoring, security, pending

    • Severity — (String)

      Specifies the Amazon Redshift event severity to be published by the event notification subscription.

      Values: ERROR, INFO

    • Enabled — (Boolean)

      A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.

    • Tags — (Array<map>)

      A list of tag instances.

      • Key — (String)

        The key, or name, for the resource tag.

      • Value — (String)

        The value for the resource tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EventSubscription — (map)

        Describes event subscriptions.

        • CustomerAwsId — (String)

          The Amazon Web Services account associated with the Amazon Redshift event notification subscription.

        • CustSubscriptionId — (String)

          The name of the Amazon Redshift event notification subscription.

        • SnsTopicArn — (String)

          The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.

        • Status — (String)

          The status of the Amazon Redshift event notification subscription.

          Constraints:

          • Can be one of the following: active | no-permission | topic-not-exist

          • The status "no-permission" indicates that Amazon Redshift no longer has permission to post to the Amazon SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

        • SubscriptionCreationTime — (Date)

          The date and time the Amazon Redshift event notification subscription was created.

        • SourceType — (String)

          The source type of the events returned by the Amazon Redshift event notification, such as cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, or scheduled-action.

        • SourceIdsList — (Array<String>)

          A list of the sources that publish events to the Amazon Redshift event notification subscription.

        • EventCategoriesList — (Array<String>)

          The list of Amazon Redshift event categories specified in the event notification subscription.

          Values: Configuration, Management, Monitoring, Security, Pending

        • Severity — (String)

          The event severity specified in the Amazon Redshift event notification subscription.

          Values: ERROR, INFO

        • Enabled — (Boolean)

          A boolean value indicating whether the subscription is enabled; true indicates that the subscription is enabled.

        • Tags — (Array<map>)

          The list of tags for the event subscription.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createHsmClientCertificate(params = {}, callback) ⇒ AWS.Request

Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases.

The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.

Service Reference:

Examples:

Calling the createHsmClientCertificate operation

var params = {
  HsmClientCertificateIdentifier: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
redshift.createHsmClientCertificate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • HsmClientCertificateIdentifier — (String)

      The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.

    • Tags — (Array<map>)

      A list of tag instances.

      • Key — (String)

        The key, or name, for the resource tag.

      • Value — (String)

        The value for the resource tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HsmClientCertificate — (map)

        Returns information about an HSM client certificate. The certificate is stored in a secure Hardware Storage Module (HSM), and used by the Amazon Redshift cluster to encrypt data files.

        • HsmClientCertificateIdentifier — (String)

          The identifier of the HSM client certificate.

        • HsmClientCertificatePublicKey — (String)

          The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.

        • Tags — (Array<map>)

          The list of tags for the HSM client certificate.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createHsmConfiguration(params = {}, callback) ⇒ AWS.Request

Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM.

In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.

Service Reference:

Examples:

Calling the createHsmConfiguration operation

var params = {
  Description: 'STRING_VALUE', /* required */
  HsmConfigurationIdentifier: 'STRING_VALUE', /* required */
  HsmIpAddress: 'STRING_VALUE', /* required */
  HsmPartitionName: 'STRING_VALUE', /* required */
  HsmPartitionPassword: 'STRING_VALUE', /* required */
  HsmServerPublicCertificate: 'STRING_VALUE', /* required */
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
redshift.createHsmConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • HsmConfigurationIdentifier — (String)

      The identifier to be assigned to the new Amazon Redshift HSM configuration.

    • Description — (String)

      A text description of the HSM configuration to be created.

    • HsmIpAddress — (String)

      The IP address that the Amazon Redshift cluster must use to access the HSM.

    • HsmPartitionName — (String)

      The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

    • HsmPartitionPassword — (String)

      The password required to access the HSM partition.

    • HsmServerPublicCertificate — (String)

      The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

    • Tags — (Array<map>)

      A list of tag instances.

      • Key — (String)

        The key, or name, for the resource tag.

      • Value — (String)

        The value for the resource tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • HsmConfiguration — (map)

        Returns information about an HSM configuration, which is an object that describes to Amazon Redshift clusters the information they require to connect to an HSM where they can store database encryption keys.

        • HsmConfigurationIdentifier — (String)

          The name of the Amazon Redshift HSM configuration.

        • Description — (String)

          A text description of the HSM configuration.

        • HsmIpAddress — (String)

          The IP address that the Amazon Redshift cluster must use to access the HSM.

        • HsmPartitionName — (String)

          The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

        • Tags — (Array<map>)

          The list of tags for the HSM configuration.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createScheduledAction(params = {}, callback) ⇒ AWS.Request

Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the ResizeCluster API operation.

Service Reference:

Examples:

Calling the createScheduledAction operation

var params = {
  IamRole: 'STRING_VALUE', /* required */
  Schedule: 'STRING_VALUE', /* required */
  ScheduledActionName: 'STRING_VALUE', /* required */
  TargetAction: { /* required */
    PauseCluster: {
      ClusterIdentifier: 'STRING_VALUE' /* required */
    },
    ResizeCluster: {
      ClusterIdentifier: 'STRING_VALUE', /* required */
      Classic: true || false,
      ClusterType: 'STRING_VALUE',
      NodeType: 'STRING_VALUE',
      NumberOfNodes: 'NUMBER_VALUE'
    },
    ResumeCluster: {
      ClusterIdentifier: 'STRING_VALUE' /* required */
    }
  },
  Enable: true || false,
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  ScheduledActionDescription: 'STRING_VALUE',
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
redshift.createScheduledAction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ScheduledActionName — (String)

      The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see ScheduledAction.

    • TargetAction — (map)

      A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see ScheduledAction.

      • ResizeCluster — (map)

        An action that runs a ResizeCluster API operation.

        • ClusterIdentifier — required — (String)

          The unique identifier for the cluster to resize.

        • ClusterType — (String)

          The new cluster type for the specified cluster.

        • NodeType — (String)

          The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.

        • NumberOfNodes — (Integer)

          The new number of nodes for the cluster. If not specified, the cluster's current number of nodes is used.

        • Classic — (Boolean)

          A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false, the resize type is elastic.

      • PauseCluster — (map)

        An action that runs a PauseCluster API operation.

        • ClusterIdentifier — required — (String)

          The identifier of the cluster to be paused.

      • ResumeCluster — (map)

        An action that runs a ResumeCluster API operation.

        • ClusterIdentifier — required — (String)

          The identifier of the cluster to be resumed.

    • Schedule — (String)

      The schedule in at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.

    • IamRole — (String)

      The IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.

    • ScheduledActionDescription — (String)

      The description of the scheduled action.

    • StartTime — (Date)

      The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

    • EndTime — (Date)

      The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

    • Enable — (Boolean)

      If true, the schedule is enabled. If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ScheduledActionName — (String)

        The name of the scheduled action.

      • TargetAction — (map)

        A JSON format string of the Amazon Redshift API operation with input parameters.

        "{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}".

        • ResizeCluster — (map)

          An action that runs a ResizeCluster API operation.

          • ClusterIdentifier — required — (String)

            The unique identifier for the cluster to resize.

          • ClusterType — (String)

            The new cluster type for the specified cluster.

          • NodeType — (String)

            The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.

          • NumberOfNodes — (Integer)

            The new number of nodes for the cluster. If not specified, the cluster's current number of nodes is used.

          • Classic — (Boolean)

            A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false, the resize type is elastic.

        • PauseCluster — (map)

          An action that runs a PauseCluster API operation.

          • ClusterIdentifier — required — (String)

            The identifier of the cluster to be paused.

        • ResumeCluster — (map)

          An action that runs a ResumeCluster API operation.

          • ClusterIdentifier — required — (String)

            The identifier of the cluster to be resumed.

      • Schedule — (String)

        The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.

        Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, "at(2016-03-04T17:27:00)".

        Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year)". For example, "cron(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

      • IamRole — (String)

        The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.

      • ScheduledActionDescription — (String)

        The description of the scheduled action.

      • State — (String)

        The state of the scheduled action. For example, DISABLED.

        Possible values include:
        • "ACTIVE"
        • "DISABLED"
      • NextInvocations — (Array<Date>)

        List of times when the scheduled action will run.

      • StartTime — (Date)

        The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

      • EndTime — (Date)

        The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createSnapshotCopyGrant(params = {}, callback) ⇒ AWS.Request

Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from Key Management Service (KMS) to encrypt copied snapshots in a destination region.

For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

Service Reference:

Examples:

Calling the createSnapshotCopyGrant operation

var params = {
  SnapshotCopyGrantName: 'STRING_VALUE', /* required */
  KmsKeyId: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
redshift.createSnapshotCopyGrant(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SnapshotCopyGrantName — (String)

      The name of the snapshot copy grant. This name must be unique in the region for the Amazon Web Services account.

      Constraints:

      • Must contain from 1 to 63 alphanumeric characters or hyphens.

      • Alphabetic characters must be lowercase.

      • First character must be a letter.

      • Cannot end with a hyphen or contain two consecutive hyphens.

      • Must be unique for all clusters within an Amazon Web Services account.

    • KmsKeyId — (String)

      The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.

    • Tags — (Array<map>)

      A list of tag instances.

      • Key — (String)

        The key, or name, for the resource tag.

      • Value — (String)

        The value for the resource tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SnapshotCopyGrant — (map)

        The snapshot copy grant that grants Amazon Redshift permission to encrypt copied snapshots with the specified customer master key (CMK) from Amazon Web Services KMS in the destination region.

        For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

        • SnapshotCopyGrantName — (String)

          The name of the snapshot copy grant.

        • KmsKeyId — (String)

          The unique identifier of the customer master key (CMK) in Amazon Web Services KMS to which Amazon Redshift is granted permission.

        • Tags — (Array<map>)

          A list of tag instances.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createSnapshotSchedule(params = {}, callback) ⇒ AWS.Request

Create a snapshot schedule that can be associated to a cluster and which overrides the default system backup schedule.

Service Reference:

Examples:

Calling the createSnapshotSchedule operation

var params = {
  DryRun: true || false,
  NextInvocations: 'NUMBER_VALUE',
  ScheduleDefinitions: [
    'STRING_VALUE',
    /* more items */
  ],
  ScheduleDescription: 'STRING_VALUE',
  ScheduleIdentifier: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
redshift.createSnapshotSchedule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ScheduleDefinitions — (Array<String>)

      The definition of the snapshot schedule. The definition is made up of schedule expressions, for example "cron(30 12 *)" or "rate(12 hours)".

    • ScheduleIdentifier — (String)

      A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier.

    • ScheduleDescription — (String)

      The description of the snapshot schedule.

    • Tags — (Array<map>)

      An optional set of tags you can use to search for the schedule.

      • Key — (String)

        The key, or name, for the resource tag.

      • Value — (String)

        The value for the resource tag.

    • DryRun — (Boolean)

    • NextInvocations — (Integer)

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ScheduleDefinitions — (Array<String>)

        A list of ScheduleDefinitions.

      • ScheduleIdentifier — (String)

        A unique identifier for the schedule.

      • ScheduleDescription — (String)

        The description of the schedule.

      • Tags — (Array<map>)

        An optional set of tags describing the schedule.

        • Key — (String)

          The key, or name, for the resource tag.

        • Value — (String)

          The value for the resource tag.

      • NextInvocations — (Array<Date>)

      • AssociatedClusterCount — (Integer)

        The number of clusters associated with the schedule.

      • AssociatedClusters — (Array<map>)

        A list of clusters associated with the schedule. A maximum of 100 clusters is returned.

        • ClusterIdentifier — (String)

        • ScheduleAssociationState — (String)

          Possible values include:

          • "MODIFYING"
          • "ACTIVE"
          • "FAILED"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createTags(params = {}, callback) ⇒ AWS.Request

Adds tags to a cluster.

A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, you will receive an error and the attempt will fail.

If you specify a key that already exists for the resource, the value for that key will be updated with the new value.

Service Reference:

Examples:

Calling the createTags operation

var params = {
  ResourceName: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
redshift.createTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceName — (String)

      The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

    • Tags — (Array<map>)

      One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter Key and the corresponding value is passed in with the parameter Value. The Key and Value parameters are separated by a comma (,). Separate multiple tags with a space. For example, --tags "Key"="owner","Value"="admin" "Key"="environment","Value"="test" "Key"="version","Value"="1.0".

      • Key — (String)

        The key, or name, for the resource tag.

      • Value — (String)

        The value for the resource tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createUsageLimit(params = {}, callback) ⇒ AWS.Request

Creates a usage limit for a specified Amazon Redshift feature on a cluster. The usage limit is identified by the returned usage limit identifier.

Service Reference:

Examples:

Calling the createUsageLimit operation

var params = {
  Amount: 'NUMBER_VALUE', /* required */
  ClusterIdentifier: 'STRING_VALUE', /* required */
  FeatureType: spectrum | concurrency-scaling, /* required */
  LimitType: time | data-scanned, /* required */
  BreachAction: log | emit-metric | disable,
  Period: daily | weekly | monthly,
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
redshift.createUsageLimit(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      The identifier of the cluster that you want to limit usage.

    • FeatureType — (String)

      The Amazon Redshift feature that you want to limit.

      Possible values include:
      • "spectrum"
      • "concurrency-scaling"
    • LimitType — (String)

      The type of limit. Depending on the feature type, this can be based on a time duration or data size. If FeatureType is spectrum, then LimitType must be data-scanned. If FeatureType is concurrency-scaling, then LimitType must be time.

      Possible values include:
      • "time"
      • "data-scanned"
    • Amount — (Integer)

      The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). The value must be a positive number.

    • Period — (String)

      The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

      Possible values include:
      • "daily"
      • "weekly"
      • "monthly"
    • BreachAction — (String)

      The action that Amazon Redshift takes when the limit is reached. The default is log. For more information about this parameter, see UsageLimit.

      Possible values include:
      • "log"
      • "emit-metric"
      • "disable"
    • Tags — (Array<map>)

      A list of tag instances.

      • Key — (String)

        The key, or name, for the resource tag.

      • Value — (String)

        The value for the resource tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • UsageLimitId — (String)

        The identifier of the usage limit.

      • ClusterIdentifier — (String)

        The identifier of the cluster with a usage limit.

      • FeatureType — (String)

        The Amazon Redshift feature to which the limit applies.

        Possible values include:
        • "spectrum"
        • "concurrency-scaling"
      • LimitType — (String)

        The type of limit. Depending on the feature type, this can be based on a time duration or data size.

        Possible values include:
        • "time"
        • "data-scanned"
      • Amount — (Integer)

        The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).

      • Period — (String)

        The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

        Possible values include:
        • "daily"
        • "weekly"
        • "monthly"
      • BreachAction — (String)

        The action that Amazon Redshift takes when the limit is reached. Possible values are:

        • log - To log an event in a system table. The default is log.

        • emit-metric - To emit CloudWatch metrics.

        • disable - To disable the feature until the next usage period begins.

        Possible values include:
        • "log"
        • "emit-metric"
        • "disable"
      • Tags — (Array<map>)

        A list of tag instances.

        • Key — (String)

          The key, or name, for the resource tag.

        • Value — (String)

          The value for the resource tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deauthorizeDataShare(params = {}, callback) ⇒ AWS.Request

From the producer account, removes authorization from the specified datashare.

Service Reference:

Examples:

Calling the deauthorizeDataShare operation

var params = {
  ConsumerIdentifier: 'STRING_VALUE', /* required */
  DataShareArn: 'STRING_VALUE' /* required */
};
redshift.deauthorizeDataShare(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DataShareArn — (String)

      The Amazon Resource Name (ARN) of the datashare to remove authorization from.

    • ConsumerIdentifier — (String)

      The identifier of the data consumer that is to have authorization removed from the datashare. This identifier is an AWS account ID.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DataShareArn — (String)

        An Amazon Resource Name (ARN) that references the datashare that is owned by a specific namespace of the producer cluster. A datashare ARN is in the arn:aws:redshift:{region}:{account-id}:{datashare}:{namespace-guid}/{datashare-name} format.

      • ProducerArn — (String)

        The Amazon Resource Name (ARN) of the producer.

      • AllowPubliclyAccessibleConsumers — (Boolean)

        A value that specifies whether the datashare can be shared to a publicly accessible cluster.

      • DataShareAssociations — (Array<map>)

        A value that specifies when the datashare has an association between a producer and data consumers.

        • ConsumerIdentifier — (String)

          The name of the consumer accounts that have an association with a producer datashare.

        • Status — (String)

          The status of the datashare that is associated.

          Possible values include:
          • "ACTIVE"
          • "PENDING_AUTHORIZATION"
          • "AUTHORIZED"
          • "DEAUTHORIZED"
          • "REJECTED"
          • "AVAILABLE"
        • CreatedDate — (Date)

          The creation date of the datashare that is associated.

        • StatusChangeDate — (Date)

          The status change data of the datashare that is associated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteAuthenticationProfile(params = {}, callback) ⇒ AWS.Request

Deletes an authentication profile.

Service Reference:

Examples:

Calling the deleteAuthenticationProfile operation

var params = {
  AuthenticationProfileName: 'STRING_VALUE' /* required */
};
redshift.deleteAuthenticationProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AuthenticationProfileName — (String)

      The name of the authentication profile to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AuthenticationProfileName — (String)

        The name of the authentication profile that was deleted.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteCluster(params = {}, callback) ⇒ AWS.Request

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

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

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

Service Reference:

Examples:

Calling the deleteCluster operation

var params = {
  ClusterIdentifier: 'STRING_VALUE', /* required */
  FinalClusterSnapshotIdentifier: 'STRING_VALUE',
  FinalClusterSnapshotRetentionPeriod: 'NUMBER_VALUE',
  SkipFinalClusterSnapshot: true || false
};
redshift.deleteCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      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.

    • SkipFinalClusterSnapshot — (Boolean)

      Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted.

      Note: The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.

      Default: false

    • FinalClusterSnapshotIdentifier — (String)

      The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

      Constraints:

      • Must be 1 to 255 alphanumeric characters.

      • First character must be a letter.

      • Cannot end with a hyphen or contain two consecutive hyphens.

    • FinalClusterSnapshotRetentionPeriod — (Integer)

      The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

      The value must be either -1 or an integer between 1 and 3,653.

      The default value is -1.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        Describes a cluster.

        • ClusterIdentifier — (String)

          The unique identifier of the cluster.

        • NodeType — (String)

          The node type for the nodes in the cluster.

        • ClusterStatus — (String)

          The current state of the cluster. Possible values are the following:

          • available

          • available, prep-for-resize

          • available, resize-cleanup

          • cancelling-resize

          • creating

          • deleting

          • final-snapshot

          • hardware-failure

          • incompatible-hsm

          • incompatible-network

          • incompatible-parameters

          • incompatible-restore

          • modifying

          • paused

          • rebooting

          • renaming

          • resizing

          • rotating-keys

          • storage-full

          • updating-hsm

        • ClusterAvailabilityStatus — (String)

          The availability status of the cluster for queries. Possible values are the following:

          • Available - The cluster is available for queries.

          • Unavailable - The cluster is not available for queries.

          • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

          • Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.

          • Failed - The cluster failed and is not available for queries.

        • ModifyStatus — (String)

          The status of a modify operation, if any, initiated for the cluster.

        • MasterUsername — (String)

          The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

        • DBName — (String)

          The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

        • Endpoint — (map)

          The connection endpoint.

          • Address — (String)

            The DNS address of the Cluster.

          • Port — (Integer)

            The port that the database engine is listening on.

          • VpcEndpoints — (Array<map>)

            Describes a connection endpoint.

            • VpcEndpointId — (String)

              The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

            • VpcId — (String)

              The VPC identifier that the endpoint is associated.

            • NetworkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • NetworkInterfaceId — (String)

                The network interface identifier.

              • SubnetId — (String)

                The subnet identifier.

              • PrivateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • AvailabilityZone — (String)

                The Availability Zone.

        • ClusterCreateTime — (Date)

          The date and time that the cluster was created.

        • AutomatedSnapshotRetentionPeriod — (Integer)

          The number of days that automatic cluster snapshots are retained.

        • ManualSnapshotRetentionPeriod — (Integer)

          The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

          The value must be either -1 or an integer between 1 and 3,653.

        • ClusterSecurityGroups — (Array<map>)

          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.

          • ClusterSecurityGroupName — (String)

            The name of the cluster security group.

          • Status — (String)

            The status of the cluster security group.

        • VpcSecurityGroups — (Array<map>)

          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.

          • VpcSecurityGroupId — (String)

            The identifier of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • ClusterParameterGroups — (Array<map>)

          The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

          • ParameterGroupName — (String)

            The name of the cluster parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • ClusterParameterStatusList — (Array<map>)

            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.

            • 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 — (map)

          A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

          • MasterUserPassword — (String)

            The pending or in-progress change of the admin user password for the cluster.

          • NodeType — (String)

            The pending or in-progress change of the cluster's node type.

          • NumberOfNodes — (Integer)

            The pending or in-progress change of the number of nodes in the cluster.

          • ClusterType — (String)

            The pending or in-progress change of the cluster type.

          • ClusterVersion — (String)

            The pending or in-progress change of the service version.

          • AutomatedSnapshotRetentionPeriod — (Integer)

            The pending or in-progress change of the automated snapshot retention period.

          • ClusterIdentifier — (String)

            The pending or in-progress change of the new identifier for the cluster.

          • PubliclyAccessible — (Boolean)

            The pending or in-progress change of the ability to connect to the cluster from the public network.

          • EnhancedVpcRouting — (Boolean)

            An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

            Default: false

          • MaintenanceTrackName — (String)

            The name of the maintenance track that the cluster will change to during the next maintenance window.

          • EncryptionType — (String)

            The encryption type for a cluster. Possible values are: KMS and None.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • AllowVersionUpgrade — (Boolean)

          A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

        • NumberOfNodes — (Integer)

          The number of compute nodes in the cluster.

        • PubliclyAccessible — (Boolean)

          A boolean value that, if true, indicates that the cluster can be accessed from a public network.

        • Encrypted — (Boolean)

          A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

        • RestoreStatus — (map)

          A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

          • Status — (String)

            The status of the restore action. Returns starting, restoring, completed, or failed.

          • CurrentRestoreRateInMegaBytesPerSecond — (Float)

            The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.

          • SnapshotSizeInMegaBytes — (Integer)

            The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

          • ProgressInMegaBytes — (Integer)

            The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

          • ElapsedTimeInSeconds — (Integer)

            The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.

        • DataTransferProgress — (map)

          • Status — (String)

            Describes the status of the cluster. While the transfer is in progress the status is transferringdata.

          • CurrentRateInMegaBytesPerSecond — (Float)

            Describes the data transfer rate in MB's per second.

          • TotalDataInMegaBytes — (Integer)

            Describes the total amount of data to be transfered in megabytes.

          • DataTransferredInMegaBytes — (Integer)

            Describes the total amount of data that has been transfered in MB's.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            Describes the estimated number of seconds remaining to complete the transfer.

          • ElapsedTimeInSeconds — (Integer)

            Describes the number of seconds that have elapsed during the data transfer.

        • HsmStatus — (map)

          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 — (map)

          A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

          • DestinationRegion — (String)

            The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

          • RetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

          • ManualSnapshotRetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.

            The value must be either -1 or an integer between 1 and 3,653.

          • SnapshotCopyGrantName — (String)

            The name of the snapshot copy grant.

        • ClusterPublicKey — (String)

          The public key for the cluster.

        • ClusterNodes — (Array<map>)

          The nodes in the 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 — (map)

          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 — (Array<map>)

          The list of tags for the cluster.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

        • EnhancedVpcRouting — (Boolean)

          An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

          Default: false

        • IamRoles — (Array<map>)

          A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

          • IamRoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

          • ApplyStatus — (String)

            A value that describes the status of the IAM role's association with an Amazon Redshift cluster.

            The following are possible statuses and descriptions.

            • in-sync: The role is available for use by the cluster.

            • adding: The role is in the process of being associated with the cluster.

            • removing: The role is in the process of being disassociated with the cluster.

        • PendingActions — (Array<String>)

          Cluster operations that are waiting to be started.

        • MaintenanceTrackName — (String)

          The name of the maintenance track for the cluster.

        • ElasticResizeNumberOfNodeOptions — (String)

          The number of nodes that you can resize the cluster to with the elastic resize method.

        • DeferredMaintenanceWindows — (Array<map>)

          Describes a group of DeferredMaintenanceWindow objects.

          • DeferMaintenanceIdentifier — (String)

            A unique identifier for the maintenance window.

          • DeferMaintenanceStartTime — (Date)

            A timestamp for the beginning of the time period when we defer maintenance.

          • DeferMaintenanceEndTime — (Date)

            A timestamp for the end of the time period when we defer maintenance.

        • SnapshotScheduleIdentifier — (String)

          A unique identifier for the cluster snapshot schedule.

        • SnapshotScheduleState — (String)

          The current state of the cluster snapshot schedule.

          Possible values include:
          • "MODIFYING"
          • "ACTIVE"
          • "FAILED"
        • ExpectedNextSnapshotScheduleTime — (Date)

          The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

        • ExpectedNextSnapshotScheduleTimeStatus — (String)

          The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

          • OnTrack - The next snapshot is expected to be taken on time.

          • Pending - The next snapshot is pending to be taken.

        • NextMaintenanceWindowStartTime — (Date)

          The date and time in UTC when system maintenance can begin.

        • ResizeInfo — (map)

          Returns the following:

          • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

          • ResizeType: Returns ClassicResize

          • ResizeType — (String)

            Returns the value ClassicResize.

          • AllowCancelResize — (Boolean)

            A boolean value indicating if the resize operation can be cancelled.

        • AvailabilityZoneRelocationStatus — (String)

          Describes the status of the Availability Zone relocation operation.

        • ClusterNamespaceArn — (String)

          The namespace Amazon Resource Name (ARN) of the cluster.

        • TotalStorageCapacityInMegaBytes — (Integer)

          The total storage capacity of the cluster in megabytes.

        • AquaConfiguration — (map)

          The AQUA (Advanced Query Accelerator) configuration of the cluster.

          • AquaStatus — (String)

            The value indicates the status of AQUA on the cluster. Possible values include the following.

            • enabled - AQUA is enabled.

            • disabled - AQUA is not enabled.

            • applying - AQUA status is being applied.

            Possible values include:
            • "enabled"
            • "disabled"
            • "applying"
          • AquaConfigurationStatus — (String)

            The value represents how the cluster is configured to use AQUA. Possible values include the following.

            • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

            • disabled - Don't use AQUA.

            • auto - Amazon Redshift determines whether to use AQUA.

            Possible values include:
            • "enabled"
            • "disabled"
            • "auto"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteClusterParameterGroup(params = {}, callback) ⇒ AWS.Request

Deletes a specified Amazon Redshift parameter group.

Note: You cannot delete a parameter group if it is associated with a cluster.

Service Reference:

Examples:

Calling the deleteClusterParameterGroup operation

var params = {
  ParameterGroupName: 'STRING_VALUE' /* required */
};
redshift.deleteClusterParameterGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ParameterGroupName — (String)

      The name of the parameter group to be deleted.

      Constraints:

      • Must be the name of an existing cluster parameter group.

      • Cannot delete a default cluster parameter group.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteClusterSecurityGroup(params = {}, callback) ⇒ AWS.Request

Deletes an Amazon Redshift security group.

Note: You cannot delete a security group that is associated with any clusters. You cannot delete the default security group.

For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

Service Reference:

Examples:

Calling the deleteClusterSecurityGroup operation

var params = {
  ClusterSecurityGroupName: 'STRING_VALUE' /* required */
};
redshift.deleteClusterSecurityGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterSecurityGroupName — (String)

      The name of the cluster security group to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteClusterSnapshot(params = {}, callback) ⇒ AWS.Request

Deletes the specified manual snapshot. The snapshot must be in the available state, with no other users authorized to access the snapshot.

Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.

Service Reference:

Examples:

Calling the deleteClusterSnapshot operation

var params = {
  SnapshotIdentifier: 'STRING_VALUE', /* required */
  SnapshotClusterIdentifier: 'STRING_VALUE'
};
redshift.deleteClusterSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SnapshotIdentifier — (String)

      The unique identifier of the manual snapshot to be deleted.

      Constraints: Must be the name of an existing snapshot that is in the available, failed, or cancelled state.

    • SnapshotClusterIdentifier — (String)

      The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

      Constraints: Must be the name of valid cluster.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Snapshot — (map)

        Describes a snapshot.

        • SnapshotIdentifier — (String)

          The snapshot identifier that is provided in the request.

        • ClusterIdentifier — (String)

          The identifier of the cluster for which the snapshot was taken.

        • SnapshotCreateTime — (Date)

          The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

        • Status — (String)

          The snapshot status. The value of the status depends on the API operation used:

        • Port — (Integer)

          The port that the cluster is listening on.

        • AvailabilityZone — (String)

          The Availability Zone in which the cluster was created.

        • ClusterCreateTime — (Date)

          The time (UTC) when the cluster was originally created.

        • MasterUsername — (String)

          The admin user name for the cluster.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • EngineFullVersion — (String)

          The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

        • SnapshotType — (String)

          The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

        • NodeType — (String)

          The node type of the nodes in the cluster.

        • NumberOfNodes — (Integer)

          The number of nodes in the cluster.

        • DBName — (String)

          The name of the database that was created when the cluster was created.

        • VpcId — (String)

          The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

        • Encrypted — (Boolean)

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

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

        • EncryptedWithHSM — (Boolean)

          A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

        • AccountsWithRestoreAccess — (Array<map>)

          A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

          • AccountId — (String)

            The identifier of an Amazon Web Services account authorized to restore a snapshot.

          • AccountAlias — (String)

            The identifier of an Amazon Web Services support account authorized to restore a snapshot. For Amazon Web Services Support, the identifier is amazon-redshift-support.

        • OwnerAccount — (String)

          For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

        • TotalBackupSizeInMegaBytes — (Float)

          The size of the complete set of backup data that would be used to restore the cluster.

        • ActualIncrementalBackupSizeInMegaBytes — (Float)

          The size of the incremental backup.

        • BackupProgressInMegaBytes — (Float)

          The number of megabytes that have been transferred to the snapshot backup.

        • CurrentBackupRateInMegaBytesPerSecond — (Float)

          The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

        • EstimatedSecondsToCompletion — (Integer)

          The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

        • ElapsedTimeInSeconds — (Integer)

          The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

        • SourceRegion — (String)

          The source region from which the snapshot was copied.

        • Tags — (Array<map>)

          The list of tags for the cluster snapshot.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • RestorableNodeTypes — (Array<String>)

          The list of node types that this cluster snapshot is able to restore into.

        • 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 for the snapshot.

        • ManualSnapshotRetentionPeriod — (Integer)

          The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

          The value must be either -1 or an integer between 1 and 3,653.

        • ManualSnapshotRemainingDays — (Integer)

          The number of days until a manual snapshot will pass its retention period.

        • SnapshotRetentionStartTime — (Date)

          A timestamp representing the start of the retention period for the snapshot.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteClusterSubnetGroup(params = {}, callback) ⇒ AWS.Request

Deletes the specified cluster subnet group.

Service Reference:

Examples:

Calling the deleteClusterSubnetGroup operation

var params = {
  ClusterSubnetGroupName: 'STRING_VALUE' /* required */
};
redshift.deleteClusterSubnetGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterSubnetGroupName — (String)

      The name of the cluster subnet group name to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteEndpointAccess(params = {}, callback) ⇒ AWS.Request

Deletes a Redshift-managed VPC endpoint.

Service Reference:

Examples:

Calling the deleteEndpointAccess operation

var params = {
  EndpointName: 'STRING_VALUE' /* required */
};
redshift.deleteEndpointAccess(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EndpointName — (String)

      The Redshift-managed VPC endpoint to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ClusterIdentifier — (String)

        The cluster identifier of the cluster associated with the endpoint.

      • ResourceOwner — (String)

        The Amazon Web Services account ID of the owner of the cluster.

      • SubnetGroupName — (String)

        The subnet group name where Amazon Redshift chooses to deploy the endpoint.

      • EndpointStatus — (String)

        The status of the endpoint.

      • EndpointName — (String)

        The name of the endpoint.

      • EndpointCreateTime — (Date)

        The time (UTC) that the endpoint was created.

      • Port — (Integer)

        The port number on which the cluster accepts incoming connections.

      • Address — (String)

        The DNS address of the endpoint.

      • VpcSecurityGroups — (Array<map>)

        The security groups associated with the endpoint.

        • VpcSecurityGroupId — (String)

          The identifier of the VPC security group.

        • Status — (String)

          The status of the VPC security group.

      • VpcEndpoint — (map)

        The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.

        • VpcEndpointId — (String)

          The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

        • VpcId — (String)

          The VPC identifier that the endpoint is associated.

        • NetworkInterfaces — (Array<map>)

          One or more network interfaces of the endpoint. Also known as an interface endpoint.

          • NetworkInterfaceId — (String)

            The network interface identifier.

          • SubnetId — (String)

            The subnet identifier.

          • PrivateIpAddress — (String)

            The IPv4 address of the network interface within the subnet.

          • AvailabilityZone — (String)

            The Availability Zone.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteEventSubscription(params = {}, callback) ⇒ AWS.Request

Deletes an Amazon Redshift event notification subscription.

Service Reference:

Examples:

Calling the deleteEventSubscription operation

var params = {
  SubscriptionName: 'STRING_VALUE' /* required */
};
redshift.deleteEventSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SubscriptionName — (String)

      The name of the Amazon Redshift event notification subscription to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteHsmClientCertificate(params = {}, callback) ⇒ AWS.Request

Deletes the specified HSM client certificate.

Service Reference:

Examples:

Calling the deleteHsmClientCertificate operation

var params = {
  HsmClientCertificateIdentifier: 'STRING_VALUE' /* required */
};
redshift.deleteHsmClientCertificate(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • HsmClientCertificateIdentifier — (String)

      The identifier of the HSM client certificate to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteHsmConfiguration(params = {}, callback) ⇒ AWS.Request

Deletes the specified Amazon Redshift HSM configuration.

Service Reference:

Examples:

Calling the deleteHsmConfiguration operation

var params = {
  HsmConfigurationIdentifier: 'STRING_VALUE' /* required */
};
redshift.deleteHsmConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • HsmConfigurationIdentifier — (String)

      The identifier of the Amazon Redshift HSM configuration to be deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deletePartner(params = {}, callback) ⇒ AWS.Request

Deletes a partner integration from a cluster. Data can still flow to the cluster until the integration is deleted at the partner's website.

Service Reference:

Examples:

Calling the deletePartner operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ClusterIdentifier: 'STRING_VALUE', /* required */
  DatabaseName: 'STRING_VALUE', /* required */
  PartnerName: 'STRING_VALUE' /* required */
};
redshift.deletePartner(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AccountId — (String)

      The Amazon Web Services account ID that owns the cluster.

    • ClusterIdentifier — (String)

      The cluster identifier of the cluster that receives data from the partner.

    • DatabaseName — (String)

      The name of the database that receives data from the partner.

    • PartnerName — (String)

      The name of the partner that is authorized to send data.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DatabaseName — (String)

        The name of the database that receives data from the partner.

      • PartnerName — (String)

        The name of the partner that is authorized to send data.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteScheduledAction(params = {}, callback) ⇒ AWS.Request

Deletes a scheduled action.

Service Reference:

Examples:

Calling the deleteScheduledAction operation

var params = {
  ScheduledActionName: 'STRING_VALUE' /* required */
};
redshift.deleteScheduledAction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ScheduledActionName — (String)

      The name of the scheduled action to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteSnapshotCopyGrant(params = {}, callback) ⇒ AWS.Request

Deletes the specified snapshot copy grant.

Service Reference:

Examples:

Calling the deleteSnapshotCopyGrant operation

var params = {
  SnapshotCopyGrantName: 'STRING_VALUE' /* required */
};
redshift.deleteSnapshotCopyGrant(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SnapshotCopyGrantName — (String)

      The name of the snapshot copy grant to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteSnapshotSchedule(params = {}, callback) ⇒ AWS.Request

Deletes a snapshot schedule.

Service Reference:

Examples:

Calling the deleteSnapshotSchedule operation

var params = {
  ScheduleIdentifier: 'STRING_VALUE' /* required */
};
redshift.deleteSnapshotSchedule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ScheduleIdentifier — (String)

      A unique identifier of the snapshot schedule to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteTags(params = {}, callback) ⇒ AWS.Request

Deletes tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.

Service Reference:

Examples:

Calling the deleteTags operation

var params = {
  ResourceName: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
redshift.deleteTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceName — (String)

      The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

    • TagKeys — (Array<String>)

      The tag key that you want to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteUsageLimit(params = {}, callback) ⇒ AWS.Request

Deletes a usage limit from a cluster.

Service Reference:

Examples:

Calling the deleteUsageLimit operation

var params = {
  UsageLimitId: 'STRING_VALUE' /* required */
};
redshift.deleteUsageLimit(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • UsageLimitId — (String)

      The identifier of the usage limit to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeAccountAttributes(params = {}, callback) ⇒ AWS.Request

Returns a list of attributes attached to an account

Service Reference:

Examples:

Calling the describeAccountAttributes operation

var params = {
  AttributeNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
redshift.describeAccountAttributes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AttributeNames — (Array<String>)

      A list of attribute names.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AccountAttributes — (Array<map>)

        A list of attributes assigned to an account.

        • AttributeName — (String)

          The name of the attribute.

        • AttributeValues — (Array<map>)

          A list of attribute values.

          • AttributeValue — (String)

            The value of the attribute.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeAuthenticationProfiles(params = {}, callback) ⇒ AWS.Request

Describes an authentication profile.

Service Reference:

Examples:

Calling the describeAuthenticationProfiles operation

var params = {
  AuthenticationProfileName: 'STRING_VALUE'
};
redshift.describeAuthenticationProfiles(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AuthenticationProfileName — (String)

      The name of the authentication profile to describe. If not specified then all authentication profiles owned by the account are listed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AuthenticationProfiles — (Array<map>)

        The list of authentication profiles.

        • AuthenticationProfileName — (String)

          The name of the authentication profile.

        • AuthenticationProfileContent — (String)

          The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeClusterDbRevisions(params = {}, callback) ⇒ AWS.Request

Returns an array of ClusterDbRevision objects.

Service Reference:

Examples:

Calling the describeClusterDbRevisions operation

var params = {
  ClusterIdentifier: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
redshift.describeClusterDbRevisions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      A unique identifier for a cluster whose ClusterDbRevisions you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default.

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in 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.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • Marker — (String)

      An optional parameter that specifies the starting point for returning a set of response records. When the results of a DescribeClusterDbRevisions request exceed the value specified in MaxRecords, Amazon Redshift 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Marker — (String)

        A string representing the starting point for the next set of revisions. If a value is returned in a response, you can retrieve the next set of revisions by providing the value in the marker parameter and retrying the command. If the marker field is empty, all revisions have already been returned.

      • ClusterDbRevisions — (Array<map>)

        A list of revisions.

        • ClusterIdentifier — (String)

          The unique identifier of the cluster.

        • CurrentDatabaseRevision — (String)

          A string representing the current cluster version.

        • DatabaseRevisionReleaseDate — (Date)

          The date on which the database revision was released.

        • RevisionTargets — (Array<map>)

          A list of RevisionTarget objects, where each object describes the database revision that a cluster can be updated to.

          • DatabaseRevision — (String)

            A unique string that identifies the version to update the cluster to. You can use this value in ModifyClusterDbRevision.

          • Description — (String)

            A string that describes the changes and features that will be applied to the cluster when it is updated to the corresponding ClusterDbRevision.

          • DatabaseRevisionReleaseDate — (Date)

            The date on which the database revision was released.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeClusterParameterGroups(params = {}, callback) ⇒ AWS.Request

Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all parameter groups that have any combination of those values are returned.

If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.

Service Reference:

Examples:

Calling the describeClusterParameterGroups operation

var params = {
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  ParameterGroupName: 'STRING_VALUE',
  TagKeys: [
    'STRING_VALUE',
    /* more items */
  ],
  TagValues: [
    'STRING_VALUE',
    /* more items */
  ]
};
redshift.describeClusterParameterGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ParameterGroupName — (String)

      The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • Marker — (String)

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

    • TagKeys — (Array<String>)

      A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.

    • TagValues — (Array<String>)

      A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

      • ParameterGroups — (Array<map>)

        A list of ClusterParameterGroup instances. Each instance describes one cluster parameter group.

        • ParameterGroupName — (String)

          The name of the cluster parameter group.

        • ParameterGroupFamily — (String)

          The name of the cluster parameter group family that this cluster parameter group is compatible with.

        • Description — (String)

          The description of the parameter group.

        • Tags — (Array<map>)

          The list of tags for the cluster parameter group.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeClusterParameters(params = {}, callback) ⇒ AWS.Request

Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.

You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Service Reference:

Examples:

Calling the describeClusterParameters operation

var params = {
  ParameterGroupName: 'STRING_VALUE', /* required */
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  Source: 'STRING_VALUE'
};
redshift.describeClusterParameters(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ParameterGroupName — (String)

      The name of a cluster parameter group for which to return details.

    • Source — (String)

      The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

      Default: All parameter types returned.

      Valid Values: user | engine-default

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Parameters — (Array<map>)

        A list of Parameter instances. Each instance lists the parameters of one cluster parameter group.

        • ParameterName — (String)

          The name of the parameter.

        • ParameterValue — (String)

          The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.

        • Description — (String)

          A description of the parameter.

        • Source — (String)

          The source of the parameter value, such as "engine-default" or "user".

        • DataType — (String)

          The data type of the parameter.

        • AllowedValues — (String)

          The valid range of values for the parameter.

        • ApplyType — (String)

          Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

          Possible values include:
          • "static"
          • "dynamic"
        • IsModifiable — (Boolean)

          If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

        • MinimumEngineVersion — (String)

          The earliest engine version to which the parameter can apply.

      • Marker — (String)

        A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeClusters(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeClusters operation

var params = {
  ClusterIdentifier: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  TagKeys: [
    'STRING_VALUE',
    /* more items */
  ],
  TagValues: [
    'STRING_VALUE',
    /* more items */
  ]
};
redshift.describeClusters(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

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

      The default is that all clusters defined for an account are returned.

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • Marker — (String)

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

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

    • TagKeys — (Array<String>)

      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.

    • TagValues — (Array<String>)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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 — (Array<map>)

        A list of Cluster objects, where each object describes one cluster.

        • ClusterIdentifier — (String)

          The unique identifier of the cluster.

        • NodeType — (String)

          The node type for the nodes in the cluster.

        • ClusterStatus — (String)

          The current state of the cluster. Possible values are the following:

          • available

          • available, prep-for-resize

          • available, resize-cleanup

          • cancelling-resize

          • creating

          • deleting

          • final-snapshot

          • hardware-failure

          • incompatible-hsm

          • incompatible-network

          • incompatible-parameters

          • incompatible-restore

          • modifying

          • paused

          • rebooting

          • renaming

          • resizing

          • rotating-keys

          • storage-full

          • updating-hsm

        • ClusterAvailabilityStatus — (String)

          The availability status of the cluster for queries. Possible values are the following:

          • Available - The cluster is available for queries.

          • Unavailable - The cluster is not available for queries.

          • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

          • Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.

          • Failed - The cluster failed and is not available for queries.

        • ModifyStatus — (String)

          The status of a modify operation, if any, initiated for the cluster.

        • MasterUsername — (String)

          The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

        • DBName — (String)

          The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

        • Endpoint — (map)

          The connection endpoint.

          • Address — (String)

            The DNS address of the Cluster.

          • Port — (Integer)

            The port that the database engine is listening on.

          • VpcEndpoints — (Array<map>)

            Describes a connection endpoint.

            • VpcEndpointId — (String)

              The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

            • VpcId — (String)

              The VPC identifier that the endpoint is associated.

            • NetworkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • NetworkInterfaceId — (String)

                The network interface identifier.

              • SubnetId — (String)

                The subnet identifier.

              • PrivateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • AvailabilityZone — (String)

                The Availability Zone.

        • ClusterCreateTime — (Date)

          The date and time that the cluster was created.

        • AutomatedSnapshotRetentionPeriod — (Integer)

          The number of days that automatic cluster snapshots are retained.

        • ManualSnapshotRetentionPeriod — (Integer)

          The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

          The value must be either -1 or an integer between 1 and 3,653.

        • ClusterSecurityGroups — (Array<map>)

          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.

          • ClusterSecurityGroupName — (String)

            The name of the cluster security group.

          • Status — (String)

            The status of the cluster security group.

        • VpcSecurityGroups — (Array<map>)

          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.

          • VpcSecurityGroupId — (String)

            The identifier of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • ClusterParameterGroups — (Array<map>)

          The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

          • ParameterGroupName — (String)

            The name of the cluster parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • ClusterParameterStatusList — (Array<map>)

            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.

            • 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 — (map)

          A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

          • MasterUserPassword — (String)

            The pending or in-progress change of the admin user password for the cluster.

          • NodeType — (String)

            The pending or in-progress change of the cluster's node type.

          • NumberOfNodes — (Integer)

            The pending or in-progress change of the number of nodes in the cluster.

          • ClusterType — (String)

            The pending or in-progress change of the cluster type.

          • ClusterVersion — (String)

            The pending or in-progress change of the service version.

          • AutomatedSnapshotRetentionPeriod — (Integer)

            The pending or in-progress change of the automated snapshot retention period.

          • ClusterIdentifier — (String)

            The pending or in-progress change of the new identifier for the cluster.

          • PubliclyAccessible — (Boolean)

            The pending or in-progress change of the ability to connect to the cluster from the public network.

          • EnhancedVpcRouting — (Boolean)

            An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

            Default: false

          • MaintenanceTrackName — (String)

            The name of the maintenance track that the cluster will change to during the next maintenance window.

          • EncryptionType — (String)

            The encryption type for a cluster. Possible values are: KMS and None.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • AllowVersionUpgrade — (Boolean)

          A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

        • NumberOfNodes — (Integer)

          The number of compute nodes in the cluster.

        • PubliclyAccessible — (Boolean)

          A boolean value that, if true, indicates that the cluster can be accessed from a public network.

        • Encrypted — (Boolean)

          A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

        • RestoreStatus — (map)

          A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

          • Status — (String)

            The status of the restore action. Returns starting, restoring, completed, or failed.

          • CurrentRestoreRateInMegaBytesPerSecond — (Float)

            The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.

          • SnapshotSizeInMegaBytes — (Integer)

            The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

          • ProgressInMegaBytes — (Integer)

            The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

          • ElapsedTimeInSeconds — (Integer)

            The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.

        • DataTransferProgress — (map)

          • Status — (String)

            Describes the status of the cluster. While the transfer is in progress the status is transferringdata.

          • CurrentRateInMegaBytesPerSecond — (Float)

            Describes the data transfer rate in MB's per second.

          • TotalDataInMegaBytes — (Integer)

            Describes the total amount of data to be transfered in megabytes.

          • DataTransferredInMegaBytes — (Integer)

            Describes the total amount of data that has been transfered in MB's.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            Describes the estimated number of seconds remaining to complete the transfer.

          • ElapsedTimeInSeconds — (Integer)

            Describes the number of seconds that have elapsed during the data transfer.

        • HsmStatus — (map)

          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 — (map)

          A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

          • DestinationRegion — (String)

            The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

          • RetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

          • ManualSnapshotRetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.

            The value must be either -1 or an integer between 1 and 3,653.

          • SnapshotCopyGrantName — (String)

            The name of the snapshot copy grant.

        • ClusterPublicKey — (String)

          The public key for the cluster.

        • ClusterNodes — (Array<map>)

          The nodes in the 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 — (map)

          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 — (Array<map>)

          The list of tags for the cluster.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

        • EnhancedVpcRouting — (Boolean)

          An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

          Default: false

        • IamRoles — (Array<map>)

          A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

          • IamRoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

          • ApplyStatus — (String)

            A value that describes the status of the IAM role's association with an Amazon Redshift cluster.

            The following are possible statuses and descriptions.

            • in-sync: The role is available for use by the cluster.

            • adding: The role is in the process of being associated with the cluster.

            • removing: The role is in the process of being disassociated with the cluster.

        • PendingActions — (Array<String>)

          Cluster operations that are waiting to be started.

        • MaintenanceTrackName — (String)

          The name of the maintenance track for the cluster.

        • ElasticResizeNumberOfNodeOptions — (String)

          The number of nodes that you can resize the cluster to with the elastic resize method.

        • DeferredMaintenanceWindows — (Array<map>)

          Describes a group of DeferredMaintenanceWindow objects.

          • DeferMaintenanceIdentifier — (String)

            A unique identifier for the maintenance window.

          • DeferMaintenanceStartTime — (Date)

            A timestamp for the beginning of the time period when we defer maintenance.

          • DeferMaintenanceEndTime — (Date)

            A timestamp for the end of the time period when we defer maintenance.

        • SnapshotScheduleIdentifier — (String)

          A unique identifier for the cluster snapshot schedule.

        • SnapshotScheduleState — (String)

          The current state of the cluster snapshot schedule.

          Possible values include:
          • "MODIFYING"
          • "ACTIVE"
          • "FAILED"
        • ExpectedNextSnapshotScheduleTime — (Date)

          The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

        • ExpectedNextSnapshotScheduleTimeStatus — (String)

          The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

          • OnTrack - The next snapshot is expected to be taken on time.

          • Pending - The next snapshot is pending to be taken.

        • NextMaintenanceWindowStartTime — (Date)

          The date and time in UTC when system maintenance can begin.

        • ResizeInfo — (map)

          Returns the following:

          • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

          • ResizeType: Returns ClassicResize

          • ResizeType — (String)

            Returns the value ClassicResize.

          • AllowCancelResize — (Boolean)

            A boolean value indicating if the resize operation can be cancelled.

        • AvailabilityZoneRelocationStatus — (String)

          Describes the status of the Availability Zone relocation operation.

        • ClusterNamespaceArn — (String)

          The namespace Amazon Resource Name (ARN) of the cluster.

        • TotalStorageCapacityInMegaBytes — (Integer)

          The total storage capacity of the cluster in megabytes.

        • AquaConfiguration — (map)

          The AQUA (Advanced Query Accelerator) configuration of the cluster.

          • AquaStatus — (String)

            The value indicates the status of AQUA on the cluster. Possible values include the following.

            • enabled - AQUA is enabled.

            • disabled - AQUA is not enabled.

            • applying - AQUA status is being applied.

            Possible values include:
            • "enabled"
            • "disabled"
            • "applying"
          • AquaConfigurationStatus — (String)

            The value represents how the cluster is configured to use AQUA. Possible values include the following.

            • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

            • disabled - Don't use AQUA.

            • auto - Amazon Redshift determines whether to use AQUA.

            Possible values include:
            • "enabled"
            • "disabled"
            • "auto"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeClusterSecurityGroups(params = {}, callback) ⇒ AWS.Request

Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.

For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all security groups that have any combination of those values are returned.

If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.

Service Reference:

Examples:

Calling the describeClusterSecurityGroups operation

var params = {
  ClusterSecurityGroupName: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  TagKeys: [
    'STRING_VALUE',
    /* more items */
  ],
  TagValues: [
    'STRING_VALUE',
    /* more items */
  ]
};
redshift.describeClusterSecurityGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterSecurityGroupName — (String)

      The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.

      Example: securitygroup1

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • Marker — (String)

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

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

    • TagKeys — (Array<String>)

      A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys. For example, suppose that you have security groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag keys associated with them.

    • TagValues — (Array<String>)

      A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values. For example, suppose that you have security groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag values associated with them.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

      • ClusterSecurityGroups — (Array<map>)

        A list of ClusterSecurityGroup instances.

        • ClusterSecurityGroupName — (String)

          The name of the cluster security group to which the operation was applied.

        • Description — (String)

          A description of the security group.

        • EC2SecurityGroups — (Array<map>)

          A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.

          • Status — (String)

            The status of the EC2 security group.

          • EC2SecurityGroupName — (String)

            The name of the EC2 Security Group.

          • EC2SecurityGroupOwnerId — (String)

            The Amazon Web Services account ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

          • Tags — (Array<map>)

            The list of tags for the EC2 security group.

            • Key — (String)

              The key, or name, for the resource tag.

            • Value — (String)

              The value for the resource tag.

        • IPRanges — (Array<map>)

          A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.

          • Status — (String)

            The status of the IP range, for example, "authorized".

          • CIDRIP — (String)

            The IP range in Classless Inter-Domain Routing (CIDR) notation.

          • Tags — (Array<map>)

            The list of tags for the IP range.

            • Key — (String)

              The key, or name, for the resource tag.

            • Value — (String)

              The value for the resource tag.

        • Tags — (Array<map>)

          The list of tags for the cluster security group.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeClusterSnapshots(params = {}, callback) ⇒ AWS.Request

Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by your Amazon Web Services account. No information is returned for snapshots owned by inactive Amazon Web Services accounts.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters.

If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.

Service Reference:

Examples:

Calling the describeClusterSnapshots operation

var params = {
  ClusterExists: true || false,
  ClusterIdentifier: 'STRING_VALUE',
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  OwnerAccount: 'STRING_VALUE',
  SnapshotIdentifier: 'STRING_VALUE',
  SnapshotType: 'STRING_VALUE',
  SortingEntities: [
    {
      Attribute: SOURCE_TYPE | TOTAL_SIZE | CREATE_TIME, /* required */
      SortOrder: ASC | DESC
    },
    /* more items */
  ],
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  TagKeys: [
    'STRING_VALUE',
    /* more items */
  ],
  TagValues: [
    'STRING_VALUE',
    /* more items */
  ]
};
redshift.describeClusterSnapshots(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      The identifier of the cluster which generated the requested snapshots.

    • SnapshotIdentifier — (String)

      The snapshot identifier of the snapshot about which to return information.

    • SnapshotType — (String)

      The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.

      Valid Values: automated | manual

    • StartTime — (Date)

      A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: 2012-07-16T18:00:00Z

    • EndTime — (Date)

      A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: 2012-07-16T18:00:00Z

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • Marker — (String)

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

    • OwnerAccount — (String)

      The Amazon Web Services account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your Amazon Web Services account, or do not specify the parameter.

    • TagKeys — (Array<String>)

      A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.

    • TagValues — (Array<String>)

      A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.

    • ClusterExists — (Boolean)

      A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:

      • If ClusterExists is set to true, ClusterIdentifier is required.

      • If ClusterExists is set to false and ClusterIdentifier isn't specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.

      • If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.

      • If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.

    • SortingEntities — (Array<map>)

      • Attribute — required — (String)

        The category for sorting the snapshots.

        Possible values include:
        • "SOURCE_TYPE"
        • "TOTAL_SIZE"
        • "CREATE_TIME"
      • SortOrder — (String)

        The order for listing the attributes.

        Possible values include:
        • "ASC"
        • "DESC"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Marker — (String)

        A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

      • Snapshots — (Array<map>)

        A list of Snapshot instances.

        • SnapshotIdentifier — (String)

          The snapshot identifier that is provided in the request.

        • ClusterIdentifier — (String)

          The identifier of the cluster for which the snapshot was taken.

        • SnapshotCreateTime — (Date)

          The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

        • Status — (String)

          The snapshot status. The value of the status depends on the API operation used:

        • Port — (Integer)

          The port that the cluster is listening on.

        • AvailabilityZone — (String)

          The Availability Zone in which the cluster was created.

        • ClusterCreateTime — (Date)

          The time (UTC) when the cluster was originally created.

        • MasterUsername — (String)

          The admin user name for the cluster.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • EngineFullVersion — (String)

          The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

        • SnapshotType — (String)

          The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

        • NodeType — (String)

          The node type of the nodes in the cluster.

        • NumberOfNodes — (Integer)

          The number of nodes in the cluster.

        • DBName — (String)

          The name of the database that was created when the cluster was created.

        • VpcId — (String)

          The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

        • Encrypted — (Boolean)

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

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

        • EncryptedWithHSM — (Boolean)

          A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

        • AccountsWithRestoreAccess — (Array<map>)

          A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

          • AccountId — (String)

            The identifier of an Amazon Web Services account authorized to restore a snapshot.

          • AccountAlias — (String)

            The identifier of an Amazon Web Services support account authorized to restore a snapshot. For Amazon Web Services Support, the identifier is amazon-redshift-support.

        • OwnerAccount — (String)

          For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

        • TotalBackupSizeInMegaBytes — (Float)

          The size of the complete set of backup data that would be used to restore the cluster.

        • ActualIncrementalBackupSizeInMegaBytes — (Float)

          The size of the incremental backup.

        • BackupProgressInMegaBytes — (Float)

          The number of megabytes that have been transferred to the snapshot backup.

        • CurrentBackupRateInMegaBytesPerSecond — (Float)

          The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

        • EstimatedSecondsToCompletion — (Integer)

          The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

        • ElapsedTimeInSeconds — (Integer)

          The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

        • SourceRegion — (String)

          The source region from which the snapshot was copied.

        • Tags — (Array<map>)

          The list of tags for the cluster snapshot.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • RestorableNodeTypes — (Array<String>)

          The list of node types that this cluster snapshot is able to restore into.

        • 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 for the snapshot.

        • ManualSnapshotRetentionPeriod — (Integer)

          The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

          The value must be either -1 or an integer between 1 and 3,653.

        • ManualSnapshotRemainingDays — (Integer)

          The number of days until a manual snapshot will pass its retention period.

        • SnapshotRetentionStartTime — (Date)

          A timestamp representing the start of the retention period for the snapshot.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

describeClusterSubnetGroups(params = {}, callback) ⇒ AWS.Request

Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in your Amazon Web Services account.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subnet groups that have any combination of those values are returned.

If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.

Service Reference:

Examples:

Calling the describeClusterSubnetGroups operation

var params = {
  ClusterSubnetGroupName: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  TagKeys: [
    'STRING_VALUE',
    /* more items */
  ],
  TagValues: [
    'STRING_VALUE',
    /* more items */
  ]
};
redshift.describeClusterSubnetGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterSubnetGroupName — (String)

      The name of the cluster subnet group for which information is requested.

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • Marker — (String)

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

    • TagKeys — (Array<String>)

      A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag keys associated with them.

    • TagValues — (Array<String>)

      A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag values associated with them.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Marker — (String)

        A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

      • ClusterSubnetGroups — (Array<map>)

        A list of ClusterSubnetGroup instances.

        • ClusterSubnetGroupName — (String)

          The name of the cluster subnet group.

        • Description — (String)

          The description of the cluster subnet group.

        • VpcId — (String)

          The VPC ID of the cluster subnet group.

        • SubnetGroupStatus — (String)

          The status of the cluster subnet group. Possible values are Complete, Incomplete and Invalid.

        • Subnets — (Array<map>)

          A list of the VPC Subnet elements.

          • SubnetIdentifier — (String)

            The identifier of the subnet.

          • SubnetAvailabilityZone — (map)

            • Name — (String)

              The name of the availability zone.

            • SupportedPlatforms — (Array<map>)

              • Name — (String)

          • SubnetStatus — (String)

            The status of the subnet.

        • Tags — (Array<map>)

          The list of tags for the cluster subnet group.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeClusterTracks(params = {}, callback) ⇒ AWS.Request

Returns a list of all the available maintenance tracks.

Service Reference:

Examples:

Calling the describeClusterTracks operation

var params = {
  MaintenanceTrackName: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
redshift.describeClusterTracks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • MaintenanceTrackName — (String)

      The name of the maintenance track.

    • MaxRecords — (Integer)

      An integer value for the maximum number of maintenance tracks to return.

    • Marker — (String)

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterTracks request exceed the value specified in MaxRecords, Amazon Redshift 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MaintenanceTracks — (Array<map>)

        A list of maintenance tracks output by the DescribeClusterTracks operation.

        • MaintenanceTrackName — (String)

          The name of the maintenance track. Possible values are current and trailing.

        • DatabaseVersion — (String)

          The version number for the cluster release.

        • UpdateTargets — (Array<map>)

          An array of UpdateTarget objects to update with the maintenance track.

          • MaintenanceTrackName — (String)

            The name of the new maintenance track.

          • DatabaseVersion — (String)

            The cluster version for the new maintenance track.

          • SupportedOperations — (Array<map>)

            A list of operations supported by the maintenance track.

            • OperationName — (String)

              A list of the supported operations.

      • Marker — (String)

        The starting point to return a set of response tracklist records. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeClusterVersions(params = {}, callback) ⇒ AWS.Request

Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Service Reference:

Examples:

Calling the describeClusterVersions operation

var params = {
  ClusterParameterGroupFamily: 'STRING_VALUE',
  ClusterVersion: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
redshift.describeClusterVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterVersion — (String)

      The specific cluster version to return.

      Example: 1.0

    • ClusterParameterGroupFamily — (String)

      The name of a specific cluster parameter group family to return details for.

      Constraints:

      • Must be 1 to 255 alphanumeric characters

      • First character must be a letter

      • Cannot end with a hyphen or contain two consecutive hyphens

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

      • ClusterVersions — (Array<map>)

        A list of Version elements.

        • ClusterVersion — (String)

          The version number used by the cluster.

        • ClusterParameterGroupFamily — (String)

          The name of the cluster parameter group family for the cluster.

        • Description — (String)

          The description of the cluster version.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeDataShares(params = {}, callback) ⇒ AWS.Request

Shows the status of any inbound or outbound datashares available in the specified account.

Service Reference:

Examples:

Calling the describeDataShares operation

var params = {
  DataShareArn: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
redshift.describeDataShares(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DataShareArn — (String)

      The identifier of the datashare to describe details of.

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    • Marker — (String)

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataShares 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DataShares — (Array<map>)

        The results returned from describing datashares.

        • DataShareArn — (String)

          An Amazon Resource Name (ARN) that references the datashare that is owned by a specific namespace of the producer cluster. A datashare ARN is in the arn:aws:redshift:{region}:{account-id}:{datashare}:{namespace-guid}/{datashare-name} format.

        • ProducerArn — (String)

          The Amazon Resource Name (ARN) of the producer.

        • AllowPubliclyAccessibleConsumers — (Boolean)

          A value that specifies whether the datashare can be shared to a publicly accessible cluster.

        • DataShareAssociations — (Array<map>)

          A value that specifies when the datashare has an association between a producer and data consumers.

          • ConsumerIdentifier — (String)

            The name of the consumer accounts that have an association with a producer datashare.

          • Status — (String)

            The status of the datashare that is associated.

            Possible values include:
            • "ACTIVE"
            • "PENDING_AUTHORIZATION"
            • "AUTHORIZED"
            • "DEAUTHORIZED"
            • "REJECTED"
            • "AVAILABLE"
          • CreatedDate — (Date)

            The creation date of the datashare that is associated.

          • StatusChangeDate — (Date)

            The status change data of the datashare that is associated.

      • Marker — (String)

        An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataShares 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeDataSharesForConsumer(params = {}, callback) ⇒ AWS.Request

Returns a list of datashares where the account identifier being called is a consumer account identifier.

Service Reference:

Examples:

Calling the describeDataSharesForConsumer operation

var params = {
  ConsumerArn: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  Status: ACTIVE | AVAILABLE
};
redshift.describeDataSharesForConsumer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ConsumerArn — (String)

      The Amazon Resource Name (ARN) of the consumer that returns in the list of datashares.

    • Status — (String)

      An identifier giving the status of a datashare in the consumer cluster. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.

      Possible values include:
      • "ACTIVE"
      • "AVAILABLE"
    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    • Marker — (String)

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForConsumer 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DataShares — (Array<map>)

        Shows the results of datashares available for consumers.

        • DataShareArn — (String)

          An Amazon Resource Name (ARN) that references the datashare that is owned by a specific namespace of the producer cluster. A datashare ARN is in the arn:aws:redshift:{region}:{account-id}:{datashare}:{namespace-guid}/{datashare-name} format.

        • ProducerArn — (String)

          The Amazon Resource Name (ARN) of the producer.

        • AllowPubliclyAccessibleConsumers — (Boolean)

          A value that specifies whether the datashare can be shared to a publicly accessible cluster.

        • DataShareAssociations — (Array<map>)

          A value that specifies when the datashare has an association between a producer and data consumers.

          • ConsumerIdentifier — (String)

            The name of the consumer accounts that have an association with a producer datashare.

          • Status — (String)

            The status of the datashare that is associated.

            Possible values include:
            • "ACTIVE"
            • "PENDING_AUTHORIZATION"
            • "AUTHORIZED"
            • "DEAUTHORIZED"
            • "REJECTED"
            • "AVAILABLE"
          • CreatedDate — (Date)

            The creation date of the datashare that is associated.

          • StatusChangeDate — (Date)

            The status change data of the datashare that is associated.

      • Marker — (String)

        An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForConsumer 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeDataSharesForProducer(params = {}, callback) ⇒ AWS.Request

Returns a list of datashares when the account identifier being called is a producer account identifier.

Service Reference:

Examples:

Calling the describeDataSharesForProducer operation

var params = {
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  ProducerArn: 'STRING_VALUE',
  Status: ACTIVE | AUTHORIZED | PENDING_AUTHORIZATION | DEAUTHORIZED | REJECTED
};
redshift.describeDataSharesForProducer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ProducerArn — (String)

      The Amazon Resource Name (ARN) of the producer that returns in the list of datashares.

    • Status — (String)

      An identifier giving the status of a datashare in the producer. If this field is specified, Amazon Redshift returns the list of datashares that have the specified status.

      Possible values include:
      • "ACTIVE"
      • "AUTHORIZED"
      • "PENDING_AUTHORIZATION"
      • "DEAUTHORIZED"
      • "REJECTED"
    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    • Marker — (String)

      An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForProducer 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DataShares — (Array<map>)

        Shows the results of datashares available for producers.

        • DataShareArn — (String)

          An Amazon Resource Name (ARN) that references the datashare that is owned by a specific namespace of the producer cluster. A datashare ARN is in the arn:aws:redshift:{region}:{account-id}:{datashare}:{namespace-guid}/{datashare-name} format.

        • ProducerArn — (String)

          The Amazon Resource Name (ARN) of the producer.

        • AllowPubliclyAccessibleConsumers — (Boolean)

          A value that specifies whether the datashare can be shared to a publicly accessible cluster.

        • DataShareAssociations — (Array<map>)

          A value that specifies when the datashare has an association between a producer and data consumers.

          • ConsumerIdentifier — (String)

            The name of the consumer accounts that have an association with a producer datashare.

          • Status — (String)

            The status of the datashare that is associated.

            Possible values include:
            • "ACTIVE"
            • "PENDING_AUTHORIZATION"
            • "AUTHORIZED"
            • "DEAUTHORIZED"
            • "REJECTED"
            • "AVAILABLE"
          • CreatedDate — (Date)

            The creation date of the datashare that is associated.

          • StatusChangeDate — (Date)

            The status change data of the datashare that is associated.

      • Marker — (String)

        An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDataSharesForProducer 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeDefaultClusterParameters(params = {}, callback) ⇒ AWS.Request

Returns a list of parameter settings for the specified parameter group family.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Service Reference:

Examples:

Calling the describeDefaultClusterParameters operation

var params = {
  ParameterGroupFamily: 'STRING_VALUE', /* required */
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
redshift.describeDefaultClusterParameters(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ParameterGroupFamily — (String)

      The name of the cluster parameter group family.

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DefaultClusterParameters — (map)

        Describes the default cluster parameters for a parameter group family.

        • ParameterGroupFamily — (String)

          The name of the cluster parameter group family to which the engine default parameters apply.

        • Marker — (String)

          A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

        • Parameters — (Array<map>)

          The list of cluster default parameters.

          • ParameterName — (String)

            The name of the parameter.

          • ParameterValue — (String)

            The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.

          • Description — (String)

            A description of the parameter.

          • Source — (String)

            The source of the parameter value, such as "engine-default" or "user".

          • DataType — (String)

            The data type of the parameter.

          • AllowedValues — (String)

            The valid range of values for the parameter.

          • ApplyType — (String)

            Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

            Possible values include:
            • "static"
            • "dynamic"
          • IsModifiable — (Boolean)

            If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

          • MinimumEngineVersion — (String)

            The earliest engine version to which the parameter can apply.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeEndpointAccess(params = {}, callback) ⇒ AWS.Request

Describes a Redshift-managed VPC endpoint.

Service Reference:

Examples:

Calling the describeEndpointAccess operation

var params = {
  ClusterIdentifier: 'STRING_VALUE',
  EndpointName: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  ResourceOwner: 'STRING_VALUE',
  VpcId: 'STRING_VALUE'
};
redshift.describeEndpointAccess(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      The cluster identifier associated with the described endpoint.

    • ResourceOwner — (String)

      The Amazon Web Services account ID of the owner of the cluster.

    • EndpointName — (String)

      The name of the endpoint to be described.

    • VpcId — (String)

      The virtual private cloud (VPC) identifier with access to the cluster.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a Marker is included in the response so that the remaining results can be retrieved.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeEndpointAccess request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EndpointAccessList — (Array<map>)

        The list of endpoints with access to the cluster.

        • ClusterIdentifier — (String)

          The cluster identifier of the cluster associated with the endpoint.

        • ResourceOwner — (String)

          The Amazon Web Services account ID of the owner of the cluster.

        • SubnetGroupName — (String)

          The subnet group name where Amazon Redshift chooses to deploy the endpoint.

        • EndpointStatus — (String)

          The status of the endpoint.

        • EndpointName — (String)

          The name of the endpoint.

        • EndpointCreateTime — (Date)

          The time (UTC) that the endpoint was created.

        • Port — (Integer)

          The port number on which the cluster accepts incoming connections.

        • Address — (String)

          The DNS address of the endpoint.

        • VpcSecurityGroups — (Array<map>)

          The security groups associated with the endpoint.

          • VpcSecurityGroupId — (String)

            The identifier of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • VpcEndpoint — (map)

          The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.

          • VpcEndpointId — (String)

            The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

          • VpcId — (String)

            The VPC identifier that the endpoint is associated.

          • NetworkInterfaces — (Array<map>)

            One or more network interfaces of the endpoint. Also known as an interface endpoint.

            • NetworkInterfaceId — (String)

              The network interface identifier.

            • SubnetId — (String)

              The subnet identifier.

            • PrivateIpAddress — (String)

              The IPv4 address of the network interface within the subnet.

            • AvailabilityZone — (String)

              The Availability Zone.

      • Marker — (String)

        An optional pagination token provided by a previous DescribeEndpointAccess request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeEndpointAuthorization(params = {}, callback) ⇒ AWS.Request

Describes an endpoint authorization.

Service Reference:

Examples:

Calling the describeEndpointAuthorization operation

var params = {
  Account: 'STRING_VALUE',
  ClusterIdentifier: 'STRING_VALUE',
  Grantee: true || false,
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
redshift.describeEndpointAuthorization(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      The cluster identifier of the cluster to access.

    • Account — (String)

      The AAmazon Web Services account ID of either the cluster owner (grantor) or grantee. If Grantee parameter is true, then the Account value is of the grantor.

    • Grantee — (Boolean)

      Indicates whether to check authorization from a grantor or grantee point of view. If true, Amazon Redshift returns endpoint authorizations that you've been granted. If false (default), checks authorization from a grantor point of view.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a Marker is included in the response so that the remaining results can be retrieved.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeEndpointAuthorization request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EndpointAuthorizationList — (Array<map>)

        The authorizations to an endpoint.

        • Grantor — (String)

          The Amazon Web Services account ID of the cluster owner.

        • Grantee — (String)

          The Amazon Web Services account ID of the grantee of the cluster.

        • ClusterIdentifier — (String)

          The cluster identifier.

        • AuthorizeTime — (Date)

          The time (UTC) when the authorization was created.

        • ClusterStatus — (String)

          The status of the cluster.

        • Status — (String)

          The status of the authorization action.

          Possible values include:
          • "Authorized"
          • "Revoking"
        • AllowedAllVPCs — (Boolean)

          Indicates whether all VPCs in the grantee account are allowed access to the cluster.

        • AllowedVPCs — (Array<String>)

          The VPCs allowed access to the cluster.

        • EndpointCount — (Integer)

          The number of Redshift-managed VPC endpoints created for the authorization.

      • Marker — (String)

        An optional pagination token provided by a previous DescribeEndpointAuthorization request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeEventCategories(params = {}, callback) ⇒ AWS.Request

Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications.

Service Reference:

Examples:

Calling the describeEventCategories operation

var params = {
  SourceType: 'STRING_VALUE'
};
redshift.describeEventCategories(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SourceType — (String)

      The source type, such as cluster or parameter group, to which the described event categories apply.

      Valid values: cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, and scheduled-action.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EventCategoriesMapList — (Array<map>)

        A list of event categories descriptions.

        • SourceType — (String)

          The source type, such as cluster or cluster-snapshot, that the returned categories belong to.

        • Events — (Array<map>)

          The events in the event category.

          • EventId — (String)

            The identifier of an Amazon Redshift event.

          • EventCategories — (Array<String>)

            The category of an Amazon Redshift event.

          • EventDescription — (String)

            The description of an Amazon Redshift event.

          • Severity — (String)

            The severity of the event.

            Values: ERROR, INFO

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeEvents(params = {}, callback) ⇒ AWS.Request

Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

Service Reference:

Examples:

Calling the describeEvents operation

var params = {
  Duration: 'NUMBER_VALUE',
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  SourceIdentifier: 'STRING_VALUE',
  SourceType: cluster | cluster-parameter-group | cluster-security-group | cluster-snapshot | scheduled-action,
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
redshift.describeEvents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SourceIdentifier — (String)

      The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.

      Constraints:

      If SourceIdentifier is supplied, SourceType must also be provided.

      • Specify a cluster identifier when SourceType is cluster.

      • Specify a cluster security group name when SourceType is cluster-security-group.

      • Specify a cluster parameter group name when SourceType is cluster-parameter-group.

      • Specify a cluster snapshot identifier when SourceType is cluster-snapshot.

    • SourceType — (String)

      The event source to retrieve events for. If no value is specified, all events are returned.

      Constraints:

      If SourceType is supplied, SourceIdentifier must also be provided.

      • Specify cluster when SourceIdentifier is a cluster identifier.

      • Specify cluster-security-group when SourceIdentifier is a cluster security group name.

      • Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name.

      • Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.

      Possible values include:
      • "cluster"
      • "cluster-parameter-group"
      • "cluster-security-group"
      • "cluster-snapshot"
      • "scheduled-action"
    • StartTime — (Date)

      The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: 2009-07-08T18:00Z

    • EndTime — (Date)

      The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: 2009-07-08T18:00Z

    • Duration — (Integer)

      The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.

      Default: 60

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

      • Events — (Array<map>)

        A list of Event instances.

        • SourceIdentifier — (String)

          The identifier for the source of the event.

        • SourceType — (String)

          The source type for this event.

          Possible values include:
          • "cluster"
          • "cluster-parameter-group"
          • "cluster-security-group"
          • "cluster-snapshot"
          • "scheduled-action"
        • Message — (String)

          The text of this event.

        • EventCategories — (Array<String>)

          A list of the event categories.

          Values: Configuration, Management, Monitoring, Security, Pending

        • Severity — (String)

          The severity of the event.

          Values: ERROR, INFO

        • Date — (Date)

          The date and time of the event.

        • EventId — (String)

          The identifier of the event.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeEventSubscriptions(params = {}, callback) ⇒ AWS.Request

Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification subscriptions 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 subscriptions that have any combination of those values are returned.

If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.

Service Reference:

Examples:

Calling the describeEventSubscriptions operation

var params = {
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  SubscriptionName: 'STRING_VALUE',
  TagKeys: [
    'STRING_VALUE',
    /* more items */
  ],
  TagValues: [
    'STRING_VALUE',
    /* more items */
  ]
};
redshift.describeEventSubscriptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SubscriptionName — (String)

      The name of the Amazon Redshift event notification subscription to be described.

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • Marker — (String)

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

    • TagKeys — (Array<String>)

      A tag key or keys for which you want to return all matching event notification subscriptions that are associated with the specified key or keys. For example, suppose that you have subscriptions 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 subscriptions that have either or both of these tag keys associated with them.

    • TagValues — (Array<String>)

      A tag value or values for which you want to return all matching event notification subscriptions that are associated with the specified tag value or values. For example, suppose that you have subscriptions 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 subscriptions that have either or both of these tag values associated with them.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

      • EventSubscriptionsList — (Array<map>)

        A list of event subscriptions.

        • CustomerAwsId — (String)

          The Amazon Web Services account associated with the Amazon Redshift event notification subscription.

        • CustSubscriptionId — (String)

          The name of the Amazon Redshift event notification subscription.

        • SnsTopicArn — (String)

          The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.

        • Status — (String)

          The status of the Amazon Redshift event notification subscription.

          Constraints:

          • Can be one of the following: active | no-permission | topic-not-exist

          • The status "no-permission" indicates that Amazon Redshift no longer has permission to post to the Amazon SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

        • SubscriptionCreationTime — (Date)

          The date and time the Amazon Redshift event notification subscription was created.

        • SourceType — (String)

          The source type of the events returned by the Amazon Redshift event notification, such as cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, or scheduled-action.

        • SourceIdsList — (Array<String>)

          A list of the sources that publish events to the Amazon Redshift event notification subscription.

        • EventCategoriesList — (Array<String>)

          The list of Amazon Redshift event categories specified in the event notification subscription.

          Values: Configuration, Management, Monitoring, Security, Pending

        • Severity — (String)

          The event severity specified in the Amazon Redshift event notification subscription.

          Values: ERROR, INFO

        • Enabled — (Boolean)

          A boolean value indicating whether the subscription is enabled; true indicates that the subscription is enabled.

        • Tags — (Array<map>)

          The list of tags for the event subscription.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeHsmClientCertificates(params = {}, callback) ⇒ AWS.Request

Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your Amazon Web Services account.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates 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 HSM client certificates that have any combination of those values are returned.

If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.

Service Reference:

Examples:

Calling the describeHsmClientCertificates operation

var params = {
  HsmClientCertificateIdentifier: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  TagKeys: [
    'STRING_VALUE',
    /* more items */
  ],
  TagValues: [
    'STRING_VALUE',
    /* more items */
  ]
};
redshift.describeHsmClientCertificates(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • HsmClientCertificateIdentifier — (String)

      The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your Amazon Web Services account.

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • Marker — (String)

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

    • TagKeys — (Array<String>)

      A tag key or keys for which you want to return all matching HSM client certificates that are associated with the specified key or keys. For example, suppose that you have HSM client certificates 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 HSM client certificates that have either or both of these tag keys associated with them.

    • TagValues — (Array<String>)

      A tag value or values for which you want to return all matching HSM client certificates that are associated with the specified tag value or values. For example, suppose that you have HSM client certificates 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 HSM client certificates that have either or both of these tag values associated with them.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

      • HsmClientCertificates — (Array<map>)

        A list of the identifiers for one or more HSM client certificates used by Amazon Redshift clusters to store and retrieve database encryption keys in an HSM.

        • HsmClientCertificateIdentifier — (String)

          The identifier of the HSM client certificate.

        • HsmClientCertificatePublicKey — (String)

          The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.

        • Tags — (Array<map>)

          The list of tags for the HSM client certificate.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeHsmConfigurations(params = {}, callback) ⇒ AWS.Request

Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your Amazon Web Services account.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections 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 HSM connections that have any combination of those values are returned.

If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.

Service Reference:

Examples:

Calling the describeHsmConfigurations operation

var params = {
  HsmConfigurationIdentifier: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  TagKeys: [
    'STRING_VALUE',
    /* more items */
  ],
  TagValues: [
    'STRING_VALUE',
    /* more items */
  ]
};
redshift.describeHsmConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • HsmConfigurationIdentifier — (String)

      The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your Amazon Web Services account.

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • Marker — (String)

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

    • TagKeys — (Array<String>)

      A tag key or keys for which you want to return all matching HSM configurations that are associated with the specified key or keys. For example, suppose that you have HSM configurations 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 HSM configurations that have either or both of these tag keys associated with them.

    • TagValues — (Array<String>)

      A tag value or values for which you want to return all matching HSM configurations that are associated with the specified tag value or values. For example, suppose that you have HSM configurations 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 HSM configurations that have either or both of these tag values associated with them.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

      • HsmConfigurations — (Array<map>)

        A list of HsmConfiguration objects.

        • HsmConfigurationIdentifier — (String)

          The name of the Amazon Redshift HSM configuration.

        • Description — (String)

          A text description of the HSM configuration.

        • HsmIpAddress — (String)

          The IP address that the Amazon Redshift cluster must use to access the HSM.

        • HsmPartitionName — (String)

          The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

        • Tags — (Array<map>)

          The list of tags for the HSM configuration.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeLoggingStatus(params = {}, callback) ⇒ AWS.Request

Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.

Service Reference:

Examples:

Calling the describeLoggingStatus operation

var params = {
  ClusterIdentifier: 'STRING_VALUE' /* required */
};
redshift.describeLoggingStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      The identifier of the cluster from which to get the logging status.

      Example: examplecluster

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LoggingEnabled — (Boolean)

        true if logging is on, false if logging is off.

      • BucketName — (String)

        The name of the S3 bucket where the log files are stored.

      • S3KeyPrefix — (String)

        The prefix applied to the log file names.

      • LastSuccessfulDeliveryTime — (Date)

        The last time that logs were delivered.

      • LastFailureTime — (Date)

        The last time when logs failed to be delivered.

      • LastFailureMessage — (String)

        The message indicating that logs failed to be delivered.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeNodeConfigurationOptions(params = {}, callback) ⇒ AWS.Request

Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.

Service Reference:

Examples:

Calling the describeNodeConfigurationOptions operation

var params = {
  ActionType: restore-cluster | recommend-node-config | resize-cluster, /* required */
  ClusterIdentifier: 'STRING_VALUE',
  Filters: [
    {
      Name: NodeType | NumberOfNodes | EstimatedDiskUtilizationPercent | Mode,
      Operator: eq | lt | gt | le | ge | in | between,
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  OwnerAccount: 'STRING_VALUE',
  SnapshotIdentifier: 'STRING_VALUE'
};
redshift.describeNodeConfigurationOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ActionType — (String)

      The action type to evaluate for possible node configurations. Specify "restore-cluster" to get configuration combinations based on an existing snapshot. Specify "recommend-node-config" to get configuration recommendations based on an existing cluster or snapshot. Specify "resize-cluster" to get configuration combinations for elastic resize based on an existing cluster.

      Possible values include:
      • "restore-cluster"
      • "recommend-node-config"
      • "resize-cluster"
    • ClusterIdentifier — (String)

      The identifier of the cluster to evaluate for possible node configurations.

    • SnapshotIdentifier — (String)

      The identifier of the snapshot to evaluate for possible node configurations.

    • OwnerAccount — (String)

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

    • Filters — (Array<map>)

      A set of name, operator, and value items to filter the results.

      • Name — (String)

        The name of the element to filter.

        Possible values include:
        • "NodeType"
        • "NumberOfNodes"
        • "EstimatedDiskUtilizationPercent"
        • "Mode"
      • Operator — (String)

        The filter operator. If filter Name is NodeType only the 'in' operator is supported. Provide one value to evaluate for 'eq', 'lt', 'le', 'gt', and 'ge'. Provide two values to evaluate for 'between'. Provide a list of values for 'in'.

        Possible values include:
        • "eq"
        • "lt"
        • "gt"
        • "le"
        • "ge"
        • "in"
        • "between"
      • Values — (Array<String>)

        List of values. Compare Name using Operator to Values. If filter Name is NumberOfNodes, then values can range from 0 to 200. If filter Name is EstimatedDiskUtilizationPercent, then values can range from 0 to 100. For example, filter NumberOfNodes (name) GT (operator) 3 (values).

    • Marker — (String)

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

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 500

      Constraints: minimum 100, maximum 500.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NodeConfigurationOptionList — (Array<map>)

        A list of valid node configurations.

        • NodeType — (String)

          The node type, such as, "ds2.8xlarge".

        • NumberOfNodes — (Integer)

          The number of nodes.

        • EstimatedDiskUtilizationPercent — (Float)

          The estimated disk utilizaton percentage.

        • Mode — (String)

          The category of the node configuration recommendation.

          Possible values include:
          • "standard"
          • "high-performance"
      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeOrderableClusterOptions(params = {}, callback) ⇒ AWS.Request

Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific Amazon Web Services Region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Service Reference:

Examples:

Calling the describeOrderableClusterOptions operation

var params = {
  ClusterVersion: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  NodeType: 'STRING_VALUE'
};
redshift.describeOrderableClusterOptions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterVersion — (String)

      The version filter value. Specify this parameter to show only the available offerings matching the specified version.

      Default: All versions.

      Constraints: Must be one of the version returned from DescribeClusterVersions.

    • NodeType — (String)

      The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OrderableClusterOptions — (Array<map>)

        An OrderableClusterOption structure containing information about orderable options for the cluster.

        • ClusterVersion — (String)

          The version of the orderable cluster.

        • ClusterType — (String)

          The cluster type, for example multi-node.

        • NodeType — (String)

          The node type for the orderable cluster.

        • AvailabilityZones — (Array<map>)

          A list of availability zones for the orderable cluster.

          • Name — (String)

            The name of the availability zone.

          • SupportedPlatforms — (Array<map>)

            • Name — (String)

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describePartners(params = {}, callback) ⇒ AWS.Request

Returns information about the partner integrations defined for a cluster.

Service Reference:

Examples:

Calling the describePartners operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ClusterIdentifier: 'STRING_VALUE', /* required */
  DatabaseName: 'STRING_VALUE',
  PartnerName: 'STRING_VALUE'
};
redshift.describePartners(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AccountId — (String)

      The Amazon Web Services account ID that owns the cluster.

    • ClusterIdentifier — (String)

      The cluster identifier of the cluster whose partner integration is being described.

    • DatabaseName — (String)

      The name of the database whose partner integration is being described. If database name is not specified, then all databases in the cluster are described.

    • PartnerName — (String)

      The name of the partner that is being described. If partner name is not specified, then all partner integrations are described.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • PartnerIntegrationInfoList — (Array<map>)

        A list of partner integrations.

        • DatabaseName — (String)

          The name of the database that receives data from a partner.

        • PartnerName — (String)

          The name of the partner.

        • Status — (String)

          The partner integration status.

          Possible values include:
          • "Active"
          • "Inactive"
          • "RuntimeFailure"
          • "ConnectionFailure"
        • StatusMessage — (String)

          The status message provided by the partner.

        • CreatedAt — (Date)

          The date (UTC) that the partner integration was created.

        • UpdatedAt — (Date)

          The date (UTC) that the partner integration status was last updated by the partner.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeReservedNodeOfferings(params = {}, callback) ⇒ AWS.Request

Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.

For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.

Service Reference:

Examples:

Calling the describeReservedNodeOfferings operation

var params = {
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  ReservedNodeOfferingId: 'STRING_VALUE'
};
redshift.describeReservedNodeOfferings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ReservedNodeOfferingId — (String)

      The unique identifier for the offering.

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

      • ReservedNodeOfferings — (Array<map>)

        A list of ReservedNodeOffering objects.

        • ReservedNodeOfferingId — (String)

          The offering identifier.

        • NodeType — (String)

          The node type offered by the reserved node offering.

        • Duration — (Integer)

          The duration, in seconds, for which the offering will reserve the node.

        • FixedPrice — (Float)

          The upfront fixed charge you will pay to purchase the specific reserved node offering.

        • UsagePrice — (Float)

          The rate you are charged for each hour the cluster that is using the offering is running.

        • CurrencyCode — (String)

          The currency code for the compute nodes offering.

        • OfferingType — (String)

          The anticipated utilization of the reserved node, as defined in the reserved node offering.

        • RecurringCharges — (Array<map>)

          The charge to your account regardless of whether you are creating any clusters using the node offering. Recurring charges are only in effect for heavy-utilization reserved nodes.

          • RecurringChargeAmount — (Float)

            The amount charged per the period of time specified by the recurring charge frequency.

          • RecurringChargeFrequency — (String)

            The frequency at which the recurring charge amount is applied.

        • ReservedNodeOfferingType — (String)

          Possible values include:

          • "Regular"
          • "Upgradable"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeReservedNodes(params = {}, callback) ⇒ AWS.Request

Returns the descriptions of the reserved nodes.

Service Reference:

Examples:

Calling the describeReservedNodes operation

var params = {
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  ReservedNodeId: 'STRING_VALUE'
};
redshift.describeReservedNodes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ReservedNodeId — (String)

      Identifier for the node reservation.

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • Marker — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

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

      • ReservedNodes — (Array<map>)

        The list of ReservedNode objects.

        • ReservedNodeId — (String)

          The unique identifier for the reservation.

        • ReservedNodeOfferingId — (String)

          The identifier for the reserved node offering.

        • NodeType — (String)

          The node type of the reserved node.

        • StartTime — (Date)

          The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.

        • Duration — (Integer)

          The duration of the node reservation in seconds.

        • FixedPrice — (Float)

          The fixed cost Amazon Redshift charges you for this reserved node.

        • UsagePrice — (Float)

          The hourly rate Amazon Redshift charges you for this reserved node.

        • CurrencyCode — (String)

          The currency code for the reserved cluster.

        • NodeCount — (Integer)

          The number of reserved compute nodes.

        • State — (String)

          The state of the reserved compute node.

          Possible Values:

          • pending-payment-This reserved node has recently been purchased, and the sale has been approved, but payment has not yet been confirmed.

          • active-This reserved node is owned by the caller and is available for use.

          • payment-failed-Payment failed for the purchase attempt.

          • retired-The reserved node is no longer available.

          • exchanging-The owner is exchanging the reserved node for another reserved node.

        • OfferingType — (String)

          The anticipated utilization of the reserved node, as defined in the reserved node offering.

        • RecurringCharges — (Array<map>)

          The recurring charges for the reserved node.

          • RecurringChargeAmount — (Float)

            The amount charged per the period of time specified by the recurring charge frequency.

          • RecurringChargeFrequency — (String)

            The frequency at which the recurring charge amount is applied.

        • ReservedNodeOfferingType — (String)

          Possible values include:

          • "Regular"
          • "Upgradable"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeResize(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the describeResize operation

var params = {
  ClusterIdentifier: 'STRING_VALUE' /* required */
};
redshift.describeResize(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      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 Amazon Web Services account are returned.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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 | CANCELLING

      • ImportTablesCompleted — (Array<String>)

        The names of tables that have been completely imported .

        Valid Values: List of table names.

      • ImportTablesInProgress — (Array<String>)

        The names of tables that are being currently imported.

        Valid Values: List of table names.

      • ImportTablesNotStarted — (Array<String>)

        The names of tables that have not been yet imported.

        Valid Values: List of table names

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

      • DataTransferProgressPercent — (Float)

        The percent of data transferred from source cluster to target cluster.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeScheduledActions(params = {}, callback) ⇒ AWS.Request

Describes properties of scheduled actions.

Service Reference:

Examples:

Calling the describeScheduledActions operation

var params = {
  Active: true || false,
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  Filters: [
    {
      Name: cluster-identifier | iam-role, /* required */
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  ScheduledActionName: 'STRING_VALUE',
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  TargetActionType: ResizeCluster | PauseCluster | ResumeCluster
};
redshift.describeScheduledActions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ScheduledActionName — (String)

      The name of the scheduled action to retrieve.

    • TargetActionType — (String)

      The type of the scheduled actions to retrieve.

      Possible values include:
      • "ResizeCluster"
      • "PauseCluster"
      • "ResumeCluster"
    • StartTime — (Date)

      The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.

    • EndTime — (Date)

      The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.

    • Active — (Boolean)

      If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.

    • Filters — (Array<map>)

      List of scheduled action filters.

      • Name — required — (String)

        The type of element to filter.

        Possible values include:
        • "cluster-identifier"
        • "iam-role"
      • Values — required — (Array<String>)

        List of values. Compare if the value (of type defined by Name) equals an item in the list of scheduled actions.

    • Marker — (String)

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

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Marker — (String)

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

      • ScheduledActions — (Array<map>)

        List of retrieved scheduled actions.

        • ScheduledActionName — (String)

          The name of the scheduled action.

        • TargetAction — (map)

          A JSON format string of the Amazon Redshift API operation with input parameters.

          "{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}".

          • ResizeCluster — (map)

            An action that runs a ResizeCluster API operation.

            • ClusterIdentifier — required — (String)

              The unique identifier for the cluster to resize.

            • ClusterType — (String)

              The new cluster type for the specified cluster.

            • NodeType — (String)

              The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.

            • NumberOfNodes — (Integer)

              The new number of nodes for the cluster. If not specified, the cluster's current number of nodes is used.

            • Classic — (Boolean)

              A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false, the resize type is elastic.

          • PauseCluster — (map)

            An action that runs a PauseCluster API operation.

            • ClusterIdentifier — required — (String)

              The identifier of the cluster to be paused.

          • ResumeCluster — (map)

            An action that runs a ResumeCluster API operation.

            • ClusterIdentifier — required — (String)

              The identifier of the cluster to be resumed.

        • Schedule — (String)

          The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.

          Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, "at(2016-03-04T17:27:00)".

          Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year)". For example, "cron(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

        • IamRole — (String)

          The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.

        • ScheduledActionDescription — (String)

          The description of the scheduled action.

        • State — (String)

          The state of the scheduled action. For example, DISABLED.

          Possible values include:
          • "ACTIVE"
          • "DISABLED"
        • NextInvocations — (Array<Date>)

          List of times when the scheduled action will run.

        • StartTime — (Date)

          The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

        • EndTime — (Date)

          The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeSnapshotCopyGrants(params = {}, callback) ⇒ AWS.Request

Returns a list of snapshot copy grants owned by the Amazon Web Services account in the destination region.

For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

Service Reference:

Examples:

Calling the describeSnapshotCopyGrants operation

var params = {
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  SnapshotCopyGrantName: 'STRING_VALUE',
  TagKeys: [
    'STRING_VALUE',
    /* more items */
  ],
  TagValues: [
    'STRING_VALUE',
    /* more items */
  ]
};
redshift.describeSnapshotCopyGrants(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SnapshotCopyGrantName — (String)

      The name of the snapshot copy grant.

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • Marker — (String)

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

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

    • TagKeys — (Array<String>)

      A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.

    • TagValues — (Array<String>)

      A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Marker — (String)

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

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

      • SnapshotCopyGrants — (Array<map>)

        The list of SnapshotCopyGrant objects.

        • SnapshotCopyGrantName — (String)

          The name of the snapshot copy grant.

        • KmsKeyId — (String)

          The unique identifier of the customer master key (CMK) in Amazon Web Services KMS to which Amazon Redshift is granted permission.

        • Tags — (Array<map>)

          A list of tag instances.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeSnapshotSchedules(params = {}, callback) ⇒ AWS.Request

Returns a list of snapshot schedules.

Service Reference:

Examples:

Calling the describeSnapshotSchedules operation

var params = {
  ClusterIdentifier: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  ScheduleIdentifier: 'STRING_VALUE',
  TagKeys: [
    'STRING_VALUE',
    /* more items */
  ],
  TagValues: [
    'STRING_VALUE',
    /* more items */
  ]
};
redshift.describeSnapshotSchedules(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      The unique identifier for the cluster whose snapshot schedules you want to view.

    • ScheduleIdentifier — (String)

      A unique identifier for a snapshot schedule.

    • TagKeys — (Array<String>)

      The key value for a snapshot schedule tag.

    • TagValues — (Array<String>)

      The value corresponding to the key of the snapshot schedule tag.

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

    • MaxRecords — (Integer)

      The maximum number or 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SnapshotSchedules — (Array<map>)

        A list of SnapshotSchedules.

        • ScheduleDefinitions — (Array<String>)

          A list of ScheduleDefinitions.

        • ScheduleIdentifier — (String)

          A unique identifier for the schedule.

        • ScheduleDescription — (String)

          The description of the schedule.

        • Tags — (Array<map>)

          An optional set of tags describing the schedule.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • NextInvocations — (Array<Date>)

        • AssociatedClusterCount — (Integer)

          The number of clusters associated with the schedule.

        • AssociatedClusters — (Array<map>)

          A list of clusters associated with the schedule. A maximum of 100 clusters is returned.

          • ClusterIdentifier — (String)

          • ScheduleAssociationState — (String)

            Possible values include:

            • "MODIFYING"
            • "ACTIVE"
            • "FAILED"
      • 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.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeStorage(params = {}, callback) ⇒ AWS.Request

Returns account level backups storage size and provisional storage.

Service Reference:

Examples:

Calling the describeStorage operation

redshift.describeStorage(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TotalBackupSizeInMegaBytes — (Float)

        The total amount of storage currently used for snapshots.

      • TotalProvisionedStorageInMegaBytes — (Float)

        The total amount of storage currently provisioned.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeTableRestoreStatus(params = {}, callback) ⇒ AWS.Request

Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action. If you don't specify a value for the TableRestoreRequestId parameter, then DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of the table specified by TableRestoreRequestId.

Service Reference:

Examples:

Calling the describeTableRestoreStatus operation

var params = {
  ClusterIdentifier: 'STRING_VALUE',
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  TableRestoreRequestId: 'STRING_VALUE'
};
redshift.describeTableRestoreStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      The Amazon Redshift cluster that the table is being restored to.

    • TableRestoreRequestId — (String)

      The identifier of the table restore request to return status for. If you don't specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.

    • MaxRecords — (Integer)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

    • Marker — (String)

      An optional pagination token provided by a previous DescribeTableRestoreStatus request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TableRestoreStatusDetails — (Array<map>)

        A list of status details for one or more table restore requests.

        • TableRestoreRequestId — (String)

          The unique identifier for the table restore request.

        • Status — (String)

          A value that describes the current state of the table restore request.

          Valid Values: SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS

          Possible values include:
          • "PENDING"
          • "IN_PROGRESS"
          • "SUCCEEDED"
          • "FAILED"
          • "CANCELED"
        • Message — (String)

          A description of the status of the table restore request. Status values include SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS.

        • RequestTime — (Date)

          The time that the table restore request was made, in Universal Coordinated Time (UTC).

        • ProgressInMegaBytes — (Integer)

          The amount of data restored to the new table so far, in megabytes (MB).

        • TotalDataInMegaBytes — (Integer)

          The total amount of data to restore to the new table, in megabytes (MB).

        • ClusterIdentifier — (String)

          The identifier of the Amazon Redshift cluster that the table is being restored to.

        • SnapshotIdentifier — (String)

          The identifier of the snapshot that the table is being restored from.

        • SourceDatabaseName — (String)

          The name of the source database that contains the table being restored.

        • SourceSchemaName — (String)

          The name of the source schema that contains the table being restored.

        • SourceTableName — (String)

          The name of the source table being restored.

        • TargetDatabaseName — (String)

          The name of the database to restore the table to.

        • TargetSchemaName — (String)

          The name of the schema to restore the table to.

        • NewTableName — (String)

          The name of the table to create as a result of the table restore request.

      • Marker — (String)

        A pagination token that can be used in a subsequent DescribeTableRestoreStatus request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeTags(params = {}, callback) ⇒ AWS.Request

Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.

The following are limitations for DescribeTags:

  • You cannot specify an ARN and a resource-type value together in the same request.

  • You cannot use the MaxRecords and Marker parameters together with the ARN parameter.

  • The MaxRecords parameter can be a range from 10 to 50 results to return in a request.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources 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 resources that have any combination of those values are returned.

If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.

Service Reference:

Examples:

Calling the describeTags operation

var params = {
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  ResourceName: 'STRING_VALUE',
  ResourceType: 'STRING_VALUE',
  TagKeys: [
    'STRING_VALUE',
    /* more items */
  ],
  TagValues: [
    'STRING_VALUE',
    /* more items */
  ]
};
redshift.describeTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceName — (String)

      The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-2:123456789:cluster:t1.

    • ResourceType — (String)

      The type of resource with which you want to view tags. Valid resource types are:

      • Cluster

      • CIDR/IP

      • EC2 security group

      • Snapshot

      • Cluster security group

      • Subnet group

      • HSM connection

      • HSM certificate

      • Parameter group

      • Snapshot copy grant

      For more information about Amazon Redshift resource types and constructing ARNs, go to Specifying Policy Elements: Actions, Effects, Resources, and Principals in the Amazon Redshift Cluster Management Guide.

    • MaxRecords — (Integer)

      The maximum number or 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.

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

    • TagKeys — (Array<String>)

      A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.

    • TagValues — (Array<String>)

      A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TaggedResources — (Array<map>)

        A list of tags with their associated resources.

        • Tag — (map)

          The tag for the resource.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • ResourceName — (String)

          The Amazon Resource Name (ARN) with which the tag is associated, for example: arn:aws:redshift:us-east-2:123456789:cluster:t1.

        • ResourceType — (String)

          The type of resource with which the tag is associated. Valid resource types are:

          • Cluster

          • CIDR/IP

          • EC2 security group

          • Snapshot

          • Cluster security group

          • Subnet group

          • HSM connection

          • HSM certificate

          • Parameter group

          For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeUsageLimits(params = {}, callback) ⇒ AWS.Request

Shows usage limits on a cluster. Results are filtered based on the combination of input usage limit identifier, cluster identifier, and feature type parameters:

  • If usage limit identifier, cluster identifier, and feature type are not provided, then all usage limit objects for the current account in the current region are returned.

  • If usage limit identifier is provided, then the corresponding usage limit object is returned.

  • If cluster identifier is provided, then all usage limit objects for the specified cluster are returned.

  • If cluster identifier and feature type are provided, then all usage limit objects for the combination of cluster and feature are returned.

Service Reference:

Examples:

Calling the describeUsageLimits operation

var params = {
  ClusterIdentifier: 'STRING_VALUE',
  FeatureType: spectrum | concurrency-scaling,
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE',
  TagKeys: [
    'STRING_VALUE',
    /* more items */
  ],
  TagValues: [
    'STRING_VALUE',
    /* more items */
  ],
  UsageLimitId: 'STRING_VALUE'
};
redshift.describeUsageLimits(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • UsageLimitId — (String)

      The identifier of the usage limit to describe.

    • ClusterIdentifier — (String)

      The identifier of the cluster for which you want to describe usage limits.

    • FeatureType — (String)

      The feature type for which you want to describe usage limits.

      Possible values include:
      • "spectrum"
      • "concurrency-scaling"
    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • Marker — (String)

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

    • TagKeys — (Array<String>)

      A tag key or keys for which you want to return all matching usage limit objects that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the usage limit objects have either or both of these tag keys associated with them.

    • TagValues — (Array<String>)

      A tag value or values for which you want to return all matching usage limit objects that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the usage limit objects that have either or both of these tag values associated with them.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • UsageLimits — (Array<map>)

        Contains the output from the DescribeUsageLimits action.

        • UsageLimitId — (String)

          The identifier of the usage limit.

        • ClusterIdentifier — (String)

          The identifier of the cluster with a usage limit.

        • FeatureType — (String)

          The Amazon Redshift feature to which the limit applies.

          Possible values include:
          • "spectrum"
          • "concurrency-scaling"
        • LimitType — (String)

          The type of limit. Depending on the feature type, this can be based on a time duration or data size.

          Possible values include:
          • "time"
          • "data-scanned"
        • Amount — (Integer)

          The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).

        • Period — (String)

          The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

          Possible values include:
          • "daily"
          • "weekly"
          • "monthly"
        • BreachAction — (String)

          The action that Amazon Redshift takes when the limit is reached. Possible values are:

          • log - To log an event in a system table. The default is log.

          • emit-metric - To emit CloudWatch metrics.

          • disable - To disable the feature until the next usage period begins.

          Possible values include:
          • "log"
          • "emit-metric"
          • "disable"
        • Tags — (Array<map>)

          A list of tag instances.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

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

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

disableLogging(params = {}, callback) ⇒ AWS.Request

Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Service Reference:

Examples:

Calling the disableLogging operation

var params = {
  ClusterIdentifier: 'STRING_VALUE' /* required */
};
redshift.disableLogging(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      The identifier of the cluster on which logging is to be stopped.

      Example: examplecluster

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LoggingEnabled — (Boolean)

        true if logging is on, false if logging is off.

      • BucketName — (String)

        The name of the S3 bucket where the log files are stored.

      • S3KeyPrefix — (String)

        The prefix applied to the log file names.

      • LastSuccessfulDeliveryTime — (Date)

        The last time that logs were delivered.

      • LastFailureTime — (Date)

        The last time when logs failed to be delivered.

      • LastFailureMessage — (String)

        The message indicating that logs failed to be delivered.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

disableSnapshotCopy(params = {}, callback) ⇒ AWS.Request

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 Key Management Service, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the CMK in the destination region.

Service Reference:

Examples:

Calling the disableSnapshotCopy operation

var params = {
  ClusterIdentifier: 'STRING_VALUE' /* required */
};
redshift.disableSnapshotCopy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        Describes a cluster.

        • ClusterIdentifier — (String)

          The unique identifier of the cluster.

        • NodeType — (String)

          The node type for the nodes in the cluster.

        • ClusterStatus — (String)

          The current state of the cluster. Possible values are the following:

          • available

          • available, prep-for-resize

          • available, resize-cleanup

          • cancelling-resize

          • creating

          • deleting

          • final-snapshot

          • hardware-failure

          • incompatible-hsm

          • incompatible-network

          • incompatible-parameters

          • incompatible-restore

          • modifying

          • paused

          • rebooting

          • renaming

          • resizing

          • rotating-keys

          • storage-full

          • updating-hsm

        • ClusterAvailabilityStatus — (String)

          The availability status of the cluster for queries. Possible values are the following:

          • Available - The cluster is available for queries.

          • Unavailable - The cluster is not available for queries.

          • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

          • Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.

          • Failed - The cluster failed and is not available for queries.

        • ModifyStatus — (String)

          The status of a modify operation, if any, initiated for the cluster.

        • MasterUsername — (String)

          The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

        • DBName — (String)

          The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

        • Endpoint — (map)

          The connection endpoint.

          • Address — (String)

            The DNS address of the Cluster.

          • Port — (Integer)

            The port that the database engine is listening on.

          • VpcEndpoints — (Array<map>)

            Describes a connection endpoint.

            • VpcEndpointId — (String)

              The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

            • VpcId — (String)

              The VPC identifier that the endpoint is associated.

            • NetworkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • NetworkInterfaceId — (String)

                The network interface identifier.

              • SubnetId — (String)

                The subnet identifier.

              • PrivateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • AvailabilityZone — (String)

                The Availability Zone.

        • ClusterCreateTime — (Date)

          The date and time that the cluster was created.

        • AutomatedSnapshotRetentionPeriod — (Integer)

          The number of days that automatic cluster snapshots are retained.

        • ManualSnapshotRetentionPeriod — (Integer)

          The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

          The value must be either -1 or an integer between 1 and 3,653.

        • ClusterSecurityGroups — (Array<map>)

          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.

          • ClusterSecurityGroupName — (String)

            The name of the cluster security group.

          • Status — (String)

            The status of the cluster security group.

        • VpcSecurityGroups — (Array<map>)

          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.

          • VpcSecurityGroupId — (String)

            The identifier of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • ClusterParameterGroups — (Array<map>)

          The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

          • ParameterGroupName — (String)

            The name of the cluster parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • ClusterParameterStatusList — (Array<map>)

            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.

            • 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 — (map)

          A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

          • MasterUserPassword — (String)

            The pending or in-progress change of the admin user password for the cluster.

          • NodeType — (String)

            The pending or in-progress change of the cluster's node type.

          • NumberOfNodes — (Integer)

            The pending or in-progress change of the number of nodes in the cluster.

          • ClusterType — (String)

            The pending or in-progress change of the cluster type.

          • ClusterVersion — (String)

            The pending or in-progress change of the service version.

          • AutomatedSnapshotRetentionPeriod — (Integer)

            The pending or in-progress change of the automated snapshot retention period.

          • ClusterIdentifier — (String)

            The pending or in-progress change of the new identifier for the cluster.

          • PubliclyAccessible — (Boolean)

            The pending or in-progress change of the ability to connect to the cluster from the public network.

          • EnhancedVpcRouting — (Boolean)

            An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

            Default: false

          • MaintenanceTrackName — (String)

            The name of the maintenance track that the cluster will change to during the next maintenance window.

          • EncryptionType — (String)

            The encryption type for a cluster. Possible values are: KMS and None.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • AllowVersionUpgrade — (Boolean)

          A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

        • NumberOfNodes — (Integer)

          The number of compute nodes in the cluster.

        • PubliclyAccessible — (Boolean)

          A boolean value that, if true, indicates that the cluster can be accessed from a public network.

        • Encrypted — (Boolean)

          A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

        • RestoreStatus — (map)

          A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

          • Status — (String)

            The status of the restore action. Returns starting, restoring, completed, or failed.

          • CurrentRestoreRateInMegaBytesPerSecond — (Float)

            The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.

          • SnapshotSizeInMegaBytes — (Integer)

            The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

          • ProgressInMegaBytes — (Integer)

            The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

          • ElapsedTimeInSeconds — (Integer)

            The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.

        • DataTransferProgress — (map)

          • Status — (String)

            Describes the status of the cluster. While the transfer is in progress the status is transferringdata.

          • CurrentRateInMegaBytesPerSecond — (Float)

            Describes the data transfer rate in MB's per second.

          • TotalDataInMegaBytes — (Integer)

            Describes the total amount of data to be transfered in megabytes.

          • DataTransferredInMegaBytes — (Integer)

            Describes the total amount of data that has been transfered in MB's.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            Describes the estimated number of seconds remaining to complete the transfer.

          • ElapsedTimeInSeconds — (Integer)

            Describes the number of seconds that have elapsed during the data transfer.

        • HsmStatus — (map)

          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 — (map)

          A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

          • DestinationRegion — (String)

            The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

          • RetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

          • ManualSnapshotRetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.

            The value must be either -1 or an integer between 1 and 3,653.

          • SnapshotCopyGrantName — (String)

            The name of the snapshot copy grant.

        • ClusterPublicKey — (String)

          The public key for the cluster.

        • ClusterNodes — (Array<map>)

          The nodes in the 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 — (map)

          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 — (Array<map>)

          The list of tags for the cluster.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

        • EnhancedVpcRouting — (Boolean)

          An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

          Default: false

        • IamRoles — (Array<map>)

          A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

          • IamRoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

          • ApplyStatus — (String)

            A value that describes the status of the IAM role's association with an Amazon Redshift cluster.

            The following are possible statuses and descriptions.

            • in-sync: The role is available for use by the cluster.

            • adding: The role is in the process of being associated with the cluster.

            • removing: The role is in the process of being disassociated with the cluster.

        • PendingActions — (Array<String>)

          Cluster operations that are waiting to be started.

        • MaintenanceTrackName — (String)

          The name of the maintenance track for the cluster.

        • ElasticResizeNumberOfNodeOptions — (String)

          The number of nodes that you can resize the cluster to with the elastic resize method.

        • DeferredMaintenanceWindows — (Array<map>)

          Describes a group of DeferredMaintenanceWindow objects.

          • DeferMaintenanceIdentifier — (String)

            A unique identifier for the maintenance window.

          • DeferMaintenanceStartTime — (Date)

            A timestamp for the beginning of the time period when we defer maintenance.

          • DeferMaintenanceEndTime — (Date)

            A timestamp for the end of the time period when we defer maintenance.

        • SnapshotScheduleIdentifier — (String)

          A unique identifier for the cluster snapshot schedule.

        • SnapshotScheduleState — (String)

          The current state of the cluster snapshot schedule.

          Possible values include:
          • "MODIFYING"
          • "ACTIVE"
          • "FAILED"
        • ExpectedNextSnapshotScheduleTime — (Date)

          The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

        • ExpectedNextSnapshotScheduleTimeStatus — (String)

          The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

          • OnTrack - The next snapshot is expected to be taken on time.

          • Pending - The next snapshot is pending to be taken.

        • NextMaintenanceWindowStartTime — (Date)

          The date and time in UTC when system maintenance can begin.

        • ResizeInfo — (map)

          Returns the following:

          • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

          • ResizeType: Returns ClassicResize

          • ResizeType — (String)

            Returns the value ClassicResize.

          • AllowCancelResize — (Boolean)

            A boolean value indicating if the resize operation can be cancelled.

        • AvailabilityZoneRelocationStatus — (String)

          Describes the status of the Availability Zone relocation operation.

        • ClusterNamespaceArn — (String)

          The namespace Amazon Resource Name (ARN) of the cluster.

        • TotalStorageCapacityInMegaBytes — (Integer)

          The total storage capacity of the cluster in megabytes.

        • AquaConfiguration — (map)

          The AQUA (Advanced Query Accelerator) configuration of the cluster.

          • AquaStatus — (String)

            The value indicates the status of AQUA on the cluster. Possible values include the following.

            • enabled - AQUA is enabled.

            • disabled - AQUA is not enabled.

            • applying - AQUA status is being applied.

            Possible values include:
            • "enabled"
            • "disabled"
            • "applying"
          • AquaConfigurationStatus — (String)

            The value represents how the cluster is configured to use AQUA. Possible values include the following.

            • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

            • disabled - Don't use AQUA.

            • auto - Amazon Redshift determines whether to use AQUA.

            Possible values include:
            • "enabled"
            • "disabled"
            • "auto"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

disassociateDataShareConsumer(params = {}, callback) ⇒ AWS.Request

From a consumer account, remove association for the specified datashare.

Service Reference:

Examples:

Calling the disassociateDataShareConsumer operation

var params = {
  DataShareArn: 'STRING_VALUE', /* required */
  ConsumerArn: 'STRING_VALUE',
  DisassociateEntireAccount: true || false
};
redshift.disassociateDataShareConsumer(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DataShareArn — (String)

      The Amazon Resource Name (ARN) of the datashare to remove association for.

    • DisassociateEntireAccount — (Boolean)

      A value that specifies whether association for the datashare is removed from the entire account.

    • ConsumerArn — (String)

      The Amazon Resource Name (ARN) of the consumer that association for the datashare is removed from.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DataShareArn — (String)

        An Amazon Resource Name (ARN) that references the datashare that is owned by a specific namespace of the producer cluster. A datashare ARN is in the arn:aws:redshift:{region}:{account-id}:{datashare}:{namespace-guid}/{datashare-name} format.

      • ProducerArn — (String)

        The Amazon Resource Name (ARN) of the producer.

      • AllowPubliclyAccessibleConsumers — (Boolean)

        A value that specifies whether the datashare can be shared to a publicly accessible cluster.

      • DataShareAssociations — (Array<map>)

        A value that specifies when the datashare has an association between a producer and data consumers.

        • ConsumerIdentifier — (String)

          The name of the consumer accounts that have an association with a producer datashare.

        • Status — (String)

          The status of the datashare that is associated.

          Possible values include:
          • "ACTIVE"
          • "PENDING_AUTHORIZATION"
          • "AUTHORIZED"
          • "DEAUTHORIZED"
          • "REJECTED"
          • "AVAILABLE"
        • CreatedDate — (Date)

          The creation date of the datashare that is associated.

        • StatusChangeDate — (Date)

          The status change data of the datashare that is associated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

enableLogging(params = {}, callback) ⇒ AWS.Request

Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Service Reference:

Examples:

Calling the enableLogging operation

var params = {
  BucketName: 'STRING_VALUE', /* required */
  ClusterIdentifier: 'STRING_VALUE', /* required */
  S3KeyPrefix: 'STRING_VALUE'
};
redshift.enableLogging(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      The identifier of the cluster on which logging is to be started.

      Example: examplecluster

    • BucketName — (String)

      The name of an existing S3 bucket where the log files are to be stored.

      Constraints:

      • Must be in the same region as the cluster

      • The cluster must have read bucket and put object permissions

    • S3KeyPrefix — (String)

      The prefix applied to the log file names.

      Constraints:

      • Cannot exceed 512 characters

      • Cannot contain spaces( ), double quotes ("), single quotes ('), a backslash (), or control characters. The hexadecimal codes for invalid characters are:

        • x00 to x20

        • x22

        • x27

        • x5c

        • x7f or larger

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LoggingEnabled — (Boolean)

        true if logging is on, false if logging is off.

      • BucketName — (String)

        The name of the S3 bucket where the log files are stored.

      • S3KeyPrefix — (String)

        The prefix applied to the log file names.

      • LastSuccessfulDeliveryTime — (Date)

        The last time that logs were delivered.

      • LastFailureTime — (Date)

        The last time when logs failed to be delivered.

      • LastFailureMessage — (String)

        The message indicating that logs failed to be delivered.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

enableSnapshotCopy(params = {}, callback) ⇒ AWS.Request

Enables the automatic copy of snapshots from one region to another region for a specified cluster.

Service Reference:

Examples:

Calling the enableSnapshotCopy operation

var params = {
  ClusterIdentifier: 'STRING_VALUE', /* required */
  DestinationRegion: 'STRING_VALUE', /* required */
  ManualSnapshotRetentionPeriod: 'NUMBER_VALUE',
  RetentionPeriod: 'NUMBER_VALUE',
  SnapshotCopyGrantName: 'STRING_VALUE'
};
redshift.enableSnapshotCopy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      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.

    • DestinationRegion — (String)

      The destination Amazon Web Services Region that you want to copy snapshots to.

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

    • RetentionPeriod — (Integer)

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

      Default: 7.

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

    • SnapshotCopyGrantName — (String)

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

    • ManualSnapshotRetentionPeriod — (Integer)

      The number of days to retain newly copied snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region. If the value is -1, the manual snapshot is retained indefinitely.

      The value must be either -1 or an integer between 1 and 3,653.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        Describes a cluster.

        • ClusterIdentifier — (String)

          The unique identifier of the cluster.

        • NodeType — (String)

          The node type for the nodes in the cluster.

        • ClusterStatus — (String)

          The current state of the cluster. Possible values are the following:

          • available

          • available, prep-for-resize

          • available, resize-cleanup

          • cancelling-resize

          • creating

          • deleting

          • final-snapshot

          • hardware-failure

          • incompatible-hsm

          • incompatible-network

          • incompatible-parameters

          • incompatible-restore

          • modifying

          • paused

          • rebooting

          • renaming

          • resizing

          • rotating-keys

          • storage-full

          • updating-hsm

        • ClusterAvailabilityStatus — (String)

          The availability status of the cluster for queries. Possible values are the following:

          • Available - The cluster is available for queries.

          • Unavailable - The cluster is not available for queries.

          • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

          • Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.

          • Failed - The cluster failed and is not available for queries.

        • ModifyStatus — (String)

          The status of a modify operation, if any, initiated for the cluster.

        • MasterUsername — (String)

          The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

        • DBName — (String)

          The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

        • Endpoint — (map)

          The connection endpoint.

          • Address — (String)

            The DNS address of the Cluster.

          • Port — (Integer)

            The port that the database engine is listening on.

          • VpcEndpoints — (Array<map>)

            Describes a connection endpoint.

            • VpcEndpointId — (String)

              The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

            • VpcId — (String)

              The VPC identifier that the endpoint is associated.

            • NetworkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • NetworkInterfaceId — (String)

                The network interface identifier.

              • SubnetId — (String)

                The subnet identifier.

              • PrivateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • AvailabilityZone — (String)

                The Availability Zone.

        • ClusterCreateTime — (Date)

          The date and time that the cluster was created.

        • AutomatedSnapshotRetentionPeriod — (Integer)

          The number of days that automatic cluster snapshots are retained.

        • ManualSnapshotRetentionPeriod — (Integer)

          The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

          The value must be either -1 or an integer between 1 and 3,653.

        • ClusterSecurityGroups — (Array<map>)

          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.

          • ClusterSecurityGroupName — (String)

            The name of the cluster security group.

          • Status — (String)

            The status of the cluster security group.

        • VpcSecurityGroups — (Array<map>)

          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.

          • VpcSecurityGroupId — (String)

            The identifier of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • ClusterParameterGroups — (Array<map>)

          The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

          • ParameterGroupName — (String)

            The name of the cluster parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • ClusterParameterStatusList — (Array<map>)

            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.

            • 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 — (map)

          A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

          • MasterUserPassword — (String)

            The pending or in-progress change of the admin user password for the cluster.

          • NodeType — (String)

            The pending or in-progress change of the cluster's node type.

          • NumberOfNodes — (Integer)

            The pending or in-progress change of the number of nodes in the cluster.

          • ClusterType — (String)

            The pending or in-progress change of the cluster type.

          • ClusterVersion — (String)

            The pending or in-progress change of the service version.

          • AutomatedSnapshotRetentionPeriod — (Integer)

            The pending or in-progress change of the automated snapshot retention period.

          • ClusterIdentifier — (String)

            The pending or in-progress change of the new identifier for the cluster.

          • PubliclyAccessible — (Boolean)

            The pending or in-progress change of the ability to connect to the cluster from the public network.

          • EnhancedVpcRouting — (Boolean)

            An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

            Default: false

          • MaintenanceTrackName — (String)

            The name of the maintenance track that the cluster will change to during the next maintenance window.

          • EncryptionType — (String)

            The encryption type for a cluster. Possible values are: KMS and None.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • AllowVersionUpgrade — (Boolean)

          A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

        • NumberOfNodes — (Integer)

          The number of compute nodes in the cluster.

        • PubliclyAccessible — (Boolean)

          A boolean value that, if true, indicates that the cluster can be accessed from a public network.

        • Encrypted — (Boolean)

          A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

        • RestoreStatus — (map)

          A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

          • Status — (String)

            The status of the restore action. Returns starting, restoring, completed, or failed.

          • CurrentRestoreRateInMegaBytesPerSecond — (Float)

            The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.

          • SnapshotSizeInMegaBytes — (Integer)

            The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

          • ProgressInMegaBytes — (Integer)

            The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

          • ElapsedTimeInSeconds — (Integer)

            The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.

        • DataTransferProgress — (map)

          • Status — (String)

            Describes the status of the cluster. While the transfer is in progress the status is transferringdata.

          • CurrentRateInMegaBytesPerSecond — (Float)

            Describes the data transfer rate in MB's per second.

          • TotalDataInMegaBytes — (Integer)

            Describes the total amount of data to be transfered in megabytes.

          • DataTransferredInMegaBytes — (Integer)

            Describes the total amount of data that has been transfered in MB's.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            Describes the estimated number of seconds remaining to complete the transfer.

          • ElapsedTimeInSeconds — (Integer)

            Describes the number of seconds that have elapsed during the data transfer.

        • HsmStatus — (map)

          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 — (map)

          A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

          • DestinationRegion — (String)

            The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

          • RetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

          • ManualSnapshotRetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.

            The value must be either -1 or an integer between 1 and 3,653.

          • SnapshotCopyGrantName — (String)

            The name of the snapshot copy grant.

        • ClusterPublicKey — (String)

          The public key for the cluster.

        • ClusterNodes — (Array<map>)

          The nodes in the 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 — (map)

          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 — (Array<map>)

          The list of tags for the cluster.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

        • EnhancedVpcRouting — (Boolean)

          An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

          Default: false

        • IamRoles — (Array<map>)

          A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

          • IamRoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

          • ApplyStatus — (String)

            A value that describes the status of the IAM role's association with an Amazon Redshift cluster.

            The following are possible statuses and descriptions.

            • in-sync: The role is available for use by the cluster.

            • adding: The role is in the process of being associated with the cluster.

            • removing: The role is in the process of being disassociated with the cluster.

        • PendingActions — (Array<String>)

          Cluster operations that are waiting to be started.

        • MaintenanceTrackName — (String)

          The name of the maintenance track for the cluster.

        • ElasticResizeNumberOfNodeOptions — (String)

          The number of nodes that you can resize the cluster to with the elastic resize method.

        • DeferredMaintenanceWindows — (Array<map>)

          Describes a group of DeferredMaintenanceWindow objects.

          • DeferMaintenanceIdentifier — (String)

            A unique identifier for the maintenance window.

          • DeferMaintenanceStartTime — (Date)

            A timestamp for the beginning of the time period when we defer maintenance.

          • DeferMaintenanceEndTime — (Date)

            A timestamp for the end of the time period when we defer maintenance.

        • SnapshotScheduleIdentifier — (String)

          A unique identifier for the cluster snapshot schedule.

        • SnapshotScheduleState — (String)

          The current state of the cluster snapshot schedule.

          Possible values include:
          • "MODIFYING"
          • "ACTIVE"
          • "FAILED"
        • ExpectedNextSnapshotScheduleTime — (Date)

          The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

        • ExpectedNextSnapshotScheduleTimeStatus — (String)

          The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

          • OnTrack - The next snapshot is expected to be taken on time.

          • Pending - The next snapshot is pending to be taken.

        • NextMaintenanceWindowStartTime — (Date)

          The date and time in UTC when system maintenance can begin.

        • ResizeInfo — (map)

          Returns the following:

          • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

          • ResizeType: Returns ClassicResize

          • ResizeType — (String)

            Returns the value ClassicResize.

          • AllowCancelResize — (Boolean)

            A boolean value indicating if the resize operation can be cancelled.

        • AvailabilityZoneRelocationStatus — (String)

          Describes the status of the Availability Zone relocation operation.

        • ClusterNamespaceArn — (String)

          The namespace Amazon Resource Name (ARN) of the cluster.

        • TotalStorageCapacityInMegaBytes — (Integer)

          The total storage capacity of the cluster in megabytes.

        • AquaConfiguration — (map)

          The AQUA (Advanced Query Accelerator) configuration of the cluster.

          • AquaStatus — (String)

            The value indicates the status of AQUA on the cluster. Possible values include the following.

            • enabled - AQUA is enabled.

            • disabled - AQUA is not enabled.

            • applying - AQUA status is being applied.

            Possible values include:
            • "enabled"
            • "disabled"
            • "applying"
          • AquaConfigurationStatus — (String)

            The value represents how the cluster is configured to use AQUA. Possible values include the following.

            • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

            • disabled - Don't use AQUA.

            • auto - Amazon Redshift determines whether to use AQUA.

            Possible values include:
            • "enabled"
            • "disabled"
            • "auto"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getClusterCredentials(params = {}, callback) ⇒ AWS.Request

Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with IAM: if AutoCreate is False or IAMA: if AutoCreate is True. You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Using IAM Authentication to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.

The Identity and Access Management (IAM) user or role that runs GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide.

If the DbGroups parameter is specified, the IAM policy must allow the redshift:JoinGroup action with access to the listed dbgroups.

In addition, if the AutoCreate parameter is set to True, then the policy must include the redshift:CreateClusterUser privilege.

If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.

Service Reference:

Examples:

Calling the getClusterCredentials operation

var params = {
  ClusterIdentifier: 'STRING_VALUE', /* required */
  DbUser: 'STRING_VALUE', /* required */
  AutoCreate: true || false,
  DbGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  DbName: 'STRING_VALUE',
  DurationSeconds: 'NUMBER_VALUE'
};
redshift.getClusterCredentials(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DbUser — (String)

      The name of a database user. If a user name matching DbUser exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser doesn't exist in the database and Autocreate is True, a new user is created using the value for DbUser with PUBLIC permissions. If a database user matching the value for DbUser doesn't exist and Autocreate is False, then the command succeeds but the connection attempt will fail because the user doesn't exist in the database.

      For more information, see CREATE USER in the Amazon Redshift Database Developer Guide.

      Constraints:

      • Must be 1 to 64 alphanumeric characters or hyphens. The user name can't be PUBLIC.

      • Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

      • First character must be a letter.

      • Must not contain a colon ( : ) or slash ( / ).

      • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

    • DbName — (String)

      The name of a database that DbUser is authorized to log on to. If DbName is not specified, DbUser can log on to any existing database.

      Constraints:

      • Must be 1 to 64 alphanumeric characters or hyphens

      • Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

      • First character must be a letter.

      • Must not contain a colon ( : ) or slash ( / ).

      • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

    • ClusterIdentifier — (String)

      The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive.

    • DurationSeconds — (Integer)

      The number of seconds until the returned temporary password expires.

      Constraint: minimum 900, maximum 3600.

      Default: 900

    • AutoCreate — (Boolean)

      Create a database user with the name specified for the user named in DbUser if one does not exist.

    • DbGroups — (Array<String>)

      A list of the names of existing database groups that the user named in DbUser will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC.

      Database group name constraints

      • Must be 1 to 64 alphanumeric characters or hyphens

      • Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

      • First character must be a letter.

      • Must not contain a colon ( : ) or slash ( / ).

      • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DbUser — (String)

        A database user name that is authorized to log on to the database DbName using the password DbPassword. If the specified DbUser exists in the database, the new user name has the same database privileges as the the user named in DbUser. By default, the user is added to PUBLIC. If the DbGroups parameter is specifed, DbUser is added to the listed groups for any sessions created using these credentials.

      • DbPassword — (String)

        A temporary password that authorizes the user name returned by DbUser to log on to the database DbName.

      • Expiration — (Date)

        The date and time the password in DbPassword expires.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getReservedNodeExchangeOfferings(params = {}, callback) ⇒ AWS.Request

Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.

Service Reference:

Examples:

Calling the getReservedNodeExchangeOfferings operation

var params = {
  ReservedNodeId: 'STRING_VALUE', /* required */
  Marker: 'STRING_VALUE',
  MaxRecords: 'NUMBER_VALUE'
};
redshift.getReservedNodeExchangeOfferings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ReservedNodeId — (String)

      A string representing the node identifier for the DC1 Reserved Node to be exchanged.

    • MaxRecords — (Integer)

      An integer setting the maximum number of ReservedNodeOfferings to retrieve.

    • Marker — (String)

      A value that indicates the starting point for the next set of ReservedNodeOfferings.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Marker — (String)

        An optional parameter that specifies the starting point for returning a set of response records. When the results of a GetReservedNodeExchangeOfferings request exceed the value specified in MaxRecords, Amazon Redshift 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.

      • ReservedNodeOfferings — (Array<map>)

        Returns an array of ReservedNodeOffering objects.

        • ReservedNodeOfferingId — (String)

          The offering identifier.

        • NodeType — (String)

          The node type offered by the reserved node offering.

        • Duration — (Integer)

          The duration, in seconds, for which the offering will reserve the node.

        • FixedPrice — (Float)

          The upfront fixed charge you will pay to purchase the specific reserved node offering.

        • UsagePrice — (Float)

          The rate you are charged for each hour the cluster that is using the offering is running.

        • CurrencyCode — (String)

          The currency code for the compute nodes offering.

        • OfferingType — (String)

          The anticipated utilization of the reserved node, as defined in the reserved node offering.

        • RecurringCharges — (Array<map>)

          The charge to your account regardless of whether you are creating any clusters using the node offering. Recurring charges are only in effect for heavy-utilization reserved nodes.

          • RecurringChargeAmount — (Float)

            The amount charged per the period of time specified by the recurring charge frequency.

          • RecurringChargeFrequency — (String)

            The frequency at which the recurring charge amount is applied.

        • ReservedNodeOfferingType — (String)

          Possible values include:

          • "Regular"
          • "Upgradable"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyAquaConfiguration(params = {}, callback) ⇒ AWS.Request

Modifies whether a cluster can use AQUA (Advanced Query Accelerator).

Service Reference:

Examples:

Calling the modifyAquaConfiguration operation

var params = {
  ClusterIdentifier: 'STRING_VALUE', /* required */
  AquaConfigurationStatus: enabled | disabled | auto
};
redshift.modifyAquaConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      The identifier of the cluster to be modified.

    • AquaConfigurationStatus — (String)

      The new value of AQUA configuration status. Possible values include the following.

      • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

      • disabled - Don't use AQUA.

      • auto - Amazon Redshift determines whether to use AQUA.

      Possible values include:
      • "enabled"
      • "disabled"
      • "auto"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AquaConfiguration — (map)

        The updated AQUA configuration of the cluster.

        • AquaStatus — (String)

          The value indicates the status of AQUA on the cluster. Possible values include the following.

          • enabled - AQUA is enabled.

          • disabled - AQUA is not enabled.

          • applying - AQUA status is being applied.

          Possible values include:
          • "enabled"
          • "disabled"
          • "applying"
        • AquaConfigurationStatus — (String)

          The value represents how the cluster is configured to use AQUA. Possible values include the following.

          • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

          • disabled - Don't use AQUA.

          • auto - Amazon Redshift determines whether to use AQUA.

          Possible values include:
          • "enabled"
          • "disabled"
          • "auto"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyAuthenticationProfile(params = {}, callback) ⇒ AWS.Request

Modifies an authentication profile.

Service Reference:

Examples:

Calling the modifyAuthenticationProfile operation

var params = {
  AuthenticationProfileContent: 'STRING_VALUE', /* required */
  AuthenticationProfileName: 'STRING_VALUE' /* required */
};
redshift.modifyAuthenticationProfile(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AuthenticationProfileName — (String)

      The name of the authentication profile to replace.

    • AuthenticationProfileContent — (String)

      The new content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AuthenticationProfileName — (String)

        The name of the authentication profile that was replaced.

      • AuthenticationProfileContent — (String)

        The updated content of the authentication profile in JSON format.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyCluster(params = {}, callback) ⇒ AWS.Request

Modifies the settings for a cluster.

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

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

Service Reference:

Examples:

Calling the modifyCluster operation

var params = {
  ClusterIdentifier: 'STRING_VALUE', /* required */
  AllowVersionUpgrade: true || false,
  AutomatedSnapshotRetentionPeriod: 'NUMBER_VALUE',
  AvailabilityZone: 'STRING_VALUE',
  AvailabilityZoneRelocation: true || false,
  ClusterParameterGroupName: 'STRING_VALUE',
  ClusterSecurityGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  ClusterType: 'STRING_VALUE',
  ClusterVersion: 'STRING_VALUE',
  ElasticIp: 'STRING_VALUE',
  Encrypted: true || false,
  EnhancedVpcRouting: true || false,
  HsmClientCertificateIdentifier: 'STRING_VALUE',
  HsmConfigurationIdentifier: 'STRING_VALUE',
  KmsKeyId: 'STRING_VALUE',
  MaintenanceTrackName: 'STRING_VALUE',
  ManualSnapshotRetentionPeriod: 'NUMBER_VALUE',
  MasterUserPassword: 'STRING_VALUE',
  NewClusterIdentifier: 'STRING_VALUE',
  NodeType: 'STRING_VALUE',
  NumberOfNodes: 'NUMBER_VALUE',
  Port: 'NUMBER_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  PubliclyAccessible: true || false,
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
redshift.modifyCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      The unique identifier of the cluster to be modified.

      Example: examplecluster

    • ClusterType — (String)

      The new cluster type.

      When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.

      Valid Values: multi-node | single-node

    • NodeType — (String)

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

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

      Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge

    • NumberOfNodes — (Integer)

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

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

      Valid Values: Integer greater than 0.

    • ClusterSecurityGroups — (Array<String>)

      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

    • VpcSecurityGroupIds — (Array<String>)

      A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is asynchronously applied as soon as possible.

    • MasterUserPassword — (String)

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

      Note: Operations never return the password, so this operation provides a way to regain access to the admin user account for a cluster if the password is lost.

      Default: Uses existing setting.

      Constraints:

      • Must be between 8 and 64 characters in length.

      • Must contain at least one uppercase letter.

      • Must contain at least one lowercase letter.

      • Must contain one number.

      • Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.

    • ClusterParameterGroupName — (String)

      The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster.

      Default: Uses existing setting.

      Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.

    • AutomatedSnapshotRetentionPeriod — (Integer)

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

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

      You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.

      Default: Uses existing setting.

      Constraints: Must be a value from 0 to 35.

    • ManualSnapshotRetentionPeriod — (Integer)

      The default for number of days that a newly created manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. This value doesn't retroactively change the retention periods of existing manual snapshots.

      The value must be either -1 or an integer between 1 and 3,653.

      The default value is -1.

    • PreferredMaintenanceWindow — (String)

      The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage.

      This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied.

      Default: Uses existing setting.

      Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.

      Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

      Constraints: Must be at least 30 minutes.

    • ClusterVersion — (String)

      The new version number of the Amazon Redshift engine to upgrade to.

      For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

      Example: 1.0

    • AllowVersionUpgrade — (Boolean)

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

      Default: false

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

    • NewClusterIdentifier — (String)

      The new identifier for the cluster.

      Constraints:

      • Must contain from 1 to 63 alphanumeric characters or hyphens.

      • Alphabetic characters must be lowercase.

      • First character must be a letter.

      • Cannot end with a hyphen or contain two consecutive hyphens.

      • Must be unique for all clusters within an Amazon Web Services account.

      Example: examplecluster

    • PubliclyAccessible — (Boolean)

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

    • ElasticIp — (String)

      The Elastic IP (EIP) address for the cluster.

      Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

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

    • Encrypted — (Boolean)

      Indicates whether the cluster is encrypted. If the value is encrypted (true) and you provide a value for the KmsKeyId parameter, we encrypt the cluster with the provided KmsKeyId. If you don't provide a KmsKeyId, we encrypt with the default key.

      If the value is not encrypted (false), then the cluster is decrypted.

    • KmsKeyId — (String)

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

    • AvailabilityZoneRelocation — (Boolean)

      The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete.

    • AvailabilityZone — (String)

      The option to initiate relocation for an Amazon Redshift cluster to the target Availability Zone.

    • Port — (Integer)

      The option to change the port of an Amazon Redshift cluster.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        Describes a cluster.

        • ClusterIdentifier — (String)

          The unique identifier of the cluster.

        • NodeType — (String)

          The node type for the nodes in the cluster.

        • ClusterStatus — (String)

          The current state of the cluster. Possible values are the following:

          • available

          • available, prep-for-resize

          • available, resize-cleanup

          • cancelling-resize

          • creating

          • deleting

          • final-snapshot

          • hardware-failure

          • incompatible-hsm

          • incompatible-network

          • incompatible-parameters

          • incompatible-restore

          • modifying

          • paused

          • rebooting

          • renaming

          • resizing

          • rotating-keys

          • storage-full

          • updating-hsm

        • ClusterAvailabilityStatus — (String)

          The availability status of the cluster for queries. Possible values are the following:

          • Available - The cluster is available for queries.

          • Unavailable - The cluster is not available for queries.

          • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

          • Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.

          • Failed - The cluster failed and is not available for queries.

        • ModifyStatus — (String)

          The status of a modify operation, if any, initiated for the cluster.

        • MasterUsername — (String)

          The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

        • DBName — (String)

          The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

        • Endpoint — (map)

          The connection endpoint.

          • Address — (String)

            The DNS address of the Cluster.

          • Port — (Integer)

            The port that the database engine is listening on.

          • VpcEndpoints — (Array<map>)

            Describes a connection endpoint.

            • VpcEndpointId — (String)

              The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

            • VpcId — (String)

              The VPC identifier that the endpoint is associated.

            • NetworkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • NetworkInterfaceId — (String)

                The network interface identifier.

              • SubnetId — (String)

                The subnet identifier.

              • PrivateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • AvailabilityZone — (String)

                The Availability Zone.

        • ClusterCreateTime — (Date)

          The date and time that the cluster was created.

        • AutomatedSnapshotRetentionPeriod — (Integer)

          The number of days that automatic cluster snapshots are retained.

        • ManualSnapshotRetentionPeriod — (Integer)

          The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

          The value must be either -1 or an integer between 1 and 3,653.

        • ClusterSecurityGroups — (Array<map>)

          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.

          • ClusterSecurityGroupName — (String)

            The name of the cluster security group.

          • Status — (String)

            The status of the cluster security group.

        • VpcSecurityGroups — (Array<map>)

          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.

          • VpcSecurityGroupId — (String)

            The identifier of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • ClusterParameterGroups — (Array<map>)

          The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

          • ParameterGroupName — (String)

            The name of the cluster parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • ClusterParameterStatusList — (Array<map>)

            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.

            • 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 — (map)

          A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

          • MasterUserPassword — (String)

            The pending or in-progress change of the admin user password for the cluster.

          • NodeType — (String)

            The pending or in-progress change of the cluster's node type.

          • NumberOfNodes — (Integer)

            The pending or in-progress change of the number of nodes in the cluster.

          • ClusterType — (String)

            The pending or in-progress change of the cluster type.

          • ClusterVersion — (String)

            The pending or in-progress change of the service version.

          • AutomatedSnapshotRetentionPeriod — (Integer)

            The pending or in-progress change of the automated snapshot retention period.

          • ClusterIdentifier — (String)

            The pending or in-progress change of the new identifier for the cluster.

          • PubliclyAccessible — (Boolean)

            The pending or in-progress change of the ability to connect to the cluster from the public network.

          • EnhancedVpcRouting — (Boolean)

            An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

            Default: false

          • MaintenanceTrackName — (String)

            The name of the maintenance track that the cluster will change to during the next maintenance window.

          • EncryptionType — (String)

            The encryption type for a cluster. Possible values are: KMS and None.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • AllowVersionUpgrade — (Boolean)

          A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

        • NumberOfNodes — (Integer)

          The number of compute nodes in the cluster.

        • PubliclyAccessible — (Boolean)

          A boolean value that, if true, indicates that the cluster can be accessed from a public network.

        • Encrypted — (Boolean)

          A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

        • RestoreStatus — (map)

          A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

          • Status — (String)

            The status of the restore action. Returns starting, restoring, completed, or failed.

          • CurrentRestoreRateInMegaBytesPerSecond — (Float)

            The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.

          • SnapshotSizeInMegaBytes — (Integer)

            The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

          • ProgressInMegaBytes — (Integer)

            The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

          • ElapsedTimeInSeconds — (Integer)

            The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.

        • DataTransferProgress — (map)

          • Status — (String)

            Describes the status of the cluster. While the transfer is in progress the status is transferringdata.

          • CurrentRateInMegaBytesPerSecond — (Float)

            Describes the data transfer rate in MB's per second.

          • TotalDataInMegaBytes — (Integer)

            Describes the total amount of data to be transfered in megabytes.

          • DataTransferredInMegaBytes — (Integer)

            Describes the total amount of data that has been transfered in MB's.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            Describes the estimated number of seconds remaining to complete the transfer.

          • ElapsedTimeInSeconds — (Integer)

            Describes the number of seconds that have elapsed during the data transfer.

        • HsmStatus — (map)

          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 — (map)

          A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

          • DestinationRegion — (String)

            The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

          • RetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

          • ManualSnapshotRetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.

            The value must be either -1 or an integer between 1 and 3,653.

          • SnapshotCopyGrantName — (String)

            The name of the snapshot copy grant.

        • ClusterPublicKey — (String)

          The public key for the cluster.

        • ClusterNodes — (Array<map>)

          The nodes in the 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 — (map)

          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 — (Array<map>)

          The list of tags for the cluster.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

        • EnhancedVpcRouting — (Boolean)

          An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

          Default: false

        • IamRoles — (Array<map>)

          A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

          • IamRoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

          • ApplyStatus — (String)

            A value that describes the status of the IAM role's association with an Amazon Redshift cluster.

            The following are possible statuses and descriptions.

            • in-sync: The role is available for use by the cluster.

            • adding: The role is in the process of being associated with the cluster.

            • removing: The role is in the process of being disassociated with the cluster.

        • PendingActions — (Array<String>)

          Cluster operations that are waiting to be started.

        • MaintenanceTrackName — (String)

          The name of the maintenance track for the cluster.

        • ElasticResizeNumberOfNodeOptions — (String)

          The number of nodes that you can resize the cluster to with the elastic resize method.

        • DeferredMaintenanceWindows — (Array<map>)

          Describes a group of DeferredMaintenanceWindow objects.

          • DeferMaintenanceIdentifier — (String)

            A unique identifier for the maintenance window.

          • DeferMaintenanceStartTime — (Date)

            A timestamp for the beginning of the time period when we defer maintenance.

          • DeferMaintenanceEndTime — (Date)

            A timestamp for the end of the time period when we defer maintenance.

        • SnapshotScheduleIdentifier — (String)

          A unique identifier for the cluster snapshot schedule.

        • SnapshotScheduleState — (String)

          The current state of the cluster snapshot schedule.

          Possible values include:
          • "MODIFYING"
          • "ACTIVE"
          • "FAILED"
        • ExpectedNextSnapshotScheduleTime — (Date)

          The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

        • ExpectedNextSnapshotScheduleTimeStatus — (String)

          The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

          • OnTrack - The next snapshot is expected to be taken on time.

          • Pending - The next snapshot is pending to be taken.

        • NextMaintenanceWindowStartTime — (Date)

          The date and time in UTC when system maintenance can begin.

        • ResizeInfo — (map)

          Returns the following:

          • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

          • ResizeType: Returns ClassicResize

          • ResizeType — (String)

            Returns the value ClassicResize.

          • AllowCancelResize — (Boolean)

            A boolean value indicating if the resize operation can be cancelled.

        • AvailabilityZoneRelocationStatus — (String)

          Describes the status of the Availability Zone relocation operation.

        • ClusterNamespaceArn — (String)

          The namespace Amazon Resource Name (ARN) of the cluster.

        • TotalStorageCapacityInMegaBytes — (Integer)

          The total storage capacity of the cluster in megabytes.

        • AquaConfiguration — (map)

          The AQUA (Advanced Query Accelerator) configuration of the cluster.

          • AquaStatus — (String)

            The value indicates the status of AQUA on the cluster. Possible values include the following.

            • enabled - AQUA is enabled.

            • disabled - AQUA is not enabled.

            • applying - AQUA status is being applied.

            Possible values include:
            • "enabled"
            • "disabled"
            • "applying"
          • AquaConfigurationStatus — (String)

            The value represents how the cluster is configured to use AQUA. Possible values include the following.

            • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

            • disabled - Don't use AQUA.

            • auto - Amazon Redshift determines whether to use AQUA.

            Possible values include:
            • "enabled"
            • "disabled"
            • "auto"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyClusterDbRevision(params = {}, callback) ⇒ AWS.Request

Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.

Service Reference:

Examples:

Calling the modifyClusterDbRevision operation

var params = {
  ClusterIdentifier: 'STRING_VALUE', /* required */
  RevisionTarget: 'STRING_VALUE' /* required */
};
redshift.modifyClusterDbRevision(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

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

      Example: examplecluster

    • RevisionTarget — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        Describes a cluster.

        • ClusterIdentifier — (String)

          The unique identifier of the cluster.

        • NodeType — (String)

          The node type for the nodes in the cluster.

        • ClusterStatus — (String)

          The current state of the cluster. Possible values are the following:

          • available

          • available, prep-for-resize

          • available, resize-cleanup

          • cancelling-resize

          • creating

          • deleting

          • final-snapshot

          • hardware-failure

          • incompatible-hsm

          • incompatible-network

          • incompatible-parameters

          • incompatible-restore

          • modifying

          • paused

          • rebooting

          • renaming

          • resizing

          • rotating-keys

          • storage-full

          • updating-hsm

        • ClusterAvailabilityStatus — (String)

          The availability status of the cluster for queries. Possible values are the following:

          • Available - The cluster is available for queries.

          • Unavailable - The cluster is not available for queries.

          • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

          • Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.

          • Failed - The cluster failed and is not available for queries.

        • ModifyStatus — (String)

          The status of a modify operation, if any, initiated for the cluster.

        • MasterUsername — (String)

          The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

        • DBName — (String)

          The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

        • Endpoint — (map)

          The connection endpoint.

          • Address — (String)

            The DNS address of the Cluster.

          • Port — (Integer)

            The port that the database engine is listening on.

          • VpcEndpoints — (Array<map>)

            Describes a connection endpoint.

            • VpcEndpointId — (String)

              The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

            • VpcId — (String)

              The VPC identifier that the endpoint is associated.

            • NetworkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • NetworkInterfaceId — (String)

                The network interface identifier.

              • SubnetId — (String)

                The subnet identifier.

              • PrivateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • AvailabilityZone — (String)

                The Availability Zone.

        • ClusterCreateTime — (Date)

          The date and time that the cluster was created.

        • AutomatedSnapshotRetentionPeriod — (Integer)

          The number of days that automatic cluster snapshots are retained.

        • ManualSnapshotRetentionPeriod — (Integer)

          The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

          The value must be either -1 or an integer between 1 and 3,653.

        • ClusterSecurityGroups — (Array<map>)

          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.

          • ClusterSecurityGroupName — (String)

            The name of the cluster security group.

          • Status — (String)

            The status of the cluster security group.

        • VpcSecurityGroups — (Array<map>)

          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.

          • VpcSecurityGroupId — (String)

            The identifier of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • ClusterParameterGroups — (Array<map>)

          The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

          • ParameterGroupName — (String)

            The name of the cluster parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • ClusterParameterStatusList — (Array<map>)

            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.

            • 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 — (map)

          A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

          • MasterUserPassword — (String)

            The pending or in-progress change of the admin user password for the cluster.

          • NodeType — (String)

            The pending or in-progress change of the cluster's node type.

          • NumberOfNodes — (Integer)

            The pending or in-progress change of the number of nodes in the cluster.

          • ClusterType — (String)

            The pending or in-progress change of the cluster type.

          • ClusterVersion — (String)

            The pending or in-progress change of the service version.

          • AutomatedSnapshotRetentionPeriod — (Integer)

            The pending or in-progress change of the automated snapshot retention period.

          • ClusterIdentifier — (String)

            The pending or in-progress change of the new identifier for the cluster.

          • PubliclyAccessible — (Boolean)

            The pending or in-progress change of the ability to connect to the cluster from the public network.

          • EnhancedVpcRouting — (Boolean)

            An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

            Default: false

          • MaintenanceTrackName — (String)

            The name of the maintenance track that the cluster will change to during the next maintenance window.

          • EncryptionType — (String)

            The encryption type for a cluster. Possible values are: KMS and None.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • AllowVersionUpgrade — (Boolean)

          A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

        • NumberOfNodes — (Integer)

          The number of compute nodes in the cluster.

        • PubliclyAccessible — (Boolean)

          A boolean value that, if true, indicates that the cluster can be accessed from a public network.

        • Encrypted — (Boolean)

          A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

        • RestoreStatus — (map)

          A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

          • Status — (String)

            The status of the restore action. Returns starting, restoring, completed, or failed.

          • CurrentRestoreRateInMegaBytesPerSecond — (Float)

            The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.

          • SnapshotSizeInMegaBytes — (Integer)

            The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

          • ProgressInMegaBytes — (Integer)

            The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

          • ElapsedTimeInSeconds — (Integer)

            The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.

        • DataTransferProgress — (map)

          • Status — (String)

            Describes the status of the cluster. While the transfer is in progress the status is transferringdata.

          • CurrentRateInMegaBytesPerSecond — (Float)

            Describes the data transfer rate in MB's per second.

          • TotalDataInMegaBytes — (Integer)

            Describes the total amount of data to be transfered in megabytes.

          • DataTransferredInMegaBytes — (Integer)

            Describes the total amount of data that has been transfered in MB's.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            Describes the estimated number of seconds remaining to complete the transfer.

          • ElapsedTimeInSeconds — (Integer)

            Describes the number of seconds that have elapsed during the data transfer.

        • HsmStatus — (map)

          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 — (map)

          A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

          • DestinationRegion — (String)

            The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

          • RetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

          • ManualSnapshotRetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.

            The value must be either -1 or an integer between 1 and 3,653.

          • SnapshotCopyGrantName — (String)

            The name of the snapshot copy grant.

        • ClusterPublicKey — (String)

          The public key for the cluster.

        • ClusterNodes — (Array<map>)

          The nodes in the 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 — (map)

          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 — (Array<map>)

          The list of tags for the cluster.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

        • EnhancedVpcRouting — (Boolean)

          An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

          Default: false

        • IamRoles — (Array<map>)

          A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

          • IamRoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

          • ApplyStatus — (String)

            A value that describes the status of the IAM role's association with an Amazon Redshift cluster.

            The following are possible statuses and descriptions.

            • in-sync: The role is available for use by the cluster.

            • adding: The role is in the process of being associated with the cluster.

            • removing: The role is in the process of being disassociated with the cluster.

        • PendingActions — (Array<String>)

          Cluster operations that are waiting to be started.

        • MaintenanceTrackName — (String)

          The name of the maintenance track for the cluster.

        • ElasticResizeNumberOfNodeOptions — (String)

          The number of nodes that you can resize the cluster to with the elastic resize method.

        • DeferredMaintenanceWindows — (Array<map>)

          Describes a group of DeferredMaintenanceWindow objects.

          • DeferMaintenanceIdentifier — (String)

            A unique identifier for the maintenance window.

          • DeferMaintenanceStartTime — (Date)

            A timestamp for the beginning of the time period when we defer maintenance.

          • DeferMaintenanceEndTime — (Date)

            A timestamp for the end of the time period when we defer maintenance.

        • SnapshotScheduleIdentifier — (String)

          A unique identifier for the cluster snapshot schedule.

        • SnapshotScheduleState — (String)

          The current state of the cluster snapshot schedule.

          Possible values include:
          • "MODIFYING"
          • "ACTIVE"
          • "FAILED"
        • ExpectedNextSnapshotScheduleTime — (Date)

          The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

        • ExpectedNextSnapshotScheduleTimeStatus — (String)

          The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

          • OnTrack - The next snapshot is expected to be taken on time.

          • Pending - The next snapshot is pending to be taken.

        • NextMaintenanceWindowStartTime — (Date)

          The date and time in UTC when system maintenance can begin.

        • ResizeInfo — (map)

          Returns the following:

          • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

          • ResizeType: Returns ClassicResize

          • ResizeType — (String)

            Returns the value ClassicResize.

          • AllowCancelResize — (Boolean)

            A boolean value indicating if the resize operation can be cancelled.

        • AvailabilityZoneRelocationStatus — (String)

          Describes the status of the Availability Zone relocation operation.

        • ClusterNamespaceArn — (String)

          The namespace Amazon Resource Name (ARN) of the cluster.

        • TotalStorageCapacityInMegaBytes — (Integer)

          The total storage capacity of the cluster in megabytes.

        • AquaConfiguration — (map)

          The AQUA (Advanced Query Accelerator) configuration of the cluster.

          • AquaStatus — (String)

            The value indicates the status of AQUA on the cluster. Possible values include the following.

            • enabled - AQUA is enabled.

            • disabled - AQUA is not enabled.

            • applying - AQUA status is being applied.

            Possible values include:
            • "enabled"
            • "disabled"
            • "applying"
          • AquaConfigurationStatus — (String)

            The value represents how the cluster is configured to use AQUA. Possible values include the following.

            • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

            • disabled - Don't use AQUA.

            • auto - Amazon Redshift determines whether to use AQUA.

            Possible values include:
            • "enabled"
            • "disabled"
            • "auto"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyClusterIamRoles(params = {}, callback) ⇒ AWS.Request

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

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

Service Reference:

Examples:

Calling the modifyClusterIamRoles operation

var params = {
  ClusterIdentifier: 'STRING_VALUE', /* required */
  AddIamRoles: [
    'STRING_VALUE',
    /* more items */
  ],
  RemoveIamRoles: [
    'STRING_VALUE',
    /* more items */
  ]
};
redshift.modifyClusterIamRoles(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

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

    • AddIamRoles — (Array<String>)

      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.

    • RemoveIamRoles — (Array<String>)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        Describes a cluster.

        • ClusterIdentifier — (String)

          The unique identifier of the cluster.

        • NodeType — (String)

          The node type for the nodes in the cluster.

        • ClusterStatus — (String)

          The current state of the cluster. Possible values are the following:

          • available

          • available, prep-for-resize

          • available, resize-cleanup

          • cancelling-resize

          • creating

          • deleting

          • final-snapshot

          • hardware-failure

          • incompatible-hsm

          • incompatible-network

          • incompatible-parameters

          • incompatible-restore

          • modifying

          • paused

          • rebooting

          • renaming

          • resizing

          • rotating-keys

          • storage-full

          • updating-hsm

        • ClusterAvailabilityStatus — (String)

          The availability status of the cluster for queries. Possible values are the following:

          • Available - The cluster is available for queries.

          • Unavailable - The cluster is not available for queries.

          • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

          • Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.

          • Failed - The cluster failed and is not available for queries.

        • ModifyStatus — (String)

          The status of a modify operation, if any, initiated for the cluster.

        • MasterUsername — (String)

          The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

        • DBName — (String)

          The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

        • Endpoint — (map)

          The connection endpoint.

          • Address — (String)

            The DNS address of the Cluster.

          • Port — (Integer)

            The port that the database engine is listening on.

          • VpcEndpoints — (Array<map>)

            Describes a connection endpoint.

            • VpcEndpointId — (String)

              The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

            • VpcId — (String)

              The VPC identifier that the endpoint is associated.

            • NetworkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • NetworkInterfaceId — (String)

                The network interface identifier.

              • SubnetId — (String)

                The subnet identifier.

              • PrivateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • AvailabilityZone — (String)

                The Availability Zone.

        • ClusterCreateTime — (Date)

          The date and time that the cluster was created.

        • AutomatedSnapshotRetentionPeriod — (Integer)

          The number of days that automatic cluster snapshots are retained.

        • ManualSnapshotRetentionPeriod — (Integer)

          The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

          The value must be either -1 or an integer between 1 and 3,653.

        • ClusterSecurityGroups — (Array<map>)

          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.

          • ClusterSecurityGroupName — (String)

            The name of the cluster security group.

          • Status — (String)

            The status of the cluster security group.

        • VpcSecurityGroups — (Array<map>)

          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.

          • VpcSecurityGroupId — (String)

            The identifier of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • ClusterParameterGroups — (Array<map>)

          The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

          • ParameterGroupName — (String)

            The name of the cluster parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • ClusterParameterStatusList — (Array<map>)

            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.

            • 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 — (map)

          A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

          • MasterUserPassword — (String)

            The pending or in-progress change of the admin user password for the cluster.

          • NodeType — (String)

            The pending or in-progress change of the cluster's node type.

          • NumberOfNodes — (Integer)

            The pending or in-progress change of the number of nodes in the cluster.

          • ClusterType — (String)

            The pending or in-progress change of the cluster type.

          • ClusterVersion — (String)

            The pending or in-progress change of the service version.

          • AutomatedSnapshotRetentionPeriod — (Integer)

            The pending or in-progress change of the automated snapshot retention period.

          • ClusterIdentifier — (String)

            The pending or in-progress change of the new identifier for the cluster.

          • PubliclyAccessible — (Boolean)

            The pending or in-progress change of the ability to connect to the cluster from the public network.

          • EnhancedVpcRouting — (Boolean)

            An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

            Default: false

          • MaintenanceTrackName — (String)

            The name of the maintenance track that the cluster will change to during the next maintenance window.

          • EncryptionType — (String)

            The encryption type for a cluster. Possible values are: KMS and None.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • AllowVersionUpgrade — (Boolean)

          A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

        • NumberOfNodes — (Integer)

          The number of compute nodes in the cluster.

        • PubliclyAccessible — (Boolean)

          A boolean value that, if true, indicates that the cluster can be accessed from a public network.

        • Encrypted — (Boolean)

          A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

        • RestoreStatus — (map)

          A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

          • Status — (String)

            The status of the restore action. Returns starting, restoring, completed, or failed.

          • CurrentRestoreRateInMegaBytesPerSecond — (Float)

            The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.

          • SnapshotSizeInMegaBytes — (Integer)

            The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

          • ProgressInMegaBytes — (Integer)

            The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

          • ElapsedTimeInSeconds — (Integer)

            The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.

        • DataTransferProgress — (map)

          • Status — (String)

            Describes the status of the cluster. While the transfer is in progress the status is transferringdata.

          • CurrentRateInMegaBytesPerSecond — (Float)

            Describes the data transfer rate in MB's per second.

          • TotalDataInMegaBytes — (Integer)

            Describes the total amount of data to be transfered in megabytes.

          • DataTransferredInMegaBytes — (Integer)

            Describes the total amount of data that has been transfered in MB's.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            Describes the estimated number of seconds remaining to complete the transfer.

          • ElapsedTimeInSeconds — (Integer)

            Describes the number of seconds that have elapsed during the data transfer.

        • HsmStatus — (map)

          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 — (map)

          A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

          • DestinationRegion — (String)

            The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

          • RetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

          • ManualSnapshotRetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.

            The value must be either -1 or an integer between 1 and 3,653.

          • SnapshotCopyGrantName — (String)

            The name of the snapshot copy grant.

        • ClusterPublicKey — (String)

          The public key for the cluster.

        • ClusterNodes — (Array<map>)

          The nodes in the 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 — (map)

          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 — (Array<map>)

          The list of tags for the cluster.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

        • EnhancedVpcRouting — (Boolean)

          An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

          Default: false

        • IamRoles — (Array<map>)

          A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

          • IamRoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

          • ApplyStatus — (String)

            A value that describes the status of the IAM role's association with an Amazon Redshift cluster.

            The following are possible statuses and descriptions.

            • in-sync: The role is available for use by the cluster.

            • adding: The role is in the process of being associated with the cluster.

            • removing: The role is in the process of being disassociated with the cluster.

        • PendingActions — (Array<String>)

          Cluster operations that are waiting to be started.

        • MaintenanceTrackName — (String)

          The name of the maintenance track for the cluster.

        • ElasticResizeNumberOfNodeOptions — (String)

          The number of nodes that you can resize the cluster to with the elastic resize method.

        • DeferredMaintenanceWindows — (Array<map>)

          Describes a group of DeferredMaintenanceWindow objects.

          • DeferMaintenanceIdentifier — (String)

            A unique identifier for the maintenance window.

          • DeferMaintenanceStartTime — (Date)

            A timestamp for the beginning of the time period when we defer maintenance.

          • DeferMaintenanceEndTime — (Date)

            A timestamp for the end of the time period when we defer maintenance.

        • SnapshotScheduleIdentifier — (String)

          A unique identifier for the cluster snapshot schedule.

        • SnapshotScheduleState — (String)

          The current state of the cluster snapshot schedule.

          Possible values include:
          • "MODIFYING"
          • "ACTIVE"
          • "FAILED"
        • ExpectedNextSnapshotScheduleTime — (Date)

          The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

        • ExpectedNextSnapshotScheduleTimeStatus — (String)

          The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

          • OnTrack - The next snapshot is expected to be taken on time.

          • Pending - The next snapshot is pending to be taken.

        • NextMaintenanceWindowStartTime — (Date)

          The date and time in UTC when system maintenance can begin.

        • ResizeInfo — (map)

          Returns the following:

          • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

          • ResizeType: Returns ClassicResize

          • ResizeType — (String)

            Returns the value ClassicResize.

          • AllowCancelResize — (Boolean)

            A boolean value indicating if the resize operation can be cancelled.

        • AvailabilityZoneRelocationStatus — (String)

          Describes the status of the Availability Zone relocation operation.

        • ClusterNamespaceArn — (String)

          The namespace Amazon Resource Name (ARN) of the cluster.

        • TotalStorageCapacityInMegaBytes — (Integer)

          The total storage capacity of the cluster in megabytes.

        • AquaConfiguration — (map)

          The AQUA (Advanced Query Accelerator) configuration of the cluster.

          • AquaStatus — (String)

            The value indicates the status of AQUA on the cluster. Possible values include the following.

            • enabled - AQUA is enabled.

            • disabled - AQUA is not enabled.

            • applying - AQUA status is being applied.

            Possible values include:
            • "enabled"
            • "disabled"
            • "applying"
          • AquaConfigurationStatus — (String)

            The value represents how the cluster is configured to use AQUA. Possible values include the following.

            • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

            • disabled - Don't use AQUA.

            • auto - Amazon Redshift determines whether to use AQUA.

            Possible values include:
            • "enabled"
            • "disabled"
            • "auto"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyClusterMaintenance(params = {}, callback) ⇒ AWS.Request

Modifies the maintenance settings of a cluster.

Service Reference:

Examples:

Calling the modifyClusterMaintenance operation

var params = {
  ClusterIdentifier: 'STRING_VALUE', /* required */
  DeferMaintenance: true || false,
  DeferMaintenanceDuration: 'NUMBER_VALUE',
  DeferMaintenanceEndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  DeferMaintenanceIdentifier: 'STRING_VALUE',
  DeferMaintenanceStartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
redshift.modifyClusterMaintenance(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      A unique identifier for the cluster.

    • DeferMaintenance — (Boolean)

      A boolean indicating whether to enable the deferred maintenance window.

    • DeferMaintenanceIdentifier — (String)

      A unique identifier for the deferred maintenance window.

    • DeferMaintenanceStartTime — (Date)

      A timestamp indicating the start time for the deferred maintenance window.

    • DeferMaintenanceEndTime — (Date)

      A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.

    • DeferMaintenanceDuration — (Integer)

      An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        Describes a cluster.

        • ClusterIdentifier — (String)

          The unique identifier of the cluster.

        • NodeType — (String)

          The node type for the nodes in the cluster.

        • ClusterStatus — (String)

          The current state of the cluster. Possible values are the following:

          • available

          • available, prep-for-resize

          • available, resize-cleanup

          • cancelling-resize

          • creating

          • deleting

          • final-snapshot

          • hardware-failure

          • incompatible-hsm

          • incompatible-network

          • incompatible-parameters

          • incompatible-restore

          • modifying

          • paused

          • rebooting

          • renaming

          • resizing

          • rotating-keys

          • storage-full

          • updating-hsm

        • ClusterAvailabilityStatus — (String)

          The availability status of the cluster for queries. Possible values are the following:

          • Available - The cluster is available for queries.

          • Unavailable - The cluster is not available for queries.

          • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

          • Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.

          • Failed - The cluster failed and is not available for queries.

        • ModifyStatus — (String)

          The status of a modify operation, if any, initiated for the cluster.

        • MasterUsername — (String)

          The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

        • DBName — (String)

          The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

        • Endpoint — (map)

          The connection endpoint.

          • Address — (String)

            The DNS address of the Cluster.

          • Port — (Integer)

            The port that the database engine is listening on.

          • VpcEndpoints — (Array<map>)

            Describes a connection endpoint.

            • VpcEndpointId — (String)

              The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

            • VpcId — (String)

              The VPC identifier that the endpoint is associated.

            • NetworkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • NetworkInterfaceId — (String)

                The network interface identifier.

              • SubnetId — (String)

                The subnet identifier.

              • PrivateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • AvailabilityZone — (String)

                The Availability Zone.

        • ClusterCreateTime — (Date)

          The date and time that the cluster was created.

        • AutomatedSnapshotRetentionPeriod — (Integer)

          The number of days that automatic cluster snapshots are retained.

        • ManualSnapshotRetentionPeriod — (Integer)

          The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

          The value must be either -1 or an integer between 1 and 3,653.

        • ClusterSecurityGroups — (Array<map>)

          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.

          • ClusterSecurityGroupName — (String)

            The name of the cluster security group.

          • Status — (String)

            The status of the cluster security group.

        • VpcSecurityGroups — (Array<map>)

          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.

          • VpcSecurityGroupId — (String)

            The identifier of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • ClusterParameterGroups — (Array<map>)

          The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

          • ParameterGroupName — (String)

            The name of the cluster parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • ClusterParameterStatusList — (Array<map>)

            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.

            • 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 — (map)

          A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

          • MasterUserPassword — (String)

            The pending or in-progress change of the admin user password for the cluster.

          • NodeType — (String)

            The pending or in-progress change of the cluster's node type.

          • NumberOfNodes — (Integer)

            The pending or in-progress change of the number of nodes in the cluster.

          • ClusterType — (String)

            The pending or in-progress change of the cluster type.

          • ClusterVersion — (String)

            The pending or in-progress change of the service version.

          • AutomatedSnapshotRetentionPeriod — (Integer)

            The pending or in-progress change of the automated snapshot retention period.

          • ClusterIdentifier — (String)

            The pending or in-progress change of the new identifier for the cluster.

          • PubliclyAccessible — (Boolean)

            The pending or in-progress change of the ability to connect to the cluster from the public network.

          • EnhancedVpcRouting — (Boolean)

            An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

            Default: false

          • MaintenanceTrackName — (String)

            The name of the maintenance track that the cluster will change to during the next maintenance window.

          • EncryptionType — (String)

            The encryption type for a cluster. Possible values are: KMS and None.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • AllowVersionUpgrade — (Boolean)

          A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

        • NumberOfNodes — (Integer)

          The number of compute nodes in the cluster.

        • PubliclyAccessible — (Boolean)

          A boolean value that, if true, indicates that the cluster can be accessed from a public network.

        • Encrypted — (Boolean)

          A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

        • RestoreStatus — (map)

          A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

          • Status — (String)

            The status of the restore action. Returns starting, restoring, completed, or failed.

          • CurrentRestoreRateInMegaBytesPerSecond — (Float)

            The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.

          • SnapshotSizeInMegaBytes — (Integer)

            The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

          • ProgressInMegaBytes — (Integer)

            The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

          • ElapsedTimeInSeconds — (Integer)

            The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.

        • DataTransferProgress — (map)

          • Status — (String)

            Describes the status of the cluster. While the transfer is in progress the status is transferringdata.

          • CurrentRateInMegaBytesPerSecond — (Float)

            Describes the data transfer rate in MB's per second.

          • TotalDataInMegaBytes — (Integer)

            Describes the total amount of data to be transfered in megabytes.

          • DataTransferredInMegaBytes — (Integer)

            Describes the total amount of data that has been transfered in MB's.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            Describes the estimated number of seconds remaining to complete the transfer.

          • ElapsedTimeInSeconds — (Integer)

            Describes the number of seconds that have elapsed during the data transfer.

        • HsmStatus — (map)

          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 — (map)

          A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

          • DestinationRegion — (String)

            The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

          • RetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

          • ManualSnapshotRetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.

            The value must be either -1 or an integer between 1 and 3,653.

          • SnapshotCopyGrantName — (String)

            The name of the snapshot copy grant.

        • ClusterPublicKey — (String)

          The public key for the cluster.

        • ClusterNodes — (Array<map>)

          The nodes in the 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 — (map)

          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 — (Array<map>)

          The list of tags for the cluster.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

        • EnhancedVpcRouting — (Boolean)

          An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

          Default: false

        • IamRoles — (Array<map>)

          A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

          • IamRoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

          • ApplyStatus — (String)

            A value that describes the status of the IAM role's association with an Amazon Redshift cluster.

            The following are possible statuses and descriptions.

            • in-sync: The role is available for use by the cluster.

            • adding: The role is in the process of being associated with the cluster.

            • removing: The role is in the process of being disassociated with the cluster.

        • PendingActions — (Array<String>)

          Cluster operations that are waiting to be started.

        • MaintenanceTrackName — (String)

          The name of the maintenance track for the cluster.

        • ElasticResizeNumberOfNodeOptions — (String)

          The number of nodes that you can resize the cluster to with the elastic resize method.

        • DeferredMaintenanceWindows — (Array<map>)

          Describes a group of DeferredMaintenanceWindow objects.

          • DeferMaintenanceIdentifier — (String)

            A unique identifier for the maintenance window.

          • DeferMaintenanceStartTime — (Date)

            A timestamp for the beginning of the time period when we defer maintenance.

          • DeferMaintenanceEndTime — (Date)

            A timestamp for the end of the time period when we defer maintenance.

        • SnapshotScheduleIdentifier — (String)

          A unique identifier for the cluster snapshot schedule.

        • SnapshotScheduleState — (String)

          The current state of the cluster snapshot schedule.

          Possible values include:
          • "MODIFYING"
          • "ACTIVE"
          • "FAILED"
        • ExpectedNextSnapshotScheduleTime — (Date)

          The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

        • ExpectedNextSnapshotScheduleTimeStatus — (String)

          The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

          • OnTrack - The next snapshot is expected to be taken on time.

          • Pending - The next snapshot is pending to be taken.

        • NextMaintenanceWindowStartTime — (Date)

          The date and time in UTC when system maintenance can begin.

        • ResizeInfo — (map)

          Returns the following:

          • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

          • ResizeType: Returns ClassicResize

          • ResizeType — (String)

            Returns the value ClassicResize.

          • AllowCancelResize — (Boolean)

            A boolean value indicating if the resize operation can be cancelled.

        • AvailabilityZoneRelocationStatus — (String)

          Describes the status of the Availability Zone relocation operation.

        • ClusterNamespaceArn — (String)

          The namespace Amazon Resource Name (ARN) of the cluster.

        • TotalStorageCapacityInMegaBytes — (Integer)

          The total storage capacity of the cluster in megabytes.

        • AquaConfiguration — (map)

          The AQUA (Advanced Query Accelerator) configuration of the cluster.

          • AquaStatus — (String)

            The value indicates the status of AQUA on the cluster. Possible values include the following.

            • enabled - AQUA is enabled.

            • disabled - AQUA is not enabled.

            • applying - AQUA status is being applied.

            Possible values include:
            • "enabled"
            • "disabled"
            • "applying"
          • AquaConfigurationStatus — (String)

            The value represents how the cluster is configured to use AQUA. Possible values include the following.

            • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

            • disabled - Don't use AQUA.

            • auto - Amazon Redshift determines whether to use AQUA.

            Possible values include:
            • "enabled"
            • "disabled"
            • "auto"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyClusterParameterGroup(params = {}, callback) ⇒ AWS.Request

Modifies the parameters of a parameter group. For the parameters parameter, it can't contain ASCII characters.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Service Reference:

Examples:

Calling the modifyClusterParameterGroup operation

var params = {
  ParameterGroupName: 'STRING_VALUE', /* required */
  Parameters: [ /* required */
    {
      AllowedValues: 'STRING_VALUE',
      ApplyType: static | dynamic,
      DataType: 'STRING_VALUE',
      Description: 'STRING_VALUE',
      IsModifiable: true || false,
      MinimumEngineVersion: 'STRING_VALUE',
      ParameterName: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE',
      Source: 'STRING_VALUE'
    },
    /* more items */
  ]
};
redshift.modifyClusterParameterGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ParameterGroupName — (String)

      The name of the parameter group to be modified.

    • Parameters — (Array<map>)

      An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.

      For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.

      For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.

      • ParameterName — (String)

        The name of the parameter.

      • ParameterValue — (String)

        The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.

      • Description — (String)

        A description of the parameter.

      • Source — (String)

        The source of the parameter value, such as "engine-default" or "user".

      • DataType — (String)

        The data type of the parameter.

      • AllowedValues — (String)

        The valid range of values for the parameter.

      • ApplyType — (String)

        Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

        Possible values include:
        • "static"
        • "dynamic"
      • IsModifiable — (Boolean)

        If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

      • MinimumEngineVersion — (String)

        The earliest engine version to which the parameter can apply.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ParameterGroupName — (String)

        The name of the cluster parameter group.

      • ParameterGroupStatus — (String)

        The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyClusterSnapshot(params = {}, callback) ⇒ AWS.Request

Modifies the settings for a snapshot.

This exanmple modifies the manual retention period setting for a cluster snapshot.

Service Reference:

Examples:

Calling the modifyClusterSnapshot operation

var params = {
  SnapshotIdentifier: 'STRING_VALUE', /* required */
  Force: true || false,
  ManualSnapshotRetentionPeriod: 'NUMBER_VALUE'
};
redshift.modifyClusterSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SnapshotIdentifier — (String)

      The identifier of the snapshot whose setting you want to modify.

    • ManualSnapshotRetentionPeriod — (Integer)

      The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

      If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot.

      The value must be either -1 or an integer between 1 and 3,653.

    • Force — (Boolean)

      A Boolean option to override an exception if the retention period has already passed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Snapshot — (map)

        Describes a snapshot.

        • SnapshotIdentifier — (String)

          The snapshot identifier that is provided in the request.

        • ClusterIdentifier — (String)

          The identifier of the cluster for which the snapshot was taken.

        • SnapshotCreateTime — (Date)

          The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

        • Status — (String)

          The snapshot status. The value of the status depends on the API operation used:

        • Port — (Integer)

          The port that the cluster is listening on.

        • AvailabilityZone — (String)

          The Availability Zone in which the cluster was created.

        • ClusterCreateTime — (Date)

          The time (UTC) when the cluster was originally created.

        • MasterUsername — (String)

          The admin user name for the cluster.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • EngineFullVersion — (String)

          The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

        • SnapshotType — (String)

          The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

        • NodeType — (String)

          The node type of the nodes in the cluster.

        • NumberOfNodes — (Integer)

          The number of nodes in the cluster.

        • DBName — (String)

          The name of the database that was created when the cluster was created.

        • VpcId — (String)

          The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

        • Encrypted — (Boolean)

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

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

        • EncryptedWithHSM — (Boolean)

          A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

        • AccountsWithRestoreAccess — (Array<map>)

          A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

          • AccountId — (String)

            The identifier of an Amazon Web Services account authorized to restore a snapshot.

          • AccountAlias — (String)

            The identifier of an Amazon Web Services support account authorized to restore a snapshot. For Amazon Web Services Support, the identifier is amazon-redshift-support.

        • OwnerAccount — (String)

          For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

        • TotalBackupSizeInMegaBytes — (Float)

          The size of the complete set of backup data that would be used to restore the cluster.

        • ActualIncrementalBackupSizeInMegaBytes — (Float)

          The size of the incremental backup.

        • BackupProgressInMegaBytes — (Float)

          The number of megabytes that have been transferred to the snapshot backup.

        • CurrentBackupRateInMegaBytesPerSecond — (Float)

          The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

        • EstimatedSecondsToCompletion — (Integer)

          The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

        • ElapsedTimeInSeconds — (Integer)

          The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

        • SourceRegion — (String)

          The source region from which the snapshot was copied.

        • Tags — (Array<map>)

          The list of tags for the cluster snapshot.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • RestorableNodeTypes — (Array<String>)

          The list of node types that this cluster snapshot is able to restore into.

        • 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 for the snapshot.

        • ManualSnapshotRetentionPeriod — (Integer)

          The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

          The value must be either -1 or an integer between 1 and 3,653.

        • ManualSnapshotRemainingDays — (Integer)

          The number of days until a manual snapshot will pass its retention period.

        • SnapshotRetentionStartTime — (Date)

          A timestamp representing the start of the retention period for the snapshot.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyClusterSnapshotSchedule(params = {}, callback) ⇒ AWS.Request

Modifies a snapshot schedule for a cluster.

Service Reference:

Examples:

Calling the modifyClusterSnapshotSchedule operation

var params = {
  ClusterIdentifier: 'STRING_VALUE', /* required */
  DisassociateSchedule: true || false,
  ScheduleIdentifier: 'STRING_VALUE'
};
redshift.modifyClusterSnapshotSchedule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      A unique identifier for the cluster whose snapshot schedule you want to modify.

    • ScheduleIdentifier — (String)

      A unique alphanumeric identifier for the schedule that you want to associate with the cluster.

    • DisassociateSchedule — (Boolean)

      A boolean to indicate whether to remove the assoiciation between the cluster and the schedule.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyClusterSubnetGroup(params = {}, callback) ⇒ AWS.Request

Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets.

Service Reference:

Examples:

Calling the modifyClusterSubnetGroup operation

var params = {
  ClusterSubnetGroupName: 'STRING_VALUE', /* required */
  SubnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Description: 'STRING_VALUE'
};
redshift.modifyClusterSubnetGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterSubnetGroupName — (String)

      The name of the subnet group to be modified.

    • Description — (String)

      A text description of the subnet group to be modified.

    • SubnetIds — (Array<String>)

      An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ClusterSubnetGroup — (map)

        Describes a subnet group.

        • ClusterSubnetGroupName — (String)

          The name of the cluster subnet group.

        • Description — (String)

          The description of the cluster subnet group.

        • VpcId — (String)

          The VPC ID of the cluster subnet group.

        • SubnetGroupStatus — (String)

          The status of the cluster subnet group. Possible values are Complete, Incomplete and Invalid.

        • Subnets — (Array<map>)

          A list of the VPC Subnet elements.

          • SubnetIdentifier — (String)

            The identifier of the subnet.

          • SubnetAvailabilityZone — (map)

            • Name — (String)

              The name of the availability zone.

            • SupportedPlatforms — (Array<map>)

              • Name — (String)

          • SubnetStatus — (String)

            The status of the subnet.

        • Tags — (Array<map>)

          The list of tags for the cluster subnet group.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyEndpointAccess(params = {}, callback) ⇒ AWS.Request

Modifies a Redshift-managed VPC endpoint.

Service Reference:

Examples:

Calling the modifyEndpointAccess operation

var params = {
  EndpointName: 'STRING_VALUE', /* required */
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
redshift.modifyEndpointAccess(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • EndpointName — (String)

      The endpoint to be modified.

    • VpcSecurityGroupIds — (Array<String>)

      The complete list of VPC security groups associated with the endpoint after the endpoint is modified.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ClusterIdentifier — (String)

        The cluster identifier of the cluster associated with the endpoint.

      • ResourceOwner — (String)

        The Amazon Web Services account ID of the owner of the cluster.

      • SubnetGroupName — (String)

        The subnet group name where Amazon Redshift chooses to deploy the endpoint.

      • EndpointStatus — (String)

        The status of the endpoint.

      • EndpointName — (String)

        The name of the endpoint.

      • EndpointCreateTime — (Date)

        The time (UTC) that the endpoint was created.

      • Port — (Integer)

        The port number on which the cluster accepts incoming connections.

      • Address — (String)

        The DNS address of the endpoint.

      • VpcSecurityGroups — (Array<map>)

        The security groups associated with the endpoint.

        • VpcSecurityGroupId — (String)

          The identifier of the VPC security group.

        • Status — (String)

          The status of the VPC security group.

      • VpcEndpoint — (map)

        The connection endpoint for connecting to an Amazon Redshift cluster through the proxy.

        • VpcEndpointId — (String)

          The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

        • VpcId — (String)

          The VPC identifier that the endpoint is associated.

        • NetworkInterfaces — (Array<map>)

          One or more network interfaces of the endpoint. Also known as an interface endpoint.

          • NetworkInterfaceId — (String)

            The network interface identifier.

          • SubnetId — (String)

            The subnet identifier.

          • PrivateIpAddress — (String)

            The IPv4 address of the network interface within the subnet.

          • AvailabilityZone — (String)

            The Availability Zone.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyEventSubscription(params = {}, callback) ⇒ AWS.Request

Modifies an existing Amazon Redshift event notification subscription.

Service Reference:

Examples:

Calling the modifyEventSubscription operation

var params = {
  SubscriptionName: 'STRING_VALUE', /* required */
  Enabled: true || false,
  EventCategories: [
    'STRING_VALUE',
    /* more items */
  ],
  Severity: 'STRING_VALUE',
  SnsTopicArn: 'STRING_VALUE',
  SourceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  SourceType: 'STRING_VALUE'
};
redshift.modifyEventSubscription(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SubscriptionName — (String)

      The name of the modified Amazon Redshift event notification subscription.

    • SnsTopicArn — (String)

      The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.

    • SourceType — (String)

      The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your Amazon Web Services account. You must specify a source type in order to specify source IDs.

      Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.

    • SourceIds — (Array<String>)

      A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

      Example: my-cluster-1, my-cluster-2

      Example: my-snapshot-20131010

    • EventCategories — (Array<String>)

      Specifies the Amazon Redshift event categories to be published by the event notification subscription.

      Values: configuration, management, monitoring, security, pending

    • Severity — (String)

      Specifies the Amazon Redshift event severity to be published by the event notification subscription.

      Values: ERROR, INFO

    • Enabled — (Boolean)

      A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • EventSubscription — (map)

        Describes event subscriptions.

        • CustomerAwsId — (String)

          The Amazon Web Services account associated with the Amazon Redshift event notification subscription.

        • CustSubscriptionId — (String)

          The name of the Amazon Redshift event notification subscription.

        • SnsTopicArn — (String)

          The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.

        • Status — (String)

          The status of the Amazon Redshift event notification subscription.

          Constraints:

          • Can be one of the following: active | no-permission | topic-not-exist

          • The status "no-permission" indicates that Amazon Redshift no longer has permission to post to the Amazon SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

        • SubscriptionCreationTime — (Date)

          The date and time the Amazon Redshift event notification subscription was created.

        • SourceType — (String)

          The source type of the events returned by the Amazon Redshift event notification, such as cluster, cluster-snapshot, cluster-parameter-group, cluster-security-group, or scheduled-action.

        • SourceIdsList — (Array<String>)

          A list of the sources that publish events to the Amazon Redshift event notification subscription.

        • EventCategoriesList — (Array<String>)

          The list of Amazon Redshift event categories specified in the event notification subscription.

          Values: Configuration, Management, Monitoring, Security, Pending

        • Severity — (String)

          The event severity specified in the Amazon Redshift event notification subscription.

          Values: ERROR, INFO

        • Enabled — (Boolean)

          A boolean value indicating whether the subscription is enabled; true indicates that the subscription is enabled.

        • Tags — (Array<map>)

          The list of tags for the event subscription.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyScheduledAction(params = {}, callback) ⇒ AWS.Request

Modifies a scheduled action.

Service Reference:

Examples:

Calling the modifyScheduledAction operation

var params = {
  ScheduledActionName: 'STRING_VALUE', /* required */
  Enable: true || false,
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  IamRole: 'STRING_VALUE',
  Schedule: 'STRING_VALUE',
  ScheduledActionDescription: 'STRING_VALUE',
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  TargetAction: {
    PauseCluster: {
      ClusterIdentifier: 'STRING_VALUE' /* required */
    },
    ResizeCluster: {
      ClusterIdentifier: 'STRING_VALUE', /* required */
      Classic: true || false,
      ClusterType: 'STRING_VALUE',
      NodeType: 'STRING_VALUE',
      NumberOfNodes: 'NUMBER_VALUE'
    },
    ResumeCluster: {
      ClusterIdentifier: 'STRING_VALUE' /* required */
    }
  }
};
redshift.modifyScheduledAction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ScheduledActionName — (String)

      The name of the scheduled action to modify.

    • TargetAction — (map)

      A modified JSON format of the scheduled action. For more information about this parameter, see ScheduledAction.

      • ResizeCluster — (map)

        An action that runs a ResizeCluster API operation.

        • ClusterIdentifier — required — (String)

          The unique identifier for the cluster to resize.

        • ClusterType — (String)

          The new cluster type for the specified cluster.

        • NodeType — (String)

          The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.

        • NumberOfNodes — (Integer)

          The new number of nodes for the cluster. If not specified, the cluster's current number of nodes is used.

        • Classic — (Boolean)

          A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false, the resize type is elastic.

      • PauseCluster — (map)

        An action that runs a PauseCluster API operation.

        • ClusterIdentifier — required — (String)

          The identifier of the cluster to be paused.

      • ResumeCluster — (map)

        An action that runs a ResumeCluster API operation.

        • ClusterIdentifier — required — (String)

          The identifier of the cluster to be resumed.

    • Schedule — (String)

      A modified schedule in either at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.

    • IamRole — (String)

      A different IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.

    • ScheduledActionDescription — (String)

      A modified description of the scheduled action.

    • StartTime — (Date)

      A modified start time of the scheduled action. For more information about this parameter, see ScheduledAction.

    • EndTime — (Date)

      A modified end time of the scheduled action. For more information about this parameter, see ScheduledAction.

    • Enable — (Boolean)

      A modified enable flag of the scheduled action. If true, the scheduled action is active. If false, the scheduled action is disabled.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ScheduledActionName — (String)

        The name of the scheduled action.

      • TargetAction — (map)

        A JSON format string of the Amazon Redshift API operation with input parameters.

        "{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}".

        • ResizeCluster — (map)

          An action that runs a ResizeCluster API operation.

          • ClusterIdentifier — required — (String)

            The unique identifier for the cluster to resize.

          • ClusterType — (String)

            The new cluster type for the specified cluster.

          • NodeType — (String)

            The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.

          • NumberOfNodes — (Integer)

            The new number of nodes for the cluster. If not specified, the cluster's current number of nodes is used.

          • Classic — (Boolean)

            A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false, the resize type is elastic.

        • PauseCluster — (map)

          An action that runs a PauseCluster API operation.

          • ClusterIdentifier — required — (String)

            The identifier of the cluster to be paused.

        • ResumeCluster — (map)

          An action that runs a ResumeCluster API operation.

          • ClusterIdentifier — required — (String)

            The identifier of the cluster to be resumed.

      • Schedule — (String)

        The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.

        Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, "at(2016-03-04T17:27:00)".

        Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year)". For example, "cron(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

      • IamRole — (String)

        The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.

      • ScheduledActionDescription — (String)

        The description of the scheduled action.

      • State — (String)

        The state of the scheduled action. For example, DISABLED.

        Possible values include:
        • "ACTIVE"
        • "DISABLED"
      • NextInvocations — (Array<Date>)

        List of times when the scheduled action will run.

      • StartTime — (Date)

        The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

      • EndTime — (Date)

        The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifySnapshotCopyRetentionPeriod(params = {}, callback) ⇒ AWS.Request

Modifies the number of days to retain snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period.

Service Reference:

Examples:

Calling the modifySnapshotCopyRetentionPeriod operation

var params = {
  ClusterIdentifier: 'STRING_VALUE', /* required */
  RetentionPeriod: 'NUMBER_VALUE', /* required */
  Manual: true || false
};
redshift.modifySnapshotCopyRetentionPeriod(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination Amazon Web Services Region.

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

    • RetentionPeriod — (Integer)

      The number of days to retain automated snapshots in the destination Amazon Web Services Region after they are copied from the source Amazon Web Services Region.

      By default, this only changes the retention period of copied automated snapshots.

      If you decrease the retention period for automated snapshots that are copied to a destination Amazon Web Services Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination Amazon Web Services Region and that fall outside of the new retention period.

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

      If you specify the manual option, only newly copied manual snapshots will have the new retention period.

      If you specify the value of -1 newly copied manual snapshots are retained indefinitely.

      Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.

    • Manual — (Boolean)

      Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        Describes a cluster.

        • ClusterIdentifier — (String)

          The unique identifier of the cluster.

        • NodeType — (String)

          The node type for the nodes in the cluster.

        • ClusterStatus — (String)

          The current state of the cluster. Possible values are the following:

          • available

          • available, prep-for-resize

          • available, resize-cleanup

          • cancelling-resize

          • creating

          • deleting

          • final-snapshot

          • hardware-failure

          • incompatible-hsm

          • incompatible-network

          • incompatible-parameters

          • incompatible-restore

          • modifying

          • paused

          • rebooting

          • renaming

          • resizing

          • rotating-keys

          • storage-full

          • updating-hsm

        • ClusterAvailabilityStatus — (String)

          The availability status of the cluster for queries. Possible values are the following:

          • Available - The cluster is available for queries.

          • Unavailable - The cluster is not available for queries.

          • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

          • Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.

          • Failed - The cluster failed and is not available for queries.

        • ModifyStatus — (String)

          The status of a modify operation, if any, initiated for the cluster.

        • MasterUsername — (String)

          The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

        • DBName — (String)

          The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

        • Endpoint — (map)

          The connection endpoint.

          • Address — (String)

            The DNS address of the Cluster.

          • Port — (Integer)

            The port that the database engine is listening on.

          • VpcEndpoints — (Array<map>)

            Describes a connection endpoint.

            • VpcEndpointId — (String)

              The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

            • VpcId — (String)

              The VPC identifier that the endpoint is associated.

            • NetworkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • NetworkInterfaceId — (String)

                The network interface identifier.

              • SubnetId — (String)

                The subnet identifier.

              • PrivateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • AvailabilityZone — (String)

                The Availability Zone.

        • ClusterCreateTime — (Date)

          The date and time that the cluster was created.

        • AutomatedSnapshotRetentionPeriod — (Integer)

          The number of days that automatic cluster snapshots are retained.

        • ManualSnapshotRetentionPeriod — (Integer)

          The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

          The value must be either -1 or an integer between 1 and 3,653.

        • ClusterSecurityGroups — (Array<map>)

          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.

          • ClusterSecurityGroupName — (String)

            The name of the cluster security group.

          • Status — (String)

            The status of the cluster security group.

        • VpcSecurityGroups — (Array<map>)

          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.

          • VpcSecurityGroupId — (String)

            The identifier of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • ClusterParameterGroups — (Array<map>)

          The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

          • ParameterGroupName — (String)

            The name of the cluster parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • ClusterParameterStatusList — (Array<map>)

            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.

            • 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 — (map)

          A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

          • MasterUserPassword — (String)

            The pending or in-progress change of the admin user password for the cluster.

          • NodeType — (String)

            The pending or in-progress change of the cluster's node type.

          • NumberOfNodes — (Integer)

            The pending or in-progress change of the number of nodes in the cluster.

          • ClusterType — (String)

            The pending or in-progress change of the cluster type.

          • ClusterVersion — (String)

            The pending or in-progress change of the service version.

          • AutomatedSnapshotRetentionPeriod — (Integer)

            The pending or in-progress change of the automated snapshot retention period.

          • ClusterIdentifier — (String)

            The pending or in-progress change of the new identifier for the cluster.

          • PubliclyAccessible — (Boolean)

            The pending or in-progress change of the ability to connect to the cluster from the public network.

          • EnhancedVpcRouting — (Boolean)

            An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

            Default: false

          • MaintenanceTrackName — (String)

            The name of the maintenance track that the cluster will change to during the next maintenance window.

          • EncryptionType — (String)

            The encryption type for a cluster. Possible values are: KMS and None.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • AllowVersionUpgrade — (Boolean)

          A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

        • NumberOfNodes — (Integer)

          The number of compute nodes in the cluster.

        • PubliclyAccessible — (Boolean)

          A boolean value that, if true, indicates that the cluster can be accessed from a public network.

        • Encrypted — (Boolean)

          A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

        • RestoreStatus — (map)

          A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

          • Status — (String)

            The status of the restore action. Returns starting, restoring, completed, or failed.

          • CurrentRestoreRateInMegaBytesPerSecond — (Float)

            The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.

          • SnapshotSizeInMegaBytes — (Integer)

            The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

          • ProgressInMegaBytes — (Integer)

            The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

          • ElapsedTimeInSeconds — (Integer)

            The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.

        • DataTransferProgress — (map)

          • Status — (String)

            Describes the status of the cluster. While the transfer is in progress the status is transferringdata.

          • CurrentRateInMegaBytesPerSecond — (Float)

            Describes the data transfer rate in MB's per second.

          • TotalDataInMegaBytes — (Integer)

            Describes the total amount of data to be transfered in megabytes.

          • DataTransferredInMegaBytes — (Integer)

            Describes the total amount of data that has been transfered in MB's.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            Describes the estimated number of seconds remaining to complete the transfer.

          • ElapsedTimeInSeconds — (Integer)

            Describes the number of seconds that have elapsed during the data transfer.

        • HsmStatus — (map)

          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 — (map)

          A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

          • DestinationRegion — (String)

            The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

          • RetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

          • ManualSnapshotRetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.

            The value must be either -1 or an integer between 1 and 3,653.

          • SnapshotCopyGrantName — (String)

            The name of the snapshot copy grant.

        • ClusterPublicKey — (String)

          The public key for the cluster.

        • ClusterNodes — (Array<map>)

          The nodes in the 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 — (map)

          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 — (Array<map>)

          The list of tags for the cluster.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

        • EnhancedVpcRouting — (Boolean)

          An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

          Default: false

        • IamRoles — (Array<map>)

          A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

          • IamRoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

          • ApplyStatus — (String)

            A value that describes the status of the IAM role's association with an Amazon Redshift cluster.

            The following are possible statuses and descriptions.

            • in-sync: The role is available for use by the cluster.

            • adding: The role is in the process of being associated with the cluster.

            • removing: The role is in the process of being disassociated with the cluster.

        • PendingActions — (Array<String>)

          Cluster operations that are waiting to be started.

        • MaintenanceTrackName — (String)

          The name of the maintenance track for the cluster.

        • ElasticResizeNumberOfNodeOptions — (String)

          The number of nodes that you can resize the cluster to with the elastic resize method.

        • DeferredMaintenanceWindows — (Array<map>)

          Describes a group of DeferredMaintenanceWindow objects.

          • DeferMaintenanceIdentifier — (String)

            A unique identifier for the maintenance window.

          • DeferMaintenanceStartTime — (Date)

            A timestamp for the beginning of the time period when we defer maintenance.

          • DeferMaintenanceEndTime — (Date)

            A timestamp for the end of the time period when we defer maintenance.

        • SnapshotScheduleIdentifier — (String)

          A unique identifier for the cluster snapshot schedule.

        • SnapshotScheduleState — (String)

          The current state of the cluster snapshot schedule.

          Possible values include:
          • "MODIFYING"
          • "ACTIVE"
          • "FAILED"
        • ExpectedNextSnapshotScheduleTime — (Date)

          The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

        • ExpectedNextSnapshotScheduleTimeStatus — (String)

          The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

          • OnTrack - The next snapshot is expected to be taken on time.

          • Pending - The next snapshot is pending to be taken.

        • NextMaintenanceWindowStartTime — (Date)

          The date and time in UTC when system maintenance can begin.

        • ResizeInfo — (map)

          Returns the following:

          • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

          • ResizeType: Returns ClassicResize

          • ResizeType — (String)

            Returns the value ClassicResize.

          • AllowCancelResize — (Boolean)

            A boolean value indicating if the resize operation can be cancelled.

        • AvailabilityZoneRelocationStatus — (String)

          Describes the status of the Availability Zone relocation operation.

        • ClusterNamespaceArn — (String)

          The namespace Amazon Resource Name (ARN) of the cluster.

        • TotalStorageCapacityInMegaBytes — (Integer)

          The total storage capacity of the cluster in megabytes.

        • AquaConfiguration — (map)

          The AQUA (Advanced Query Accelerator) configuration of the cluster.

          • AquaStatus — (String)

            The value indicates the status of AQUA on the cluster. Possible values include the following.

            • enabled - AQUA is enabled.

            • disabled - AQUA is not enabled.

            • applying - AQUA status is being applied.

            Possible values include:
            • "enabled"
            • "disabled"
            • "applying"
          • AquaConfigurationStatus — (String)

            The value represents how the cluster is configured to use AQUA. Possible values include the following.

            • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

            • disabled - Don't use AQUA.

            • auto - Amazon Redshift determines whether to use AQUA.

            Possible values include:
            • "enabled"
            • "disabled"
            • "auto"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifySnapshotSchedule(params = {}, callback) ⇒ AWS.Request

Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.

Service Reference:

Examples:

Calling the modifySnapshotSchedule operation

var params = {
  ScheduleDefinitions: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  ScheduleIdentifier: 'STRING_VALUE' /* required */
};
redshift.modifySnapshotSchedule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ScheduleIdentifier — (String)

      A unique alphanumeric identifier of the schedule to modify.

    • ScheduleDefinitions — (Array<String>)

      An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, "cron(30 12 *)" or "rate(12 hours)".

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ScheduleDefinitions — (Array<String>)

        A list of ScheduleDefinitions.

      • ScheduleIdentifier — (String)

        A unique identifier for the schedule.

      • ScheduleDescription — (String)

        The description of the schedule.

      • Tags — (Array<map>)

        An optional set of tags describing the schedule.

        • Key — (String)

          The key, or name, for the resource tag.

        • Value — (String)

          The value for the resource tag.

      • NextInvocations — (Array<Date>)

      • AssociatedClusterCount — (Integer)

        The number of clusters associated with the schedule.

      • AssociatedClusters — (Array<map>)

        A list of clusters associated with the schedule. A maximum of 100 clusters is returned.

        • ClusterIdentifier — (String)

        • ScheduleAssociationState — (String)

          Possible values include:

          • "MODIFYING"
          • "ACTIVE"
          • "FAILED"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

modifyUsageLimit(params = {}, callback) ⇒ AWS.Request

Modifies a usage limit in a cluster. You can't modify the feature type or period of a usage limit.

Service Reference:

Examples:

Calling the modifyUsageLimit operation

var params = {
  UsageLimitId: 'STRING_VALUE', /* required */
  Amount: 'NUMBER_VALUE',
  BreachAction: log | emit-metric | disable
};
redshift.modifyUsageLimit(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • UsageLimitId — (String)

      The identifier of the usage limit to modify.

    • Amount — (Integer)

      The new limit amount. For more information about this parameter, see UsageLimit.

    • BreachAction — (String)

      The new action that Amazon Redshift takes when the limit is reached. For more information about this parameter, see UsageLimit.

      Possible values include:
      • "log"
      • "emit-metric"
      • "disable"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • UsageLimitId — (String)

        The identifier of the usage limit.

      • ClusterIdentifier — (String)

        The identifier of the cluster with a usage limit.

      • FeatureType — (String)

        The Amazon Redshift feature to which the limit applies.

        Possible values include:
        • "spectrum"
        • "concurrency-scaling"
      • LimitType — (String)

        The type of limit. Depending on the feature type, this can be based on a time duration or data size.

        Possible values include:
        • "time"
        • "data-scanned"
      • Amount — (Integer)

        The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB).

      • Period — (String)

        The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.

        Possible values include:
        • "daily"
        • "weekly"
        • "monthly"
      • BreachAction — (String)

        The action that Amazon Redshift takes when the limit is reached. Possible values are:

        • log - To log an event in a system table. The default is log.

        • emit-metric - To emit CloudWatch metrics.

        • disable - To disable the feature until the next usage period begins.

        Possible values include:
        • "log"
        • "emit-metric"
        • "disable"
      • Tags — (Array<map>)

        A list of tag instances.

        • Key — (String)

          The key, or name, for the resource tag.

        • Value — (String)

          The value for the resource tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

pauseCluster(params = {}, callback) ⇒ AWS.Request

Pauses a cluster.

Service Reference:

Examples:

Calling the pauseCluster operation

var params = {
  ClusterIdentifier: 'STRING_VALUE' /* required */
};
redshift.pauseCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      The identifier of the cluster to be paused.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        Describes a cluster.

        • ClusterIdentifier — (String)

          The unique identifier of the cluster.

        • NodeType — (String)

          The node type for the nodes in the cluster.

        • ClusterStatus — (String)

          The current state of the cluster. Possible values are the following:

          • available

          • available, prep-for-resize

          • available, resize-cleanup

          • cancelling-resize

          • creating

          • deleting

          • final-snapshot

          • hardware-failure

          • incompatible-hsm

          • incompatible-network

          • incompatible-parameters

          • incompatible-restore

          • modifying

          • paused

          • rebooting

          • renaming

          • resizing

          • rotating-keys

          • storage-full

          • updating-hsm

        • ClusterAvailabilityStatus — (String)

          The availability status of the cluster for queries. Possible values are the following:

          • Available - The cluster is available for queries.

          • Unavailable - The cluster is not available for queries.

          • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

          • Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.

          • Failed - The cluster failed and is not available for queries.

        • ModifyStatus — (String)

          The status of a modify operation, if any, initiated for the cluster.

        • MasterUsername — (String)

          The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

        • DBName — (String)

          The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

        • Endpoint — (map)

          The connection endpoint.

          • Address — (String)

            The DNS address of the Cluster.

          • Port — (Integer)

            The port that the database engine is listening on.

          • VpcEndpoints — (Array<map>)

            Describes a connection endpoint.

            • VpcEndpointId — (String)

              The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

            • VpcId — (String)

              The VPC identifier that the endpoint is associated.

            • NetworkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • NetworkInterfaceId — (String)

                The network interface identifier.

              • SubnetId — (String)

                The subnet identifier.

              • PrivateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • AvailabilityZone — (String)

                The Availability Zone.

        • ClusterCreateTime — (Date)

          The date and time that the cluster was created.

        • AutomatedSnapshotRetentionPeriod — (Integer)

          The number of days that automatic cluster snapshots are retained.

        • ManualSnapshotRetentionPeriod — (Integer)

          The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

          The value must be either -1 or an integer between 1 and 3,653.

        • ClusterSecurityGroups — (Array<map>)

          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.

          • ClusterSecurityGroupName — (String)

            The name of the cluster security group.

          • Status — (String)

            The status of the cluster security group.

        • VpcSecurityGroups — (Array<map>)

          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.

          • VpcSecurityGroupId — (String)

            The identifier of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • ClusterParameterGroups — (Array<map>)

          The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

          • ParameterGroupName — (String)

            The name of the cluster parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • ClusterParameterStatusList — (Array<map>)

            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.

            • 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 — (map)

          A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

          • MasterUserPassword — (String)

            The pending or in-progress change of the admin user password for the cluster.

          • NodeType — (String)

            The pending or in-progress change of the cluster's node type.

          • NumberOfNodes — (Integer)

            The pending or in-progress change of the number of nodes in the cluster.

          • ClusterType — (String)

            The pending or in-progress change of the cluster type.

          • ClusterVersion — (String)

            The pending or in-progress change of the service version.

          • AutomatedSnapshotRetentionPeriod — (Integer)

            The pending or in-progress change of the automated snapshot retention period.

          • ClusterIdentifier — (String)

            The pending or in-progress change of the new identifier for the cluster.

          • PubliclyAccessible — (Boolean)

            The pending or in-progress change of the ability to connect to the cluster from the public network.

          • EnhancedVpcRouting — (Boolean)

            An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

            Default: false

          • MaintenanceTrackName — (String)

            The name of the maintenance track that the cluster will change to during the next maintenance window.

          • EncryptionType — (String)

            The encryption type for a cluster. Possible values are: KMS and None.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • AllowVersionUpgrade — (Boolean)

          A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

        • NumberOfNodes — (Integer)

          The number of compute nodes in the cluster.

        • PubliclyAccessible — (Boolean)

          A boolean value that, if true, indicates that the cluster can be accessed from a public network.

        • Encrypted — (Boolean)

          A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

        • RestoreStatus — (map)

          A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

          • Status — (String)

            The status of the restore action. Returns starting, restoring, completed, or failed.

          • CurrentRestoreRateInMegaBytesPerSecond — (Float)

            The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.

          • SnapshotSizeInMegaBytes — (Integer)

            The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

          • ProgressInMegaBytes — (Integer)

            The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

          • ElapsedTimeInSeconds — (Integer)

            The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.

        • DataTransferProgress — (map)

          • Status — (String)

            Describes the status of the cluster. While the transfer is in progress the status is transferringdata.

          • CurrentRateInMegaBytesPerSecond — (Float)

            Describes the data transfer rate in MB's per second.

          • TotalDataInMegaBytes — (Integer)

            Describes the total amount of data to be transfered in megabytes.

          • DataTransferredInMegaBytes — (Integer)

            Describes the total amount of data that has been transfered in MB's.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            Describes the estimated number of seconds remaining to complete the transfer.

          • ElapsedTimeInSeconds — (Integer)

            Describes the number of seconds that have elapsed during the data transfer.

        • HsmStatus — (map)

          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 — (map)

          A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

          • DestinationRegion — (String)

            The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

          • RetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

          • ManualSnapshotRetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.

            The value must be either -1 or an integer between 1 and 3,653.

          • SnapshotCopyGrantName — (String)

            The name of the snapshot copy grant.

        • ClusterPublicKey — (String)

          The public key for the cluster.

        • ClusterNodes — (Array<map>)

          The nodes in the 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 — (map)

          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 — (Array<map>)

          The list of tags for the cluster.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

        • EnhancedVpcRouting — (Boolean)

          An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

          Default: false

        • IamRoles — (Array<map>)

          A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

          • IamRoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

          • ApplyStatus — (String)

            A value that describes the status of the IAM role's association with an Amazon Redshift cluster.

            The following are possible statuses and descriptions.

            • in-sync: The role is available for use by the cluster.

            • adding: The role is in the process of being associated with the cluster.

            • removing: The role is in the process of being disassociated with the cluster.

        • PendingActions — (Array<String>)

          Cluster operations that are waiting to be started.

        • MaintenanceTrackName — (String)

          The name of the maintenance track for the cluster.

        • ElasticResizeNumberOfNodeOptions — (String)

          The number of nodes that you can resize the cluster to with the elastic resize method.

        • DeferredMaintenanceWindows — (Array<map>)

          Describes a group of DeferredMaintenanceWindow objects.

          • DeferMaintenanceIdentifier — (String)

            A unique identifier for the maintenance window.

          • DeferMaintenanceStartTime — (Date)

            A timestamp for the beginning of the time period when we defer maintenance.

          • DeferMaintenanceEndTime — (Date)

            A timestamp for the end of the time period when we defer maintenance.

        • SnapshotScheduleIdentifier — (String)

          A unique identifier for the cluster snapshot schedule.

        • SnapshotScheduleState — (String)

          The current state of the cluster snapshot schedule.

          Possible values include:
          • "MODIFYING"
          • "ACTIVE"
          • "FAILED"
        • ExpectedNextSnapshotScheduleTime — (Date)

          The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

        • ExpectedNextSnapshotScheduleTimeStatus — (String)

          The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

          • OnTrack - The next snapshot is expected to be taken on time.

          • Pending - The next snapshot is pending to be taken.

        • NextMaintenanceWindowStartTime — (Date)

          The date and time in UTC when system maintenance can begin.

        • ResizeInfo — (map)

          Returns the following:

          • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

          • ResizeType: Returns ClassicResize

          • ResizeType — (String)

            Returns the value ClassicResize.

          • AllowCancelResize — (Boolean)

            A boolean value indicating if the resize operation can be cancelled.

        • AvailabilityZoneRelocationStatus — (String)

          Describes the status of the Availability Zone relocation operation.

        • ClusterNamespaceArn — (String)

          The namespace Amazon Resource Name (ARN) of the cluster.

        • TotalStorageCapacityInMegaBytes — (Integer)

          The total storage capacity of the cluster in megabytes.

        • AquaConfiguration — (map)

          The AQUA (Advanced Query Accelerator) configuration of the cluster.

          • AquaStatus — (String)

            The value indicates the status of AQUA on the cluster. Possible values include the following.

            • enabled - AQUA is enabled.

            • disabled - AQUA is not enabled.

            • applying - AQUA status is being applied.

            Possible values include:
            • "enabled"
            • "disabled"
            • "applying"
          • AquaConfigurationStatus — (String)

            The value represents how the cluster is configured to use AQUA. Possible values include the following.

            • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

            • disabled - Don't use AQUA.

            • auto - Amazon Redshift determines whether to use AQUA.

            Possible values include:
            • "enabled"
            • "disabled"
            • "auto"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

purchaseReservedNodeOffering(params = {}, callback) ⇒ AWS.Request

Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve.

For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.

Service Reference:

Examples:

Calling the purchaseReservedNodeOffering operation

var params = {
  ReservedNodeOfferingId: 'STRING_VALUE', /* required */
  NodeCount: 'NUMBER_VALUE'
};
redshift.purchaseReservedNodeOffering(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ReservedNodeOfferingId — (String)

      The unique identifier of the reserved node offering you want to purchase.

    • NodeCount — (Integer)

      The number of reserved nodes that you want to purchase.

      Default: 1

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ReservedNode — (map)

        Describes a reserved node. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings.

        • ReservedNodeId — (String)

          The unique identifier for the reservation.

        • ReservedNodeOfferingId — (String)

          The identifier for the reserved node offering.

        • NodeType — (String)

          The node type of the reserved node.

        • StartTime — (Date)

          The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.

        • Duration — (Integer)

          The duration of the node reservation in seconds.

        • FixedPrice — (Float)

          The fixed cost Amazon Redshift charges you for this reserved node.

        • UsagePrice — (Float)

          The hourly rate Amazon Redshift charges you for this reserved node.

        • CurrencyCode — (String)

          The currency code for the reserved cluster.

        • NodeCount — (Integer)

          The number of reserved compute nodes.

        • State — (String)

          The state of the reserved compute node.

          Possible Values:

          • pending-payment-This reserved node has recently been purchased, and the sale has been approved, but payment has not yet been confirmed.

          • active-This reserved node is owned by the caller and is available for use.

          • payment-failed-Payment failed for the purchase attempt.

          • retired-The reserved node is no longer available.

          • exchanging-The owner is exchanging the reserved node for another reserved node.

        • OfferingType — (String)

          The anticipated utilization of the reserved node, as defined in the reserved node offering.

        • RecurringCharges — (Array<map>)

          The recurring charges for the reserved node.

          • RecurringChargeAmount — (Float)

            The amount charged per the period of time specified by the recurring charge frequency.

          • RecurringChargeFrequency — (String)

            The frequency at which the recurring charge amount is applied.

        • ReservedNodeOfferingType — (String)

          Possible values include:

          • "Regular"
          • "Upgradable"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

rebootCluster(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the rebootCluster operation

var params = {
  ClusterIdentifier: 'STRING_VALUE' /* required */
};
redshift.rebootCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      The cluster identifier.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        Describes a cluster.

        • ClusterIdentifier — (String)

          The unique identifier of the cluster.

        • NodeType — (String)

          The node type for the nodes in the cluster.

        • ClusterStatus — (String)

          The current state of the cluster. Possible values are the following:

          • available

          • available, prep-for-resize

          • available, resize-cleanup

          • cancelling-resize

          • creating

          • deleting

          • final-snapshot

          • hardware-failure

          • incompatible-hsm

          • incompatible-network

          • incompatible-parameters

          • incompatible-restore

          • modifying

          • paused

          • rebooting

          • renaming

          • resizing

          • rotating-keys

          • storage-full

          • updating-hsm

        • ClusterAvailabilityStatus — (String)

          The availability status of the cluster for queries. Possible values are the following:

          • Available - The cluster is available for queries.

          • Unavailable - The cluster is not available for queries.

          • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

          • Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.

          • Failed - The cluster failed and is not available for queries.

        • ModifyStatus — (String)

          The status of a modify operation, if any, initiated for the cluster.

        • MasterUsername — (String)

          The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

        • DBName — (String)

          The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

        • Endpoint — (map)

          The connection endpoint.

          • Address — (String)

            The DNS address of the Cluster.

          • Port — (Integer)

            The port that the database engine is listening on.

          • VpcEndpoints — (Array<map>)

            Describes a connection endpoint.

            • VpcEndpointId — (String)

              The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

            • VpcId — (String)

              The VPC identifier that the endpoint is associated.

            • NetworkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • NetworkInterfaceId — (String)

                The network interface identifier.

              • SubnetId — (String)

                The subnet identifier.

              • PrivateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • AvailabilityZone — (String)

                The Availability Zone.

        • ClusterCreateTime — (Date)

          The date and time that the cluster was created.

        • AutomatedSnapshotRetentionPeriod — (Integer)

          The number of days that automatic cluster snapshots are retained.

        • ManualSnapshotRetentionPeriod — (Integer)

          The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

          The value must be either -1 or an integer between 1 and 3,653.

        • ClusterSecurityGroups — (Array<map>)

          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.

          • ClusterSecurityGroupName — (String)

            The name of the cluster security group.

          • Status — (String)

            The status of the cluster security group.

        • VpcSecurityGroups — (Array<map>)

          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.

          • VpcSecurityGroupId — (String)

            The identifier of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • ClusterParameterGroups — (Array<map>)

          The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

          • ParameterGroupName — (String)

            The name of the cluster parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • ClusterParameterStatusList — (Array<map>)

            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.

            • 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 — (map)

          A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

          • MasterUserPassword — (String)

            The pending or in-progress change of the admin user password for the cluster.

          • NodeType — (String)

            The pending or in-progress change of the cluster's node type.

          • NumberOfNodes — (Integer)

            The pending or in-progress change of the number of nodes in the cluster.

          • ClusterType — (String)

            The pending or in-progress change of the cluster type.

          • ClusterVersion — (String)

            The pending or in-progress change of the service version.

          • AutomatedSnapshotRetentionPeriod — (Integer)

            The pending or in-progress change of the automated snapshot retention period.

          • ClusterIdentifier — (String)

            The pending or in-progress change of the new identifier for the cluster.

          • PubliclyAccessible — (Boolean)

            The pending or in-progress change of the ability to connect to the cluster from the public network.

          • EnhancedVpcRouting — (Boolean)

            An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

            Default: false

          • MaintenanceTrackName — (String)

            The name of the maintenance track that the cluster will change to during the next maintenance window.

          • EncryptionType — (String)

            The encryption type for a cluster. Possible values are: KMS and None.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • AllowVersionUpgrade — (Boolean)

          A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

        • NumberOfNodes — (Integer)

          The number of compute nodes in the cluster.

        • PubliclyAccessible — (Boolean)

          A boolean value that, if true, indicates that the cluster can be accessed from a public network.

        • Encrypted — (Boolean)

          A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

        • RestoreStatus — (map)

          A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

          • Status — (String)

            The status of the restore action. Returns starting, restoring, completed, or failed.

          • CurrentRestoreRateInMegaBytesPerSecond — (Float)

            The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.

          • SnapshotSizeInMegaBytes — (Integer)

            The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

          • ProgressInMegaBytes — (Integer)

            The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

          • ElapsedTimeInSeconds — (Integer)

            The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.

        • DataTransferProgress — (map)

          • Status — (String)

            Describes the status of the cluster. While the transfer is in progress the status is transferringdata.

          • CurrentRateInMegaBytesPerSecond — (Float)

            Describes the data transfer rate in MB's per second.

          • TotalDataInMegaBytes — (Integer)

            Describes the total amount of data to be transfered in megabytes.

          • DataTransferredInMegaBytes — (Integer)

            Describes the total amount of data that has been transfered in MB's.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            Describes the estimated number of seconds remaining to complete the transfer.

          • ElapsedTimeInSeconds — (Integer)

            Describes the number of seconds that have elapsed during the data transfer.

        • HsmStatus — (map)

          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 — (map)

          A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

          • DestinationRegion — (String)

            The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

          • RetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

          • ManualSnapshotRetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.

            The value must be either -1 or an integer between 1 and 3,653.

          • SnapshotCopyGrantName — (String)

            The name of the snapshot copy grant.

        • ClusterPublicKey — (String)

          The public key for the cluster.

        • ClusterNodes — (Array<map>)

          The nodes in the 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 — (map)

          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 — (Array<map>)

          The list of tags for the cluster.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

        • EnhancedVpcRouting — (Boolean)

          An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

          Default: false

        • IamRoles — (Array<map>)

          A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

          • IamRoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

          • ApplyStatus — (String)

            A value that describes the status of the IAM role's association with an Amazon Redshift cluster.

            The following are possible statuses and descriptions.

            • in-sync: The role is available for use by the cluster.

            • adding: The role is in the process of being associated with the cluster.

            • removing: The role is in the process of being disassociated with the cluster.

        • PendingActions — (Array<String>)

          Cluster operations that are waiting to be started.

        • MaintenanceTrackName — (String)

          The name of the maintenance track for the cluster.

        • ElasticResizeNumberOfNodeOptions — (String)

          The number of nodes that you can resize the cluster to with the elastic resize method.

        • DeferredMaintenanceWindows — (Array<map>)

          Describes a group of DeferredMaintenanceWindow objects.

          • DeferMaintenanceIdentifier — (String)

            A unique identifier for the maintenance window.

          • DeferMaintenanceStartTime — (Date)

            A timestamp for the beginning of the time period when we defer maintenance.

          • DeferMaintenanceEndTime — (Date)

            A timestamp for the end of the time period when we defer maintenance.

        • SnapshotScheduleIdentifier — (String)

          A unique identifier for the cluster snapshot schedule.

        • SnapshotScheduleState — (String)

          The current state of the cluster snapshot schedule.

          Possible values include:
          • "MODIFYING"
          • "ACTIVE"
          • "FAILED"
        • ExpectedNextSnapshotScheduleTime — (Date)

          The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

        • ExpectedNextSnapshotScheduleTimeStatus — (String)

          The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

          • OnTrack - The next snapshot is expected to be taken on time.

          • Pending - The next snapshot is pending to be taken.

        • NextMaintenanceWindowStartTime — (Date)

          The date and time in UTC when system maintenance can begin.

        • ResizeInfo — (map)

          Returns the following:

          • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

          • ResizeType: Returns ClassicResize

          • ResizeType — (String)

            Returns the value ClassicResize.

          • AllowCancelResize — (Boolean)

            A boolean value indicating if the resize operation can be cancelled.

        • AvailabilityZoneRelocationStatus — (String)

          Describes the status of the Availability Zone relocation operation.

        • ClusterNamespaceArn — (String)

          The namespace Amazon Resource Name (ARN) of the cluster.

        • TotalStorageCapacityInMegaBytes — (Integer)

          The total storage capacity of the cluster in megabytes.

        • AquaConfiguration — (map)

          The AQUA (Advanced Query Accelerator) configuration of the cluster.

          • AquaStatus — (String)

            The value indicates the status of AQUA on the cluster. Possible values include the following.

            • enabled - AQUA is enabled.

            • disabled - AQUA is not enabled.

            • applying - AQUA status is being applied.

            Possible values include:
            • "enabled"
            • "disabled"
            • "applying"
          • AquaConfigurationStatus — (String)

            The value represents how the cluster is configured to use AQUA. Possible values include the following.

            • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

            • disabled - Don't use AQUA.

            • auto - Amazon Redshift determines whether to use AQUA.

            Possible values include:
            • "enabled"
            • "disabled"
            • "auto"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

rejectDataShare(params = {}, callback) ⇒ AWS.Request

From the consumer account, rejects the specified datashare.

Service Reference:

Examples:

Calling the rejectDataShare operation

var params = {
  DataShareArn: 'STRING_VALUE' /* required */
};
redshift.rejectDataShare(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DataShareArn — (String)

      The Amazon Resource Name (ARN) of the datashare to reject.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DataShareArn — (String)

        An Amazon Resource Name (ARN) that references the datashare that is owned by a specific namespace of the producer cluster. A datashare ARN is in the arn:aws:redshift:{region}:{account-id}:{datashare}:{namespace-guid}/{datashare-name} format.

      • ProducerArn — (String)

        The Amazon Resource Name (ARN) of the producer.

      • AllowPubliclyAccessibleConsumers — (Boolean)

        A value that specifies whether the datashare can be shared to a publicly accessible cluster.

      • DataShareAssociations — (Array<map>)

        A value that specifies when the datashare has an association between a producer and data consumers.

        • ConsumerIdentifier — (String)

          The name of the consumer accounts that have an association with a producer datashare.

        • Status — (String)

          The status of the datashare that is associated.

          Possible values include:
          • "ACTIVE"
          • "PENDING_AUTHORIZATION"
          • "AUTHORIZED"
          • "DEAUTHORIZED"
          • "REJECTED"
          • "AVAILABLE"
        • CreatedDate — (Date)

          The creation date of the datashare that is associated.

        • StatusChangeDate — (Date)

          The status change data of the datashare that is associated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

resetClusterParameterGroup(params = {}, callback) ⇒ AWS.Request

Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to "engine-default". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters.

Service Reference:

Examples:

Calling the resetClusterParameterGroup operation

var params = {
  ParameterGroupName: 'STRING_VALUE', /* required */
  Parameters: [
    {
      AllowedValues: 'STRING_VALUE',
      ApplyType: static | dynamic,
      DataType: 'STRING_VALUE',
      Description: 'STRING_VALUE',
      IsModifiable: true || false,
      MinimumEngineVersion: 'STRING_VALUE',
      ParameterName: 'STRING_VALUE',
      ParameterValue: 'STRING_VALUE',
      Source: 'STRING_VALUE'
    },
    /* more items */
  ],
  ResetAllParameters: true || false
};
redshift.resetClusterParameterGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ParameterGroupName — (String)

      The name of the cluster parameter group to be reset.

    • ResetAllParameters — (Boolean)

      If true, all parameters in the specified parameter group will be reset to their default values.

      Default: true

    • Parameters — (Array<map>)

      An array of names of parameters to be reset. If ResetAllParameters option is not used, then at least one parameter name must be supplied.

      Constraints: A maximum of 20 parameters can be reset in a single request.

      • ParameterName — (String)

        The name of the parameter.

      • ParameterValue — (String)

        The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.

      • Description — (String)

        A description of the parameter.

      • Source — (String)

        The source of the parameter value, such as "engine-default" or "user".

      • DataType — (String)

        The data type of the parameter.

      • AllowedValues — (String)

        The valid range of values for the parameter.

      • ApplyType — (String)

        Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

        Possible values include:
        • "static"
        • "dynamic"
      • IsModifiable — (Boolean)

        If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

      • MinimumEngineVersion — (String)

        The earliest engine version to which the parameter can apply.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ParameterGroupName — (String)

        The name of the cluster parameter group.

      • ParameterGroupStatus — (String)

        The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

resizeCluster(params = {}, callback) ⇒ AWS.Request

Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method.

Elastic resize operations have the following restrictions:

  • You can only resize clusters of the following types:

    • dc1.large (if your cluster is in a VPC)

    • dc1.8xlarge (if your cluster is in a VPC)

    • dc2.large

    • dc2.8xlarge

    • ds2.xlarge

    • ds2.8xlarge

    • ra3.xlplus

    • ra3.4xlarge

    • ra3.16xlarge

  • The type of nodes that you add must match the node type for the cluster.

Service Reference:

Examples:

Calling the resizeCluster operation

var params = {
  ClusterIdentifier: 'STRING_VALUE', /* required */
  Classic: true || false,
  ClusterType: 'STRING_VALUE',
  NodeType: 'STRING_VALUE',
  NumberOfNodes: 'NUMBER_VALUE'
};
redshift.resizeCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      The unique identifier for the cluster to resize.

    • ClusterType — (String)

      The new cluster type for the specified cluster.

    • NodeType — (String)

      The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.

    • NumberOfNodes — (Integer)

      The new number of nodes for the cluster. If not specified, the cluster's current number of nodes is used.

    • Classic — (Boolean)

      A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false, the resize type is elastic.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        Describes a cluster.

        • ClusterIdentifier — (String)

          The unique identifier of the cluster.

        • NodeType — (String)

          The node type for the nodes in the cluster.

        • ClusterStatus — (String)

          The current state of the cluster. Possible values are the following:

          • available

          • available, prep-for-resize

          • available, resize-cleanup

          • cancelling-resize

          • creating

          • deleting

          • final-snapshot

          • hardware-failure

          • incompatible-hsm

          • incompatible-network

          • incompatible-parameters

          • incompatible-restore

          • modifying

          • paused

          • rebooting

          • renaming

          • resizing

          • rotating-keys

          • storage-full

          • updating-hsm

        • ClusterAvailabilityStatus — (String)

          The availability status of the cluster for queries. Possible values are the following:

          • Available - The cluster is available for queries.

          • Unavailable - The cluster is not available for queries.

          • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

          • Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.

          • Failed - The cluster failed and is not available for queries.

        • ModifyStatus — (String)

          The status of a modify operation, if any, initiated for the cluster.

        • MasterUsername — (String)

          The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

        • DBName — (String)

          The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

        • Endpoint — (map)

          The connection endpoint.

          • Address — (String)

            The DNS address of the Cluster.

          • Port — (Integer)

            The port that the database engine is listening on.

          • VpcEndpoints — (Array<map>)

            Describes a connection endpoint.

            • VpcEndpointId — (String)

              The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

            • VpcId — (String)

              The VPC identifier that the endpoint is associated.

            • NetworkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • NetworkInterfaceId — (String)

                The network interface identifier.

              • SubnetId — (String)

                The subnet identifier.

              • PrivateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • AvailabilityZone — (String)

                The Availability Zone.

        • ClusterCreateTime — (Date)

          The date and time that the cluster was created.

        • AutomatedSnapshotRetentionPeriod — (Integer)

          The number of days that automatic cluster snapshots are retained.

        • ManualSnapshotRetentionPeriod — (Integer)

          The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

          The value must be either -1 or an integer between 1 and 3,653.

        • ClusterSecurityGroups — (Array<map>)

          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.

          • ClusterSecurityGroupName — (String)

            The name of the cluster security group.

          • Status — (String)

            The status of the cluster security group.

        • VpcSecurityGroups — (Array<map>)

          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.

          • VpcSecurityGroupId — (String)

            The identifier of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • ClusterParameterGroups — (Array<map>)

          The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

          • ParameterGroupName — (String)

            The name of the cluster parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • ClusterParameterStatusList — (Array<map>)

            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.

            • 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 — (map)

          A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

          • MasterUserPassword — (String)

            The pending or in-progress change of the admin user password for the cluster.

          • NodeType — (String)

            The pending or in-progress change of the cluster's node type.

          • NumberOfNodes — (Integer)

            The pending or in-progress change of the number of nodes in the cluster.

          • ClusterType — (String)

            The pending or in-progress change of the cluster type.

          • ClusterVersion — (String)

            The pending or in-progress change of the service version.

          • AutomatedSnapshotRetentionPeriod — (Integer)

            The pending or in-progress change of the automated snapshot retention period.

          • ClusterIdentifier — (String)

            The pending or in-progress change of the new identifier for the cluster.

          • PubliclyAccessible — (Boolean)

            The pending or in-progress change of the ability to connect to the cluster from the public network.

          • EnhancedVpcRouting — (Boolean)

            An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

            Default: false

          • MaintenanceTrackName — (String)

            The name of the maintenance track that the cluster will change to during the next maintenance window.

          • EncryptionType — (String)

            The encryption type for a cluster. Possible values are: KMS and None.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • AllowVersionUpgrade — (Boolean)

          A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

        • NumberOfNodes — (Integer)

          The number of compute nodes in the cluster.

        • PubliclyAccessible — (Boolean)

          A boolean value that, if true, indicates that the cluster can be accessed from a public network.

        • Encrypted — (Boolean)

          A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

        • RestoreStatus — (map)

          A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

          • Status — (String)

            The status of the restore action. Returns starting, restoring, completed, or failed.

          • CurrentRestoreRateInMegaBytesPerSecond — (Float)

            The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.

          • SnapshotSizeInMegaBytes — (Integer)

            The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

          • ProgressInMegaBytes — (Integer)

            The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

          • ElapsedTimeInSeconds — (Integer)

            The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.

        • DataTransferProgress — (map)

          • Status — (String)

            Describes the status of the cluster. While the transfer is in progress the status is transferringdata.

          • CurrentRateInMegaBytesPerSecond — (Float)

            Describes the data transfer rate in MB's per second.

          • TotalDataInMegaBytes — (Integer)

            Describes the total amount of data to be transfered in megabytes.

          • DataTransferredInMegaBytes — (Integer)

            Describes the total amount of data that has been transfered in MB's.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            Describes the estimated number of seconds remaining to complete the transfer.

          • ElapsedTimeInSeconds — (Integer)

            Describes the number of seconds that have elapsed during the data transfer.

        • HsmStatus — (map)

          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 — (map)

          A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

          • DestinationRegion — (String)

            The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

          • RetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

          • ManualSnapshotRetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.

            The value must be either -1 or an integer between 1 and 3,653.

          • SnapshotCopyGrantName — (String)

            The name of the snapshot copy grant.

        • ClusterPublicKey — (String)

          The public key for the cluster.

        • ClusterNodes — (Array<map>)

          The nodes in the 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 — (map)

          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 — (Array<map>)

          The list of tags for the cluster.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

        • EnhancedVpcRouting — (Boolean)

          An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

          Default: false

        • IamRoles — (Array<map>)

          A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

          • IamRoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

          • ApplyStatus — (String)

            A value that describes the status of the IAM role's association with an Amazon Redshift cluster.

            The following are possible statuses and descriptions.

            • in-sync: The role is available for use by the cluster.

            • adding: The role is in the process of being associated with the cluster.

            • removing: The role is in the process of being disassociated with the cluster.

        • PendingActions — (Array<String>)

          Cluster operations that are waiting to be started.

        • MaintenanceTrackName — (String)

          The name of the maintenance track for the cluster.

        • ElasticResizeNumberOfNodeOptions — (String)

          The number of nodes that you can resize the cluster to with the elastic resize method.

        • DeferredMaintenanceWindows — (Array<map>)

          Describes a group of DeferredMaintenanceWindow objects.

          • DeferMaintenanceIdentifier — (String)

            A unique identifier for the maintenance window.

          • DeferMaintenanceStartTime — (Date)

            A timestamp for the beginning of the time period when we defer maintenance.

          • DeferMaintenanceEndTime — (Date)

            A timestamp for the end of the time period when we defer maintenance.

        • SnapshotScheduleIdentifier — (String)

          A unique identifier for the cluster snapshot schedule.

        • SnapshotScheduleState — (String)

          The current state of the cluster snapshot schedule.

          Possible values include:
          • "MODIFYING"
          • "ACTIVE"
          • "FAILED"
        • ExpectedNextSnapshotScheduleTime — (Date)

          The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

        • ExpectedNextSnapshotScheduleTimeStatus — (String)

          The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

          • OnTrack - The next snapshot is expected to be taken on time.

          • Pending - The next snapshot is pending to be taken.

        • NextMaintenanceWindowStartTime — (Date)

          The date and time in UTC when system maintenance can begin.

        • ResizeInfo — (map)

          Returns the following:

          • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

          • ResizeType: Returns ClassicResize

          • ResizeType — (String)

            Returns the value ClassicResize.

          • AllowCancelResize — (Boolean)

            A boolean value indicating if the resize operation can be cancelled.

        • AvailabilityZoneRelocationStatus — (String)

          Describes the status of the Availability Zone relocation operation.

        • ClusterNamespaceArn — (String)

          The namespace Amazon Resource Name (ARN) of the cluster.

        • TotalStorageCapacityInMegaBytes — (Integer)

          The total storage capacity of the cluster in megabytes.

        • AquaConfiguration — (map)

          The AQUA (Advanced Query Accelerator) configuration of the cluster.

          • AquaStatus — (String)

            The value indicates the status of AQUA on the cluster. Possible values include the following.

            • enabled - AQUA is enabled.

            • disabled - AQUA is not enabled.

            • applying - AQUA status is being applied.

            Possible values include:
            • "enabled"
            • "disabled"
            • "applying"
          • AquaConfigurationStatus — (String)

            The value represents how the cluster is configured to use AQUA. Possible values include the following.

            • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

            • disabled - Don't use AQUA.

            • auto - Amazon Redshift determines whether to use AQUA.

            Possible values include:
            • "enabled"
            • "disabled"
            • "auto"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

restoreFromClusterSnapshot(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the restoreFromClusterSnapshot operation

var params = {
  ClusterIdentifier: 'STRING_VALUE', /* required */
  SnapshotIdentifier: 'STRING_VALUE', /* required */
  AdditionalInfo: 'STRING_VALUE',
  AllowVersionUpgrade: true || false,
  AquaConfigurationStatus: enabled | disabled | auto,
  AutomatedSnapshotRetentionPeriod: 'NUMBER_VALUE',
  AvailabilityZone: 'STRING_VALUE',
  AvailabilityZoneRelocation: true || false,
  ClusterParameterGroupName: 'STRING_VALUE',
  ClusterSecurityGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  ClusterSubnetGroupName: 'STRING_VALUE',
  ElasticIp: 'STRING_VALUE',
  EnhancedVpcRouting: true || false,
  HsmClientCertificateIdentifier: 'STRING_VALUE',
  HsmConfigurationIdentifier: 'STRING_VALUE',
  IamRoles: [
    'STRING_VALUE',
    /* more items */
  ],
  KmsKeyId: 'STRING_VALUE',
  MaintenanceTrackName: 'STRING_VALUE',
  ManualSnapshotRetentionPeriod: 'NUMBER_VALUE',
  NodeType: 'STRING_VALUE',
  NumberOfNodes: 'NUMBER_VALUE',
  OwnerAccount: 'STRING_VALUE',
  Port: 'NUMBER_VALUE',
  PreferredMaintenanceWindow: 'STRING_VALUE',
  PubliclyAccessible: true || false,
  SnapshotClusterIdentifier: 'STRING_VALUE',
  SnapshotScheduleIdentifier: 'STRING_VALUE',
  VpcSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
redshift.restoreFromClusterSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

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

      Constraints:

      • Must contain from 1 to 63 alphanumeric characters or hyphens.

      • Alphabetic characters must be lowercase.

      • First character must be a letter.

      • Cannot end with a hyphen or contain two consecutive hyphens.

      • Must be unique for all clusters within an Amazon Web Services account.

    • SnapshotIdentifier — (String)

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

      Example: my-snapshot-id

    • SnapshotClusterIdentifier — (String)

      The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

    • Port — (Integer)

      The port number on which the cluster accepts connections.

      Default: The same port as the original cluster.

      Constraints: Must be between 1115 and 65535.

    • AvailabilityZone — (String)

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

      Default: A random, system-chosen Availability Zone.

      Example: us-east-2a

    • AllowVersionUpgrade — (Boolean)

      If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

      Default: true

    • ClusterSubnetGroupName — (String)

      The name of the subnet group where you want to cluster restored.

      A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.

    • PubliclyAccessible — (Boolean)

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

    • OwnerAccount — (String)

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

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

    • ElasticIp — (String)

      The elastic IP (EIP) address for the cluster.

    • ClusterParameterGroupName — (String)

      The name of the parameter group to be associated with this cluster.

      Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups.

      Constraints:

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

    • ClusterSecurityGroups — (Array<String>)

      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.

    • VpcSecurityGroupIds — (Array<String>)

      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.

    • PreferredMaintenanceWindow — (String)

      The weekly time range (in UTC) during which automated cluster maintenance can occur.

      Format: ddd:hh24:mi-ddd:hh24:mi

      Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

      Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

      Constraints: Minimum 30-minute window.

    • AutomatedSnapshotRetentionPeriod — (Integer)

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

      You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.

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

      Constraints: Must be a value from 0 to 35.

    • ManualSnapshotRetentionPeriod — (Integer)

      The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

      The value must be either -1 or an integer between 1 and 3,653.

    • KmsKeyId — (String)

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

    • NodeType — (String)

      The node type that the restored cluster will be provisioned with.

      Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds1.xlarge into ds2.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type or dc2.large instance type. You can't restore dc1.8xlarge to dc2.8xlarge. First restore to a dc1.8xlarge cluster, then resize to a dc2.8large cluster. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide.

    • 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

    • AdditionalInfo — (String)

      Reserved.

    • IamRoles — (Array<String>)

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

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

    • MaintenanceTrackName — (String)

      The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The snapshot might be on a different track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source cluster are on different tracks.

    • SnapshotScheduleIdentifier — (String)

      A unique identifier for the snapshot schedule.

    • NumberOfNodes — (Integer)

      The number of nodes specified when provisioning the restored cluster.

    • AvailabilityZoneRelocation — (Boolean)

      The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.

    • AquaConfigurationStatus — (String)

      The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.

      • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

      • disabled - Don't use AQUA.

      • auto - Amazon Redshift determines whether to use AQUA.

      Possible values include:
      • "enabled"
      • "disabled"
      • "auto"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        Describes a cluster.

        • ClusterIdentifier — (String)

          The unique identifier of the cluster.

        • NodeType — (String)

          The node type for the nodes in the cluster.

        • ClusterStatus — (String)

          The current state of the cluster. Possible values are the following:

          • available

          • available, prep-for-resize

          • available, resize-cleanup

          • cancelling-resize

          • creating

          • deleting

          • final-snapshot

          • hardware-failure

          • incompatible-hsm

          • incompatible-network

          • incompatible-parameters

          • incompatible-restore

          • modifying

          • paused

          • rebooting

          • renaming

          • resizing

          • rotating-keys

          • storage-full

          • updating-hsm

        • ClusterAvailabilityStatus — (String)

          The availability status of the cluster for queries. Possible values are the following:

          • Available - The cluster is available for queries.

          • Unavailable - The cluster is not available for queries.

          • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

          • Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.

          • Failed - The cluster failed and is not available for queries.

        • ModifyStatus — (String)

          The status of a modify operation, if any, initiated for the cluster.

        • MasterUsername — (String)

          The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

        • DBName — (String)

          The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

        • Endpoint — (map)

          The connection endpoint.

          • Address — (String)

            The DNS address of the Cluster.

          • Port — (Integer)

            The port that the database engine is listening on.

          • VpcEndpoints — (Array<map>)

            Describes a connection endpoint.

            • VpcEndpointId — (String)

              The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

            • VpcId — (String)

              The VPC identifier that the endpoint is associated.

            • NetworkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • NetworkInterfaceId — (String)

                The network interface identifier.

              • SubnetId — (String)

                The subnet identifier.

              • PrivateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • AvailabilityZone — (String)

                The Availability Zone.

        • ClusterCreateTime — (Date)

          The date and time that the cluster was created.

        • AutomatedSnapshotRetentionPeriod — (Integer)

          The number of days that automatic cluster snapshots are retained.

        • ManualSnapshotRetentionPeriod — (Integer)

          The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

          The value must be either -1 or an integer between 1 and 3,653.

        • ClusterSecurityGroups — (Array<map>)

          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.

          • ClusterSecurityGroupName — (String)

            The name of the cluster security group.

          • Status — (String)

            The status of the cluster security group.

        • VpcSecurityGroups — (Array<map>)

          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.

          • VpcSecurityGroupId — (String)

            The identifier of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • ClusterParameterGroups — (Array<map>)

          The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

          • ParameterGroupName — (String)

            The name of the cluster parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • ClusterParameterStatusList — (Array<map>)

            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.

            • 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 — (map)

          A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

          • MasterUserPassword — (String)

            The pending or in-progress change of the admin user password for the cluster.

          • NodeType — (String)

            The pending or in-progress change of the cluster's node type.

          • NumberOfNodes — (Integer)

            The pending or in-progress change of the number of nodes in the cluster.

          • ClusterType — (String)

            The pending or in-progress change of the cluster type.

          • ClusterVersion — (String)

            The pending or in-progress change of the service version.

          • AutomatedSnapshotRetentionPeriod — (Integer)

            The pending or in-progress change of the automated snapshot retention period.

          • ClusterIdentifier — (String)

            The pending or in-progress change of the new identifier for the cluster.

          • PubliclyAccessible — (Boolean)

            The pending or in-progress change of the ability to connect to the cluster from the public network.

          • EnhancedVpcRouting — (Boolean)

            An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

            Default: false

          • MaintenanceTrackName — (String)

            The name of the maintenance track that the cluster will change to during the next maintenance window.

          • EncryptionType — (String)

            The encryption type for a cluster. Possible values are: KMS and None.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • AllowVersionUpgrade — (Boolean)

          A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

        • NumberOfNodes — (Integer)

          The number of compute nodes in the cluster.

        • PubliclyAccessible — (Boolean)

          A boolean value that, if true, indicates that the cluster can be accessed from a public network.

        • Encrypted — (Boolean)

          A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

        • RestoreStatus — (map)

          A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

          • Status — (String)

            The status of the restore action. Returns starting, restoring, completed, or failed.

          • CurrentRestoreRateInMegaBytesPerSecond — (Float)

            The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.

          • SnapshotSizeInMegaBytes — (Integer)

            The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

          • ProgressInMegaBytes — (Integer)

            The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

          • ElapsedTimeInSeconds — (Integer)

            The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.

        • DataTransferProgress — (map)

          • Status — (String)

            Describes the status of the cluster. While the transfer is in progress the status is transferringdata.

          • CurrentRateInMegaBytesPerSecond — (Float)

            Describes the data transfer rate in MB's per second.

          • TotalDataInMegaBytes — (Integer)

            Describes the total amount of data to be transfered in megabytes.

          • DataTransferredInMegaBytes — (Integer)

            Describes the total amount of data that has been transfered in MB's.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            Describes the estimated number of seconds remaining to complete the transfer.

          • ElapsedTimeInSeconds — (Integer)

            Describes the number of seconds that have elapsed during the data transfer.

        • HsmStatus — (map)

          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 — (map)

          A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

          • DestinationRegion — (String)

            The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

          • RetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

          • ManualSnapshotRetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.

            The value must be either -1 or an integer between 1 and 3,653.

          • SnapshotCopyGrantName — (String)

            The name of the snapshot copy grant.

        • ClusterPublicKey — (String)

          The public key for the cluster.

        • ClusterNodes — (Array<map>)

          The nodes in the 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 — (map)

          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 — (Array<map>)

          The list of tags for the cluster.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

        • EnhancedVpcRouting — (Boolean)

          An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

          Default: false

        • IamRoles — (Array<map>)

          A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

          • IamRoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

          • ApplyStatus — (String)

            A value that describes the status of the IAM role's association with an Amazon Redshift cluster.

            The following are possible statuses and descriptions.

            • in-sync: The role is available for use by the cluster.

            • adding: The role is in the process of being associated with the cluster.

            • removing: The role is in the process of being disassociated with the cluster.

        • PendingActions — (Array<String>)

          Cluster operations that are waiting to be started.

        • MaintenanceTrackName — (String)

          The name of the maintenance track for the cluster.

        • ElasticResizeNumberOfNodeOptions — (String)

          The number of nodes that you can resize the cluster to with the elastic resize method.

        • DeferredMaintenanceWindows — (Array<map>)

          Describes a group of DeferredMaintenanceWindow objects.

          • DeferMaintenanceIdentifier — (String)

            A unique identifier for the maintenance window.

          • DeferMaintenanceStartTime — (Date)

            A timestamp for the beginning of the time period when we defer maintenance.

          • DeferMaintenanceEndTime — (Date)

            A timestamp for the end of the time period when we defer maintenance.

        • SnapshotScheduleIdentifier — (String)

          A unique identifier for the cluster snapshot schedule.

        • SnapshotScheduleState — (String)

          The current state of the cluster snapshot schedule.

          Possible values include:
          • "MODIFYING"
          • "ACTIVE"
          • "FAILED"
        • ExpectedNextSnapshotScheduleTime — (Date)

          The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

        • ExpectedNextSnapshotScheduleTimeStatus — (String)

          The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

          • OnTrack - The next snapshot is expected to be taken on time.

          • Pending - The next snapshot is pending to be taken.

        • NextMaintenanceWindowStartTime — (Date)

          The date and time in UTC when system maintenance can begin.

        • ResizeInfo — (map)

          Returns the following:

          • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

          • ResizeType: Returns ClassicResize

          • ResizeType — (String)

            Returns the value ClassicResize.

          • AllowCancelResize — (Boolean)

            A boolean value indicating if the resize operation can be cancelled.

        • AvailabilityZoneRelocationStatus — (String)

          Describes the status of the Availability Zone relocation operation.

        • ClusterNamespaceArn — (String)

          The namespace Amazon Resource Name (ARN) of the cluster.

        • TotalStorageCapacityInMegaBytes — (Integer)

          The total storage capacity of the cluster in megabytes.

        • AquaConfiguration — (map)

          The AQUA (Advanced Query Accelerator) configuration of the cluster.

          • AquaStatus — (String)

            The value indicates the status of AQUA on the cluster. Possible values include the following.

            • enabled - AQUA is enabled.

            • disabled - AQUA is not enabled.

            • applying - AQUA status is being applied.

            Possible values include:
            • "enabled"
            • "disabled"
            • "applying"
          • AquaConfigurationStatus — (String)

            The value represents how the cluster is configured to use AQUA. Possible values include the following.

            • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

            • disabled - Don't use AQUA.

            • auto - Amazon Redshift determines whether to use AQUA.

            Possible values include:
            • "enabled"
            • "disabled"
            • "auto"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

restoreTableFromClusterSnapshot(params = {}, callback) ⇒ AWS.Request

Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from.

You cannot use RestoreTableFromClusterSnapshot to restore a table with the same name as an existing table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored table. If you want to replace your original table with a new, restored table, then rename or drop your original table before you call RestoreTableFromClusterSnapshot. When you have renamed your original table, then you can pass the original name of the table as the NewTableName parameter value in the call to RestoreTableFromClusterSnapshot. This way, you can replace the original table with the table created from the snapshot.

Service Reference:

Examples:

Calling the restoreTableFromClusterSnapshot operation

var params = {
  ClusterIdentifier: 'STRING_VALUE', /* required */
  NewTableName: 'STRING_VALUE', /* required */
  SnapshotIdentifier: 'STRING_VALUE', /* required */
  SourceDatabaseName: 'STRING_VALUE', /* required */
  SourceTableName: 'STRING_VALUE', /* required */
  EnableCaseSensitiveIdentifier: true || false,
  SourceSchemaName: 'STRING_VALUE',
  TargetDatabaseName: 'STRING_VALUE',
  TargetSchemaName: 'STRING_VALUE'
};
redshift.restoreTableFromClusterSnapshot(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      The identifier of the Amazon Redshift cluster to restore the table to.

    • SnapshotIdentifier — (String)

      The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the ClusterIdentifier parameter.

    • SourceDatabaseName — (String)

      The name of the source database that contains the table to restore from.

    • SourceSchemaName — (String)

      The name of the source schema that contains the table to restore from. If you do not specify a SourceSchemaName value, the default is public.

    • SourceTableName — (String)

      The name of the source table to restore from.

    • TargetDatabaseName — (String)

      The name of the database to restore the table to.

    • TargetSchemaName — (String)

      The name of the schema to restore the table to.

    • NewTableName — (String)

      The name of the table to create as a result of the current request.

    • EnableCaseSensitiveIdentifier — (Boolean)

      Indicates whether name identifiers for database, schema, and table are case sensitive. If true, the names are case sensitive. If false (default), the names are not case sensitive.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • TableRestoreStatus — (map)

        Describes the status of a RestoreTableFromClusterSnapshot operation.

        • TableRestoreRequestId — (String)

          The unique identifier for the table restore request.

        • Status — (String)

          A value that describes the current state of the table restore request.

          Valid Values: SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS

          Possible values include:
          • "PENDING"
          • "IN_PROGRESS"
          • "SUCCEEDED"
          • "FAILED"
          • "CANCELED"
        • Message — (String)

          A description of the status of the table restore request. Status values include SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS.

        • RequestTime — (Date)

          The time that the table restore request was made, in Universal Coordinated Time (UTC).

        • ProgressInMegaBytes — (Integer)

          The amount of data restored to the new table so far, in megabytes (MB).

        • TotalDataInMegaBytes — (Integer)

          The total amount of data to restore to the new table, in megabytes (MB).

        • ClusterIdentifier — (String)

          The identifier of the Amazon Redshift cluster that the table is being restored to.

        • SnapshotIdentifier — (String)

          The identifier of the snapshot that the table is being restored from.

        • SourceDatabaseName — (String)

          The name of the source database that contains the table being restored.

        • SourceSchemaName — (String)

          The name of the source schema that contains the table being restored.

        • SourceTableName — (String)

          The name of the source table being restored.

        • TargetDatabaseName — (String)

          The name of the database to restore the table to.

        • TargetSchemaName — (String)

          The name of the schema to restore the table to.

        • NewTableName — (String)

          The name of the table to create as a result of the table restore request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

resumeCluster(params = {}, callback) ⇒ AWS.Request

Resumes a paused cluster.

Service Reference:

Examples:

Calling the resumeCluster operation

var params = {
  ClusterIdentifier: 'STRING_VALUE' /* required */
};
redshift.resumeCluster(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      The identifier of the cluster to be resumed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        Describes a cluster.

        • ClusterIdentifier — (String)

          The unique identifier of the cluster.

        • NodeType — (String)

          The node type for the nodes in the cluster.

        • ClusterStatus — (String)

          The current state of the cluster. Possible values are the following:

          • available

          • available, prep-for-resize

          • available, resize-cleanup

          • cancelling-resize

          • creating

          • deleting

          • final-snapshot

          • hardware-failure

          • incompatible-hsm

          • incompatible-network

          • incompatible-parameters

          • incompatible-restore

          • modifying

          • paused

          • rebooting

          • renaming

          • resizing

          • rotating-keys

          • storage-full

          • updating-hsm

        • ClusterAvailabilityStatus — (String)

          The availability status of the cluster for queries. Possible values are the following:

          • Available - The cluster is available for queries.

          • Unavailable - The cluster is not available for queries.

          • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

          • Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.

          • Failed - The cluster failed and is not available for queries.

        • ModifyStatus — (String)

          The status of a modify operation, if any, initiated for the cluster.

        • MasterUsername — (String)

          The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

        • DBName — (String)

          The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

        • Endpoint — (map)

          The connection endpoint.

          • Address — (String)

            The DNS address of the Cluster.

          • Port — (Integer)

            The port that the database engine is listening on.

          • VpcEndpoints — (Array<map>)

            Describes a connection endpoint.

            • VpcEndpointId — (String)

              The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

            • VpcId — (String)

              The VPC identifier that the endpoint is associated.

            • NetworkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • NetworkInterfaceId — (String)

                The network interface identifier.

              • SubnetId — (String)

                The subnet identifier.

              • PrivateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • AvailabilityZone — (String)

                The Availability Zone.

        • ClusterCreateTime — (Date)

          The date and time that the cluster was created.

        • AutomatedSnapshotRetentionPeriod — (Integer)

          The number of days that automatic cluster snapshots are retained.

        • ManualSnapshotRetentionPeriod — (Integer)

          The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

          The value must be either -1 or an integer between 1 and 3,653.

        • ClusterSecurityGroups — (Array<map>)

          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.

          • ClusterSecurityGroupName — (String)

            The name of the cluster security group.

          • Status — (String)

            The status of the cluster security group.

        • VpcSecurityGroups — (Array<map>)

          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.

          • VpcSecurityGroupId — (String)

            The identifier of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • ClusterParameterGroups — (Array<map>)

          The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

          • ParameterGroupName — (String)

            The name of the cluster parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • ClusterParameterStatusList — (Array<map>)

            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.

            • 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 — (map)

          A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

          • MasterUserPassword — (String)

            The pending or in-progress change of the admin user password for the cluster.

          • NodeType — (String)

            The pending or in-progress change of the cluster's node type.

          • NumberOfNodes — (Integer)

            The pending or in-progress change of the number of nodes in the cluster.

          • ClusterType — (String)

            The pending or in-progress change of the cluster type.

          • ClusterVersion — (String)

            The pending or in-progress change of the service version.

          • AutomatedSnapshotRetentionPeriod — (Integer)

            The pending or in-progress change of the automated snapshot retention period.

          • ClusterIdentifier — (String)

            The pending or in-progress change of the new identifier for the cluster.

          • PubliclyAccessible — (Boolean)

            The pending or in-progress change of the ability to connect to the cluster from the public network.

          • EnhancedVpcRouting — (Boolean)

            An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

            Default: false

          • MaintenanceTrackName — (String)

            The name of the maintenance track that the cluster will change to during the next maintenance window.

          • EncryptionType — (String)

            The encryption type for a cluster. Possible values are: KMS and None.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • AllowVersionUpgrade — (Boolean)

          A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

        • NumberOfNodes — (Integer)

          The number of compute nodes in the cluster.

        • PubliclyAccessible — (Boolean)

          A boolean value that, if true, indicates that the cluster can be accessed from a public network.

        • Encrypted — (Boolean)

          A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

        • RestoreStatus — (map)

          A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

          • Status — (String)

            The status of the restore action. Returns starting, restoring, completed, or failed.

          • CurrentRestoreRateInMegaBytesPerSecond — (Float)

            The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.

          • SnapshotSizeInMegaBytes — (Integer)

            The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

          • ProgressInMegaBytes — (Integer)

            The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

          • ElapsedTimeInSeconds — (Integer)

            The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.

        • DataTransferProgress — (map)

          • Status — (String)

            Describes the status of the cluster. While the transfer is in progress the status is transferringdata.

          • CurrentRateInMegaBytesPerSecond — (Float)

            Describes the data transfer rate in MB's per second.

          • TotalDataInMegaBytes — (Integer)

            Describes the total amount of data to be transfered in megabytes.

          • DataTransferredInMegaBytes — (Integer)

            Describes the total amount of data that has been transfered in MB's.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            Describes the estimated number of seconds remaining to complete the transfer.

          • ElapsedTimeInSeconds — (Integer)

            Describes the number of seconds that have elapsed during the data transfer.

        • HsmStatus — (map)

          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 — (map)

          A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

          • DestinationRegion — (String)

            The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

          • RetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

          • ManualSnapshotRetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.

            The value must be either -1 or an integer between 1 and 3,653.

          • SnapshotCopyGrantName — (String)

            The name of the snapshot copy grant.

        • ClusterPublicKey — (String)

          The public key for the cluster.

        • ClusterNodes — (Array<map>)

          The nodes in the 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 — (map)

          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 — (Array<map>)

          The list of tags for the cluster.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

        • EnhancedVpcRouting — (Boolean)

          An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

          Default: false

        • IamRoles — (Array<map>)

          A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

          • IamRoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

          • ApplyStatus — (String)

            A value that describes the status of the IAM role's association with an Amazon Redshift cluster.

            The following are possible statuses and descriptions.

            • in-sync: The role is available for use by the cluster.

            • adding: The role is in the process of being associated with the cluster.

            • removing: The role is in the process of being disassociated with the cluster.

        • PendingActions — (Array<String>)

          Cluster operations that are waiting to be started.

        • MaintenanceTrackName — (String)

          The name of the maintenance track for the cluster.

        • ElasticResizeNumberOfNodeOptions — (String)

          The number of nodes that you can resize the cluster to with the elastic resize method.

        • DeferredMaintenanceWindows — (Array<map>)

          Describes a group of DeferredMaintenanceWindow objects.

          • DeferMaintenanceIdentifier — (String)

            A unique identifier for the maintenance window.

          • DeferMaintenanceStartTime — (Date)

            A timestamp for the beginning of the time period when we defer maintenance.

          • DeferMaintenanceEndTime — (Date)

            A timestamp for the end of the time period when we defer maintenance.

        • SnapshotScheduleIdentifier — (String)

          A unique identifier for the cluster snapshot schedule.

        • SnapshotScheduleState — (String)

          The current state of the cluster snapshot schedule.

          Possible values include:
          • "MODIFYING"
          • "ACTIVE"
          • "FAILED"
        • ExpectedNextSnapshotScheduleTime — (Date)

          The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

        • ExpectedNextSnapshotScheduleTimeStatus — (String)

          The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

          • OnTrack - The next snapshot is expected to be taken on time.

          • Pending - The next snapshot is pending to be taken.

        • NextMaintenanceWindowStartTime — (Date)

          The date and time in UTC when system maintenance can begin.

        • ResizeInfo — (map)

          Returns the following:

          • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

          • ResizeType: Returns ClassicResize

          • ResizeType — (String)

            Returns the value ClassicResize.

          • AllowCancelResize — (Boolean)

            A boolean value indicating if the resize operation can be cancelled.

        • AvailabilityZoneRelocationStatus — (String)

          Describes the status of the Availability Zone relocation operation.

        • ClusterNamespaceArn — (String)

          The namespace Amazon Resource Name (ARN) of the cluster.

        • TotalStorageCapacityInMegaBytes — (Integer)

          The total storage capacity of the cluster in megabytes.

        • AquaConfiguration — (map)

          The AQUA (Advanced Query Accelerator) configuration of the cluster.

          • AquaStatus — (String)

            The value indicates the status of AQUA on the cluster. Possible values include the following.

            • enabled - AQUA is enabled.

            • disabled - AQUA is not enabled.

            • applying - AQUA status is being applied.

            Possible values include:
            • "enabled"
            • "disabled"
            • "applying"
          • AquaConfigurationStatus — (String)

            The value represents how the cluster is configured to use AQUA. Possible values include the following.

            • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

            • disabled - Don't use AQUA.

            • auto - Amazon Redshift determines whether to use AQUA.

            Possible values include:
            • "enabled"
            • "disabled"
            • "auto"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

revokeClusterSecurityGroupIngress(params = {}, callback) ⇒ AWS.Request

Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

Service Reference:

Examples:

Calling the revokeClusterSecurityGroupIngress operation

var params = {
  ClusterSecurityGroupName: 'STRING_VALUE', /* required */
  CIDRIP: 'STRING_VALUE',
  EC2SecurityGroupName: 'STRING_VALUE',
  EC2SecurityGroupOwnerId: 'STRING_VALUE'
};
redshift.revokeClusterSecurityGroupIngress(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterSecurityGroupName — (String)

      The name of the security Group from which to revoke the ingress rule.

    • CIDRIP — (String)

      The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided.

    • EC2SecurityGroupName — (String)

      The name of the EC2 Security Group whose access is to be revoked. If EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId must also be provided and CIDRIP cannot be provided.

    • EC2SecurityGroupOwnerId — (String)

      The Amazon Web Services account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The Amazon Web Services access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided.

      Example: 111122223333

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ClusterSecurityGroup — (map)

        Describes a security group.

        • ClusterSecurityGroupName — (String)

          The name of the cluster security group to which the operation was applied.

        • Description — (String)

          A description of the security group.

        • EC2SecurityGroups — (Array<map>)

          A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.

          • Status — (String)

            The status of the EC2 security group.

          • EC2SecurityGroupName — (String)

            The name of the EC2 Security Group.

          • EC2SecurityGroupOwnerId — (String)

            The Amazon Web Services account ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

          • Tags — (Array<map>)

            The list of tags for the EC2 security group.

            • Key — (String)

              The key, or name, for the resource tag.

            • Value — (String)

              The value for the resource tag.

        • IPRanges — (Array<map>)

          A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.

          • Status — (String)

            The status of the IP range, for example, "authorized".

          • CIDRIP — (String)

            The IP range in Classless Inter-Domain Routing (CIDR) notation.

          • Tags — (Array<map>)

            The list of tags for the IP range.

            • Key — (String)

              The key, or name, for the resource tag.

            • Value — (String)

              The value for the resource tag.

        • Tags — (Array<map>)

          The list of tags for the cluster security group.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

revokeEndpointAccess(params = {}, callback) ⇒ AWS.Request

Revokes access to a cluster.

Service Reference:

Examples:

Calling the revokeEndpointAccess operation

var params = {
  Account: 'STRING_VALUE',
  ClusterIdentifier: 'STRING_VALUE',
  Force: true || false,
  VpcIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
redshift.revokeEndpointAccess(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      The cluster to revoke access from.

    • Account — (String)

      The Amazon Web Services account ID whose access is to be revoked.

    • VpcIds — (Array<String>)

      The virtual private cloud (VPC) identifiers for which access is to be revoked.

    • Force — (Boolean)

      Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Grantor — (String)

        The Amazon Web Services account ID of the cluster owner.

      • Grantee — (String)

        The Amazon Web Services account ID of the grantee of the cluster.

      • ClusterIdentifier — (String)

        The cluster identifier.

      • AuthorizeTime — (Date)

        The time (UTC) when the authorization was created.

      • ClusterStatus — (String)

        The status of the cluster.

      • Status — (String)

        The status of the authorization action.

        Possible values include:
        • "Authorized"
        • "Revoking"
      • AllowedAllVPCs — (Boolean)

        Indicates whether all VPCs in the grantee account are allowed access to the cluster.

      • AllowedVPCs — (Array<String>)

        The VPCs allowed access to the cluster.

      • EndpointCount — (Integer)

        The number of Redshift-managed VPC endpoints created for the authorization.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

revokeSnapshotAccess(params = {}, callback) ⇒ AWS.Request

Removes the ability of the specified Amazon Web Services account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

Service Reference:

Examples:

Calling the revokeSnapshotAccess operation

var params = {
  AccountWithRestoreAccess: 'STRING_VALUE', /* required */
  SnapshotIdentifier: 'STRING_VALUE', /* required */
  SnapshotClusterIdentifier: 'STRING_VALUE'
};
redshift.revokeSnapshotAccess(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • SnapshotIdentifier — (String)

      The identifier of the snapshot that the account can no longer access.

    • SnapshotClusterIdentifier — (String)

      The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

    • AccountWithRestoreAccess — (String)

      The identifier of the Amazon Web Services account that can no longer restore the specified snapshot.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Snapshot — (map)

        Describes a snapshot.

        • SnapshotIdentifier — (String)

          The snapshot identifier that is provided in the request.

        • ClusterIdentifier — (String)

          The identifier of the cluster for which the snapshot was taken.

        • SnapshotCreateTime — (Date)

          The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

        • Status — (String)

          The snapshot status. The value of the status depends on the API operation used:

        • Port — (Integer)

          The port that the cluster is listening on.

        • AvailabilityZone — (String)

          The Availability Zone in which the cluster was created.

        • ClusterCreateTime — (Date)

          The time (UTC) when the cluster was originally created.

        • MasterUsername — (String)

          The admin user name for the cluster.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • EngineFullVersion — (String)

          The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

        • SnapshotType — (String)

          The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

        • NodeType — (String)

          The node type of the nodes in the cluster.

        • NumberOfNodes — (Integer)

          The number of nodes in the cluster.

        • DBName — (String)

          The name of the database that was created when the cluster was created.

        • VpcId — (String)

          The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

        • Encrypted — (Boolean)

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

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

        • EncryptedWithHSM — (Boolean)

          A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

        • AccountsWithRestoreAccess — (Array<map>)

          A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

          • AccountId — (String)

            The identifier of an Amazon Web Services account authorized to restore a snapshot.

          • AccountAlias — (String)

            The identifier of an Amazon Web Services support account authorized to restore a snapshot. For Amazon Web Services Support, the identifier is amazon-redshift-support.

        • OwnerAccount — (String)

          For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

        • TotalBackupSizeInMegaBytes — (Float)

          The size of the complete set of backup data that would be used to restore the cluster.

        • ActualIncrementalBackupSizeInMegaBytes — (Float)

          The size of the incremental backup.

        • BackupProgressInMegaBytes — (Float)

          The number of megabytes that have been transferred to the snapshot backup.

        • CurrentBackupRateInMegaBytesPerSecond — (Float)

          The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

        • EstimatedSecondsToCompletion — (Integer)

          The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

        • ElapsedTimeInSeconds — (Integer)

          The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

        • SourceRegion — (String)

          The source region from which the snapshot was copied.

        • Tags — (Array<map>)

          The list of tags for the cluster snapshot.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • RestorableNodeTypes — (Array<String>)

          The list of node types that this cluster snapshot is able to restore into.

        • 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 for the snapshot.

        • ManualSnapshotRetentionPeriod — (Integer)

          The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

          The value must be either -1 or an integer between 1 and 3,653.

        • ManualSnapshotRemainingDays — (Integer)

          The number of days until a manual snapshot will pass its retention period.

        • SnapshotRetentionStartTime — (Date)

          A timestamp representing the start of the retention period for the snapshot.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

rotateEncryptionKey(params = {}, callback) ⇒ AWS.Request

Rotates the encryption keys for a cluster.

Service Reference:

Examples:

Calling the rotateEncryptionKey operation

var params = {
  ClusterIdentifier: 'STRING_VALUE' /* required */
};
redshift.rotateEncryptionKey(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClusterIdentifier — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Cluster — (map)

        Describes a cluster.

        • ClusterIdentifier — (String)

          The unique identifier of the cluster.

        • NodeType — (String)

          The node type for the nodes in the cluster.

        • ClusterStatus — (String)

          The current state of the cluster. Possible values are the following:

          • available

          • available, prep-for-resize

          • available, resize-cleanup

          • cancelling-resize

          • creating

          • deleting

          • final-snapshot

          • hardware-failure

          • incompatible-hsm

          • incompatible-network

          • incompatible-parameters

          • incompatible-restore

          • modifying

          • paused

          • rebooting

          • renaming

          • resizing

          • rotating-keys

          • storage-full

          • updating-hsm

        • ClusterAvailabilityStatus — (String)

          The availability status of the cluster for queries. Possible values are the following:

          • Available - The cluster is available for queries.

          • Unavailable - The cluster is not available for queries.

          • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

          • Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.

          • Failed - The cluster failed and is not available for queries.

        • ModifyStatus — (String)

          The status of a modify operation, if any, initiated for the cluster.

        • MasterUsername — (String)

          The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

        • DBName — (String)

          The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

        • Endpoint — (map)

          The connection endpoint.

          • Address — (String)

            The DNS address of the Cluster.

          • Port — (Integer)

            The port that the database engine is listening on.

          • VpcEndpoints — (Array<map>)

            Describes a connection endpoint.

            • VpcEndpointId — (String)

              The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

            • VpcId — (String)

              The VPC identifier that the endpoint is associated.

            • NetworkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • NetworkInterfaceId — (String)

                The network interface identifier.

              • SubnetId — (String)

                The subnet identifier.

              • PrivateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • AvailabilityZone — (String)

                The Availability Zone.

        • ClusterCreateTime — (Date)

          The date and time that the cluster was created.

        • AutomatedSnapshotRetentionPeriod — (Integer)

          The number of days that automatic cluster snapshots are retained.

        • ManualSnapshotRetentionPeriod — (Integer)

          The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

          The value must be either -1 or an integer between 1 and 3,653.

        • ClusterSecurityGroups — (Array<map>)

          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.

          • ClusterSecurityGroupName — (String)

            The name of the cluster security group.

          • Status — (String)

            The status of the cluster security group.

        • VpcSecurityGroups — (Array<map>)

          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.

          • VpcSecurityGroupId — (String)

            The identifier of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • ClusterParameterGroups — (Array<map>)

          The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

          • ParameterGroupName — (String)

            The name of the cluster parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • ClusterParameterStatusList — (Array<map>)

            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.

            • 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 — (map)

          A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

          • MasterUserPassword — (String)

            The pending or in-progress change of the admin user password for the cluster.

          • NodeType — (String)

            The pending or in-progress change of the cluster's node type.

          • NumberOfNodes — (Integer)

            The pending or in-progress change of the number of nodes in the cluster.

          • ClusterType — (String)

            The pending or in-progress change of the cluster type.

          • ClusterVersion — (String)

            The pending or in-progress change of the service version.

          • AutomatedSnapshotRetentionPeriod — (Integer)

            The pending or in-progress change of the automated snapshot retention period.

          • ClusterIdentifier — (String)

            The pending or in-progress change of the new identifier for the cluster.

          • PubliclyAccessible — (Boolean)

            The pending or in-progress change of the ability to connect to the cluster from the public network.

          • EnhancedVpcRouting — (Boolean)

            An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

            Default: false

          • MaintenanceTrackName — (String)

            The name of the maintenance track that the cluster will change to during the next maintenance window.

          • EncryptionType — (String)

            The encryption type for a cluster. Possible values are: KMS and None.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • AllowVersionUpgrade — (Boolean)

          A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

        • NumberOfNodes — (Integer)

          The number of compute nodes in the cluster.

        • PubliclyAccessible — (Boolean)

          A boolean value that, if true, indicates that the cluster can be accessed from a public network.

        • Encrypted — (Boolean)

          A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

        • RestoreStatus — (map)

          A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

          • Status — (String)

            The status of the restore action. Returns starting, restoring, completed, or failed.

          • CurrentRestoreRateInMegaBytesPerSecond — (Float)

            The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.

          • SnapshotSizeInMegaBytes — (Integer)

            The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

          • ProgressInMegaBytes — (Integer)

            The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

          • ElapsedTimeInSeconds — (Integer)

            The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.

        • DataTransferProgress — (map)

          • Status — (String)

            Describes the status of the cluster. While the transfer is in progress the status is transferringdata.

          • CurrentRateInMegaBytesPerSecond — (Float)

            Describes the data transfer rate in MB's per second.

          • TotalDataInMegaBytes — (Integer)

            Describes the total amount of data to be transfered in megabytes.

          • DataTransferredInMegaBytes — (Integer)

            Describes the total amount of data that has been transfered in MB's.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            Describes the estimated number of seconds remaining to complete the transfer.

          • ElapsedTimeInSeconds — (Integer)

            Describes the number of seconds that have elapsed during the data transfer.

        • HsmStatus — (map)

          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 — (map)

          A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

          • DestinationRegion — (String)

            The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

          • RetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

          • ManualSnapshotRetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.

            The value must be either -1 or an integer between 1 and 3,653.

          • SnapshotCopyGrantName — (String)

            The name of the snapshot copy grant.

        • ClusterPublicKey — (String)

          The public key for the cluster.

        • ClusterNodes — (Array<map>)

          The nodes in the 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 — (map)

          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 — (Array<map>)

          The list of tags for the cluster.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

        • EnhancedVpcRouting — (Boolean)

          An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

          Default: false

        • IamRoles — (Array<map>)

          A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

          • IamRoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

          • ApplyStatus — (String)

            A value that describes the status of the IAM role's association with an Amazon Redshift cluster.

            The following are possible statuses and descriptions.

            • in-sync: The role is available for use by the cluster.

            • adding: The role is in the process of being associated with the cluster.

            • removing: The role is in the process of being disassociated with the cluster.

        • PendingActions — (Array<String>)

          Cluster operations that are waiting to be started.

        • MaintenanceTrackName — (String)

          The name of the maintenance track for the cluster.

        • ElasticResizeNumberOfNodeOptions — (String)

          The number of nodes that you can resize the cluster to with the elastic resize method.

        • DeferredMaintenanceWindows — (Array<map>)

          Describes a group of DeferredMaintenanceWindow objects.

          • DeferMaintenanceIdentifier — (String)

            A unique identifier for the maintenance window.

          • DeferMaintenanceStartTime — (Date)

            A timestamp for the beginning of the time period when we defer maintenance.

          • DeferMaintenanceEndTime — (Date)

            A timestamp for the end of the time period when we defer maintenance.

        • SnapshotScheduleIdentifier — (String)

          A unique identifier for the cluster snapshot schedule.

        • SnapshotScheduleState — (String)

          The current state of the cluster snapshot schedule.

          Possible values include:
          • "MODIFYING"
          • "ACTIVE"
          • "FAILED"
        • ExpectedNextSnapshotScheduleTime — (Date)

          The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

        • ExpectedNextSnapshotScheduleTimeStatus — (String)

          The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

          • OnTrack - The next snapshot is expected to be taken on time.

          • Pending - The next snapshot is pending to be taken.

        • NextMaintenanceWindowStartTime — (Date)

          The date and time in UTC when system maintenance can begin.

        • ResizeInfo — (map)

          Returns the following:

          • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

          • ResizeType: Returns ClassicResize

          • ResizeType — (String)

            Returns the value ClassicResize.

          • AllowCancelResize — (Boolean)

            A boolean value indicating if the resize operation can be cancelled.

        • AvailabilityZoneRelocationStatus — (String)

          Describes the status of the Availability Zone relocation operation.

        • ClusterNamespaceArn — (String)

          The namespace Amazon Resource Name (ARN) of the cluster.

        • TotalStorageCapacityInMegaBytes — (Integer)

          The total storage capacity of the cluster in megabytes.

        • AquaConfiguration — (map)

          The AQUA (Advanced Query Accelerator) configuration of the cluster.

          • AquaStatus — (String)

            The value indicates the status of AQUA on the cluster. Possible values include the following.

            • enabled - AQUA is enabled.

            • disabled - AQUA is not enabled.

            • applying - AQUA status is being applied.

            Possible values include:
            • "enabled"
            • "disabled"
            • "applying"
          • AquaConfigurationStatus — (String)

            The value represents how the cluster is configured to use AQUA. Possible values include the following.

            • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

            • disabled - Don't use AQUA.

            • auto - Amazon Redshift determines whether to use AQUA.

            Possible values include:
            • "enabled"
            • "disabled"
            • "auto"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updatePartnerStatus(params = {}, callback) ⇒ AWS.Request

Updates the status of a partner integration.

Service Reference:

Examples:

Calling the updatePartnerStatus operation

var params = {
  AccountId: 'STRING_VALUE', /* required */
  ClusterIdentifier: 'STRING_VALUE', /* required */
  DatabaseName: 'STRING_VALUE', /* required */
  PartnerName: 'STRING_VALUE', /* required */
  Status: Active | Inactive | RuntimeFailure | ConnectionFailure, /* required */
  StatusMessage: 'STRING_VALUE'
};
redshift.updatePartnerStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • AccountId — (String)

      The Amazon Web Services account ID that owns the cluster.

    • ClusterIdentifier — (String)

      The cluster identifier of the cluster whose partner integration status is being updated.

    • DatabaseName — (String)

      The name of the database whose partner integration status is being updated.

    • PartnerName — (String)

      The name of the partner whose integration status is being updated.

    • Status — (String)

      The value of the updated status.

      Possible values include:
      • "Active"
      • "Inactive"
      • "RuntimeFailure"
      • "ConnectionFailure"
    • StatusMessage — (String)

      The status message provided by the partner.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DatabaseName — (String)

        The name of the database that receives data from the partner.

      • PartnerName — (String)

        The name of the partner that is authorized to send data.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given Redshift resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the clusterAvailable state

var params = {
  // ... input parameters ...
};
redshift.waitFor('clusterAvailable', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • state (String) —

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {}) —

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

  • function(err, data) { ... }

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

Waiter Resource States:

Waiter Resource Details

redshift.waitFor('clusterAvailable', params = {}, [callback]) ⇒ AWS.Request

Waits for the clusterAvailable state by periodically calling the underlying Redshift.describeClusters() operation every 60 seconds (at most 30 times).

Examples:

Waiting for the clusterAvailable state

var params = {
  // ... input parameters ...
};
redshift.waitFor('clusterAvailable', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • ClusterIdentifier — (String)

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

      The default is that all clusters defined for an account are returned.

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • Marker — (String)

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

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

    • TagKeys — (Array<String>)

      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.

    • TagValues — (Array<String>)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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 — (Array<map>)

        A list of Cluster objects, where each object describes one cluster.

        • ClusterIdentifier — (String)

          The unique identifier of the cluster.

        • NodeType — (String)

          The node type for the nodes in the cluster.

        • ClusterStatus — (String)

          The current state of the cluster. Possible values are the following:

          • available

          • available, prep-for-resize

          • available, resize-cleanup

          • cancelling-resize

          • creating

          • deleting

          • final-snapshot

          • hardware-failure

          • incompatible-hsm

          • incompatible-network

          • incompatible-parameters

          • incompatible-restore

          • modifying

          • paused

          • rebooting

          • renaming

          • resizing

          • rotating-keys

          • storage-full

          • updating-hsm

        • ClusterAvailabilityStatus — (String)

          The availability status of the cluster for queries. Possible values are the following:

          • Available - The cluster is available for queries.

          • Unavailable - The cluster is not available for queries.

          • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

          • Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.

          • Failed - The cluster failed and is not available for queries.

        • ModifyStatus — (String)

          The status of a modify operation, if any, initiated for the cluster.

        • MasterUsername — (String)

          The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

        • DBName — (String)

          The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

        • Endpoint — (map)

          The connection endpoint.

          • Address — (String)

            The DNS address of the Cluster.

          • Port — (Integer)

            The port that the database engine is listening on.

          • VpcEndpoints — (Array<map>)

            Describes a connection endpoint.

            • VpcEndpointId — (String)

              The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

            • VpcId — (String)

              The VPC identifier that the endpoint is associated.

            • NetworkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • NetworkInterfaceId — (String)

                The network interface identifier.

              • SubnetId — (String)

                The subnet identifier.

              • PrivateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • AvailabilityZone — (String)

                The Availability Zone.

        • ClusterCreateTime — (Date)

          The date and time that the cluster was created.

        • AutomatedSnapshotRetentionPeriod — (Integer)

          The number of days that automatic cluster snapshots are retained.

        • ManualSnapshotRetentionPeriod — (Integer)

          The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

          The value must be either -1 or an integer between 1 and 3,653.

        • ClusterSecurityGroups — (Array<map>)

          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.

          • ClusterSecurityGroupName — (String)

            The name of the cluster security group.

          • Status — (String)

            The status of the cluster security group.

        • VpcSecurityGroups — (Array<map>)

          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.

          • VpcSecurityGroupId — (String)

            The identifier of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • ClusterParameterGroups — (Array<map>)

          The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

          • ParameterGroupName — (String)

            The name of the cluster parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • ClusterParameterStatusList — (Array<map>)

            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.

            • 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 — (map)

          A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

          • MasterUserPassword — (String)

            The pending or in-progress change of the admin user password for the cluster.

          • NodeType — (String)

            The pending or in-progress change of the cluster's node type.

          • NumberOfNodes — (Integer)

            The pending or in-progress change of the number of nodes in the cluster.

          • ClusterType — (String)

            The pending or in-progress change of the cluster type.

          • ClusterVersion — (String)

            The pending or in-progress change of the service version.

          • AutomatedSnapshotRetentionPeriod — (Integer)

            The pending or in-progress change of the automated snapshot retention period.

          • ClusterIdentifier — (String)

            The pending or in-progress change of the new identifier for the cluster.

          • PubliclyAccessible — (Boolean)

            The pending or in-progress change of the ability to connect to the cluster from the public network.

          • EnhancedVpcRouting — (Boolean)

            An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

            Default: false

          • MaintenanceTrackName — (String)

            The name of the maintenance track that the cluster will change to during the next maintenance window.

          • EncryptionType — (String)

            The encryption type for a cluster. Possible values are: KMS and None.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • AllowVersionUpgrade — (Boolean)

          A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

        • NumberOfNodes — (Integer)

          The number of compute nodes in the cluster.

        • PubliclyAccessible — (Boolean)

          A boolean value that, if true, indicates that the cluster can be accessed from a public network.

        • Encrypted — (Boolean)

          A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

        • RestoreStatus — (map)

          A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

          • Status — (String)

            The status of the restore action. Returns starting, restoring, completed, or failed.

          • CurrentRestoreRateInMegaBytesPerSecond — (Float)

            The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.

          • SnapshotSizeInMegaBytes — (Integer)

            The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

          • ProgressInMegaBytes — (Integer)

            The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

          • ElapsedTimeInSeconds — (Integer)

            The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.

        • DataTransferProgress — (map)

          • Status — (String)

            Describes the status of the cluster. While the transfer is in progress the status is transferringdata.

          • CurrentRateInMegaBytesPerSecond — (Float)

            Describes the data transfer rate in MB's per second.

          • TotalDataInMegaBytes — (Integer)

            Describes the total amount of data to be transfered in megabytes.

          • DataTransferredInMegaBytes — (Integer)

            Describes the total amount of data that has been transfered in MB's.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            Describes the estimated number of seconds remaining to complete the transfer.

          • ElapsedTimeInSeconds — (Integer)

            Describes the number of seconds that have elapsed during the data transfer.

        • HsmStatus — (map)

          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 — (map)

          A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

          • DestinationRegion — (String)

            The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

          • RetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

          • ManualSnapshotRetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.

            The value must be either -1 or an integer between 1 and 3,653.

          • SnapshotCopyGrantName — (String)

            The name of the snapshot copy grant.

        • ClusterPublicKey — (String)

          The public key for the cluster.

        • ClusterNodes — (Array<map>)

          The nodes in the 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 — (map)

          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 — (Array<map>)

          The list of tags for the cluster.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

        • EnhancedVpcRouting — (Boolean)

          An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

          Default: false

        • IamRoles — (Array<map>)

          A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

          • IamRoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

          • ApplyStatus — (String)

            A value that describes the status of the IAM role's association with an Amazon Redshift cluster.

            The following are possible statuses and descriptions.

            • in-sync: The role is available for use by the cluster.

            • adding: The role is in the process of being associated with the cluster.

            • removing: The role is in the process of being disassociated with the cluster.

        • PendingActions — (Array<String>)

          Cluster operations that are waiting to be started.

        • MaintenanceTrackName — (String)

          The name of the maintenance track for the cluster.

        • ElasticResizeNumberOfNodeOptions — (String)

          The number of nodes that you can resize the cluster to with the elastic resize method.

        • DeferredMaintenanceWindows — (Array<map>)

          Describes a group of DeferredMaintenanceWindow objects.

          • DeferMaintenanceIdentifier — (String)

            A unique identifier for the maintenance window.

          • DeferMaintenanceStartTime — (Date)

            A timestamp for the beginning of the time period when we defer maintenance.

          • DeferMaintenanceEndTime — (Date)

            A timestamp for the end of the time period when we defer maintenance.

        • SnapshotScheduleIdentifier — (String)

          A unique identifier for the cluster snapshot schedule.

        • SnapshotScheduleState — (String)

          The current state of the cluster snapshot schedule.

          Possible values include:
          • "MODIFYING"
          • "ACTIVE"
          • "FAILED"
        • ExpectedNextSnapshotScheduleTime — (Date)

          The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

        • ExpectedNextSnapshotScheduleTimeStatus — (String)

          The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

          • OnTrack - The next snapshot is expected to be taken on time.

          • Pending - The next snapshot is pending to be taken.

        • NextMaintenanceWindowStartTime — (Date)

          The date and time in UTC when system maintenance can begin.

        • ResizeInfo — (map)

          Returns the following:

          • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

          • ResizeType: Returns ClassicResize

          • ResizeType — (String)

            Returns the value ClassicResize.

          • AllowCancelResize — (Boolean)

            A boolean value indicating if the resize operation can be cancelled.

        • AvailabilityZoneRelocationStatus — (String)

          Describes the status of the Availability Zone relocation operation.

        • ClusterNamespaceArn — (String)

          The namespace Amazon Resource Name (ARN) of the cluster.

        • TotalStorageCapacityInMegaBytes — (Integer)

          The total storage capacity of the cluster in megabytes.

        • AquaConfiguration — (map)

          The AQUA (Advanced Query Accelerator) configuration of the cluster.

          • AquaStatus — (String)

            The value indicates the status of AQUA on the cluster. Possible values include the following.

            • enabled - AQUA is enabled.

            • disabled - AQUA is not enabled.

            • applying - AQUA status is being applied.

            Possible values include:
            • "enabled"
            • "disabled"
            • "applying"
          • AquaConfigurationStatus — (String)

            The value represents how the cluster is configured to use AQUA. Possible values include the following.

            • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

            • disabled - Don't use AQUA.

            • auto - Amazon Redshift determines whether to use AQUA.

            Possible values include:
            • "enabled"
            • "disabled"
            • "auto"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

redshift.waitFor('clusterDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the clusterDeleted state by periodically calling the underlying Redshift.describeClusters() operation every 60 seconds (at most 30 times).

Examples:

Waiting for the clusterDeleted state

var params = {
  // ... input parameters ...
};
redshift.waitFor('clusterDeleted', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • ClusterIdentifier — (String)

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

      The default is that all clusters defined for an account are returned.

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • Marker — (String)

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

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

    • TagKeys — (Array<String>)

      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.

    • TagValues — (Array<String>)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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 — (Array<map>)

        A list of Cluster objects, where each object describes one cluster.

        • ClusterIdentifier — (String)

          The unique identifier of the cluster.

        • NodeType — (String)

          The node type for the nodes in the cluster.

        • ClusterStatus — (String)

          The current state of the cluster. Possible values are the following:

          • available

          • available, prep-for-resize

          • available, resize-cleanup

          • cancelling-resize

          • creating

          • deleting

          • final-snapshot

          • hardware-failure

          • incompatible-hsm

          • incompatible-network

          • incompatible-parameters

          • incompatible-restore

          • modifying

          • paused

          • rebooting

          • renaming

          • resizing

          • rotating-keys

          • storage-full

          • updating-hsm

        • ClusterAvailabilityStatus — (String)

          The availability status of the cluster for queries. Possible values are the following:

          • Available - The cluster is available for queries.

          • Unavailable - The cluster is not available for queries.

          • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

          • Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.

          • Failed - The cluster failed and is not available for queries.

        • ModifyStatus — (String)

          The status of a modify operation, if any, initiated for the cluster.

        • MasterUsername — (String)

          The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

        • DBName — (String)

          The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

        • Endpoint — (map)

          The connection endpoint.

          • Address — (String)

            The DNS address of the Cluster.

          • Port — (Integer)

            The port that the database engine is listening on.

          • VpcEndpoints — (Array<map>)

            Describes a connection endpoint.

            • VpcEndpointId — (String)

              The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

            • VpcId — (String)

              The VPC identifier that the endpoint is associated.

            • NetworkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • NetworkInterfaceId — (String)

                The network interface identifier.

              • SubnetId — (String)

                The subnet identifier.

              • PrivateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • AvailabilityZone — (String)

                The Availability Zone.

        • ClusterCreateTime — (Date)

          The date and time that the cluster was created.

        • AutomatedSnapshotRetentionPeriod — (Integer)

          The number of days that automatic cluster snapshots are retained.

        • ManualSnapshotRetentionPeriod — (Integer)

          The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

          The value must be either -1 or an integer between 1 and 3,653.

        • ClusterSecurityGroups — (Array<map>)

          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.

          • ClusterSecurityGroupName — (String)

            The name of the cluster security group.

          • Status — (String)

            The status of the cluster security group.

        • VpcSecurityGroups — (Array<map>)

          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.

          • VpcSecurityGroupId — (String)

            The identifier of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • ClusterParameterGroups — (Array<map>)

          The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

          • ParameterGroupName — (String)

            The name of the cluster parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • ClusterParameterStatusList — (Array<map>)

            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.

            • 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 — (map)

          A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

          • MasterUserPassword — (String)

            The pending or in-progress change of the admin user password for the cluster.

          • NodeType — (String)

            The pending or in-progress change of the cluster's node type.

          • NumberOfNodes — (Integer)

            The pending or in-progress change of the number of nodes in the cluster.

          • ClusterType — (String)

            The pending or in-progress change of the cluster type.

          • ClusterVersion — (String)

            The pending or in-progress change of the service version.

          • AutomatedSnapshotRetentionPeriod — (Integer)

            The pending or in-progress change of the automated snapshot retention period.

          • ClusterIdentifier — (String)

            The pending or in-progress change of the new identifier for the cluster.

          • PubliclyAccessible — (Boolean)

            The pending or in-progress change of the ability to connect to the cluster from the public network.

          • EnhancedVpcRouting — (Boolean)

            An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

            Default: false

          • MaintenanceTrackName — (String)

            The name of the maintenance track that the cluster will change to during the next maintenance window.

          • EncryptionType — (String)

            The encryption type for a cluster. Possible values are: KMS and None.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • AllowVersionUpgrade — (Boolean)

          A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

        • NumberOfNodes — (Integer)

          The number of compute nodes in the cluster.

        • PubliclyAccessible — (Boolean)

          A boolean value that, if true, indicates that the cluster can be accessed from a public network.

        • Encrypted — (Boolean)

          A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

        • RestoreStatus — (map)

          A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

          • Status — (String)

            The status of the restore action. Returns starting, restoring, completed, or failed.

          • CurrentRestoreRateInMegaBytesPerSecond — (Float)

            The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.

          • SnapshotSizeInMegaBytes — (Integer)

            The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

          • ProgressInMegaBytes — (Integer)

            The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

          • ElapsedTimeInSeconds — (Integer)

            The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.

        • DataTransferProgress — (map)

          • Status — (String)

            Describes the status of the cluster. While the transfer is in progress the status is transferringdata.

          • CurrentRateInMegaBytesPerSecond — (Float)

            Describes the data transfer rate in MB's per second.

          • TotalDataInMegaBytes — (Integer)

            Describes the total amount of data to be transfered in megabytes.

          • DataTransferredInMegaBytes — (Integer)

            Describes the total amount of data that has been transfered in MB's.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            Describes the estimated number of seconds remaining to complete the transfer.

          • ElapsedTimeInSeconds — (Integer)

            Describes the number of seconds that have elapsed during the data transfer.

        • HsmStatus — (map)

          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 — (map)

          A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

          • DestinationRegion — (String)

            The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

          • RetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

          • ManualSnapshotRetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.

            The value must be either -1 or an integer between 1 and 3,653.

          • SnapshotCopyGrantName — (String)

            The name of the snapshot copy grant.

        • ClusterPublicKey — (String)

          The public key for the cluster.

        • ClusterNodes — (Array<map>)

          The nodes in the 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 — (map)

          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 — (Array<map>)

          The list of tags for the cluster.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

        • EnhancedVpcRouting — (Boolean)

          An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

          Default: false

        • IamRoles — (Array<map>)

          A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

          • IamRoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

          • ApplyStatus — (String)

            A value that describes the status of the IAM role's association with an Amazon Redshift cluster.

            The following are possible statuses and descriptions.

            • in-sync: The role is available for use by the cluster.

            • adding: The role is in the process of being associated with the cluster.

            • removing: The role is in the process of being disassociated with the cluster.

        • PendingActions — (Array<String>)

          Cluster operations that are waiting to be started.

        • MaintenanceTrackName — (String)

          The name of the maintenance track for the cluster.

        • ElasticResizeNumberOfNodeOptions — (String)

          The number of nodes that you can resize the cluster to with the elastic resize method.

        • DeferredMaintenanceWindows — (Array<map>)

          Describes a group of DeferredMaintenanceWindow objects.

          • DeferMaintenanceIdentifier — (String)

            A unique identifier for the maintenance window.

          • DeferMaintenanceStartTime — (Date)

            A timestamp for the beginning of the time period when we defer maintenance.

          • DeferMaintenanceEndTime — (Date)

            A timestamp for the end of the time period when we defer maintenance.

        • SnapshotScheduleIdentifier — (String)

          A unique identifier for the cluster snapshot schedule.

        • SnapshotScheduleState — (String)

          The current state of the cluster snapshot schedule.

          Possible values include:
          • "MODIFYING"
          • "ACTIVE"
          • "FAILED"
        • ExpectedNextSnapshotScheduleTime — (Date)

          The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

        • ExpectedNextSnapshotScheduleTimeStatus — (String)

          The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

          • OnTrack - The next snapshot is expected to be taken on time.

          • Pending - The next snapshot is pending to be taken.

        • NextMaintenanceWindowStartTime — (Date)

          The date and time in UTC when system maintenance can begin.

        • ResizeInfo — (map)

          Returns the following:

          • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

          • ResizeType: Returns ClassicResize

          • ResizeType — (String)

            Returns the value ClassicResize.

          • AllowCancelResize — (Boolean)

            A boolean value indicating if the resize operation can be cancelled.

        • AvailabilityZoneRelocationStatus — (String)

          Describes the status of the Availability Zone relocation operation.

        • ClusterNamespaceArn — (String)

          The namespace Amazon Resource Name (ARN) of the cluster.

        • TotalStorageCapacityInMegaBytes — (Integer)

          The total storage capacity of the cluster in megabytes.

        • AquaConfiguration — (map)

          The AQUA (Advanced Query Accelerator) configuration of the cluster.

          • AquaStatus — (String)

            The value indicates the status of AQUA on the cluster. Possible values include the following.

            • enabled - AQUA is enabled.

            • disabled - AQUA is not enabled.

            • applying - AQUA status is being applied.

            Possible values include:
            • "enabled"
            • "disabled"
            • "applying"
          • AquaConfigurationStatus — (String)

            The value represents how the cluster is configured to use AQUA. Possible values include the following.

            • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

            • disabled - Don't use AQUA.

            • auto - Amazon Redshift determines whether to use AQUA.

            Possible values include:
            • "enabled"
            • "disabled"
            • "auto"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

redshift.waitFor('clusterRestored', params = {}, [callback]) ⇒ AWS.Request

Waits for the clusterRestored state by periodically calling the underlying Redshift.describeClusters() operation every 60 seconds (at most 30 times).

Examples:

Waiting for the clusterRestored state

var params = {
  // ... input parameters ...
};
redshift.waitFor('clusterRestored', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • ClusterIdentifier — (String)

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

      The default is that all clusters defined for an account are returned.

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • Marker — (String)

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

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

    • TagKeys — (Array<String>)

      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.

    • TagValues — (Array<String>)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • 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 — (Array<map>)

        A list of Cluster objects, where each object describes one cluster.

        • ClusterIdentifier — (String)

          The unique identifier of the cluster.

        • NodeType — (String)

          The node type for the nodes in the cluster.

        • ClusterStatus — (String)

          The current state of the cluster. Possible values are the following:

          • available

          • available, prep-for-resize

          • available, resize-cleanup

          • cancelling-resize

          • creating

          • deleting

          • final-snapshot

          • hardware-failure

          • incompatible-hsm

          • incompatible-network

          • incompatible-parameters

          • incompatible-restore

          • modifying

          • paused

          • rebooting

          • renaming

          • resizing

          • rotating-keys

          • storage-full

          • updating-hsm

        • ClusterAvailabilityStatus — (String)

          The availability status of the cluster for queries. Possible values are the following:

          • Available - The cluster is available for queries.

          • Unavailable - The cluster is not available for queries.

          • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

          • Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.

          • Failed - The cluster failed and is not available for queries.

        • ModifyStatus — (String)

          The status of a modify operation, if any, initiated for the cluster.

        • MasterUsername — (String)

          The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

        • DBName — (String)

          The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

        • Endpoint — (map)

          The connection endpoint.

          • Address — (String)

            The DNS address of the Cluster.

          • Port — (Integer)

            The port that the database engine is listening on.

          • VpcEndpoints — (Array<map>)

            Describes a connection endpoint.

            • VpcEndpointId — (String)

              The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.

            • VpcId — (String)

              The VPC identifier that the endpoint is associated.

            • NetworkInterfaces — (Array<map>)

              One or more network interfaces of the endpoint. Also known as an interface endpoint.

              • NetworkInterfaceId — (String)

                The network interface identifier.

              • SubnetId — (String)

                The subnet identifier.

              • PrivateIpAddress — (String)

                The IPv4 address of the network interface within the subnet.

              • AvailabilityZone — (String)

                The Availability Zone.

        • ClusterCreateTime — (Date)

          The date and time that the cluster was created.

        • AutomatedSnapshotRetentionPeriod — (Integer)

          The number of days that automatic cluster snapshots are retained.

        • ManualSnapshotRetentionPeriod — (Integer)

          The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

          The value must be either -1 or an integer between 1 and 3,653.

        • ClusterSecurityGroups — (Array<map>)

          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.

          • ClusterSecurityGroupName — (String)

            The name of the cluster security group.

          • Status — (String)

            The status of the cluster security group.

        • VpcSecurityGroups — (Array<map>)

          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.

          • VpcSecurityGroupId — (String)

            The identifier of the VPC security group.

          • Status — (String)

            The status of the VPC security group.

        • ClusterParameterGroups — (Array<map>)

          The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

          • ParameterGroupName — (String)

            The name of the cluster parameter group.

          • ParameterApplyStatus — (String)

            The status of parameter updates.

          • ClusterParameterStatusList — (Array<map>)

            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.

            • 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 — (map)

          A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

          • MasterUserPassword — (String)

            The pending or in-progress change of the admin user password for the cluster.

          • NodeType — (String)

            The pending or in-progress change of the cluster's node type.

          • NumberOfNodes — (Integer)

            The pending or in-progress change of the number of nodes in the cluster.

          • ClusterType — (String)

            The pending or in-progress change of the cluster type.

          • ClusterVersion — (String)

            The pending or in-progress change of the service version.

          • AutomatedSnapshotRetentionPeriod — (Integer)

            The pending or in-progress change of the automated snapshot retention period.

          • ClusterIdentifier — (String)

            The pending or in-progress change of the new identifier for the cluster.

          • PubliclyAccessible — (Boolean)

            The pending or in-progress change of the ability to connect to the cluster from the public network.

          • EnhancedVpcRouting — (Boolean)

            An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

            Default: false

          • MaintenanceTrackName — (String)

            The name of the maintenance track that the cluster will change to during the next maintenance window.

          • EncryptionType — (String)

            The encryption type for a cluster. Possible values are: KMS and None.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • AllowVersionUpgrade — (Boolean)

          A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

        • NumberOfNodes — (Integer)

          The number of compute nodes in the cluster.

        • PubliclyAccessible — (Boolean)

          A boolean value that, if true, indicates that the cluster can be accessed from a public network.

        • Encrypted — (Boolean)

          A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

        • RestoreStatus — (map)

          A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

          • Status — (String)

            The status of the restore action. Returns starting, restoring, completed, or failed.

          • CurrentRestoreRateInMegaBytesPerSecond — (Float)

            The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.

          • SnapshotSizeInMegaBytes — (Integer)

            The size of the set of snapshot data used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.

          • ProgressInMegaBytes — (Integer)

            The number of megabytes that have been transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.

          • ElapsedTimeInSeconds — (Integer)

            The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.

        • DataTransferProgress — (map)

          • Status — (String)

            Describes the status of the cluster. While the transfer is in progress the status is transferringdata.

          • CurrentRateInMegaBytesPerSecond — (Float)

            Describes the data transfer rate in MB's per second.

          • TotalDataInMegaBytes — (Integer)

            Describes the total amount of data to be transfered in megabytes.

          • DataTransferredInMegaBytes — (Integer)

            Describes the total amount of data that has been transfered in MB's.

          • EstimatedTimeToCompletionInSeconds — (Integer)

            Describes the estimated number of seconds remaining to complete the transfer.

          • ElapsedTimeInSeconds — (Integer)

            Describes the number of seconds that have elapsed during the data transfer.

        • HsmStatus — (map)

          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 — (map)

          A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

          • DestinationRegion — (String)

            The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

          • RetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

          • ManualSnapshotRetentionPeriod — (Integer)

            The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.

            The value must be either -1 or an integer between 1 and 3,653.

          • SnapshotCopyGrantName — (String)

            The name of the snapshot copy grant.

        • ClusterPublicKey — (String)

          The public key for the cluster.

        • ClusterNodes — (Array<map>)

          The nodes in the 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 — (map)

          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 — (Array<map>)

          The list of tags for the cluster.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

        • EnhancedVpcRouting — (Boolean)

          An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

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

          Default: false

        • IamRoles — (Array<map>)

          A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

          • IamRoleArn — (String)

            The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

          • ApplyStatus — (String)

            A value that describes the status of the IAM role's association with an Amazon Redshift cluster.

            The following are possible statuses and descriptions.

            • in-sync: The role is available for use by the cluster.

            • adding: The role is in the process of being associated with the cluster.

            • removing: The role is in the process of being disassociated with the cluster.

        • PendingActions — (Array<String>)

          Cluster operations that are waiting to be started.

        • MaintenanceTrackName — (String)

          The name of the maintenance track for the cluster.

        • ElasticResizeNumberOfNodeOptions — (String)

          The number of nodes that you can resize the cluster to with the elastic resize method.

        • DeferredMaintenanceWindows — (Array<map>)

          Describes a group of DeferredMaintenanceWindow objects.

          • DeferMaintenanceIdentifier — (String)

            A unique identifier for the maintenance window.

          • DeferMaintenanceStartTime — (Date)

            A timestamp for the beginning of the time period when we defer maintenance.

          • DeferMaintenanceEndTime — (Date)

            A timestamp for the end of the time period when we defer maintenance.

        • SnapshotScheduleIdentifier — (String)

          A unique identifier for the cluster snapshot schedule.

        • SnapshotScheduleState — (String)

          The current state of the cluster snapshot schedule.

          Possible values include:
          • "MODIFYING"
          • "ACTIVE"
          • "FAILED"
        • ExpectedNextSnapshotScheduleTime — (Date)

          The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

        • ExpectedNextSnapshotScheduleTimeStatus — (String)

          The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

          • OnTrack - The next snapshot is expected to be taken on time.

          • Pending - The next snapshot is pending to be taken.

        • NextMaintenanceWindowStartTime — (Date)

          The date and time in UTC when system maintenance can begin.

        • ResizeInfo — (map)

          Returns the following:

          • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

          • ResizeType: Returns ClassicResize

          • ResizeType — (String)

            Returns the value ClassicResize.

          • AllowCancelResize — (Boolean)

            A boolean value indicating if the resize operation can be cancelled.

        • AvailabilityZoneRelocationStatus — (String)

          Describes the status of the Availability Zone relocation operation.

        • ClusterNamespaceArn — (String)

          The namespace Amazon Resource Name (ARN) of the cluster.

        • TotalStorageCapacityInMegaBytes — (Integer)

          The total storage capacity of the cluster in megabytes.

        • AquaConfiguration — (map)

          The AQUA (Advanced Query Accelerator) configuration of the cluster.

          • AquaStatus — (String)

            The value indicates the status of AQUA on the cluster. Possible values include the following.

            • enabled - AQUA is enabled.

            • disabled - AQUA is not enabled.

            • applying - AQUA status is being applied.

            Possible values include:
            • "enabled"
            • "disabled"
            • "applying"
          • AquaConfigurationStatus — (String)

            The value represents how the cluster is configured to use AQUA. Possible values include the following.

            • enabled - Use AQUA if it is available for the current Amazon Web Services Region and Amazon Redshift node type.

            • disabled - Don't use AQUA.

            • auto - Amazon Redshift determines whether to use AQUA.

            Possible values include:
            • "enabled"
            • "disabled"
            • "auto"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also:

redshift.waitFor('snapshotAvailable', params = {}, [callback]) ⇒ AWS.Request

Waits for the snapshotAvailable state by periodically calling the underlying Redshift.describeClusterSnapshots() operation every 15 seconds (at most 20 times).

Examples:

Waiting for the snapshotAvailable state

var params = {
  // ... input parameters ...
};
redshift.waitFor('snapshotAvailable', params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) —
    • ClusterIdentifier — (String)

      The identifier of the cluster which generated the requested snapshots.

    • SnapshotIdentifier — (String)

      The snapshot identifier of the snapshot about which to return information.

    • SnapshotType — (String)

      The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.

      Valid Values: automated | manual

    • StartTime — (Date)

      A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: 2012-07-16T18:00:00Z

    • EndTime — (Date)

      A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

      Example: 2012-07-16T18:00:00Z

    • MaxRecords — (Integer)

      The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

      Default: 100

      Constraints: minimum 20, maximum 100.

    • Marker — (String)

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

    • OwnerAccount — (String)

      The Amazon Web Services account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your Amazon Web Services account, or do not specify the parameter.

    • TagKeys — (Array<String>)

      A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.

    • TagValues — (Array<String>)

      A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.

    • ClusterExists — (Boolean)

      A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:

      • If ClusterExists is set to true, ClusterIdentifier is required.

      • If ClusterExists is set to false and ClusterIdentifier isn't specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.

      • If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.

      • If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.

    • SortingEntities — (Array<map>)

      • Attribute — required — (String)

        The category for sorting the snapshots.

        Possible values include:
        • "SOURCE_TYPE"
        • "TOTAL_SIZE"
        • "CREATE_TIME"
      • SortOrder — (String)

        The order for listing the attributes.

        Possible values include:
        • "ASC"
        • "DESC"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Marker — (String)

        A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

      • Snapshots — (Array<map>)

        A list of Snapshot instances.

        • SnapshotIdentifier — (String)

          The snapshot identifier that is provided in the request.

        • ClusterIdentifier — (String)

          The identifier of the cluster for which the snapshot was taken.

        • SnapshotCreateTime — (Date)

          The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

        • Status — (String)

          The snapshot status. The value of the status depends on the API operation used:

        • Port — (Integer)

          The port that the cluster is listening on.

        • AvailabilityZone — (String)

          The Availability Zone in which the cluster was created.

        • ClusterCreateTime — (Date)

          The time (UTC) when the cluster was originally created.

        • MasterUsername — (String)

          The admin user name for the cluster.

        • ClusterVersion — (String)

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • EngineFullVersion — (String)

          The cluster version of the cluster used to create the snapshot. For example, 1.0.15503.

        • SnapshotType — (String)

          The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type "manual".

        • NodeType — (String)

          The node type of the nodes in the cluster.

        • NumberOfNodes — (Integer)

          The number of nodes in the cluster.

        • DBName — (String)

          The name of the database that was created when the cluster was created.

        • VpcId — (String)

          The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

        • Encrypted — (Boolean)

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

        • KmsKeyId — (String)

          The Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

        • EncryptedWithHSM — (Boolean)

          A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

        • AccountsWithRestoreAccess — (Array<map>)

          A list of the Amazon Web Services accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

          • AccountId — (String)

            The identifier of an Amazon Web Services account authorized to restore a snapshot.

          • AccountAlias — (String)

            The identifier of an Amazon Web Services support account authorized to restore a snapshot. For Amazon Web Services Support, the identifier is amazon-redshift-support.

        • OwnerAccount — (String)

          For manual snapshots, the Amazon Web Services account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

        • TotalBackupSizeInMegaBytes — (Float)

          The size of the complete set of backup data that would be used to restore the cluster.

        • ActualIncrementalBackupSizeInMegaBytes — (Float)

          The size of the incremental backup.

        • BackupProgressInMegaBytes — (Float)

          The number of megabytes that have been transferred to the snapshot backup.

        • CurrentBackupRateInMegaBytesPerSecond — (Float)

          The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

        • EstimatedSecondsToCompletion — (Integer)

          The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

        • ElapsedTimeInSeconds — (Integer)

          The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

        • SourceRegion — (String)

          The source region from which the snapshot was copied.

        • Tags — (Array<map>)

          The list of tags for the cluster snapshot.

          • Key — (String)

            The key, or name, for the resource tag.

          • Value — (String)

            The value for the resource tag.

        • RestorableNodeTypes — (Array<String>)

          The list of node types that this cluster snapshot is able to restore into.

        • 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 for the snapshot.

        • ManualSnapshotRetentionPeriod — (Integer)

          The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

          The value must be either -1 or an integer between 1 and 3,653.

        • ManualSnapshotRemainingDays — (Integer)

          The number of days until a manual snapshot will pass its retention period.

        • SnapshotRetentionStartTime — (Date)

          A timestamp representing the start of the retention period for the snapshot.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

See Also: