Snowflake v0.61.1, Nov 14 24

Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi

snowflake.SecretWithAuthorizationCodeGrant

Explore with Pulumi AI

Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi

Import

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

Create SecretWithAuthorizationCodeGrant Resource

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

Constructor syntax

new SecretWithAuthorizationCodeGrant(name: string, args: SecretWithAuthorizationCodeGrantArgs, opts?: CustomResourceOptions);

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

@overload
def SecretWithAuthorizationCodeGrant(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     api_authentication: Optional[str] = None,
                                     database: Optional[str] = None,
                                     oauth_refresh_token: Optional[str] = None,
                                     oauth_refresh_token_expiry_time: Optional[str] = None,
                                     schema: Optional[str] = None,
                                     comment: Optional[str] = None,
                                     name: Optional[str] = None)

func NewSecretWithAuthorizationCodeGrant(ctx *Context, name string, args SecretWithAuthorizationCodeGrantArgs, opts ...ResourceOption) (*SecretWithAuthorizationCodeGrant, error)

public SecretWithAuthorizationCodeGrant(string name, SecretWithAuthorizationCodeGrantArgs args, CustomResourceOptions? opts = null)

public SecretWithAuthorizationCodeGrant(String name, SecretWithAuthorizationCodeGrantArgs args)
public SecretWithAuthorizationCodeGrant(String name, SecretWithAuthorizationCodeGrantArgs args, CustomResourceOptions options)

type: snowflake:SecretWithAuthorizationCodeGrant
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 SecretWithAuthorizationCodeGrantArgs: 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 SecretWithAuthorizationCodeGrantArgs: 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 SecretWithAuthorizationCodeGrantArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args SecretWithAuthorizationCodeGrantArgs: 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 secretWithAuthorizationCodeGrantResource = new Snowflake.SecretWithAuthorizationCodeGrant("secretWithAuthorizationCodeGrantResource", new()
{
    ApiAuthentication = "string",
    Database = "string",
    OauthRefreshToken = "string",
    OauthRefreshTokenExpiryTime = "string",
    Schema = "string",
    Comment = "string",
    Name = "string",
});

example, err := snowflake.NewSecretWithAuthorizationCodeGrant(ctx, "secretWithAuthorizationCodeGrantResource", &snowflake.SecretWithAuthorizationCodeGrantArgs{
	ApiAuthentication:           pulumi.String("string"),
	Database:                    pulumi.String("string"),
	OauthRefreshToken:           pulumi.String("string"),
	OauthRefreshTokenExpiryTime: pulumi.String("string"),
	Schema:                      pulumi.String("string"),
	Comment:                     pulumi.String("string"),
	Name:                        pulumi.String("string"),
})

var secretWithAuthorizationCodeGrantResource = new SecretWithAuthorizationCodeGrant("secretWithAuthorizationCodeGrantResource", SecretWithAuthorizationCodeGrantArgs.builder()
    .apiAuthentication("string")
    .database("string")
    .oauthRefreshToken("string")
    .oauthRefreshTokenExpiryTime("string")
    .schema("string")
    .comment("string")
    .name("string")
    .build());

secret_with_authorization_code_grant_resource = snowflake.SecretWithAuthorizationCodeGrant("secretWithAuthorizationCodeGrantResource",
    api_authentication="string",
    database="string",
    oauth_refresh_token="string",
    oauth_refresh_token_expiry_time="string",
    schema="string",
    comment="string",
    name="string")

const secretWithAuthorizationCodeGrantResource = new snowflake.SecretWithAuthorizationCodeGrant("secretWithAuthorizationCodeGrantResource", {
    apiAuthentication: "string",
    database: "string",
    oauthRefreshToken: "string",
    oauthRefreshTokenExpiryTime: "string",
    schema: "string",
    comment: "string",
    name: "string",
});

type: snowflake:SecretWithAuthorizationCodeGrant
properties:
    apiAuthentication: string
    comment: string
    database: string
    name: string
    oauthRefreshToken: string
    oauthRefreshTokenExpiryTime: string
    schema: string

SecretWithAuthorizationCodeGrant 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 SecretWithAuthorizationCodeGrant resource accepts the following input properties:

ApiAuthentication string: Specifies the name value of the Snowflake security integration that connects Snowflake to an external service.
Database string: The database in which to create the secret Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
OauthRefreshToken string
OauthRefreshTokenExpiryTime string: Specifies the timestamp as a string when the OAuth refresh token expires. Accepted string formats: YYYY-MM-DD, YYYY-MM-DD HH:MI, YYYY-MM-DD HH:MI:SS, YYYY-MM-DD HH:MI \n\n
Schema string: The schema in which to create the secret. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
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: |, ., (, ), "

