/AWS1/CL_FRHREDSHIFTDSTCONF¶
Describes the configuration of a destination in Amazon Redshift.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_rolearn TYPE /AWS1/FRHROLEARN /AWS1/FRHROLEARN¶
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
iv_clusterjdbcurl TYPE /AWS1/FRHCLUSTERJDBCURL /AWS1/FRHCLUSTERJDBCURL¶
The database connection string.
io_copycommand TYPE REF TO /AWS1/CL_FRHCOPYCOMMAND /AWS1/CL_FRHCOPYCOMMAND¶
The
COPYcommand.
io_s3configuration TYPE REF TO /AWS1/CL_FRHS3DESTINATIONCONF /AWS1/CL_FRHS3DESTINATIONCONF¶
The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic for CreateDeliveryStream.
The compression formats
SNAPPYorZIPcannot be specified inRedshiftDestinationConfiguration.S3Configurationbecause the Amazon RedshiftCOPYoperation that reads from the S3 bucket doesn't support these compression formats.
Optional arguments:¶
iv_username TYPE /AWS1/FRHUSERNAME /AWS1/FRHUSERNAME¶
The name of the user.
iv_password TYPE /AWS1/FRHPASSWORD /AWS1/FRHPASSWORD¶
The user password.
io_retryoptions TYPE REF TO /AWS1/CL_FRHREDRETRYOPTIONS /AWS1/CL_FRHREDRETRYOPTIONS¶
The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
io_processingconfiguration TYPE REF TO /AWS1/CL_FRHPROCESSINGCONF /AWS1/CL_FRHPROCESSINGCONF¶
The data processing configuration.
iv_s3backupmode TYPE /AWS1/FRHREDSHIFTS3BACKUPMODE /AWS1/FRHREDSHIFTS3BACKUPMODE¶
The Amazon S3 backup mode. After you create a Firehose stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it.
io_s3backupconfiguration TYPE REF TO /AWS1/CL_FRHS3DESTINATIONCONF /AWS1/CL_FRHS3DESTINATIONCONF¶
The configuration for backup in Amazon S3.
io_cloudwatchloggingoptions TYPE REF TO /AWS1/CL_FRHCLOUDWATCHLOGOPTS /AWS1/CL_FRHCLOUDWATCHLOGOPTS¶
The CloudWatch logging options for your Firehose stream.
io_secretsmanagerconf TYPE REF TO /AWS1/CL_FRHSECRETSMANAGERCONF /AWS1/CL_FRHSECRETSMANAGERCONF¶
The configuration that defines how you access secrets for Amazon Redshift.
Queryable Attributes¶
RoleARN¶
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
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 |
ClusterJDBCURL¶
The database connection string.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLUSTERJDBCURL() |
Getter for CLUSTERJDBCURL, with configurable default |
ASK_CLUSTERJDBCURL() |
Getter for CLUSTERJDBCURL w/ exceptions if field has no valu |
HAS_CLUSTERJDBCURL() |
Determine if CLUSTERJDBCURL has a value |
CopyCommand¶
The
COPYcommand.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COPYCOMMAND() |
Getter for COPYCOMMAND |
Username¶
The name of the user.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USERNAME() |
Getter for USERNAME, with configurable default |
ASK_USERNAME() |
Getter for USERNAME w/ exceptions if field has no value |
HAS_USERNAME() |
Determine if USERNAME has a value |
Password¶
The user password.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PASSWORD() |
Getter for PASSWORD, with configurable default |
ASK_PASSWORD() |
Getter for PASSWORD w/ exceptions if field has no value |
HAS_PASSWORD() |
Determine if PASSWORD has a value |
RetryOptions¶
The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RETRYOPTIONS() |
Getter for RETRYOPTIONS |
S3Configuration¶
The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic for CreateDeliveryStream.
The compression formats
SNAPPYorZIPcannot be specified inRedshiftDestinationConfiguration.S3Configurationbecause the Amazon RedshiftCOPYoperation that reads from the S3 bucket doesn't support these compression formats.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_S3CONFIGURATION() |
Getter for S3CONFIGURATION |
ProcessingConfiguration¶
The data processing configuration.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PROCESSINGCONFIGURATION() |
Getter for PROCESSINGCONFIGURATION |
S3BackupMode¶
The Amazon S3 backup mode. After you create a Firehose stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the Firehose stream to disable it.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_S3BACKUPMODE() |
Getter for S3BACKUPMODE, with configurable default |
ASK_S3BACKUPMODE() |
Getter for S3BACKUPMODE w/ exceptions if field has no value |
HAS_S3BACKUPMODE() |
Determine if S3BACKUPMODE has a value |
S3BackupConfiguration¶
The configuration for backup in Amazon S3.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_S3BACKUPCONFIGURATION() |
Getter for S3BACKUPCONFIGURATION |
CloudWatchLoggingOptions¶
The CloudWatch logging options for your Firehose stream.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLOUDWATCHLOGGINGOPTIONS() |
Getter for CLOUDWATCHLOGGINGOPTIONS |
SecretsManagerConfiguration¶
The configuration that defines how you access secrets for Amazon Redshift.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SECRETSMANAGERCONF() |
Getter for SECRETSMANAGERCONFIGURATION |