CData Cmdlets for Amazon Redshift 2019 - Online Help
Questions / Feedback?

Parameters (Connect-Redshift Cmdlet)

CData Cmdlets for Amazon Redshift 2019 - Build 19.0.7354

The following is the full list of the parameters of the cmdlet with short descriptions. Click the links for further details.

Parameter Required Description
AllowPreparedStatement    Prepare a query statement before its execution. 
Database    The name of the Redshift database. 
FirewallPassword    A password used to authenticate to a proxy-based firewall. 
FirewallPort    The TCP port for a proxy-based firewall. 
FirewallServer    The name or IP address of a proxy-based firewall. 
FirewallType    The protocol used by a proxy-based firewall. 
FirewallUser    The user name to use to authenticate with a proxy-based firewall. 
IdPPassword    The password required for authentication with the Identity Provider. 
IdPType    Type of authentication service to run by Identity Provider. 
IdPUrl    The url value to connect Identity Provider. 
IdPUser    The username used to authenticate with the Identity Provider IdPUrl . 
IgnoredSchemas    Visibility restriction filter which is used to hide the list of schemas by metadata quering. For example, 'information_schema, pg_catalog'. Schema names are case sensitive. 
Location    A path to the directory that contains the schema files defining tables, views, and stored procedures. 
Logfile    A path to the log file. 
MaxLogFileCount    A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted. 
MaxLogFileSize    A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. 
MaxRows    Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. 
Other    These hidden properties are used only in specific use cases. 
Password  True  The password required for authentication with the Amazon Redshift server. 
Port    The port number of the Amazon Redshift server. 
QueryPassthrough    This option passes the query to the Redshift server as is. 
Readonly    You can use this property to enforce read-only access to Redshift from the provider. 
RTK    The runtime key used for licensing. 
Server  True  The host name or IP address of the Redshift cluster. 
SSLClientCert    The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). 
SSLClientCertPassword    The password for the TLS/SSL client certificate. 
SSLClientCertSubject    The subject of the TLS/SSL client certificate. 
SSLClientCertType    The type of key store containing the TLS/SSL client certificate. 
SSLServerCert    The certificate to be accepted from the server when connecting using TLS/SSL. 
SSOLoginURL    The SSOProvider login URL. 
SSOPassword    The password of the SSOProvider used to authenticate the user. 
SSOProvider    The name of the SSO provider you are trying to authenticate. 
SSOUser    The SSOProvider user account used to authenticate. 
Tables    This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. 
Timeout    The (nonzero) value in seconds until the connection timeout error is thrown. 
TimeZone    Set time zone for the current session. 
User  True  The username used to authenticate with the Amazon Redshift Server . 
UseSSL    This field sets whether SSL is enabled. 
Verbosity    The verbosity level that determines the amount of detail included in the log file. 
Views    Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. 
Visibility    Visibility restrictions used to filter exposed metadata for tables with privileges granted to them for current user. For example 'SELECT,INSERT' filter is restricting metatdata visibility only for those tables which may be accessed by current user for SELECT and INSERT opearations. Supported privilege values are SELECT, INSERT, UPDATE, DELETE, REFERENCES. 

 
 
Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 19.0.7354.0