ENABLELOGGING()`¶

About EnableLogging¶

Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_clusteridentifier` `TYPE /AWS1/RSHSTRING` `/AWS1/RSHSTRING`¶

The identifier of the cluster on which logging is to be started.

Example: examplecluster

Optional arguments:¶

`iv_bucketname` `TYPE /AWS1/RSHSTRING` `/AWS1/RSHSTRING`¶

The name of an existing S3 bucket where the log files are to be stored.

Constraints:

Must be in the same region as the cluster

The cluster must have read bucket and put object permissions

`iv_s3keyprefix` `TYPE /AWS1/RSHS3KEYPREFIXVALUE` `/AWS1/RSHS3KEYPREFIXVALUE`¶

The prefix applied to the log file names.

Valid characters are any letter from any language, any whitespace character, any numeric character, and the following characters: underscore (_), period (.), colon (:), slash (/), equal (=), plus (+), backslash (\), hyphen (-), at symbol (@).

`iv_logdestinationtype` `TYPE /AWS1/RSHLOGDESTINATIONTYPE` `/AWS1/RSHLOGDESTINATIONTYPE`¶

The log destination type. An enum with possible values of s3 and cloudwatch.

`it_logexports` `TYPE /AWS1/CL_RSHLOGTYPELIST_W=>TT_LOGTYPELIST` `TT_LOGTYPELIST`¶

The collection of exported log types. Possible values are connectionlog, useractivitylog, and userlog.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_rshloggingstatus` `/AWS1/CL_RSHLOGGINGSTATUS`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_rsh~enablelogging(
  it_logexports = VALUE /aws1/cl_rshlogtypelist_w=>tt_logtypelist(
    ( new /aws1/cl_rshlogtypelist_w( |string| ) )
  )
  iv_bucketname = |string|
  iv_clusteridentifier = |string|
  iv_logdestinationtype = |string|
  iv_s3keyprefix = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_boolean = lo_result->get_loggingenabled( ).
  lv_string = lo_result->get_bucketname( ).
  lv_s3keyprefixvalue = lo_result->get_s3keyprefix( ).
  lv_tstamp = lo_result->get_lastsuccfuldeliverytime( ).
  lv_tstamp = lo_result->get_lastfailuretime( ).
  lv_string = lo_result->get_lastfailuremessage( ).
  lv_logdestinationtype = lo_result->get_logdestinationtype( ).
  LOOP AT lo_result->get_logexports( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/CL_RSH=>ENABLELOGGING()¶