Share via

AmazonRedshiftLinkedService Class

Linked service for Amazon Redshift.

All required parameters must be populated in order to send to server.

Constructor

AmazonRedshiftLinkedService(*, server: MutableMapping[str, Any], database: MutableMapping[str, Any], additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, version: str | None = None, connect_via: _models.IntegrationRuntimeReference | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str, Any]] | None = None, username: MutableMapping[str, Any] | None = None, password: _models.SecretBase | None = None, port: MutableMapping[str, Any] | None = None, encrypted_credential: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.

Default value: None
version
str

Version of the linked service.

Default value: None
connect_via
IntegrationRuntimeReference

The integration runtime reference.

Default value: None
description
str

Linked service description.

Default value: None
parameters
dict[str, ParameterSpecification]

Parameters for linked service.

Default value: None
annotations
list[<xref:JSON>]

List of tags that can be used for describing the linked service.

Default value: None
server
<xref:JSON>

The name of the Amazon Redshift server. Type: string (or Expression with resultType string). Required.
username
<xref:JSON>

The username of the Amazon Redshift source. Type: string (or Expression with resultType string).

Default value: None
password
SecretBase

The password of the Amazon Redshift source.

Default value: None
database
<xref:JSON>

The database name of the Amazon Redshift source. Type: string (or Expression with resultType string). Required.
port
<xref:JSON>

The TCP port number that the Amazon Redshift server uses to listen for client connections. The default value is 5439. Type: integer (or Expression with resultType integer).

Default value: None
encrypted_credential
str

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

Default value: None

Variables

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.
type
str

Type of linked service. Required.
version
str

Version of the linked service.
connect_via
IntegrationRuntimeReference

The integration runtime reference.
description
str

Linked service description.
parameters
dict[str, ParameterSpecification]

Parameters for linked service.
annotations
list[<xref:JSON>]

List of tags that can be used for describing the linked service.
server
<xref:JSON>

The name of the Amazon Redshift server. Type: string (or Expression with resultType string). Required.
username
<xref:JSON>

The username of the Amazon Redshift source. Type: string (or Expression with resultType string).
password
SecretBase

The password of the Amazon Redshift source.
database
<xref:JSON>

The database name of the Amazon Redshift source. Type: string (or Expression with resultType string). Required.
port
<xref:JSON>

The TCP port number that the Amazon Redshift server uses to listen for client connections. The default value is 5439. Type: integer (or Expression with resultType integer).
encrypted_credential
str

The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.