Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Amazon Redshift

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.

Hierarchy

Implements

Implemented by

Constructors

Properties

Methods

acceptReservedNodeExchange addPartner associateDataShareConsumer authorizeClusterSecurityGroupIngress authorizeDataShare authorizeEndpointAccess authorizeSnapshotAccess batchDeleteClusterSnapshots batchModifyClusterSnapshots cancelResize copyClusterSnapshot createAuthenticationProfile createCluster createClusterParameterGroup createClusterSecurityGroup createClusterSnapshot createClusterSubnetGroup createCustomDomainAssociation createEndpointAccess createEventSubscription createHsmClientCertificate createHsmConfiguration createScheduledAction createSnapshotCopyGrant createSnapshotSchedule createTags createUsageLimit deauthorizeDataShare deleteAuthenticationProfile deleteCluster deleteClusterParameterGroup deleteClusterSecurityGroup deleteClusterSnapshot deleteClusterSubnetGroup deleteCustomDomainAssociation deleteEndpointAccess deleteEventSubscription deleteHsmClientCertificate deleteHsmConfiguration deletePartner deleteScheduledAction deleteSnapshotCopyGrant deleteSnapshotSchedule deleteTags deleteUsageLimit describeAccountAttributes describeAuthenticationProfiles describeClusterDbRevisions describeClusterParameterGroups describeClusterParameters describeClusterSecurityGroups describeClusterSnapshots describeClusterSubnetGroups describeClusterTracks describeClusterVersions describeClusters describeCustomDomainAssociations describeDataShares describeDataSharesForConsumer describeDataSharesForProducer describeDefaultClusterParameters describeEndpointAccess describeEndpointAuthorization describeEventCategories describeEventSubscriptions describeEvents describeHsmClientCertificates describeHsmConfigurations describeLoggingStatus describeNodeConfigurationOptions describeOrderableClusterOptions describePartners describeReservedNodeExchangeStatus describeReservedNodeOfferings describeReservedNodes describeResize describeScheduledActions describeSnapshotCopyGrants describeSnapshotSchedules describeStorage describeTableRestoreStatus describeTags describeUsageLimits destroy disableLogging disableSnapshotCopy disassociateDataShareConsumer enableLogging enableSnapshotCopy getClusterCredentials getClusterCredentialsWithIAM getReservedNodeExchangeConfigurationOptions getReservedNodeExchangeOfferings modifyAquaConfiguration modifyAuthenticationProfile modifyCluster modifyClusterDbRevision modifyClusterIamRoles modifyClusterMaintenance modifyClusterParameterGroup modifyClusterSnapshot modifyClusterSnapshotSchedule modifyClusterSubnetGroup modifyCustomDomainAssociation modifyEndpointAccess modifyEventSubscription modifyScheduledAction modifySnapshotCopyRetentionPeriod modifySnapshotSchedule modifyUsageLimit pauseCluster purchaseReservedNodeOffering rebootCluster rejectDataShare resetClusterParameterGroup resizeCluster restoreFromClusterSnapshot restoreTableFromClusterSnapshot resumeCluster revokeClusterSecurityGroupIngress revokeEndpointAccess revokeSnapshotAccess rotateEncryptionKey updatePartnerStatus

Constructors

Properties

The resolved configuration of RedshiftClient class. This is resolved and normalized from the constructor configuration interface.

Methods

  • Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

    Returns void