1. Packages
  2. Snowflake Provider
  3. API Docs
  4. UserAuthenticationPolicyAttachment
Viewing docs for Snowflake v2.13.0
published on Thursday, Feb 26, 2026 by Pulumi
snowflake logo
Viewing docs for Snowflake v2.13.0
published on Thursday, Feb 26, 2026 by Pulumi

    !> Caution: Preview Feature This feature is considered a preview feature in the provider, regardless of the state of the resource in Snowflake. We do not guarantee its stability. It will be reworked and marked as a stable feature in future releases. Breaking changes are expected, even without bumping the major version. To use this feature, add the relevant feature name to preview_features_enabled field in the provider configuration. Please always refer to the Getting Help section in our Github repo to best determine how to get help for your questions.

    Required warehouse For this resource, the provider now uses policy references to get information about policies attached to users. This function requires a warehouse in the connection. Please, make sure you have either set a DEFAULT_WAREHOUSE for the user, or specified a warehouse in the provider configuration.

    Specifies the authentication policy to use for a certain user.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as snowflake from "@pulumi/snowflake";
    
    const user = new snowflake.User("user", {name: "USER_NAME"});
    const ap = new snowflake.AuthenticationPolicy("ap", {
        database: "prod",
        schema: "security",
        name: "default_policy",
    });
    const apa = new snowflake.UserAuthenticationPolicyAttachment("apa", {
        authenticationPolicyName: ap.fullyQualifiedName,
        userName: user.name,
    });
    
    import pulumi
    import pulumi_snowflake as snowflake
    
    user = snowflake.User("user", name="USER_NAME")
    ap = snowflake.AuthenticationPolicy("ap",
        database="prod",
        schema="security",
        name="default_policy")
    apa = snowflake.UserAuthenticationPolicyAttachment("apa",
        authentication_policy_name=ap.fully_qualified_name,
        user_name=user.name)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-snowflake/sdk/v2/go/snowflake"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		user, err := snowflake.NewUser(ctx, "user", &snowflake.UserArgs{
    			Name: pulumi.String("USER_NAME"),
    		})
    		if err != nil {
    			return err
    		}
    		ap, err := snowflake.NewAuthenticationPolicy(ctx, "ap", &snowflake.AuthenticationPolicyArgs{
    			Database: pulumi.String("prod"),
    			Schema:   pulumi.String("security"),
    			Name:     pulumi.String("default_policy"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = snowflake.NewUserAuthenticationPolicyAttachment(ctx, "apa", &snowflake.UserAuthenticationPolicyAttachmentArgs{
    			AuthenticationPolicyName: ap.FullyQualifiedName,
    			UserName:                 user.Name,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Snowflake = Pulumi.Snowflake;
    
    return await Deployment.RunAsync(() => 
    {
        var user = new Snowflake.User("user", new()
        {
            Name = "USER_NAME",
        });
    
        var ap = new Snowflake.AuthenticationPolicy("ap", new()
        {
            Database = "prod",
            Schema = "security",
            Name = "default_policy",
        });
    
        var apa = new Snowflake.UserAuthenticationPolicyAttachment("apa", new()
        {
            AuthenticationPolicyName = ap.FullyQualifiedName,
            UserName = user.Name,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.snowflake.User;
    import com.pulumi.snowflake.UserArgs;
    import com.pulumi.snowflake.AuthenticationPolicy;
    import com.pulumi.snowflake.AuthenticationPolicyArgs;
    import com.pulumi.snowflake.UserAuthenticationPolicyAttachment;
    import com.pulumi.snowflake.UserAuthenticationPolicyAttachmentArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var user = new User("user", UserArgs.builder()
                .name("USER_NAME")
                .build());
    
            var ap = new AuthenticationPolicy("ap", AuthenticationPolicyArgs.builder()
                .database("prod")
                .schema("security")
                .name("default_policy")
                .build());
    
            var apa = new UserAuthenticationPolicyAttachment("apa", UserAuthenticationPolicyAttachmentArgs.builder()
                .authenticationPolicyName(ap.fullyQualifiedName())
                .userName(user.name())
                .build());
    
        }
    }
    
    resources:
      user:
        type: snowflake:User
        properties:
          name: USER_NAME
      ap:
        type: snowflake:AuthenticationPolicy
        properties:
          database: prod
          schema: security
          name: default_policy
      apa:
        type: snowflake:UserAuthenticationPolicyAttachment
        properties:
          authenticationPolicyName: ${ap.fullyQualifiedName}
          userName: ${user.name}
    

    Note Instead of using fully_qualified_name, you can reference objects managed outside Terraform by constructing a correct ID, consult identifiers guide.

    Note If a field has a default value, it is shown next to the type in the schema.

    Create UserAuthenticationPolicyAttachment Resource

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

    Constructor syntax

    new UserAuthenticationPolicyAttachment(name: string, args: UserAuthenticationPolicyAttachmentArgs, opts?: CustomResourceOptions);
    @overload
    def UserAuthenticationPolicyAttachment(resource_name: str,
                                           args: UserAuthenticationPolicyAttachmentArgs,
                                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def UserAuthenticationPolicyAttachment(resource_name: str,
                                           opts: Optional[ResourceOptions] = None,
                                           authentication_policy_name: Optional[str] = None,
                                           user_name: Optional[str] = None)
    func NewUserAuthenticationPolicyAttachment(ctx *Context, name string, args UserAuthenticationPolicyAttachmentArgs, opts ...ResourceOption) (*UserAuthenticationPolicyAttachment, error)
    public UserAuthenticationPolicyAttachment(string name, UserAuthenticationPolicyAttachmentArgs args, CustomResourceOptions? opts = null)
    public UserAuthenticationPolicyAttachment(String name, UserAuthenticationPolicyAttachmentArgs args)
    public UserAuthenticationPolicyAttachment(String name, UserAuthenticationPolicyAttachmentArgs args, CustomResourceOptions options)
    
    type: snowflake:UserAuthenticationPolicyAttachment
    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 UserAuthenticationPolicyAttachmentArgs
    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 UserAuthenticationPolicyAttachmentArgs
    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 UserAuthenticationPolicyAttachmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserAuthenticationPolicyAttachmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserAuthenticationPolicyAttachmentArgs
    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 userAuthenticationPolicyAttachmentResource = new Snowflake.UserAuthenticationPolicyAttachment("userAuthenticationPolicyAttachmentResource", new()
    {
        AuthenticationPolicyName = "string",
        UserName = "string",
    });
    
    example, err := snowflake.NewUserAuthenticationPolicyAttachment(ctx, "userAuthenticationPolicyAttachmentResource", &snowflake.UserAuthenticationPolicyAttachmentArgs{
    	AuthenticationPolicyName: pulumi.String("string"),
    	UserName:                 pulumi.String("string"),
    })
    
    var userAuthenticationPolicyAttachmentResource = new UserAuthenticationPolicyAttachment("userAuthenticationPolicyAttachmentResource", UserAuthenticationPolicyAttachmentArgs.builder()
        .authenticationPolicyName("string")
        .userName("string")
        .build());
    
    user_authentication_policy_attachment_resource = snowflake.UserAuthenticationPolicyAttachment("userAuthenticationPolicyAttachmentResource",
        authentication_policy_name="string",
        user_name="string")
    
    const userAuthenticationPolicyAttachmentResource = new snowflake.UserAuthenticationPolicyAttachment("userAuthenticationPolicyAttachmentResource", {
        authenticationPolicyName: "string",
        userName: "string",
    });
    
    type: snowflake:UserAuthenticationPolicyAttachment
    properties:
        authenticationPolicyName: string
        userName: string
    

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

    AuthenticationPolicyName string
    Fully qualified name of the authentication policy
    UserName string
    User name of the user you want to attach the authentication policy to
    AuthenticationPolicyName string
    Fully qualified name of the authentication policy
    UserName string
    User name of the user you want to attach the authentication policy to
    authenticationPolicyName String
    Fully qualified name of the authentication policy
    userName String
    User name of the user you want to attach the authentication policy to
    authenticationPolicyName string
    Fully qualified name of the authentication policy
    userName string
    User name of the user you want to attach the authentication policy to
    authentication_policy_name str
    Fully qualified name of the authentication policy
    user_name str
    User name of the user you want to attach the authentication policy to
    authenticationPolicyName String
    Fully qualified name of the authentication policy
    userName String
    User name of the user you want to attach the authentication policy to

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing UserAuthenticationPolicyAttachment Resource

    Get an existing UserAuthenticationPolicyAttachment 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?: UserAuthenticationPolicyAttachmentState, opts?: CustomResourceOptions): UserAuthenticationPolicyAttachment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            authentication_policy_name: Optional[str] = None,
            user_name: Optional[str] = None) -> UserAuthenticationPolicyAttachment
    func GetUserAuthenticationPolicyAttachment(ctx *Context, name string, id IDInput, state *UserAuthenticationPolicyAttachmentState, opts ...ResourceOption) (*UserAuthenticationPolicyAttachment, error)
    public static UserAuthenticationPolicyAttachment Get(string name, Input<string> id, UserAuthenticationPolicyAttachmentState? state, CustomResourceOptions? opts = null)
    public static UserAuthenticationPolicyAttachment get(String name, Output<String> id, UserAuthenticationPolicyAttachmentState state, CustomResourceOptions options)
    resources:  _:    type: snowflake:UserAuthenticationPolicyAttachment    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:
    AuthenticationPolicyName string
    Fully qualified name of the authentication policy
    UserName string
    User name of the user you want to attach the authentication policy to
    AuthenticationPolicyName string
    Fully qualified name of the authentication policy
    UserName string
    User name of the user you want to attach the authentication policy to
    authenticationPolicyName String
    Fully qualified name of the authentication policy
    userName String
    User name of the user you want to attach the authentication policy to
    authenticationPolicyName string
    Fully qualified name of the authentication policy
    userName string
    User name of the user you want to attach the authentication policy to
    authentication_policy_name str
    Fully qualified name of the authentication policy
    user_name str
    User name of the user you want to attach the authentication policy to
    authenticationPolicyName String
    Fully qualified name of the authentication policy
    userName String
    User name of the user you want to attach the authentication policy to

    Package Details

    Repository
    Snowflake pulumi/pulumi-snowflake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the snowflake Terraform Provider.
    snowflake logo
    Viewing docs for Snowflake v2.13.0
    published on Thursday, Feb 26, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.