Categories:

System Functions (System Control)

SYSTEM$REGISTER_CMK_INFO

Registers your customer-managed key (CMK) for use with Tri-Secret Secure.

See also:

Self-registration overview

Syntax

Amazon Web Services

SYSTEM$REGISTER_CMK_INFO( '<cmk-arn>' )
Copy

Microsoft Azure

SYSTEM$REGISTER_CMK_INFO( '<vault-uri>' , '<key-name>' )
Copy

Google Cloud Platform

SYSTEM$REGISTER_CMK_INFO( '<project-id>' , '<location>', '<key-ring>' , '<key-name>' )
Copy

Arguments

cmk-arn

Specifies the Amazon Web Services resource number (ARN) that specifies the customer-managed key (CMK) for use with Tri-Secret Secure.

vault-uri

Specifies the Microsoft Azure unique endpoint identifier for your Azure Key Vault.

key-name

Specifies the name for your CMK in Microsoft Azure.

project-id

Specifies the unique identifier for your project in Google Cloud Platform.

location

Specifies the Google Cloud Platform region that hosts your Snowflake account.

key-ring

Specifies the key ring for your CMK in Google Cloud Platform.

key-name

Specifies the name of your CMK.

Returns

Returns a status message stating the registration is complete.

Usage notes

Only account administrators (users with the ACCOUNTADMIN role) can call this function.

Examples

Register your CMK for your Snowflake account on Amazon Web Services:

SELECT SYSTEM$REGISTER_CMK_INFO('arn:aws:kms:us-west-2:736112632310:key/ceab36e4-f0e5-4b46-9a78-86e8f17a0f59');
Copy

Register your CMK for your Snowflake account on Microsoft Azure:

SELECT SYSTEM$REGISTER_CMK_INFO('https://trisecretsite.vault.azure.net/', 'trisecretazkey');
Copy

Register your CMK for your Snowflake account on Google Cloud Platform:

SELECT SYSTEM$REGISTER_CMK_INFO('my-env', 'us-west1', 'trisecrettest', 'trisecretgcpkey');
Copy