Skip to content

/AWS1/IF_RSH=>MODIFYLAKEHOUSECONFIGURATION()

About ModifyLakehouseConfiguration

Modifies the lakehouse configuration for a cluster. This operation allows you to manage Amazon Redshift federated permissions and Amazon Web Services IAM Identity Center trusted identity propagation.

Method Signature

METHODS /AWS1/IF_RSH~MODIFYLAKEHOUSECONFIGURATION
  IMPORTING
    !IV_CLUSTERIDENTIFIER TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_LAKEHOUSEREGISTRATION TYPE /AWS1/RSHLAKEHOUSEREGISTRATION OPTIONAL
    !IV_CATALOGNAME TYPE /AWS1/RSHCATALOGNAMESTRING OPTIONAL
    !IV_LAKEHOUSEIDCREGISTRATION TYPE /AWS1/RSHLAKEHOUSEIDCREG OPTIONAL
    !IV_LAKEHOUSEIDCAPPARN TYPE /AWS1/RSHSTRING OPTIONAL
    !IV_DRYRUN TYPE /AWS1/RSHBOOLEANOPTIONAL OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rshlakehouseconf
  RAISING
    /AWS1/CX_RSHCLUSTNOTFOUNDFAULT
    /AWS1/CX_RSHDEPENDENTSVCACCD00
    /AWS1/CX_RSHDEPENDENTSVCUNAV00
    /AWS1/CX_RSHINVCLUSTSTATEFAULT
    /AWS1/CX_RSHREDIDCAPPLICATIO01
    /AWS1/CX_RSHUNAUTHDOPERATION
    /AWS1/CX_RSHUNSUPPORTEDOPFAULT
    /AWS1/CX_RSHCLIENTEXC
    /AWS1/CX_RSHSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_clusteridentifier TYPE /AWS1/RSHSTRING /AWS1/RSHSTRING

The unique identifier of the cluster whose lakehouse configuration you want to modify.

Optional arguments:

iv_lakehouseregistration TYPE /AWS1/RSHLAKEHOUSEREGISTRATION /AWS1/RSHLAKEHOUSEREGISTRATION

Specifies whether to register or deregister the cluster with Amazon Redshift federated permissions. Valid values are Register or Deregister.

iv_catalogname TYPE /AWS1/RSHCATALOGNAMESTRING /AWS1/RSHCATALOGNAMESTRING

The name of the Glue data catalog that will be associated with the cluster enabled with Amazon Redshift federated permissions.

Constraints:

  • Must contain at least one lowercase letter.

  • Can only contain lowercase letters (a-z), numbers (0-9), underscores (), and hyphens (-).

Pattern: ^[a-z0-9-][a-z]+[a-z0-9_-]$

Example: my-catalog_01

iv_lakehouseidcregistration TYPE /AWS1/RSHLAKEHOUSEIDCREG /AWS1/RSHLAKEHOUSEIDCREG

Modifies the Amazon Web Services IAM Identity Center trusted identity propagation on a cluster enabled with Amazon Redshift federated permissions. Valid values are Associate or Disassociate.

iv_lakehouseidcapparn TYPE /AWS1/RSHSTRING /AWS1/RSHSTRING

The Amazon Resource Name (ARN) of the IAM Identity Center application used for enabling Amazon Web Services IAM Identity Center trusted identity propagation on a cluster enabled with Amazon Redshift federated permissions.

iv_dryrun TYPE /AWS1/RSHBOOLEANOPTIONAL /AWS1/RSHBOOLEANOPTIONAL

A boolean value that, if true, validates the request without actually modifying the lakehouse configuration. Use this to check for errors before making changes.

RETURNING

oo_output TYPE REF TO /aws1/cl_rshlakehouseconf /AWS1/CL_RSHLAKEHOUSECONF

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->modifylakehouseconfiguration(
  iv_catalogname = |string|
  iv_clusteridentifier = |string|
  iv_dryrun = ABAP_TRUE
  iv_lakehouseidcapparn = |string|
  iv_lakehouseidcregistration = |string|
  iv_lakehouseregistration = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_clusteridentifier( ).
  lv_string = lo_result->get_lakehouseidcapparn( ).
  lv_string = lo_result->get_lakehouseregstatus( ).
  lv_string = lo_result->get_catalogarn( ).
ENDIF.