ModifyLakehouseConfiguration
Modifies the lakehouse configuration for a cluster. This operation allows you to manage Amazon Redshift federated permissions and AWS IAM Identity Center trusted identity propagation.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- ClusterIdentifier
-
The unique identifier of the cluster whose lakehouse configuration you want to modify.
Type: String
Length Constraints: Maximum length of 2147483647.
Required: Yes
- 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_01Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-z0-9_-]*[a-z]+[a-z0-9_-]*$Required: No
-
- 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.Type: Boolean
Required: No
- LakehouseIdcApplicationArn
-
The Amazon Resource Name (ARN) of the IAM Identity Center application used for enabling AWS IAM Identity Center trusted identity propagation on a cluster enabled with Amazon Redshift federated permissions.
Type: String
Length Constraints: Maximum length of 2147483647.
Required: No
- LakehouseIdcRegistration
-
Modifies the AWS IAM Identity Center trusted identity propagation on a cluster enabled with Amazon Redshift federated permissions. Valid values are
AssociateorDisassociate.Type: String
Valid Values:
Associate | DisassociateRequired: No
- LakehouseRegistration
-
Specifies whether to register or deregister the cluster with Amazon Redshift federated permissions. Valid values are
RegisterorDeregister.Type: String
Valid Values:
Register | DeregisterRequired: No
Response Elements
The following elements are returned by the service.
- CatalogArn
-
The Amazon Resource Name (ARN) of the Glue data catalog associated with the lakehouse configuration.
Type: String
Length Constraints: Maximum length of 2147483647.
- ClusterIdentifier
-
The unique identifier of the cluster associated with this lakehouse configuration.
Type: String
Length Constraints: Maximum length of 2147483647.
- LakehouseIdcApplicationArn
-
The Amazon Resource Name (ARN) of the IAM Identity Center application used for enabling AWS IAM Identity Center trusted identity propagation on a cluster enabled with Amazon Redshift federated permissions.
Type: String
Length Constraints: Maximum length of 2147483647.
- LakehouseRegistrationStatus
-
The current status of the lakehouse registration. Indicates whether the cluster is successfully registered with the lakehouse.
Type: String
Length Constraints: Maximum length of 2147483647.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ClusterNotFound
-
The
ClusterIdentifierparameter does not refer to an existing cluster.HTTP Status Code: 404
- DependentServiceAccessDenied
-
A dependent service denied access for the integration.
HTTP Status Code: 403
- DependentServiceUnavailableFault
-
Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.
HTTP Status Code: 400
- InvalidClusterState
-
The specified cluster is not in the
availablestate.HTTP Status Code: 400
- RedshiftIdcApplicationNotExists
-
The application you attempted to find doesn't exist.
HTTP Status Code: 404
- UnauthorizedOperation
-
Your account is not authorized to perform the requested operation.
HTTP Status Code: 400
- UnsupportedOperation
-
The requested operation isn't supported.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
