Skip to content

Modifies the lakehouse configuration for a cluster

Description

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.

Usage

redshift_modify_lakehouse_configuration(ClusterIdentifier,
  LakehouseRegistration, CatalogName, LakehouseIdcRegistration,
  LakehouseIdcApplicationArn, DryRun)

Arguments

  • ClusterIdentifier

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

  • LakehouseRegistration

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

  • CatalogName

    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

  • LakehouseIdcRegistration

    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.

  • LakehouseIdcApplicationArn

    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.

  • DryRun

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

Value

A list with the following syntax:

list(
  ClusterIdentifier = "string",
  LakehouseIdcApplicationArn = "string",
  LakehouseRegistrationStatus = "string",
  CatalogArn = "string"
)

Request syntax

svc$modify_lakehouse_configuration(
  ClusterIdentifier = "string",
  LakehouseRegistration = "Register"|"Deregister",
  CatalogName = "string",
  LakehouseIdcRegistration = "Associate"|"Disassociate",
  LakehouseIdcApplicationArn = "string",
  DryRun = TRUE|FALSE
)