Snowflake v1.3.0, Apr 23 25

Snowflake v1.3.0 published on Wednesday, Apr 23, 2025 by Pulumi

snowflake.SecretWithBasicAuthentication

Explore with Pulumi AI

Snowflake v1.3.0 published on Wednesday, Apr 23, 2025 by Pulumi

Import

$ pulumi import snowflake:index/secretWithBasicAuthentication:SecretWithBasicAuthentication example '"<database_name>"."<schema_name>"."<secret_name>"'

Create SecretWithBasicAuthentication Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SecretWithBasicAuthentication(name: string, args: SecretWithBasicAuthenticationArgs, opts?: CustomResourceOptions);

@overload
def SecretWithBasicAuthentication(resource_name: str,
                                  args: SecretWithBasicAuthenticationArgs,
                                  opts: Optional[ResourceOptions] = None)

@overload
def SecretWithBasicAuthentication(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  database: Optional[str] = None,
                                  password: Optional[str] = None,
                                  schema: Optional[str] = None,
                                  username: Optional[str] = None,
                                  comment: Optional[str] = None,
                                  name: Optional[str] = None)

func NewSecretWithBasicAuthentication(ctx *Context, name string, args SecretWithBasicAuthenticationArgs, opts ...ResourceOption) (*SecretWithBasicAuthentication, error)

public SecretWithBasicAuthentication(string name, SecretWithBasicAuthenticationArgs args, CustomResourceOptions? opts = null)

public SecretWithBasicAuthentication(String name, SecretWithBasicAuthenticationArgs args)
public SecretWithBasicAuthentication(String name, SecretWithBasicAuthenticationArgs args, CustomResourceOptions options)

type: snowflake:SecretWithBasicAuthentication
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args SecretWithBasicAuthenticationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args SecretWithBasicAuthenticationArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SecretWithBasicAuthenticationArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SecretWithBasicAuthenticationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SecretWithBasicAuthenticationArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var secretWithBasicAuthenticationResource = new Snowflake.SecretWithBasicAuthentication("secretWithBasicAuthenticationResource", new()
{
    Database = "string",
    Password = "string",
    Schema = "string",
    Username = "string",
    Comment = "string",
    Name = "string",
});

example, err := snowflake.NewSecretWithBasicAuthentication(ctx, "secretWithBasicAuthenticationResource", &snowflake.SecretWithBasicAuthenticationArgs{
	Database: pulumi.String("string"),
	Password: pulumi.String("string"),
	Schema:   pulumi.String("string"),
	Username: pulumi.String("string"),
	Comment:  pulumi.String("string"),
	Name:     pulumi.String("string"),
})

var secretWithBasicAuthenticationResource = new SecretWithBasicAuthentication("secretWithBasicAuthenticationResource", SecretWithBasicAuthenticationArgs.builder()
    .database("string")
    .password("string")
    .schema("string")
    .username("string")
    .comment("string")
    .name("string")
    .build());

secret_with_basic_authentication_resource = snowflake.SecretWithBasicAuthentication("secretWithBasicAuthenticationResource",
    database="string",
    password="string",
    schema="string",
    username="string",
    comment="string",
    name="string")

const secretWithBasicAuthenticationResource = new snowflake.SecretWithBasicAuthentication("secretWithBasicAuthenticationResource", {
    database: "string",
    password: "string",
    schema: "string",
    username: "string",
    comment: "string",
    name: "string",
});

type: snowflake:SecretWithBasicAuthentication
properties:
    comment: string
    database: string
    name: string
    password: string
    schema: string
    username: string

SecretWithBasicAuthentication Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SecretWithBasicAuthentication resource accepts the following input properties:

Database string: The database in which to create the secret Due to technical limitations (read more here), avoid using the following characters: |, ., ".
Password string
Schema string: The schema in which to create the secret. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
Username string: Specifies the username value to store in the secret.
Comment string: Specifies a comment for the secret.
Name string: String that specifies the identifier (i.e. name) for the secret, must be unique in your schema. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

Database string: The database in which to create the secret Due to technical limitations (read more here), avoid using the following characters: |, ., ".
Password string
Schema string: The schema in which to create the secret. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
Username string: Specifies the username value to store in the secret.
Comment string: Specifies a comment for the secret.
Name string: String that specifies the identifier (i.e. name) for the secret, must be unique in your schema. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

database String: The database in which to create the secret Due to technical limitations (read more here), avoid using the following characters: |, ., ".
password String
schema String: The schema in which to create the secret. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
username String: Specifies the username value to store in the secret.
comment String: Specifies a comment for the secret.
name String: String that specifies the identifier (i.e. name) for the secret, must be unique in your schema. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

