Snowflake v1.1.4, Mar 26 25

Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi

snowflake.PrimaryConnection

Explore with Pulumi AI

Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi

Import

$ pulumi import snowflake:index/primaryConnection:PrimaryConnection example '"<primary_connection_name>"'

Create PrimaryConnection Resource

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

Constructor syntax

new PrimaryConnection(name: string, args?: PrimaryConnectionArgs, opts?: CustomResourceOptions);

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

@overload
def PrimaryConnection(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      comment: Optional[str] = None,
                      enable_failover_to_accounts: Optional[Sequence[str]] = None,
                      name: Optional[str] = None)

func NewPrimaryConnection(ctx *Context, name string, args *PrimaryConnectionArgs, opts ...ResourceOption) (*PrimaryConnection, error)

public PrimaryConnection(string name, PrimaryConnectionArgs? args = null, CustomResourceOptions? opts = null)

public PrimaryConnection(String name, PrimaryConnectionArgs args)
public PrimaryConnection(String name, PrimaryConnectionArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args PrimaryConnectionArgs: 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 primaryConnectionResource = new Snowflake.PrimaryConnection("primaryConnectionResource", new()
{
    Comment = "string",
    EnableFailoverToAccounts = new[]
    {
        "string",
    },
    Name = "string",
});

example, err := snowflake.NewPrimaryConnection(ctx, "primaryConnectionResource", &snowflake.PrimaryConnectionArgs{
	Comment: pulumi.String("string"),
	EnableFailoverToAccounts: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

var primaryConnectionResource = new PrimaryConnection("primaryConnectionResource", PrimaryConnectionArgs.builder()
    .comment("string")
    .enableFailoverToAccounts("string")
    .name("string")
    .build());

primary_connection_resource = snowflake.PrimaryConnection("primaryConnectionResource",
    comment="string",
    enable_failover_to_accounts=["string"],
    name="string")

const primaryConnectionResource = new snowflake.PrimaryConnection("primaryConnectionResource", {
    comment: "string",
    enableFailoverToAccounts: ["string"],
    name: "string",
});

type: snowflake:PrimaryConnection
properties:
    comment: string
    enableFailoverToAccounts:
        - string
    name: string

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

Comment string: Specifies a comment for the connection.
EnableFailoverToAccounts List<string>: Enables failover for given connection to provided accounts. Specifies a list of accounts in your organization where a secondary connection for this primary connection can be promoted to serve as the primary connection. Include your organization name for each account in the list. For more information about this resource, see docs.
Name string: String that specifies the identifier (i.e. name) for the connection. Must start with an alphabetic character and may only contain letters, decimal digits (0-9), and underscores (*). For a primary connection, the name must be unique across connection names and account names in the organization. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

Comment string: Specifies a comment for the connection.
EnableFailoverToAccounts []string: Enables failover for given connection to provided accounts. Specifies a list of accounts in your organization where a secondary connection for this primary connection can be promoted to serve as the primary connection. Include your organization name for each account in the list. For more information about this resource, see docs.
Name string: String that specifies the identifier (i.e. name) for the connection. Must start with an alphabetic character and may only contain letters, decimal digits (0-9), and underscores (*). For a primary connection, the name must be unique across connection names and account names in the organization. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

comment String: Specifies a comment for the connection.
enableFailoverToAccounts List<String>: Enables failover for given connection to provided accounts. Specifies a list of accounts in your organization where a secondary connection for this primary connection can be promoted to serve as the primary connection. Include your organization name for each account in the list. For more information about this resource, see docs.
name String: String that specifies the identifier (i.e. name) for the connection. Must start with an alphabetic character and may only contain letters, decimal digits (0-9), and underscores (*). For a primary connection, the name must be unique across connection names and account names in the organization. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

comment string: Specifies a comment for the connection.
enableFailoverToAccounts string[]: Enables failover for given connection to provided accounts. Specifies a list of accounts in your organization where a secondary connection for this primary connection can be promoted to serve as the primary connection. Include your organization name for each account in the list. For more information about this resource, see docs.
name string: String that specifies the identifier (i.e. name) for the connection. Must start with an alphabetic character and may only contain letters, decimal digits (0-9), and underscores (*). For a primary connection, the name must be unique across connection names and account names in the organization. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

comment str: Specifies a comment for the connection.
enable_failover_to_accounts Sequence[str]: Enables failover for given connection to provided accounts. Specifies a list of accounts in your organization where a secondary connection for this primary connection can be promoted to serve as the primary connection. Include your organization name for each account in the list. For more information about this resource, see docs.
name str: String that specifies the identifier (i.e. name) for the connection. Must start with an alphabetic character and may only contain letters, decimal digits (0-9), and underscores (*). For a primary connection, the name must be unique across connection names and account names in the organization. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

comment String: Specifies a comment for the connection.
enableFailoverToAccounts List<String>: Enables failover for given connection to provided accounts. Specifies a list of accounts in your organization where a secondary connection for this primary connection can be promoted to serve as the primary connection. Include your organization name for each account in the list. For more information about this resource, see docs.
name String: String that specifies the identifier (i.e. name) for the connection. Must start with an alphabetic character and may only contain letters, decimal digits (0-9), and underscores (*). For a primary connection, the name must be unique across connection names and account names in the organization. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

Outputs

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

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.
IsPrimary bool
ShowOutputs List<PrimaryConnectionShowOutput>: Outputs the result of SHOW CONNECTIONS for the given connection.

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.
IsPrimary bool
ShowOutputs []PrimaryConnectionShowOutput: Outputs the result of SHOW CONNECTIONS for the given connection.

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.
isPrimary Boolean
showOutputs List<PrimaryConnectionShowOutput>: Outputs the result of SHOW CONNECTIONS for the given connection.

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.
isPrimary boolean
showOutputs PrimaryConnectionShowOutput[]: Outputs the result of SHOW CONNECTIONS for the given connection.

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.
is_primary bool
show_outputs Sequence[PrimaryConnectionShowOutput]: Outputs the result of SHOW CONNECTIONS for the given connection.

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.
isPrimary Boolean
showOutputs List<Property Map>: Outputs the result of SHOW CONNECTIONS for the given connection.

Look up Existing PrimaryConnection Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        enable_failover_to_accounts: Optional[Sequence[str]] = None,
        fully_qualified_name: Optional[str] = None,
        is_primary: Optional[bool] = None,
        name: Optional[str] = None,
        show_outputs: Optional[Sequence[PrimaryConnectionShowOutputArgs]] = None) -> PrimaryConnection

func GetPrimaryConnection(ctx *Context, name string, id IDInput, state *PrimaryConnectionState, opts ...ResourceOption) (*PrimaryConnection, error)

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

public static PrimaryConnection get(String name, Output<String> id, PrimaryConnectionState state, CustomResourceOptions options)

resources:  _:    type: snowflake:PrimaryConnection    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 connection.
EnableFailoverToAccounts List<string>: Enables failover for given connection to provided accounts. Specifies a list of accounts in your organization where a secondary connection for this primary connection can be promoted to serve as the primary connection. Include your organization name for each account in the list. For more information about this resource, see docs.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
IsPrimary bool
Name string: String that specifies the identifier (i.e. name) for the connection. Must start with an alphabetic character and may only contain letters, decimal digits (0-9), and underscores (*). For a primary connection, the name must be unique across connection names and account names in the organization. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
ShowOutputs List<PrimaryConnectionShowOutput>: Outputs the result of SHOW CONNECTIONS for the given connection.

Comment string: Specifies a comment for the connection.
EnableFailoverToAccounts []string: Enables failover for given connection to provided accounts. Specifies a list of accounts in your organization where a secondary connection for this primary connection can be promoted to serve as the primary connection. Include your organization name for each account in the list. For more information about this resource, see docs.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
IsPrimary bool
Name string: String that specifies the identifier (i.e. name) for the connection. Must start with an alphabetic character and may only contain letters, decimal digits (0-9), and underscores (*). For a primary connection, the name must be unique across connection names and account names in the organization. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
ShowOutputs []PrimaryConnectionShowOutputArgs: Outputs the result of SHOW CONNECTIONS for the given connection.

comment String: Specifies a comment for the connection.
enableFailoverToAccounts List<String>: Enables failover for given connection to provided accounts. Specifies a list of accounts in your organization where a secondary connection for this primary connection can be promoted to serve as the primary connection. Include your organization name for each account in the list. For more information about this resource, see docs.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
isPrimary Boolean
name String: String that specifies the identifier (i.e. name) for the connection. Must start with an alphabetic character and may only contain letters, decimal digits (0-9), and underscores (*). For a primary connection, the name must be unique across connection names and account names in the organization. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
showOutputs List<PrimaryConnectionShowOutput>: Outputs the result of SHOW CONNECTIONS for the given connection.

comment string: Specifies a comment for the connection.
enableFailoverToAccounts string[]: Enables failover for given connection to provided accounts. Specifies a list of accounts in your organization where a secondary connection for this primary connection can be promoted to serve as the primary connection. Include your organization name for each account in the list. For more information about this resource, see docs.
fullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
isPrimary boolean
name string: String that specifies the identifier (i.e. name) for the connection. Must start with an alphabetic character and may only contain letters, decimal digits (0-9), and underscores (*). For a primary connection, the name must be unique across connection names and account names in the organization. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
showOutputs PrimaryConnectionShowOutput[]: Outputs the result of SHOW CONNECTIONS for the given connection.

comment str: Specifies a comment for the connection.
enable_failover_to_accounts Sequence[str]: Enables failover for given connection to provided accounts. Specifies a list of accounts in your organization where a secondary connection for this primary connection can be promoted to serve as the primary connection. Include your organization name for each account in the list. For more information about this resource, see docs.
fully_qualified_name str: Fully qualified name of the resource. For more information, see object name resolution.
is_primary bool
name str: String that specifies the identifier (i.e. name) for the connection. Must start with an alphabetic character and may only contain letters, decimal digits (0-9), and underscores (*). For a primary connection, the name must be unique across connection names and account names in the organization. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
show_outputs Sequence[PrimaryConnectionShowOutputArgs]: Outputs the result of SHOW CONNECTIONS for the given connection.

comment String: Specifies a comment for the connection.
enableFailoverToAccounts List<String>: Enables failover for given connection to provided accounts. Specifies a list of accounts in your organization where a secondary connection for this primary connection can be promoted to serve as the primary connection. Include your organization name for each account in the list. For more information about this resource, see docs.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
isPrimary Boolean
name String: String that specifies the identifier (i.e. name) for the connection. Must start with an alphabetic character and may only contain letters, decimal digits (0-9), and underscores (*). For a primary connection, the name must be unique across connection names and account names in the organization. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
showOutputs List<Property Map>: Outputs the result of SHOW CONNECTIONS for the given connection.