Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Snowflake Provider
  3. API Docs
  4. AuthenticationPolicy
Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi
pulumi/pulumi-snowflake

snowflake.AuthenticationPolicy

Explore with Pulumi AI

snowflake logo
Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi
pulumi/pulumi-snowflake

    Import

    $ pulumi import snowflake:index/authenticationPolicy:AuthenticationPolicy example '"<database_name>"."<schema_name>"."<authentication_policy_name>"'

    Create AuthenticationPolicy Resource

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

    Constructor syntax

    new AuthenticationPolicy(name: string, args: AuthenticationPolicyArgs, opts?: CustomResourceOptions);
    @overload
def AuthenticationPolicy(resource_name: str,
                         args: AuthenticationPolicyArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def AuthenticationPolicy(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         database: Optional[str] = None,
                         schema: Optional[str] = None,
                         authentication_methods: Optional[Sequence[str]] = None,
                         client_types: Optional[Sequence[str]] = None,
                         comment: Optional[str] = None,
                         mfa_authentication_methods: Optional[Sequence[str]] = None,
                         mfa_enrollment: Optional[str] = None,
                         name: Optional[str] = None,
                         security_integrations: Optional[Sequence[str]] = None)
    func NewAuthenticationPolicy(ctx *Context, name string, args AuthenticationPolicyArgs, opts ...ResourceOption) (*AuthenticationPolicy, error)
    public AuthenticationPolicy(string name, AuthenticationPolicyArgs args, CustomResourceOptions? opts = null)
    public AuthenticationPolicy(String name, AuthenticationPolicyArgs args)
public AuthenticationPolicy(String name, AuthenticationPolicyArgs args, CustomResourceOptions options)

    type: snowflake:AuthenticationPolicy
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 AuthenticationPolicyArgs
    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 AuthenticationPolicyArgs
    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 AuthenticationPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthenticationPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthenticationPolicyArgs
    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 authenticationPolicyResource = new Snowflake.AuthenticationPolicy("authenticationPolicyResource", new()
{
    Database = "string",
    Schema = "string",
    AuthenticationMethods = new[]
    {
        "string",
    },
    ClientTypes = new[]
    {
        "string",
    },
    Comment = "string",
    MfaAuthenticationMethods = new[]
    {
        "string",
    },
    MfaEnrollment = "string",
    Name = "string",
    SecurityIntegrations = new[]
    {
        "string",
    },
});

    example, err := snowflake.NewAuthenticationPolicy(ctx, "authenticationPolicyResource", &snowflake.AuthenticationPolicyArgs{
	Database: pulumi.String("string"),
	Schema:   pulumi.String("string"),
	AuthenticationMethods: pulumi.StringArray{
		pulumi.String("string"),
	},
	ClientTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Comment: pulumi.String("string"),
	MfaAuthenticationMethods: pulumi.StringArray{
		pulumi.String("string"),
	},
	MfaEnrollment: pulumi.String("string"),
	Name:          pulumi.String("string"),
	SecurityIntegrations: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var authenticationPolicyResource = new AuthenticationPolicy("authenticationPolicyResource", AuthenticationPolicyArgs.builder()
    .database("string")
    .schema("string")
    .authenticationMethods("string")
    .clientTypes("string")
    .comment("string")
    .mfaAuthenticationMethods("string")
    .mfaEnrollment("string")
    .name("string")
    .securityIntegrations("string")
    .build());

    authentication_policy_resource = snowflake.AuthenticationPolicy("authenticationPolicyResource",
    database="string",
    schema="string",
    authentication_methods=["string"],
    client_types=["string"],
    comment="string",
    mfa_authentication_methods=["string"],
    mfa_enrollment="string",
    name="string",
    security_integrations=["string"])

    const authenticationPolicyResource = new snowflake.AuthenticationPolicy("authenticationPolicyResource", {
    database: "string",
    schema: "string",
    authenticationMethods: ["string"],
    clientTypes: ["string"],
    comment: "string",
    mfaAuthenticationMethods: ["string"],
    mfaEnrollment: "string",
    name: "string",
    securityIntegrations: ["string"],
});

    type: snowflake:AuthenticationPolicy
properties:
    authenticationMethods:
        - string
    clientTypes:
        - string
    comment: string
    database: string
    mfaAuthenticationMethods:
        - string
    mfaEnrollment: string
    name: string
    schema: string
    securityIntegrations:
        - string

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

    Database string
    The database in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    Schema string
    The schema in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    AuthenticationMethods List<string>
    A list of authentication methods that are allowed during login. This parameter accepts one or more of the following values: ALL | SAML | PASSWORD | OAUTH | KEYPAIR
    ClientTypes List<string>
    A list of clients that can authenticate with Snowflake. If a client tries to connect, and the client is not one of the valid CLIENTTYPES, then the login attempt fails. Allowed values are ALL | SNOWFLAKE_UI | DRIVERS | SNOWSQL. The CLIENTTYPES property of an authentication policy is a best effort method to block user logins based on specific clients. It should not be used as the sole control to establish a security boundary.
    Comment string
    Specifies a comment for the authentication policy.
    MfaAuthenticationMethods List<string>
    A list of authentication methods that enforce multi-factor authentication (MFA) during login. Authentication methods not listed in this parameter do not prompt for multi-factor authentication. Allowed values are ALL | SAML | PASSWORD.
    MfaEnrollment string
    Determines whether a user must enroll in multi-factor authentication. Allowed values are REQUIRED and OPTIONAL. When REQUIRED is specified, Enforces users to enroll in MFA. If this value is used, then the CLIENTTYPES parameter must include SNOWFLAKEUI, because Snowsight is the only place users can enroll in multi-factor authentication (MFA).
    Name string
    Specifies the identifier for the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    SecurityIntegrations List<string>
    A list of security integrations the authentication policy is associated with. This parameter has no effect when SAML or OAUTH are not in the AUTHENTICATIONMETHODS list. All values in the SECURITYINTEGRATIONS list must be compatible with the values in the AUTHENTICATIONMETHODS list. For example, if SECURITYINTEGRATIONS contains a SAML security integration, and AUTHENTICATION_METHODS contains OAUTH, then you cannot create the authentication policy. To allow all security integrations use ALL as parameter.
    Database string
    The database in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    Schema string
    The schema in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    AuthenticationMethods []string
    A list of authentication methods that are allowed during login. This parameter accepts one or more of the following values: ALL | SAML | PASSWORD | OAUTH | KEYPAIR
    ClientTypes []string
    A list of clients that can authenticate with Snowflake. If a client tries to connect, and the client is not one of the valid CLIENTTYPES, then the login attempt fails. Allowed values are ALL | SNOWFLAKE_UI | DRIVERS | SNOWSQL. The CLIENTTYPES property of an authentication policy is a best effort method to block user logins based on specific clients. It should not be used as the sole control to establish a security boundary.
    Comment string
    Specifies a comment for the authentication policy.
    MfaAuthenticationMethods []string
    A list of authentication methods that enforce multi-factor authentication (MFA) during login. Authentication methods not listed in this parameter do not prompt for multi-factor authentication. Allowed values are ALL | SAML | PASSWORD.
    MfaEnrollment string
    Determines whether a user must enroll in multi-factor authentication. Allowed values are REQUIRED and OPTIONAL. When REQUIRED is specified, Enforces users to enroll in MFA. If this value is used, then the CLIENTTYPES parameter must include SNOWFLAKEUI, because Snowsight is the only place users can enroll in multi-factor authentication (MFA).
    Name string
    Specifies the identifier for the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    SecurityIntegrations []string
    A list of security integrations the authentication policy is associated with. This parameter has no effect when SAML or OAUTH are not in the AUTHENTICATIONMETHODS list. All values in the SECURITYINTEGRATIONS list must be compatible with the values in the AUTHENTICATIONMETHODS list. For example, if SECURITYINTEGRATIONS contains a SAML security integration, and AUTHENTICATION_METHODS contains OAUTH, then you cannot create the authentication policy. To allow all security integrations use ALL as parameter.
    database String
    The database in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    schema String
    The schema in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    authenticationMethods List<String>
    A list of authentication methods that are allowed during login. This parameter accepts one or more of the following values: ALL | SAML | PASSWORD | OAUTH | KEYPAIR
    clientTypes List<String>
    A list of clients that can authenticate with Snowflake. If a client tries to connect, and the client is not one of the valid CLIENTTYPES, then the login attempt fails. Allowed values are ALL | SNOWFLAKE_UI | DRIVERS | SNOWSQL. The CLIENTTYPES property of an authentication policy is a best effort method to block user logins based on specific clients. It should not be used as the sole control to establish a security boundary.
    comment String
    Specifies a comment for the authentication policy.
    mfaAuthenticationMethods List<String>
    A list of authentication methods that enforce multi-factor authentication (MFA) during login. Authentication methods not listed in this parameter do not prompt for multi-factor authentication. Allowed values are ALL | SAML | PASSWORD.
    mfaEnrollment String
    Determines whether a user must enroll in multi-factor authentication. Allowed values are REQUIRED and OPTIONAL. When REQUIRED is specified, Enforces users to enroll in MFA. If this value is used, then the CLIENTTYPES parameter must include SNOWFLAKEUI, because Snowsight is the only place users can enroll in multi-factor authentication (MFA).
    name String
    Specifies the identifier for the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    securityIntegrations List<String>
    A list of security integrations the authentication policy is associated with. This parameter has no effect when SAML or OAUTH are not in the AUTHENTICATIONMETHODS list. All values in the SECURITYINTEGRATIONS list must be compatible with the values in the AUTHENTICATIONMETHODS list. For example, if SECURITYINTEGRATIONS contains a SAML security integration, and AUTHENTICATION_METHODS contains OAUTH, then you cannot create the authentication policy. To allow all security integrations use ALL as parameter.
    database string
    The database in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    schema string
    The schema in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    authenticationMethods string[]
    A list of authentication methods that are allowed during login. This parameter accepts one or more of the following values: ALL | SAML | PASSWORD | OAUTH | KEYPAIR
    clientTypes string[]
    A list of clients that can authenticate with Snowflake. If a client tries to connect, and the client is not one of the valid CLIENTTYPES, then the login attempt fails. Allowed values are ALL | SNOWFLAKE_UI | DRIVERS | SNOWSQL. The CLIENTTYPES property of an authentication policy is a best effort method to block user logins based on specific clients. It should not be used as the sole control to establish a security boundary.
    comment string
    Specifies a comment for the authentication policy.
    mfaAuthenticationMethods string[]
    A list of authentication methods that enforce multi-factor authentication (MFA) during login. Authentication methods not listed in this parameter do not prompt for multi-factor authentication. Allowed values are ALL | SAML | PASSWORD.
    mfaEnrollment string
    Determines whether a user must enroll in multi-factor authentication. Allowed values are REQUIRED and OPTIONAL. When REQUIRED is specified, Enforces users to enroll in MFA. If this value is used, then the CLIENTTYPES parameter must include SNOWFLAKEUI, because Snowsight is the only place users can enroll in multi-factor authentication (MFA).
    name string
    Specifies the identifier for the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    securityIntegrations string[]
    A list of security integrations the authentication policy is associated with. This parameter has no effect when SAML or OAUTH are not in the AUTHENTICATIONMETHODS list. All values in the SECURITYINTEGRATIONS list must be compatible with the values in the AUTHENTICATIONMETHODS list. For example, if SECURITYINTEGRATIONS contains a SAML security integration, and AUTHENTICATION_METHODS contains OAUTH, then you cannot create the authentication policy. To allow all security integrations use ALL as parameter.
    database str
    The database in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    schema str
    The schema in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    authentication_methods Sequence[str]
    A list of authentication methods that are allowed during login. This parameter accepts one or more of the following values: ALL | SAML | PASSWORD | OAUTH | KEYPAIR
    client_types Sequence[str]
    A list of clients that can authenticate with Snowflake. If a client tries to connect, and the client is not one of the valid CLIENTTYPES, then the login attempt fails. Allowed values are ALL | SNOWFLAKE_UI | DRIVERS | SNOWSQL. The CLIENTTYPES property of an authentication policy is a best effort method to block user logins based on specific clients. It should not be used as the sole control to establish a security boundary.
    comment str
    Specifies a comment for the authentication policy.
    mfa_authentication_methods Sequence[str]
    A list of authentication methods that enforce multi-factor authentication (MFA) during login. Authentication methods not listed in this parameter do not prompt for multi-factor authentication. Allowed values are ALL | SAML | PASSWORD.
    mfa_enrollment str
    Determines whether a user must enroll in multi-factor authentication. Allowed values are REQUIRED and OPTIONAL. When REQUIRED is specified, Enforces users to enroll in MFA. If this value is used, then the CLIENTTYPES parameter must include SNOWFLAKEUI, because Snowsight is the only place users can enroll in multi-factor authentication (MFA).
    name str
    Specifies the identifier for the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    security_integrations Sequence[str]
    A list of security integrations the authentication policy is associated with. This parameter has no effect when SAML or OAUTH are not in the AUTHENTICATIONMETHODS list. All values in the SECURITYINTEGRATIONS list must be compatible with the values in the AUTHENTICATIONMETHODS list. For example, if SECURITYINTEGRATIONS contains a SAML security integration, and AUTHENTICATION_METHODS contains OAUTH, then you cannot create the authentication policy. To allow all security integrations use ALL as parameter.
    database String
    The database in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    schema String
    The schema in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    authenticationMethods List<String>
    A list of authentication methods that are allowed during login. This parameter accepts one or more of the following values: ALL | SAML | PASSWORD | OAUTH | KEYPAIR
    clientTypes List<String>
    A list of clients that can authenticate with Snowflake. If a client tries to connect, and the client is not one of the valid CLIENTTYPES, then the login attempt fails. Allowed values are ALL | SNOWFLAKE_UI | DRIVERS | SNOWSQL. The CLIENTTYPES property of an authentication policy is a best effort method to block user logins based on specific clients. It should not be used as the sole control to establish a security boundary.
    comment String
    Specifies a comment for the authentication policy.
    mfaAuthenticationMethods List<String>
    A list of authentication methods that enforce multi-factor authentication (MFA) during login. Authentication methods not listed in this parameter do not prompt for multi-factor authentication. Allowed values are ALL | SAML | PASSWORD.
    mfaEnrollment String
    Determines whether a user must enroll in multi-factor authentication. Allowed values are REQUIRED and OPTIONAL. When REQUIRED is specified, Enforces users to enroll in MFA. If this value is used, then the CLIENTTYPES parameter must include SNOWFLAKEUI, because Snowsight is the only place users can enroll in multi-factor authentication (MFA).
    name String
    Specifies the identifier for the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    securityIntegrations List<String>
    A list of security integrations the authentication policy is associated with. This parameter has no effect when SAML or OAUTH are not in the AUTHENTICATIONMETHODS list. All values in the SECURITYINTEGRATIONS list must be compatible with the values in the AUTHENTICATIONMETHODS list. For example, if SECURITYINTEGRATIONS contains a SAML security integration, and AUTHENTICATION_METHODS contains OAUTH, then you cannot create the authentication policy. To allow all security integrations use ALL as parameter.

    Outputs

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

    DescribeOutputs List<AuthenticationPolicyDescribeOutput>
    Outputs the result of DESCRIBE AUTHENTICATION POLICY for the given policy.
    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.
    ShowOutputs List<AuthenticationPolicyShowOutput>
    Outputs the result of SHOW AUTHENTICATION POLICIES for the given policy.
    DescribeOutputs []AuthenticationPolicyDescribeOutput
    Outputs the result of DESCRIBE AUTHENTICATION POLICY for the given policy.
    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.
    ShowOutputs []AuthenticationPolicyShowOutput
    Outputs the result of SHOW AUTHENTICATION POLICIES for the given policy.
    describeOutputs List<AuthenticationPolicyDescribeOutput>
    Outputs the result of DESCRIBE AUTHENTICATION POLICY for the given policy.
    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.
    showOutputs List<AuthenticationPolicyShowOutput>
    Outputs the result of SHOW AUTHENTICATION POLICIES for the given policy.
    describeOutputs AuthenticationPolicyDescribeOutput[]
    Outputs the result of DESCRIBE AUTHENTICATION POLICY for the given policy.
    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.
    showOutputs AuthenticationPolicyShowOutput[]
    Outputs the result of SHOW AUTHENTICATION POLICIES for the given policy.
    describe_outputs Sequence[AuthenticationPolicyDescribeOutput]
    Outputs the result of DESCRIBE AUTHENTICATION POLICY for the given policy.
    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.
    show_outputs Sequence[AuthenticationPolicyShowOutput]
    Outputs the result of SHOW AUTHENTICATION POLICIES for the given policy.
    describeOutputs List<Property Map>
    Outputs the result of DESCRIBE AUTHENTICATION POLICY for the given policy.
    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.
    showOutputs List<Property Map>
    Outputs the result of SHOW AUTHENTICATION POLICIES for the given policy.

    Look up Existing AuthenticationPolicy Resource

    Get an existing AuthenticationPolicy 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?: AuthenticationPolicyState, opts?: CustomResourceOptions): AuthenticationPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authentication_methods: Optional[Sequence[str]] = None,
        client_types: Optional[Sequence[str]] = None,
        comment: Optional[str] = None,
        database: Optional[str] = None,
        describe_outputs: Optional[Sequence[AuthenticationPolicyDescribeOutputArgs]] = None,
        fully_qualified_name: Optional[str] = None,
        mfa_authentication_methods: Optional[Sequence[str]] = None,
        mfa_enrollment: Optional[str] = None,
        name: Optional[str] = None,
        schema: Optional[str] = None,
        security_integrations: Optional[Sequence[str]] = None,
        show_outputs: Optional[Sequence[AuthenticationPolicyShowOutputArgs]] = None) -> AuthenticationPolicy
    func GetAuthenticationPolicy(ctx *Context, name string, id IDInput, state *AuthenticationPolicyState, opts ...ResourceOption) (*AuthenticationPolicy, error)
    public static AuthenticationPolicy Get(string name, Input<string> id, AuthenticationPolicyState? state, CustomResourceOptions? opts = null)
    public static AuthenticationPolicy get(String name, Output<String> id, AuthenticationPolicyState 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:
    AuthenticationMethods List<string>
    A list of authentication methods that are allowed during login. This parameter accepts one or more of the following values: ALL | SAML | PASSWORD | OAUTH | KEYPAIR
    ClientTypes List<string>
    A list of clients that can authenticate with Snowflake. If a client tries to connect, and the client is not one of the valid CLIENTTYPES, then the login attempt fails. Allowed values are ALL | SNOWFLAKE_UI | DRIVERS | SNOWSQL. The CLIENTTYPES property of an authentication policy is a best effort method to block user logins based on specific clients. It should not be used as the sole control to establish a security boundary.
    Comment string
    Specifies a comment for the authentication policy.
    Database string
    The database in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    DescribeOutputs List<AuthenticationPolicyDescribeOutput>
    Outputs the result of DESCRIBE AUTHENTICATION POLICY for the given policy.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    MfaAuthenticationMethods List<string>
    A list of authentication methods that enforce multi-factor authentication (MFA) during login. Authentication methods not listed in this parameter do not prompt for multi-factor authentication. Allowed values are ALL | SAML | PASSWORD.
    MfaEnrollment string
    Determines whether a user must enroll in multi-factor authentication. Allowed values are REQUIRED and OPTIONAL. When REQUIRED is specified, Enforces users to enroll in MFA. If this value is used, then the CLIENTTYPES parameter must include SNOWFLAKEUI, because Snowsight is the only place users can enroll in multi-factor authentication (MFA).
    Name string
    Specifies the identifier for the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    Schema string
    The schema in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    SecurityIntegrations List<string>
    A list of security integrations the authentication policy is associated with. This parameter has no effect when SAML or OAUTH are not in the AUTHENTICATIONMETHODS list. All values in the SECURITYINTEGRATIONS list must be compatible with the values in the AUTHENTICATIONMETHODS list. For example, if SECURITYINTEGRATIONS contains a SAML security integration, and AUTHENTICATION_METHODS contains OAUTH, then you cannot create the authentication policy. To allow all security integrations use ALL as parameter.
    ShowOutputs List<AuthenticationPolicyShowOutput>
    Outputs the result of SHOW AUTHENTICATION POLICIES for the given policy.
    AuthenticationMethods []string
    A list of authentication methods that are allowed during login. This parameter accepts one or more of the following values: ALL | SAML | PASSWORD | OAUTH | KEYPAIR
    ClientTypes []string
    A list of clients that can authenticate with Snowflake. If a client tries to connect, and the client is not one of the valid CLIENTTYPES, then the login attempt fails. Allowed values are ALL | SNOWFLAKE_UI | DRIVERS | SNOWSQL. The CLIENTTYPES property of an authentication policy is a best effort method to block user logins based on specific clients. It should not be used as the sole control to establish a security boundary.
    Comment string
    Specifies a comment for the authentication policy.
    Database string
    The database in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    DescribeOutputs []AuthenticationPolicyDescribeOutputArgs
    Outputs the result of DESCRIBE AUTHENTICATION POLICY for the given policy.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    MfaAuthenticationMethods []string
    A list of authentication methods that enforce multi-factor authentication (MFA) during login. Authentication methods not listed in this parameter do not prompt for multi-factor authentication. Allowed values are ALL | SAML | PASSWORD.
    MfaEnrollment string
    Determines whether a user must enroll in multi-factor authentication. Allowed values are REQUIRED and OPTIONAL. When REQUIRED is specified, Enforces users to enroll in MFA. If this value is used, then the CLIENTTYPES parameter must include SNOWFLAKEUI, because Snowsight is the only place users can enroll in multi-factor authentication (MFA).
    Name string
    Specifies the identifier for the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    Schema string
    The schema in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    SecurityIntegrations []string
    A list of security integrations the authentication policy is associated with. This parameter has no effect when SAML or OAUTH are not in the AUTHENTICATIONMETHODS list. All values in the SECURITYINTEGRATIONS list must be compatible with the values in the AUTHENTICATIONMETHODS list. For example, if SECURITYINTEGRATIONS contains a SAML security integration, and AUTHENTICATION_METHODS contains OAUTH, then you cannot create the authentication policy. To allow all security integrations use ALL as parameter.
    ShowOutputs []AuthenticationPolicyShowOutputArgs
    Outputs the result of SHOW AUTHENTICATION POLICIES for the given policy.
    authenticationMethods List<String>
    A list of authentication methods that are allowed during login. This parameter accepts one or more of the following values: ALL | SAML | PASSWORD | OAUTH | KEYPAIR
    clientTypes List<String>
    A list of clients that can authenticate with Snowflake. If a client tries to connect, and the client is not one of the valid CLIENTTYPES, then the login attempt fails. Allowed values are ALL | SNOWFLAKE_UI | DRIVERS | SNOWSQL. The CLIENTTYPES property of an authentication policy is a best effort method to block user logins based on specific clients. It should not be used as the sole control to establish a security boundary.
    comment String
    Specifies a comment for the authentication policy.
    database String
    The database in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    describeOutputs List<AuthenticationPolicyDescribeOutput>
    Outputs the result of DESCRIBE AUTHENTICATION POLICY for the given policy.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    mfaAuthenticationMethods List<String>
    A list of authentication methods that enforce multi-factor authentication (MFA) during login. Authentication methods not listed in this parameter do not prompt for multi-factor authentication. Allowed values are ALL | SAML | PASSWORD.
    mfaEnrollment String
    Determines whether a user must enroll in multi-factor authentication. Allowed values are REQUIRED and OPTIONAL. When REQUIRED is specified, Enforces users to enroll in MFA. If this value is used, then the CLIENTTYPES parameter must include SNOWFLAKEUI, because Snowsight is the only place users can enroll in multi-factor authentication (MFA).
    name String
    Specifies the identifier for the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    schema String
    The schema in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    securityIntegrations List<String>
    A list of security integrations the authentication policy is associated with. This parameter has no effect when SAML or OAUTH are not in the AUTHENTICATIONMETHODS list. All values in the SECURITYINTEGRATIONS list must be compatible with the values in the AUTHENTICATIONMETHODS list. For example, if SECURITYINTEGRATIONS contains a SAML security integration, and AUTHENTICATION_METHODS contains OAUTH, then you cannot create the authentication policy. To allow all security integrations use ALL as parameter.
    showOutputs List<AuthenticationPolicyShowOutput>
    Outputs the result of SHOW AUTHENTICATION POLICIES for the given policy.
    authenticationMethods string[]
    A list of authentication methods that are allowed during login. This parameter accepts one or more of the following values: ALL | SAML | PASSWORD | OAUTH | KEYPAIR
    clientTypes string[]
    A list of clients that can authenticate with Snowflake. If a client tries to connect, and the client is not one of the valid CLIENTTYPES, then the login attempt fails. Allowed values are ALL | SNOWFLAKE_UI | DRIVERS | SNOWSQL. The CLIENTTYPES property of an authentication policy is a best effort method to block user logins based on specific clients. It should not be used as the sole control to establish a security boundary.
    comment string
    Specifies a comment for the authentication policy.
    database string
    The database in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    describeOutputs AuthenticationPolicyDescribeOutput[]
    Outputs the result of DESCRIBE AUTHENTICATION POLICY for the given policy.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    mfaAuthenticationMethods string[]
    A list of authentication methods that enforce multi-factor authentication (MFA) during login. Authentication methods not listed in this parameter do not prompt for multi-factor authentication. Allowed values are ALL | SAML | PASSWORD.
    mfaEnrollment string
    Determines whether a user must enroll in multi-factor authentication. Allowed values are REQUIRED and OPTIONAL. When REQUIRED is specified, Enforces users to enroll in MFA. If this value is used, then the CLIENTTYPES parameter must include SNOWFLAKEUI, because Snowsight is the only place users can enroll in multi-factor authentication (MFA).
    name string
    Specifies the identifier for the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    schema string
    The schema in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    securityIntegrations string[]
    A list of security integrations the authentication policy is associated with. This parameter has no effect when SAML or OAUTH are not in the AUTHENTICATIONMETHODS list. All values in the SECURITYINTEGRATIONS list must be compatible with the values in the AUTHENTICATIONMETHODS list. For example, if SECURITYINTEGRATIONS contains a SAML security integration, and AUTHENTICATION_METHODS contains OAUTH, then you cannot create the authentication policy. To allow all security integrations use ALL as parameter.
    showOutputs AuthenticationPolicyShowOutput[]
    Outputs the result of SHOW AUTHENTICATION POLICIES for the given policy.
    authentication_methods Sequence[str]
    A list of authentication methods that are allowed during login. This parameter accepts one or more of the following values: ALL | SAML | PASSWORD | OAUTH | KEYPAIR
    client_types Sequence[str]
    A list of clients that can authenticate with Snowflake. If a client tries to connect, and the client is not one of the valid CLIENTTYPES, then the login attempt fails. Allowed values are ALL | SNOWFLAKE_UI | DRIVERS | SNOWSQL. The CLIENTTYPES property of an authentication policy is a best effort method to block user logins based on specific clients. It should not be used as the sole control to establish a security boundary.
    comment str
    Specifies a comment for the authentication policy.
    database str
    The database in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    describe_outputs Sequence[AuthenticationPolicyDescribeOutputArgs]
    Outputs the result of DESCRIBE AUTHENTICATION POLICY for the given policy.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    mfa_authentication_methods Sequence[str]
    A list of authentication methods that enforce multi-factor authentication (MFA) during login. Authentication methods not listed in this parameter do not prompt for multi-factor authentication. Allowed values are ALL | SAML | PASSWORD.
    mfa_enrollment str
    Determines whether a user must enroll in multi-factor authentication. Allowed values are REQUIRED and OPTIONAL. When REQUIRED is specified, Enforces users to enroll in MFA. If this value is used, then the CLIENTTYPES parameter must include SNOWFLAKEUI, because Snowsight is the only place users can enroll in multi-factor authentication (MFA).
    name str
    Specifies the identifier for the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    schema str
    The schema in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    security_integrations Sequence[str]
    A list of security integrations the authentication policy is associated with. This parameter has no effect when SAML or OAUTH are not in the AUTHENTICATIONMETHODS list. All values in the SECURITYINTEGRATIONS list must be compatible with the values in the AUTHENTICATIONMETHODS list. For example, if SECURITYINTEGRATIONS contains a SAML security integration, and AUTHENTICATION_METHODS contains OAUTH, then you cannot create the authentication policy. To allow all security integrations use ALL as parameter.
    show_outputs Sequence[AuthenticationPolicyShowOutputArgs]
    Outputs the result of SHOW AUTHENTICATION POLICIES for the given policy.
    authenticationMethods List<String>
    A list of authentication methods that are allowed during login. This parameter accepts one or more of the following values: ALL | SAML | PASSWORD | OAUTH | KEYPAIR
    clientTypes List<String>
    A list of clients that can authenticate with Snowflake. If a client tries to connect, and the client is not one of the valid CLIENTTYPES, then the login attempt fails. Allowed values are ALL | SNOWFLAKE_UI | DRIVERS | SNOWSQL. The CLIENTTYPES property of an authentication policy is a best effort method to block user logins based on specific clients. It should not be used as the sole control to establish a security boundary.
    comment String
    Specifies a comment for the authentication policy.
    database String
    The database in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    describeOutputs List<Property Map>
    Outputs the result of DESCRIBE AUTHENTICATION POLICY for the given policy.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    mfaAuthenticationMethods List<String>
    A list of authentication methods that enforce multi-factor authentication (MFA) during login. Authentication methods not listed in this parameter do not prompt for multi-factor authentication. Allowed values are ALL | SAML | PASSWORD.
    mfaEnrollment String
    Determines whether a user must enroll in multi-factor authentication. Allowed values are REQUIRED and OPTIONAL. When REQUIRED is specified, Enforces users to enroll in MFA. If this value is used, then the CLIENTTYPES parameter must include SNOWFLAKEUI, because Snowsight is the only place users can enroll in multi-factor authentication (MFA).
    name String
    Specifies the identifier for the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    schema String
    The schema in which to create the authentication policy. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
    securityIntegrations List<String>
    A list of security integrations the authentication policy is associated with. This parameter has no effect when SAML or OAUTH are not in the AUTHENTICATIONMETHODS list. All values in the SECURITYINTEGRATIONS list must be compatible with the values in the AUTHENTICATIONMETHODS list. For example, if SECURITYINTEGRATIONS contains a SAML security integration, and AUTHENTICATION_METHODS contains OAUTH, then you cannot create the authentication policy. To allow all security integrations use ALL as parameter.
    showOutputs List<Property Map>
    Outputs the result of SHOW AUTHENTICATION POLICIES for the given policy.

    Supporting Types

    AuthenticationPolicyDescribeOutput, AuthenticationPolicyDescribeOutputArgs

    AuthenticationPolicyShowOutput, AuthenticationPolicyShowOutputArgs

    Comment string
    CreatedOn string
    DatabaseName string
    Name string
    Options string
    Owner string
    OwnerRoleType string
    SchemaName string
    Comment string
    CreatedOn string
    DatabaseName string
    Name string
    Options string
    Owner string
    OwnerRoleType string
    SchemaName string
    comment String
    createdOn String
    databaseName String
    name String
    options String
    owner String
    ownerRoleType String
    schemaName String
    comment string
    createdOn string
    databaseName string
    name string
    options string
    owner string
    ownerRoleType string
    schemaName string
    comment String
    createdOn String
    databaseName String
    name String
    options String
    owner String
    ownerRoleType String
    schemaName String

    Package Details

    Repository
    Snowflake pulumi/pulumi-snowflake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the snowflake Terraform Provider.
    snowflake logo
    Snowflake v0.61.1 published on Thursday, Nov 14, 2024 by Pulumi
    pulumi/pulumi-snowflake