ApiAuthentication string: Specifies the name value of the Snowflake security integration that connects Snowflake to an external service.
Database string: The database in which to create the secret Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
OauthRefreshToken string
OauthRefreshTokenExpiryTime string: Specifies the timestamp as a string when the OAuth refresh token expires. Accepted string formats: YYYY-MM-DD, YYYY-MM-DD HH:MI, YYYY-MM-DD HH:MI:SS, YYYY-MM-DD HH:MI \n\n
Schema string: The schema in which to create the secret. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
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: |, ., (, ), "

apiAuthentication String: Specifies the name value of the Snowflake security integration that connects Snowflake to an external service.
database String: The database in which to create the secret Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
oauthRefreshToken String
oauthRefreshTokenExpiryTime String: Specifies the timestamp as a string when the OAuth refresh token expires. Accepted string formats: YYYY-MM-DD, YYYY-MM-DD HH:MI, YYYY-MM-DD HH:MI:SS, YYYY-MM-DD HH:MI \n\n
schema String: The schema in which to create the secret. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
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: |, ., (, ), "

apiAuthentication string: Specifies the name value of the Snowflake security integration that connects Snowflake to an external service.
database string: The database in which to create the secret Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
oauthRefreshToken string
oauthRefreshTokenExpiryTime string: Specifies the timestamp as a string when the OAuth refresh token expires. Accepted string formats: YYYY-MM-DD, YYYY-MM-DD HH:MI, YYYY-MM-DD HH:MI:SS, YYYY-MM-DD HH:MI \n\n
schema string: The schema in which to create the secret. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
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: |, ., (, ), "

api_authentication str: Specifies the name value of the Snowflake security integration that connects Snowflake to an external service.
database str: The database in which to create the secret Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
oauth_refresh_token str
oauth_refresh_token_expiry_time str: Specifies the timestamp as a string when the OAuth refresh token expires. Accepted string formats: YYYY-MM-DD, YYYY-MM-DD HH:MI, YYYY-MM-DD HH:MI:SS, YYYY-MM-DD HH:MI \n\n
schema str: The schema in which to create the secret. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
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: |, ., (, ), "

apiAuthentication String: Specifies the name value of the Snowflake security integration that connects Snowflake to an external service.
database String: The database in which to create the secret Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
oauthRefreshToken String
oauthRefreshTokenExpiryTime String: Specifies the timestamp as a string when the OAuth refresh token expires. Accepted string formats: YYYY-MM-DD, YYYY-MM-DD HH:MI, YYYY-MM-DD HH:MI:SS, YYYY-MM-DD HH:MI \n\n
schema String: The schema in which to create the secret. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
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 SecretWithAuthorizationCodeGrant resource produces the following output properties:

DescribeOutputs List<SecretWithAuthorizationCodeGrantDescribeOutput>: 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<SecretWithAuthorizationCodeGrantShowOutput>: Outputs the result of SHOW SECRETS for the given secret.

DescribeOutputs []SecretWithAuthorizationCodeGrantDescribeOutput: 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 []SecretWithAuthorizationCodeGrantShowOutput: Outputs the result of SHOW SECRETS for the given secret.

describeOutputs List<SecretWithAuthorizationCodeGrantDescribeOutput>: 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<SecretWithAuthorizationCodeGrantShowOutput>: Outputs the result of SHOW SECRETS for the given secret.

describeOutputs SecretWithAuthorizationCodeGrantDescribeOutput[]: 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 SecretWithAuthorizationCodeGrantShowOutput[]: Outputs the result of SHOW SECRETS for the given secret.

describe_outputs Sequence[SecretWithAuthorizationCodeGrantDescribeOutput]: 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[SecretWithAuthorizationCodeGrantShowOutput]: 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 SecretWithAuthorizationCodeGrant Resource

Get an existing SecretWithAuthorizationCodeGrant 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?: SecretWithAuthorizationCodeGrantState, opts?: CustomResourceOptions): SecretWithAuthorizationCodeGrant

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_authentication: Optional[str] = None,
        comment: Optional[str] = None,
        database: Optional[str] = None,
        describe_outputs: Optional[Sequence[SecretWithAuthorizationCodeGrantDescribeOutputArgs]] = None,
        fully_qualified_name: Optional[str] = None,
        name: Optional[str] = None,
        oauth_refresh_token: Optional[str] = None,
        oauth_refresh_token_expiry_time: Optional[str] = None,
        schema: Optional[str] = None,
        secret_type: Optional[str] = None,
        show_outputs: Optional[Sequence[SecretWithAuthorizationCodeGrantShowOutputArgs]] = None) -> SecretWithAuthorizationCodeGrant

