Enabling and disabling IAM database authentication - Amazon Aurora

Enabling and disabling IAM database authentication

By default, IAM database authentication is disabled on DB clusters. You can enable or disable IAM database authentication using the AWS Management Console, AWS CLI, or the API.

You can enable IAM database authentication when you perform one of the following actions:

Each creation or modification workflow has a Database authentication section, where you can enable or disable IAM database authentication. In that section, choose Password and IAM database authentication to enable IAM database authentication.

To enable or disable IAM database authentication for an existing DB cluster

  1. Open the Amazon RDS console at https://console.aws.amazon.com/rds/.

  2. In the navigation pane, choose Databases.

  3. Choose the DB cluster that you want to modify.

    Note

    You can only enable IAM authentication if all DB instances in the DB cluster are compatible with IAM. Check the compatibility requirements in Availability for IAM database authentication.

  4. Choose Modify.

  5. In the Database authentication section, choose Password and IAM database authentication to enable IAM database authentication.

  6. Choose Continue.

  7. To apply the changes immediately, choose Immediately in the Scheduling of modifications section.

  8. Choose Modify cluster.

To create a new DB cluster with IAM authentication by using the AWS CLI, use the create-db-cluster command. Specify the --enable-iam-database-authentication option.

To update an existing DB cluster to have or not have IAM authentication, use the AWS CLI command modify-db-cluster. Specify either the --enable-iam-database-authentication or --no-enable-iam-database-authentication option, as appropriate.

Note

You can only enable IAM authentication if all DB instances in the DB cluster are compatible with IAM. Check the compatibility requirements in Availability for IAM database authentication.

By default, Aurora performs the modification during the next maintenance window. If you want to override this and enable IAM DB authentication as soon as possible, use the --apply-immediately parameter.

If you are restoring a DB cluster, use one of the following AWS CLI commands:

The IAM database authentication setting defaults to that of the source snapshot. To change this setting, set the --enable-iam-database-authentication or --no-enable-iam-database-authentication option, as appropriate.

To create a new DB instance with IAM authentication by using the API, use the API operation CreateDBCluster. Set the EnableIAMDatabaseAuthentication parameter to true.

To update an existing DB cluster to have IAM authentication, use the API operation ModifyDBCluster. Set the EnableIAMDatabaseAuthentication parameter to true to enable IAM authentication, or false to disable it.

Note

You can only enable IAM authentication if all DB instances in the DB cluster are compatible with IAM. Check the compatibility requirements in Availability for IAM database authentication.

If you are restoring a DB cluster, use one of the following API operations:

The IAM database authentication setting defaults to that of the source snapshot. To change this setting, set the EnableIAMDatabaseAuthentication parameter to true to enable IAM authentication, or false to disable it.