database string: The database in which to create the secret Due to technical limitations (read more here), avoid using the following characters: |, ., ".
password string
schema string: The schema in which to create the secret. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
username string: Specifies the username value to store in the secret.
comment string: Specifies a comment for the secret.
name string: String that specifies the identifier (i.e. name) for the secret, must be unique in your schema. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

database str: The database in which to create the secret Due to technical limitations (read more here), avoid using the following characters: |, ., ".
password str
schema str: The schema in which to create the secret. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
username str: Specifies the username value to store in the secret.
comment str: Specifies a comment for the secret.
name str: String that specifies the identifier (i.e. name) for the secret, must be unique in your schema. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

database String: The database in which to create the secret Due to technical limitations (read more here), avoid using the following characters: |, ., ".
password String
schema String: The schema in which to create the secret. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
username String: Specifies the username value to store in the secret.
comment String: Specifies a comment for the secret.
name String: String that specifies the identifier (i.e. name) for the secret, must be unique in your schema. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

Outputs

All input properties are implicitly available as output properties. Additionally, the SecretWithBasicAuthentication resource produces the following output properties:

DescribeOutputs List<SecretWithBasicAuthenticationDescribeOutput>: Outputs the result of DESCRIBE SECRET for the given secret.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
Id string: The provider-assigned unique ID for this managed resource.
SecretType string: Specifies a type for the secret. This field is used for checking external changes and recreating the resources if needed.
ShowOutputs List<SecretWithBasicAuthenticationShowOutput>: Outputs the result of SHOW SECRETS for the given secret.

DescribeOutputs []SecretWithBasicAuthenticationDescribeOutput: Outputs the result of DESCRIBE SECRET for the given secret.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
Id string: The provider-assigned unique ID for this managed resource.
SecretType string: Specifies a type for the secret. This field is used for checking external changes and recreating the resources if needed.
ShowOutputs []SecretWithBasicAuthenticationShowOutput: Outputs the result of SHOW SECRETS for the given secret.

describeOutputs List<SecretWithBasicAuthenticationDescribeOutput>: Outputs the result of DESCRIBE SECRET for the given secret.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
id String: The provider-assigned unique ID for this managed resource.
secretType String: Specifies a type for the secret. This field is used for checking external changes and recreating the resources if needed.
showOutputs List<SecretWithBasicAuthenticationShowOutput>: Outputs the result of SHOW SECRETS for the given secret.

describeOutputs SecretWithBasicAuthenticationDescribeOutput[]: Outputs the result of DESCRIBE SECRET for the given secret.
fullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
id string: The provider-assigned unique ID for this managed resource.
secretType string: Specifies a type for the secret. This field is used for checking external changes and recreating the resources if needed.
showOutputs SecretWithBasicAuthenticationShowOutput[]: Outputs the result of SHOW SECRETS for the given secret.

describe_outputs Sequence[SecretWithBasicAuthenticationDescribeOutput]: Outputs the result of DESCRIBE SECRET for the given secret.
fully_qualified_name str: Fully qualified name of the resource. For more information, see object name resolution.
id str: The provider-assigned unique ID for this managed resource.
secret_type str: Specifies a type for the secret. This field is used for checking external changes and recreating the resources if needed.
show_outputs Sequence[SecretWithBasicAuthenticationShowOutput]: Outputs the result of SHOW SECRETS for the given secret.

describeOutputs List<Property Map>: Outputs the result of DESCRIBE SECRET for the given secret.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
id String: The provider-assigned unique ID for this managed resource.
secretType String: Specifies a type for the secret. This field is used for checking external changes and recreating the resources if needed.
showOutputs List<Property Map>: Outputs the result of SHOW SECRETS for the given secret.

Look up Existing SecretWithBasicAuthentication Resource

Get an existing SecretWithBasicAuthentication resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SecretWithBasicAuthenticationState, opts?: CustomResourceOptions): SecretWithBasicAuthentication

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        database: Optional[str] = None,
        describe_outputs: Optional[Sequence[SecretWithBasicAuthenticationDescribeOutputArgs]] = None,
        fully_qualified_name: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        schema: Optional[str] = None,
        secret_type: Optional[str] = None,
        show_outputs: Optional[Sequence[SecretWithBasicAuthenticationShowOutputArgs]] = None,
        username: Optional[str] = None) -> SecretWithBasicAuthentication

func GetSecretWithBasicAuthentication(ctx *Context, name string, id IDInput, state *SecretWithBasicAuthenticationState, opts ...ResourceOption) (*SecretWithBasicAuthentication, error)

