Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RedshiftServerless

This is an interface reference for Amazon Redshift Serverless. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift Serverless.

Amazon Redshift Serverless automatically provisions data warehouse capacity and intelligently scales the underlying resources based on workload demands. Amazon Redshift Serverless adjusts capacity in seconds to deliver consistently high performance and simplified operations for even the most demanding and volatile workloads. Amazon Redshift Serverless lets you focus on using your data to acquire new insights for your business and customers.

To learn more about Amazon Redshift Serverless, see What is Amazon Redshift Serverless.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly config

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

middlewareStack

Methods

convertRecoveryPointToSnapshot

createEndpointAccess

createNamespace

createSnapshot

createUsageLimit

createWorkgroup

deleteEndpointAccess

deleteNamespace

deleteResourcePolicy

deleteSnapshot

deleteUsageLimit

deleteWorkgroup

destroy

  • destroy(): void
  • 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

getCredentials

  • Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless.

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

         <p>
         The Identity and Access Management (IAM) user or role that runs
         GetCredentials must have an IAM policy attached that allows access to all
         necessary actions and resources.
         </p>
    
         <p>
         If the <code>DbName</code> parameter is specified, the IAM policy must
         allow access to the resource dbname for the specified database name.</p>
    

    Parameters

    Returns Promise<GetCredentialsCommandOutput>

  • Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless.

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

    The Identity and Access Management (IAM) user or role that runs GetCredentials must have an IAM policy attached that allows access to all necessary actions and resources.

    If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.

    Parameters

    Returns void

  • Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless.

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

    The Identity and Access Management (IAM) user or role that runs GetCredentials must have an IAM policy attached that allows access to all necessary actions and resources.

    If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.

    Parameters

    Returns void

  • Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless.

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

         <p>
         The Identity and Access Management (IAM) user or role that runs
         GetCredentials must have an IAM policy attached that allows access to all
         necessary actions and resources.
         </p>
    
         <p>
         If the <code>DbName</code> parameter is specified, the IAM policy must
         allow access to the resource dbname for the specified database name.</p>
    

    Parameters

    • args: GetCredentialsCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetCredentialsCommandOutput>

  • Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless.

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

    The Identity and Access Management (IAM) user or role that runs GetCredentials must have an IAM policy attached that allows access to all necessary actions and resources.

    If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.

    Parameters

    Returns void

  • Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless.

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

    The Identity and Access Management (IAM) user or role that runs GetCredentials must have an IAM policy attached that allows access to all necessary actions and resources.

    If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.

    Parameters

    Returns void

getEndpointAccess

getNamespace

getRecoveryPoint

getResourcePolicy

getSnapshot

getUsageLimit

getWorkgroup

listEndpointAccess

listNamespaces

listRecoveryPoints

listSnapshots

listTagsForResource

listUsageLimits

listWorkgroups

putResourcePolicy

restoreFromRecoveryPoint

restoreFromSnapshot

send

tagResource

untagResource

updateEndpointAccess

updateNamespace

updateSnapshot

updateUsageLimit

updateWorkgroup