func GetSecretWithAuthorizationCodeGrant(ctx *Context, name string, id IDInput, state *SecretWithAuthorizationCodeGrantState, opts ...ResourceOption) (*SecretWithAuthorizationCodeGrant, error)

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

public static SecretWithAuthorizationCodeGrant get(String name, Output<String> id, SecretWithAuthorizationCodeGrantState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

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:

ApiAuthentication string: Specifies the name value of the Snowflake security integration that connects Snowflake to an external service.
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<SecretWithAuthorizationCodeGrantDescribeOutput>: 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: |, ., (, ), "
OauthRefreshToken string
OauthRefreshTokenExpiryTime string: Specifies the timestamp as a string when the OAuth refresh token expires. Accepted string formats: YYYY-MM-DD, YYYY-MM-DD HH:MI, YYYY-MM-DD HH:MI:SS, YYYY-MM-DD HH:MI \n\n
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<SecretWithAuthorizationCodeGrantShowOutput>: Outputs the result of SHOW SECRETS for the given secret.

ApiAuthentication string: Specifies the name value of the Snowflake security integration that connects Snowflake to an external service.
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 []SecretWithAuthorizationCodeGrantDescribeOutputArgs: 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: |, ., (, ), "
OauthRefreshToken string
OauthRefreshTokenExpiryTime string: Specifies the timestamp as a string when the OAuth refresh token expires. Accepted string formats: YYYY-MM-DD, YYYY-MM-DD HH:MI, YYYY-MM-DD HH:MI:SS, YYYY-MM-DD HH:MI \n\n
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 []SecretWithAuthorizationCodeGrantShowOutputArgs: Outputs the result of SHOW SECRETS for the given secret.

apiAuthentication String: Specifies the name value of the Snowflake security integration that connects Snowflake to an external service.
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<SecretWithAuthorizationCodeGrantDescribeOutput>: 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: |, ., (, ), "
oauthRefreshToken String
oauthRefreshTokenExpiryTime String: Specifies the timestamp as a string when the OAuth refresh token expires. Accepted string formats: YYYY-MM-DD, YYYY-MM-DD HH:MI, YYYY-MM-DD HH:MI:SS, YYYY-MM-DD HH:MI \n\n
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<SecretWithAuthorizationCodeGrantShowOutput>: Outputs the result of SHOW SECRETS for the given secret.

apiAuthentication string: Specifies the name value of the Snowflake security integration that connects Snowflake to an external service.
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 SecretWithAuthorizationCodeGrantDescribeOutput[]: 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: |, ., (, ), "
oauthRefreshToken string
oauthRefreshTokenExpiryTime string: Specifies the timestamp as a string when the OAuth refresh token expires. Accepted string formats: YYYY-MM-DD, YYYY-MM-DD HH:MI, YYYY-MM-DD HH:MI:SS, YYYY-MM-DD HH:MI \n\n
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 SecretWithAuthorizationCodeGrantShowOutput[]: Outputs the result of SHOW SECRETS for the given secret.

api_authentication str: Specifies the name value of the Snowflake security integration that connects Snowflake to an external service.
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[SecretWithAuthorizationCodeGrantDescribeOutputArgs]: 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: |, ., (, ), "
oauth_refresh_token str
oauth_refresh_token_expiry_time str: Specifies the timestamp as a string when the OAuth refresh token expires. Accepted string formats: YYYY-MM-DD, YYYY-MM-DD HH:MI, YYYY-MM-DD HH:MI:SS, YYYY-MM-DD HH:MI \n\n
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[SecretWithAuthorizationCodeGrantShowOutputArgs]: Outputs the result of SHOW SECRETS for the given secret.

apiAuthentication String: Specifies the name value of the Snowflake security integration that connects Snowflake to an external service.
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: |, ., (, ), "
oauthRefreshToken String
oauthRefreshTokenExpiryTime String: Specifies the timestamp as a string when the OAuth refresh token expires. Accepted string formats: YYYY-MM-DD, YYYY-MM-DD HH:MI, YYYY-MM-DD HH:MI:SS, YYYY-MM-DD HH:MI \n\n
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.