CREATE SECRET

Syntax

CREATE SECRET [IF NOT EXISTS] secret_name WITH (secret_parameter = value [, ...]);

Description

Creates a new secret within the organization.

Arguments

secret_name

Name of the secret to define. If the name is case-sensitive, you must wrap it in double quotes; otherwise, the system uses the lower case name.

WITH (secret_parameter = value [, …​ ])

This clause specifies secret parameters; see secret parameters for more information.

Secret Parameters

Parameter Name	Description
type	Required. Specifies the secret type. Type: SECRET_TYPE Valid values: GENERIC_SECRET
access_region	Required, unless specified in properties.file. Specifies the region in which the secret is available. Valid values: See LIST REGIONS
description	Optional. A description for the secret. Type: String
### GENERIC_SECRET Specific Parameters

Parameters to be used if type is GENERIC_SECRET:

Parameter Name	Description
secret_string	The string to store in the secret. The string can function as either an API token or a sensitive value string, to be utilized within the handler code of a user-defined function (UDF). Required: Yes Default value: None Type: String

Examples

Create a GENERIC_SECRET

The following creates a new secret name my_secret:

db.public/sfstore# CREATE SECRET IF NOT EXISTS
    my_secret  
WITH ( 
    'type' = GENERIC_STRING, 
    'access_region' = "AWS us-east-1", 
    'secret_string' = 'SGVsbG8gRGVsdGFzU3RyZWFtIQo=', 
    'description' = 'This is a generic_string secret'
);
+------------+------------+------------+------------------------------------------+
|  Type      |  Name      |  Command   |  Summary                                 |
+============+============+============+==========================================+
| secret     | my_secret  | CREATE     | secret "my_secret" was successfully      |
|            |            |            | created                                  |
+------------+------------+------------+------------------------------------------+