public static SecretWithBasicAuthentication Get(string name, Input<string> id, SecretWithBasicAuthenticationState? state, CustomResourceOptions? opts = null)

public static SecretWithBasicAuthentication get(String name, Output<String> id, SecretWithBasicAuthenticationState state, CustomResourceOptions options)

resources:  _:    type: snowflake:SecretWithBasicAuthentication    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Comment string: Specifies a comment for the secret.
Database string: The database in which to create the secret Due to technical limitations (read more here), avoid using the following characters: |, ., ".
DescribeOutputs List<SecretWithBasicAuthenticationDescribeOutput>: Outputs the result of DESCRIBE SECRET for the given secret.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
Name string: String that specifies the identifier (i.e. name) for the secret, must be unique in your schema. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
Password string
Schema string: The schema in which to create the secret. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
SecretType string: Specifies a type for the secret. This field is used for checking external changes and recreating the resources if needed.
ShowOutputs List<SecretWithBasicAuthenticationShowOutput>: Outputs the result of SHOW SECRETS for the given secret.
Username string: Specifies the username value to store in the secret.

Comment string: Specifies a comment for the secret.
Database string: The database in which to create the secret Due to technical limitations (read more here), avoid using the following characters: |, ., ".
DescribeOutputs []SecretWithBasicAuthenticationDescribeOutputArgs: Outputs the result of DESCRIBE SECRET for the given secret.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
Name string: String that specifies the identifier (i.e. name) for the secret, must be unique in your schema. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
Password string
Schema string: The schema in which to create the secret. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
SecretType string: Specifies a type for the secret. This field is used for checking external changes and recreating the resources if needed.
ShowOutputs []SecretWithBasicAuthenticationShowOutputArgs: Outputs the result of SHOW SECRETS for the given secret.
Username string: Specifies the username value to store in the secret.

comment String: Specifies a comment for the secret.
database String: The database in which to create the secret Due to technical limitations (read more here), avoid using the following characters: |, ., ".
describeOutputs List<SecretWithBasicAuthenticationDescribeOutput>: Outputs the result of DESCRIBE SECRET for the given secret.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
name String: String that specifies the identifier (i.e. name) for the secret, must be unique in your schema. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
password String
schema String: The schema in which to create the secret. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
secretType String: Specifies a type for the secret. This field is used for checking external changes and recreating the resources if needed.
showOutputs List<SecretWithBasicAuthenticationShowOutput>: Outputs the result of SHOW SECRETS for the given secret.
username String: Specifies the username value to store in the secret.

comment string: Specifies a comment for the secret.
database string: The database in which to create the secret Due to technical limitations (read more here), avoid using the following characters: |, ., ".
describeOutputs SecretWithBasicAuthenticationDescribeOutput[]: Outputs the result of DESCRIBE SECRET for the given secret.
fullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
name string: String that specifies the identifier (i.e. name) for the secret, must be unique in your schema. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
password string
schema string: The schema in which to create the secret. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
secretType string: Specifies a type for the secret. This field is used for checking external changes and recreating the resources if needed.
showOutputs SecretWithBasicAuthenticationShowOutput[]: Outputs the result of SHOW SECRETS for the given secret.
username string: Specifies the username value to store in the secret.

comment str: Specifies a comment for the secret.
database str: The database in which to create the secret Due to technical limitations (read more here), avoid using the following characters: |, ., ".
describe_outputs Sequence[SecretWithBasicAuthenticationDescribeOutputArgs]: Outputs the result of DESCRIBE SECRET for the given secret.
fully_qualified_name str: Fully qualified name of the resource. For more information, see object name resolution.
name str: String that specifies the identifier (i.e. name) for the secret, must be unique in your schema. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
password str
schema str: The schema in which to create the secret. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
secret_type str: Specifies a type for the secret. This field is used for checking external changes and recreating the resources if needed.
show_outputs Sequence[SecretWithBasicAuthenticationShowOutputArgs]: Outputs the result of SHOW SECRETS for the given secret.
username str: Specifies the username value to store in the secret.

comment String: Specifies a comment for the secret.
database String: The database in which to create the secret Due to technical limitations (read more here), avoid using the following characters: |, ., ".
describeOutputs List<Property Map>: Outputs the result of DESCRIBE SECRET for the given secret.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
name String: String that specifies the identifier (i.e. name) for the secret, must be unique in your schema. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
password String
schema String: The schema in which to create the secret. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
secretType String: Specifies a type for the secret. This field is used for checking external changes and recreating the resources if needed.
showOutputs List<Property Map>: Outputs the result of SHOW SECRETS for the given secret.
username String: Specifies the username value to store in the secret.