ALTER SYSTEM - Amazon Redshift
Required privilegesSyntaxParametersUsage notesExamples
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ALTER SYSTEM

Changes a system-level configuration option for the Amazon Redshift cluster or Redshift Serverless workgroup.

Required privileges

One of the following user types can run the ALTER SYSTEM command:

  • Superuser

  • Admin user

Syntax

ALTER SYSTEM SET system-level-configuration = {true| t | on | false | f | off}

Parameters

system-level-configuration

A system-level configuration. Valid value: data_catalog_auto_mount and metadata_security.

{true| t | on | false | f | off}

A value to activate or deactivate the system-level configuration. A true, t, or on indicates to activate the configuration. A false, f, or off indicates to deactivate the configuration.

Usage notes

For a provisioned cluster, changes to data_catalog_auto_mount take effect on the next reboot of the cluster. For more information, see Rebooting a cluster in the Amazon Redshift Management Guide.

For a serverliess workgroup, changes to data_catalog_auto_mount do not take effect immediately.

Examples

The following example turns on automounting the Amazon Glue Data Catalog.

ALTER SYSTEM SET data_catalog_auto_mount = true;

The following example turns on metadata security.

ALTER SYSTEM SET metadata_security = true;

Setting a default identity namespace

This example is specific to working with an identity provider. You can integrate Redshift with IAM Identity Center and an identity provider to centralize identity management for Redshift and other Amazon services.

The following sample shows how to set the default identity namespace for the system. Doing this subsequently makes it more simple to run GRANT and CREATE statements, because you don't have to include the namespace as a prefix for each identity.

ALTER SYSTEM SET default_identity_namespace = 'MYCO';

After running the command, you can run statements like the following:

GRANT SELECT ON TABLE mytable TO alice;

GRANT UPDATE ON TABLE mytable TO salesrole;
               
CREATE USER bob password 'md50c983d1a624280812631c5389e60d48c';

The effect of setting the default identity namespace is that each identity doesn't require it as a prefix. In this example, alice is replaced with MYCO:alice. This happens with any identity included. For more information about using an identity provider with Redshift, see Connect Redshift with IAM Identity Center to give users a single sign-on experience.

For more information about settings that pertain to Redshift configuration with IAM Identity Center, see SET and ALTER IDENTITY PROVIDER.