AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . redshift ]

modify-lakehouse-configuration

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.

See also: AWS API Documentation

Synopsis

  modify-lakehouse-configuration
--cluster-identifier <value>
[--lakehouse-registration <value>]
[--catalog-name <value>]
[--lakehouse-idc-registration <value>]
[--lakehouse-idc-application-arn <value>]
[--dry-run | --no-dry-run]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--cluster-identifier (string)

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

--lakehouse-registration (string)

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

Possible values:

  • Register
  • Deregister

--catalog-name (string)

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

--lakehouse-idc-registration (string)

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 .

Possible values:

  • Associate
  • Disassociate

--lakehouse-idc-application-arn (string)

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.

--dry-run | --no-dry-run (boolean)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

ClusterIdentifier -> (string)

The unique identifier of the cluster associated with this lakehouse configuration.

LakehouseIdcApplicationArn -> (string)

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.

LakehouseRegistrationStatus -> (string)

The current status of the lakehouse registration. Indicates whether the cluster is successfully registered with the lakehouse.

CatalogArn -> (string)

The Amazon Resource Name (ARN) of the Glue data catalog associated with the lakehouse configuration.