Skip to content

/AWS1/CL_APFREDCNCTORPFLPRPS

The connector-specific profile properties when using Amazon Redshift.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_bucketname TYPE /AWS1/APFBUCKETNAME /AWS1/APFBUCKETNAME

A name for the associated Amazon S3 bucket.

iv_rolearn TYPE /AWS1/APFROLEARN /AWS1/APFROLEARN

The Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift read-only access to Amazon S3. For more information, and for the polices that you attach to this role, see Allow Amazon Redshift to access your Amazon AppFlow data in Amazon S3.

Optional arguments:

iv_databaseurl TYPE /AWS1/APFDATABASEURL /AWS1/APFDATABASEURL

The JDBC URL of the Amazon Redshift cluster.

iv_bucketprefix TYPE /AWS1/APFBUCKETPREFIX /AWS1/APFBUCKETPREFIX

The object key for the destination bucket in which Amazon AppFlow places the files.

iv_dataapirolearn TYPE /AWS1/APFDATAAPIROLEARN /AWS1/APFDATAAPIROLEARN

The Amazon Resource Name (ARN) of an IAM role that permits Amazon AppFlow to access your Amazon Redshift database through the Data API. For more information, and for the polices that you attach to this role, see Allow Amazon AppFlow to access Amazon Redshift databases with the Data API.

iv_isredshiftserverless TYPE /AWS1/APFBOOLEAN /AWS1/APFBOOLEAN

Indicates whether the connector profile defines a connection to an Amazon Redshift Serverless data warehouse.

iv_clusteridentifier TYPE /AWS1/APFCLUSTERIDENTIFIER /AWS1/APFCLUSTERIDENTIFIER

The unique ID that's assigned to an Amazon Redshift cluster.

iv_workgroupname TYPE /AWS1/APFWORKGROUPNAME /AWS1/APFWORKGROUPNAME

The name of an Amazon Redshift workgroup.

iv_databasename TYPE /AWS1/APFDATABASENAME /AWS1/APFDATABASENAME

The name of an Amazon Redshift database.


Queryable Attributes

databaseUrl

The JDBC URL of the Amazon Redshift cluster.

Accessible with the following methods

Method Description
GET_DATABASEURL() Getter for DATABASEURL, with configurable default
ASK_DATABASEURL() Getter for DATABASEURL w/ exceptions if field has no value
HAS_DATABASEURL() Determine if DATABASEURL has a value

bucketName

A name for the associated Amazon S3 bucket.

Accessible with the following methods

Method Description
GET_BUCKETNAME() Getter for BUCKETNAME, with configurable default
ASK_BUCKETNAME() Getter for BUCKETNAME w/ exceptions if field has no value
HAS_BUCKETNAME() Determine if BUCKETNAME has a value

bucketPrefix

The object key for the destination bucket in which Amazon AppFlow places the files.

Accessible with the following methods

Method Description
GET_BUCKETPREFIX() Getter for BUCKETPREFIX, with configurable default
ASK_BUCKETPREFIX() Getter for BUCKETPREFIX w/ exceptions if field has no value
HAS_BUCKETPREFIX() Determine if BUCKETPREFIX has a value

roleArn

The Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift read-only access to Amazon S3. For more information, and for the polices that you attach to this role, see Allow Amazon Redshift to access your Amazon AppFlow data in Amazon S3.

Accessible with the following methods

Method Description
GET_ROLEARN() Getter for ROLEARN, with configurable default
ASK_ROLEARN() Getter for ROLEARN w/ exceptions if field has no value
HAS_ROLEARN() Determine if ROLEARN has a value

dataApiRoleArn

The Amazon Resource Name (ARN) of an IAM role that permits Amazon AppFlow to access your Amazon Redshift database through the Data API. For more information, and for the polices that you attach to this role, see Allow Amazon AppFlow to access Amazon Redshift databases with the Data API.

Accessible with the following methods

Method Description
GET_DATAAPIROLEARN() Getter for DATAAPIROLEARN, with configurable default
ASK_DATAAPIROLEARN() Getter for DATAAPIROLEARN w/ exceptions if field has no valu
HAS_DATAAPIROLEARN() Determine if DATAAPIROLEARN has a value

isRedshiftServerless

Indicates whether the connector profile defines a connection to an Amazon Redshift Serverless data warehouse.

Accessible with the following methods

Method Description
GET_ISREDSHIFTSERVERLESS() Getter for ISREDSHIFTSERVERLESS

clusterIdentifier

The unique ID that's assigned to an Amazon Redshift cluster.

Accessible with the following methods

Method Description
GET_CLUSTERIDENTIFIER() Getter for CLUSTERIDENTIFIER, with configurable default
ASK_CLUSTERIDENTIFIER() Getter for CLUSTERIDENTIFIER w/ exceptions if field has no v
HAS_CLUSTERIDENTIFIER() Determine if CLUSTERIDENTIFIER has a value

workgroupName

The name of an Amazon Redshift workgroup.

Accessible with the following methods

Method Description
GET_WORKGROUPNAME() Getter for WORKGROUPNAME, with configurable default
ASK_WORKGROUPNAME() Getter for WORKGROUPNAME w/ exceptions if field has no value
HAS_WORKGROUPNAME() Determine if WORKGROUPNAME has a value

databaseName

The name of an Amazon Redshift database.

Accessible with the following methods

Method Description
GET_DATABASENAME() Getter for DATABASENAME, with configurable default
ASK_DATABASENAME() Getter for DATABASENAME w/ exceptions if field has no value
HAS_DATABASENAME() Determine if DATABASENAME has a value