Snowflake v0.61.1, Nov 14 24

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

snowflake.SecondaryConnection

Explore with Pulumi AI

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

Import

$ pulumi import snowflake:index/secondaryConnection:SecondaryConnection example 'secondary_connection_name'

Create SecondaryConnection Resource

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

Constructor syntax

new SecondaryConnection(name: string, args: SecondaryConnectionArgs, opts?: CustomResourceOptions);

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

@overload
def SecondaryConnection(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        as_replica_of: Optional[str] = None,
                        comment: Optional[str] = None,
                        name: Optional[str] = None)

func NewSecondaryConnection(ctx *Context, name string, args SecondaryConnectionArgs, opts ...ResourceOption) (*SecondaryConnection, error)

public SecondaryConnection(string name, SecondaryConnectionArgs args, CustomResourceOptions? opts = null)

public SecondaryConnection(String name, SecondaryConnectionArgs args)
public SecondaryConnection(String name, SecondaryConnectionArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args SecondaryConnectionArgs: 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 secondaryConnectionResource = new Snowflake.SecondaryConnection("secondaryConnectionResource", new()
{
    AsReplicaOf = "string",
    Comment = "string",
    Name = "string",
});

example, err := snowflake.NewSecondaryConnection(ctx, "secondaryConnectionResource", &snowflake.SecondaryConnectionArgs{
	AsReplicaOf: pulumi.String("string"),
	Comment:     pulumi.String("string"),
	Name:        pulumi.String("string"),
})

var secondaryConnectionResource = new SecondaryConnection("secondaryConnectionResource", SecondaryConnectionArgs.builder()
    .asReplicaOf("string")
    .comment("string")
    .name("string")
    .build());

secondary_connection_resource = snowflake.SecondaryConnection("secondaryConnectionResource",
    as_replica_of="string",
    comment="string",
    name="string")

const secondaryConnectionResource = new snowflake.SecondaryConnection("secondaryConnectionResource", {
    asReplicaOf: "string",
    comment: "string",
    name: "string",
});

type: snowflake:SecondaryConnection
properties:
    asReplicaOf: string
    comment: string
    name: string

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

AsReplicaOf string: Specifies the identifier for a primary connection from which to create a replica (i.e. a secondary connection).
Comment string: Specifies a comment for the secondary connection.
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 secondary connection, the name must match the name of its primary connection. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "

AsReplicaOf string: Specifies the identifier for a primary connection from which to create a replica (i.e. a secondary connection).
Comment string: Specifies a comment for the secondary connection.
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 secondary connection, the name must match the name of its primary connection. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "

asReplicaOf String: Specifies the identifier for a primary connection from which to create a replica (i.e. a secondary connection).
comment String: Specifies a comment for the secondary connection.
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 secondary connection, the name must match the name of its primary connection. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "

asReplicaOf string: Specifies the identifier for a primary connection from which to create a replica (i.e. a secondary connection).
comment string: Specifies a comment for the secondary connection.
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 secondary connection, the name must match the name of its primary connection. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "

as_replica_of str: Specifies the identifier for a primary connection from which to create a replica (i.e. a secondary connection).
comment str: Specifies a comment for the secondary connection.
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 secondary connection, the name must match the name of its primary connection. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "

asReplicaOf String: Specifies the identifier for a primary connection from which to create a replica (i.e. a secondary connection).
comment String: Specifies a comment for the secondary connection.
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 secondary connection, the name must match the name of its primary connection. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "

Outputs

All input properties are implicitly available as output properties. Additionally, the SecondaryConnection 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: Indicates if the connection primary status has been changed. If change is detected, resource will be recreated.
ShowOutputs List<SecondaryConnectionShowOutput>: 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: Indicates if the connection primary status has been changed. If change is detected, resource will be recreated.
ShowOutputs []SecondaryConnectionShowOutput: 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: Indicates if the connection primary status has been changed. If change is detected, resource will be recreated.
showOutputs List<SecondaryConnectionShowOutput>: 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: Indicates if the connection primary status has been changed. If change is detected, resource will be recreated.
showOutputs SecondaryConnectionShowOutput[]: 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: Indicates if the connection primary status has been changed. If change is detected, resource will be recreated.
show_outputs Sequence[SecondaryConnectionShowOutput]: 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: Indicates if the connection primary status has been changed. If change is detected, resource will be recreated.
showOutputs List<Property Map>: Outputs the result of SHOW CONNECTIONS for the given connection.

Look up Existing SecondaryConnection Resource

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

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

func GetSecondaryConnection(ctx *Context, name string, id IDInput, state *SecondaryConnectionState, opts ...ResourceOption) (*SecondaryConnection, error)

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

public static SecondaryConnection get(String name, Output<String> id, SecondaryConnectionState 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:

AsReplicaOf string: Specifies the identifier for a primary connection from which to create a replica (i.e. a secondary connection).
Comment string: Specifies a comment for the secondary connection.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
IsPrimary bool: Indicates if the connection primary status has been changed. If change is detected, resource will be recreated.
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 secondary connection, the name must match the name of its primary connection. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
ShowOutputs List<SecondaryConnectionShowOutput>: Outputs the result of SHOW CONNECTIONS for the given connection.

AsReplicaOf string: Specifies the identifier for a primary connection from which to create a replica (i.e. a secondary connection).
Comment string: Specifies a comment for the secondary connection.
FullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
IsPrimary bool: Indicates if the connection primary status has been changed. If change is detected, resource will be recreated.
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 secondary connection, the name must match the name of its primary connection. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
ShowOutputs []SecondaryConnectionShowOutputArgs: Outputs the result of SHOW CONNECTIONS for the given connection.

asReplicaOf String: Specifies the identifier for a primary connection from which to create a replica (i.e. a secondary connection).
comment String: Specifies a comment for the secondary connection.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
isPrimary Boolean: Indicates if the connection primary status has been changed. If change is detected, resource will be recreated.
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 secondary connection, the name must match the name of its primary connection. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
showOutputs List<SecondaryConnectionShowOutput>: Outputs the result of SHOW CONNECTIONS for the given connection.

asReplicaOf string: Specifies the identifier for a primary connection from which to create a replica (i.e. a secondary connection).
comment string: Specifies a comment for the secondary connection.
fullyQualifiedName string: Fully qualified name of the resource. For more information, see object name resolution.
isPrimary boolean: Indicates if the connection primary status has been changed. If change is detected, resource will be recreated.
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 secondary connection, the name must match the name of its primary connection. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
showOutputs SecondaryConnectionShowOutput[]: Outputs the result of SHOW CONNECTIONS for the given connection.

as_replica_of str: Specifies the identifier for a primary connection from which to create a replica (i.e. a secondary connection).
comment str: Specifies a comment for the secondary connection.
fully_qualified_name str: Fully qualified name of the resource. For more information, see object name resolution.
is_primary bool: Indicates if the connection primary status has been changed. If change is detected, resource will be recreated.
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 secondary connection, the name must match the name of its primary connection. Due to technical limitations (read more here), avoid using the following characters: |, ., (, ), "
show_outputs Sequence[SecondaryConnectionShowOutputArgs]: Outputs the result of SHOW CONNECTIONS for the given connection.

asReplicaOf String: Specifies the identifier for a primary connection from which to create a replica (i.e. a secondary connection).
comment String: Specifies a comment for the secondary connection.
fullyQualifiedName String: Fully qualified name of the resource. For more information, see object name resolution.
isPrimary Boolean: Indicates if the connection primary status has been changed. If change is detected, resource will be recreated.
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 secondary connection, the name must match the name of its primary connection. 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.