published on Thursday, Feb 26, 2026 by Pulumi
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.
!> Updating allowed_accounts Currently, updating the allowed_accounts field may fail due to an incorrect query being sent (see #3946). This will be fixed during the resource rework. As a workaround, use the execute resource to update the allowed accounts manually. After that, refresh the state with the updated allowed_accounts field in the resource configuration.
Example Usage
Note Instead of using fully_qualified_name, you can reference objects managed outside Terraform by constructing a correct ID, consult identifiers guide.
import * as pulumi from "@pulumi/pulumi";
import * as snowflake from "@pulumi/snowflake";
const db = new snowflake.Database("db", {name: "db1"});
const sourceFailoverGroup = new snowflake.FailoverGroup("source_failover_group", {
name: "FG1",
objectTypes: [
"WAREHOUSES",
"DATABASES",
"INTEGRATIONS",
"ROLES",
],
allowedAccounts: [
"<org_name>.<target_account_name1>",
"<org_name>.<target_account_name2>",
],
allowedDatabases: [db.name],
allowedIntegrationTypes: ["SECURITY INTEGRATIONS"],
replicationSchedule: {
cron: {
expression: "0 0 10-20 * TUE,THU",
timeZone: "UTC",
},
},
});
const targetFailoverGroup = new snowflake.FailoverGroup("target_failover_group", {
name: "FG1",
fromReplica: {
organizationName: "...",
sourceAccountName: "...",
name: sourceFailoverGroup.name,
},
});
import pulumi
import pulumi_snowflake as snowflake
db = snowflake.Database("db", name="db1")
source_failover_group = snowflake.FailoverGroup("source_failover_group",
name="FG1",
object_types=[
"WAREHOUSES",
"DATABASES",
"INTEGRATIONS",
"ROLES",
],
allowed_accounts=[
"<org_name>.<target_account_name1>",
"<org_name>.<target_account_name2>",
],
allowed_databases=[db.name],
allowed_integration_types=["SECURITY INTEGRATIONS"],
replication_schedule={
"cron": {
"expression": "0 0 10-20 * TUE,THU",
"time_zone": "UTC",
},
})
target_failover_group = snowflake.FailoverGroup("target_failover_group",
name="FG1",
from_replica={
"organization_name": "...",
"source_account_name": "...",
"name": source_failover_group.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 {
db, err := snowflake.NewDatabase(ctx, "db", &snowflake.DatabaseArgs{
Name: pulumi.String("db1"),
})
if err != nil {
return err
}
sourceFailoverGroup, err := snowflake.NewFailoverGroup(ctx, "source_failover_group", &snowflake.FailoverGroupArgs{
Name: pulumi.String("FG1"),
ObjectTypes: pulumi.StringArray{
pulumi.String("WAREHOUSES"),
pulumi.String("DATABASES"),
pulumi.String("INTEGRATIONS"),
pulumi.String("ROLES"),
},
AllowedAccounts: pulumi.StringArray{
pulumi.String("<org_name>.<target_account_name1>"),
pulumi.String("<org_name>.<target_account_name2>"),
},
AllowedDatabases: pulumi.StringArray{
db.Name,
},
AllowedIntegrationTypes: pulumi.StringArray{
pulumi.String("SECURITY INTEGRATIONS"),
},
ReplicationSchedule: &snowflake.FailoverGroupReplicationScheduleArgs{
Cron: &snowflake.FailoverGroupReplicationScheduleCronArgs{
Expression: pulumi.String("0 0 10-20 * TUE,THU"),
TimeZone: pulumi.String("UTC"),
},
},
})
if err != nil {
return err
}
_, err = snowflake.NewFailoverGroup(ctx, "target_failover_group", &snowflake.FailoverGroupArgs{
Name: pulumi.String("FG1"),
FromReplica: &snowflake.FailoverGroupFromReplicaArgs{
OrganizationName: pulumi.String("..."),
SourceAccountName: pulumi.String("..."),
Name: sourceFailoverGroup.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 db = new Snowflake.Database("db", new()
{
Name = "db1",
});
var sourceFailoverGroup = new Snowflake.FailoverGroup("source_failover_group", new()
{
Name = "FG1",
ObjectTypes = new[]
{
"WAREHOUSES",
"DATABASES",
"INTEGRATIONS",
"ROLES",
},
AllowedAccounts = new[]
{
"<org_name>.<target_account_name1>",
"<org_name>.<target_account_name2>",
},
AllowedDatabases = new[]
{
db.Name,
},
AllowedIntegrationTypes = new[]
{
"SECURITY INTEGRATIONS",
},
ReplicationSchedule = new Snowflake.Inputs.FailoverGroupReplicationScheduleArgs
{
Cron = new Snowflake.Inputs.FailoverGroupReplicationScheduleCronArgs
{
Expression = "0 0 10-20 * TUE,THU",
TimeZone = "UTC",
},
},
});
var targetFailoverGroup = new Snowflake.FailoverGroup("target_failover_group", new()
{
Name = "FG1",
FromReplica = new Snowflake.Inputs.FailoverGroupFromReplicaArgs
{
OrganizationName = "...",
SourceAccountName = "...",
Name = sourceFailoverGroup.Name,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.Database;
import com.pulumi.snowflake.DatabaseArgs;
import com.pulumi.snowflake.FailoverGroup;
import com.pulumi.snowflake.FailoverGroupArgs;
import com.pulumi.snowflake.inputs.FailoverGroupReplicationScheduleArgs;
import com.pulumi.snowflake.inputs.FailoverGroupReplicationScheduleCronArgs;
import com.pulumi.snowflake.inputs.FailoverGroupFromReplicaArgs;
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 db = new Database("db", DatabaseArgs.builder()
.name("db1")
.build());
var sourceFailoverGroup = new FailoverGroup("sourceFailoverGroup", FailoverGroupArgs.builder()
.name("FG1")
.objectTypes(
"WAREHOUSES",
"DATABASES",
"INTEGRATIONS",
"ROLES")
.allowedAccounts(
"<org_name>.<target_account_name1>",
"<org_name>.<target_account_name2>")
.allowedDatabases(db.name())
.allowedIntegrationTypes("SECURITY INTEGRATIONS")
.replicationSchedule(FailoverGroupReplicationScheduleArgs.builder()
.cron(FailoverGroupReplicationScheduleCronArgs.builder()
.expression("0 0 10-20 * TUE,THU")
.timeZone("UTC")
.build())
.build())
.build());
var targetFailoverGroup = new FailoverGroup("targetFailoverGroup", FailoverGroupArgs.builder()
.name("FG1")
.fromReplica(FailoverGroupFromReplicaArgs.builder()
.organizationName("...")
.sourceAccountName("...")
.name(sourceFailoverGroup.name())
.build())
.build());
}
}
resources:
db:
type: snowflake:Database
properties:
name: db1
sourceFailoverGroup:
type: snowflake:FailoverGroup
name: source_failover_group
properties:
name: FG1
objectTypes:
- WAREHOUSES
- DATABASES
- INTEGRATIONS
- ROLES
allowedAccounts:
- <org_name>.<target_account_name1>
- <org_name>.<target_account_name2>
allowedDatabases:
- ${db.name}
allowedIntegrationTypes:
- SECURITY INTEGRATIONS
replicationSchedule:
cron:
expression: 0 0 10-20 * TUE,THU
timeZone: UTC
targetFailoverGroup:
type: snowflake:FailoverGroup
name: target_failover_group
properties:
name: FG1
fromReplica:
organizationName: '...'
sourceAccountName: '...'
name: ${sourceFailoverGroup.name}
Note If a field has a default value, it is shown next to the type in the schema.
Create FailoverGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new FailoverGroup(name: string, args?: FailoverGroupArgs, opts?: CustomResourceOptions);@overload
def FailoverGroup(resource_name: str,
args: Optional[FailoverGroupArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def FailoverGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
allowed_accounts: Optional[Sequence[str]] = None,
allowed_databases: Optional[Sequence[str]] = None,
allowed_integration_types: Optional[Sequence[str]] = None,
allowed_shares: Optional[Sequence[str]] = None,
from_replica: Optional[FailoverGroupFromReplicaArgs] = None,
ignore_edition_check: Optional[bool] = None,
name: Optional[str] = None,
object_types: Optional[Sequence[str]] = None,
replication_schedule: Optional[FailoverGroupReplicationScheduleArgs] = None)func NewFailoverGroup(ctx *Context, name string, args *FailoverGroupArgs, opts ...ResourceOption) (*FailoverGroup, error)public FailoverGroup(string name, FailoverGroupArgs? args = null, CustomResourceOptions? opts = null)
public FailoverGroup(String name, FailoverGroupArgs args)
public FailoverGroup(String name, FailoverGroupArgs args, CustomResourceOptions options)
type: snowflake:FailoverGroup
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 FailoverGroupArgs
- 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 FailoverGroupArgs
- 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 FailoverGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FailoverGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FailoverGroupArgs
- 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 failoverGroupResource = new Snowflake.FailoverGroup("failoverGroupResource", new()
{
AllowedAccounts = new[]
{
"string",
},
AllowedDatabases = new[]
{
"string",
},
AllowedIntegrationTypes = new[]
{
"string",
},
AllowedShares = new[]
{
"string",
},
FromReplica = new Snowflake.Inputs.FailoverGroupFromReplicaArgs
{
Name = "string",
OrganizationName = "string",
SourceAccountName = "string",
},
IgnoreEditionCheck = false,
Name = "string",
ObjectTypes = new[]
{
"string",
},
ReplicationSchedule = new Snowflake.Inputs.FailoverGroupReplicationScheduleArgs
{
Cron = new Snowflake.Inputs.FailoverGroupReplicationScheduleCronArgs
{
Expression = "string",
TimeZone = "string",
},
Interval = 0,
},
});
example, err := snowflake.NewFailoverGroup(ctx, "failoverGroupResource", &snowflake.FailoverGroupArgs{
AllowedAccounts: pulumi.StringArray{
pulumi.String("string"),
},
AllowedDatabases: pulumi.StringArray{
pulumi.String("string"),
},
AllowedIntegrationTypes: pulumi.StringArray{
pulumi.String("string"),
},
AllowedShares: pulumi.StringArray{
pulumi.String("string"),
},
FromReplica: &snowflake.FailoverGroupFromReplicaArgs{
Name: pulumi.String("string"),
OrganizationName: pulumi.String("string"),
SourceAccountName: pulumi.String("string"),
},
IgnoreEditionCheck: pulumi.Bool(false),
Name: pulumi.String("string"),
ObjectTypes: pulumi.StringArray{
pulumi.String("string"),
},
ReplicationSchedule: &snowflake.FailoverGroupReplicationScheduleArgs{
Cron: &snowflake.FailoverGroupReplicationScheduleCronArgs{
Expression: pulumi.String("string"),
TimeZone: pulumi.String("string"),
},
Interval: pulumi.Int(0),
},
})
var failoverGroupResource = new FailoverGroup("failoverGroupResource", FailoverGroupArgs.builder()
.allowedAccounts("string")
.allowedDatabases("string")
.allowedIntegrationTypes("string")
.allowedShares("string")
.fromReplica(FailoverGroupFromReplicaArgs.builder()
.name("string")
.organizationName("string")
.sourceAccountName("string")
.build())
.ignoreEditionCheck(false)
.name("string")
.objectTypes("string")
.replicationSchedule(FailoverGroupReplicationScheduleArgs.builder()
.cron(FailoverGroupReplicationScheduleCronArgs.builder()
.expression("string")
.timeZone("string")
.build())
.interval(0)
.build())
.build());
failover_group_resource = snowflake.FailoverGroup("failoverGroupResource",
allowed_accounts=["string"],
allowed_databases=["string"],
allowed_integration_types=["string"],
allowed_shares=["string"],
from_replica={
"name": "string",
"organization_name": "string",
"source_account_name": "string",
},
ignore_edition_check=False,
name="string",
object_types=["string"],
replication_schedule={
"cron": {
"expression": "string",
"time_zone": "string",
},
"interval": 0,
})
const failoverGroupResource = new snowflake.FailoverGroup("failoverGroupResource", {
allowedAccounts: ["string"],
allowedDatabases: ["string"],
allowedIntegrationTypes: ["string"],
allowedShares: ["string"],
fromReplica: {
name: "string",
organizationName: "string",
sourceAccountName: "string",
},
ignoreEditionCheck: false,
name: "string",
objectTypes: ["string"],
replicationSchedule: {
cron: {
expression: "string",
timeZone: "string",
},
interval: 0,
},
});
type: snowflake:FailoverGroup
properties:
allowedAccounts:
- string
allowedDatabases:
- string
allowedIntegrationTypes:
- string
allowedShares:
- string
fromReplica:
name: string
organizationName: string
sourceAccountName: string
ignoreEditionCheck: false
name: string
objectTypes:
- string
replicationSchedule:
cron:
expression: string
timeZone: string
interval: 0
FailoverGroup 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 FailoverGroup resource accepts the following input properties:
- Allowed
Accounts List<string> - Specifies the target account or list of target accounts to which replication and failover of specified objects from the source account is enabled. Secondary failover groups in the target accounts in this list can be promoted to serve as the primary failover group in case of failover. Expected in the form
<org_name>.<target_account_name>. This value is case-sensitive. - Allowed
Databases List<string> - Specifies the database or list of databases for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include DATABASES to set this parameter.
- Allowed
Integration List<string>Types - Type(s) of integrations for which you are enabling replication and failover from the source account to the target account. This property requires that the OBJECT_TYPES list include INTEGRATIONS to set this parameter. The following integration types are supported: "SECURITY INTEGRATIONS", "API INTEGRATIONS", "STORAGE INTEGRATIONS", "EXTERNAL ACCESS INTEGRATIONS", "NOTIFICATION INTEGRATIONS"
- List<string>
- Specifies the share or list of shares for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include SHARES to set this parameter.
- From
Replica FailoverGroup From Replica - Specifies the name of the replica to use as the source for the failover group.
- Ignore
Edition boolCheck - (Default:
false) Allows replicating objects to accounts on lower editions. - Name string
- Specifies the identifier for the failover group. The identifier must start with an alphabetic character and cannot contain spaces or special characters unless the identifier string is enclosed in double quotes (e.g. "My object"). Identifiers enclosed in double quotes are also case-sensitive.
- Object
Types List<string> - Type(s) of objects for which you are enabling replication and failover from the source account to the target account. The following object types are supported: "ACCOUNT PARAMETERS", "DATABASES", "INTEGRATIONS", "NETWORK POLICIES", "RESOURCE MONITORS", "ROLES", "SHARES", "USERS", "WAREHOUSES"
- Replication
Schedule FailoverGroup Replication Schedule - Specifies the schedule for refreshing secondary failover groups.
- Allowed
Accounts []string - Specifies the target account or list of target accounts to which replication and failover of specified objects from the source account is enabled. Secondary failover groups in the target accounts in this list can be promoted to serve as the primary failover group in case of failover. Expected in the form
<org_name>.<target_account_name>. This value is case-sensitive. - Allowed
Databases []string - Specifies the database or list of databases for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include DATABASES to set this parameter.
- Allowed
Integration []stringTypes - Type(s) of integrations for which you are enabling replication and failover from the source account to the target account. This property requires that the OBJECT_TYPES list include INTEGRATIONS to set this parameter. The following integration types are supported: "SECURITY INTEGRATIONS", "API INTEGRATIONS", "STORAGE INTEGRATIONS", "EXTERNAL ACCESS INTEGRATIONS", "NOTIFICATION INTEGRATIONS"
- []string
- Specifies the share or list of shares for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include SHARES to set this parameter.
- From
Replica FailoverGroup From Replica Args - Specifies the name of the replica to use as the source for the failover group.
- Ignore
Edition boolCheck - (Default:
false) Allows replicating objects to accounts on lower editions. - Name string
- Specifies the identifier for the failover group. The identifier must start with an alphabetic character and cannot contain spaces or special characters unless the identifier string is enclosed in double quotes (e.g. "My object"). Identifiers enclosed in double quotes are also case-sensitive.
- Object
Types []string - Type(s) of objects for which you are enabling replication and failover from the source account to the target account. The following object types are supported: "ACCOUNT PARAMETERS", "DATABASES", "INTEGRATIONS", "NETWORK POLICIES", "RESOURCE MONITORS", "ROLES", "SHARES", "USERS", "WAREHOUSES"
- Replication
Schedule FailoverGroup Replication Schedule Args - Specifies the schedule for refreshing secondary failover groups.
- allowed
Accounts List<String> - Specifies the target account or list of target accounts to which replication and failover of specified objects from the source account is enabled. Secondary failover groups in the target accounts in this list can be promoted to serve as the primary failover group in case of failover. Expected in the form
<org_name>.<target_account_name>. This value is case-sensitive. - allowed
Databases List<String> - Specifies the database or list of databases for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include DATABASES to set this parameter.
- allowed
Integration List<String>Types - Type(s) of integrations for which you are enabling replication and failover from the source account to the target account. This property requires that the OBJECT_TYPES list include INTEGRATIONS to set this parameter. The following integration types are supported: "SECURITY INTEGRATIONS", "API INTEGRATIONS", "STORAGE INTEGRATIONS", "EXTERNAL ACCESS INTEGRATIONS", "NOTIFICATION INTEGRATIONS"
- List<String>
- Specifies the share or list of shares for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include SHARES to set this parameter.
- from
Replica FailoverGroup From Replica - Specifies the name of the replica to use as the source for the failover group.
- ignore
Edition BooleanCheck - (Default:
false) Allows replicating objects to accounts on lower editions. - name String
- Specifies the identifier for the failover group. The identifier must start with an alphabetic character and cannot contain spaces or special characters unless the identifier string is enclosed in double quotes (e.g. "My object"). Identifiers enclosed in double quotes are also case-sensitive.
- object
Types List<String> - Type(s) of objects for which you are enabling replication and failover from the source account to the target account. The following object types are supported: "ACCOUNT PARAMETERS", "DATABASES", "INTEGRATIONS", "NETWORK POLICIES", "RESOURCE MONITORS", "ROLES", "SHARES", "USERS", "WAREHOUSES"
- replication
Schedule FailoverGroup Replication Schedule - Specifies the schedule for refreshing secondary failover groups.
- allowed
Accounts string[] - Specifies the target account or list of target accounts to which replication and failover of specified objects from the source account is enabled. Secondary failover groups in the target accounts in this list can be promoted to serve as the primary failover group in case of failover. Expected in the form
<org_name>.<target_account_name>. This value is case-sensitive. - allowed
Databases string[] - Specifies the database or list of databases for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include DATABASES to set this parameter.
- allowed
Integration string[]Types - Type(s) of integrations for which you are enabling replication and failover from the source account to the target account. This property requires that the OBJECT_TYPES list include INTEGRATIONS to set this parameter. The following integration types are supported: "SECURITY INTEGRATIONS", "API INTEGRATIONS", "STORAGE INTEGRATIONS", "EXTERNAL ACCESS INTEGRATIONS", "NOTIFICATION INTEGRATIONS"
- string[]
- Specifies the share or list of shares for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include SHARES to set this parameter.
- from
Replica FailoverGroup From Replica - Specifies the name of the replica to use as the source for the failover group.
- ignore
Edition booleanCheck - (Default:
false) Allows replicating objects to accounts on lower editions. - name string
- Specifies the identifier for the failover group. The identifier must start with an alphabetic character and cannot contain spaces or special characters unless the identifier string is enclosed in double quotes (e.g. "My object"). Identifiers enclosed in double quotes are also case-sensitive.
- object
Types string[] - Type(s) of objects for which you are enabling replication and failover from the source account to the target account. The following object types are supported: "ACCOUNT PARAMETERS", "DATABASES", "INTEGRATIONS", "NETWORK POLICIES", "RESOURCE MONITORS", "ROLES", "SHARES", "USERS", "WAREHOUSES"
- replication
Schedule FailoverGroup Replication Schedule - Specifies the schedule for refreshing secondary failover groups.
- allowed_
accounts Sequence[str] - Specifies the target account or list of target accounts to which replication and failover of specified objects from the source account is enabled. Secondary failover groups in the target accounts in this list can be promoted to serve as the primary failover group in case of failover. Expected in the form
<org_name>.<target_account_name>. This value is case-sensitive. - allowed_
databases Sequence[str] - Specifies the database or list of databases for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include DATABASES to set this parameter.
- allowed_
integration_ Sequence[str]types - Type(s) of integrations for which you are enabling replication and failover from the source account to the target account. This property requires that the OBJECT_TYPES list include INTEGRATIONS to set this parameter. The following integration types are supported: "SECURITY INTEGRATIONS", "API INTEGRATIONS", "STORAGE INTEGRATIONS", "EXTERNAL ACCESS INTEGRATIONS", "NOTIFICATION INTEGRATIONS"
- Sequence[str]
- Specifies the share or list of shares for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include SHARES to set this parameter.
- from_
replica FailoverGroup From Replica Args - Specifies the name of the replica to use as the source for the failover group.
- ignore_
edition_ boolcheck - (Default:
false) Allows replicating objects to accounts on lower editions. - name str
- Specifies the identifier for the failover group. The identifier must start with an alphabetic character and cannot contain spaces or special characters unless the identifier string is enclosed in double quotes (e.g. "My object"). Identifiers enclosed in double quotes are also case-sensitive.
- object_
types Sequence[str] - Type(s) of objects for which you are enabling replication and failover from the source account to the target account. The following object types are supported: "ACCOUNT PARAMETERS", "DATABASES", "INTEGRATIONS", "NETWORK POLICIES", "RESOURCE MONITORS", "ROLES", "SHARES", "USERS", "WAREHOUSES"
- replication_
schedule FailoverGroup Replication Schedule Args - Specifies the schedule for refreshing secondary failover groups.
- allowed
Accounts List<String> - Specifies the target account or list of target accounts to which replication and failover of specified objects from the source account is enabled. Secondary failover groups in the target accounts in this list can be promoted to serve as the primary failover group in case of failover. Expected in the form
<org_name>.<target_account_name>. This value is case-sensitive. - allowed
Databases List<String> - Specifies the database or list of databases for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include DATABASES to set this parameter.
- allowed
Integration List<String>Types - Type(s) of integrations for which you are enabling replication and failover from the source account to the target account. This property requires that the OBJECT_TYPES list include INTEGRATIONS to set this parameter. The following integration types are supported: "SECURITY INTEGRATIONS", "API INTEGRATIONS", "STORAGE INTEGRATIONS", "EXTERNAL ACCESS INTEGRATIONS", "NOTIFICATION INTEGRATIONS"
- List<String>
- Specifies the share or list of shares for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include SHARES to set this parameter.
- from
Replica Property Map - Specifies the name of the replica to use as the source for the failover group.
- ignore
Edition BooleanCheck - (Default:
false) Allows replicating objects to accounts on lower editions. - name String
- Specifies the identifier for the failover group. The identifier must start with an alphabetic character and cannot contain spaces or special characters unless the identifier string is enclosed in double quotes (e.g. "My object"). Identifiers enclosed in double quotes are also case-sensitive.
- object
Types List<String> - Type(s) of objects for which you are enabling replication and failover from the source account to the target account. The following object types are supported: "ACCOUNT PARAMETERS", "DATABASES", "INTEGRATIONS", "NETWORK POLICIES", "RESOURCE MONITORS", "ROLES", "SHARES", "USERS", "WAREHOUSES"
- replication
Schedule Property Map - Specifies the schedule for refreshing secondary failover groups.
Outputs
All input properties are implicitly available as output properties. Additionally, the FailoverGroup resource produces the following output properties:
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- id String
- The provider-assigned unique ID for this managed resource.
- fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- id string
- The provider-assigned unique ID for this managed resource.
- fully_
qualified_ strname - Fully qualified name of the resource. For more information, see object name resolution.
- id str
- The provider-assigned unique ID for this managed resource.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing FailoverGroup Resource
Get an existing FailoverGroup 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?: FailoverGroupState, opts?: CustomResourceOptions): FailoverGroup@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
allowed_accounts: Optional[Sequence[str]] = None,
allowed_databases: Optional[Sequence[str]] = None,
allowed_integration_types: Optional[Sequence[str]] = None,
allowed_shares: Optional[Sequence[str]] = None,
from_replica: Optional[FailoverGroupFromReplicaArgs] = None,
fully_qualified_name: Optional[str] = None,
ignore_edition_check: Optional[bool] = None,
name: Optional[str] = None,
object_types: Optional[Sequence[str]] = None,
replication_schedule: Optional[FailoverGroupReplicationScheduleArgs] = None) -> FailoverGroupfunc GetFailoverGroup(ctx *Context, name string, id IDInput, state *FailoverGroupState, opts ...ResourceOption) (*FailoverGroup, error)public static FailoverGroup Get(string name, Input<string> id, FailoverGroupState? state, CustomResourceOptions? opts = null)public static FailoverGroup get(String name, Output<String> id, FailoverGroupState state, CustomResourceOptions options)resources: _: type: snowflake:FailoverGroup 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.
- Allowed
Accounts List<string> - Specifies the target account or list of target accounts to which replication and failover of specified objects from the source account is enabled. Secondary failover groups in the target accounts in this list can be promoted to serve as the primary failover group in case of failover. Expected in the form
<org_name>.<target_account_name>. This value is case-sensitive. - Allowed
Databases List<string> - Specifies the database or list of databases for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include DATABASES to set this parameter.
- Allowed
Integration List<string>Types - Type(s) of integrations for which you are enabling replication and failover from the source account to the target account. This property requires that the OBJECT_TYPES list include INTEGRATIONS to set this parameter. The following integration types are supported: "SECURITY INTEGRATIONS", "API INTEGRATIONS", "STORAGE INTEGRATIONS", "EXTERNAL ACCESS INTEGRATIONS", "NOTIFICATION INTEGRATIONS"
- List<string>
- Specifies the share or list of shares for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include SHARES to set this parameter.
- From
Replica FailoverGroup From Replica - Specifies the name of the replica to use as the source for the failover group.
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Ignore
Edition boolCheck - (Default:
false) Allows replicating objects to accounts on lower editions. - Name string
- Specifies the identifier for the failover group. The identifier must start with an alphabetic character and cannot contain spaces or special characters unless the identifier string is enclosed in double quotes (e.g. "My object"). Identifiers enclosed in double quotes are also case-sensitive.
- Object
Types List<string> - Type(s) of objects for which you are enabling replication and failover from the source account to the target account. The following object types are supported: "ACCOUNT PARAMETERS", "DATABASES", "INTEGRATIONS", "NETWORK POLICIES", "RESOURCE MONITORS", "ROLES", "SHARES", "USERS", "WAREHOUSES"
- Replication
Schedule FailoverGroup Replication Schedule - Specifies the schedule for refreshing secondary failover groups.
- Allowed
Accounts []string - Specifies the target account or list of target accounts to which replication and failover of specified objects from the source account is enabled. Secondary failover groups in the target accounts in this list can be promoted to serve as the primary failover group in case of failover. Expected in the form
<org_name>.<target_account_name>. This value is case-sensitive. - Allowed
Databases []string - Specifies the database or list of databases for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include DATABASES to set this parameter.
- Allowed
Integration []stringTypes - Type(s) of integrations for which you are enabling replication and failover from the source account to the target account. This property requires that the OBJECT_TYPES list include INTEGRATIONS to set this parameter. The following integration types are supported: "SECURITY INTEGRATIONS", "API INTEGRATIONS", "STORAGE INTEGRATIONS", "EXTERNAL ACCESS INTEGRATIONS", "NOTIFICATION INTEGRATIONS"
- []string
- Specifies the share or list of shares for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include SHARES to set this parameter.
- From
Replica FailoverGroup From Replica Args - Specifies the name of the replica to use as the source for the failover group.
- Fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- Ignore
Edition boolCheck - (Default:
false) Allows replicating objects to accounts on lower editions. - Name string
- Specifies the identifier for the failover group. The identifier must start with an alphabetic character and cannot contain spaces or special characters unless the identifier string is enclosed in double quotes (e.g. "My object"). Identifiers enclosed in double quotes are also case-sensitive.
- Object
Types []string - Type(s) of objects for which you are enabling replication and failover from the source account to the target account. The following object types are supported: "ACCOUNT PARAMETERS", "DATABASES", "INTEGRATIONS", "NETWORK POLICIES", "RESOURCE MONITORS", "ROLES", "SHARES", "USERS", "WAREHOUSES"
- Replication
Schedule FailoverGroup Replication Schedule Args - Specifies the schedule for refreshing secondary failover groups.
- allowed
Accounts List<String> - Specifies the target account or list of target accounts to which replication and failover of specified objects from the source account is enabled. Secondary failover groups in the target accounts in this list can be promoted to serve as the primary failover group in case of failover. Expected in the form
<org_name>.<target_account_name>. This value is case-sensitive. - allowed
Databases List<String> - Specifies the database or list of databases for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include DATABASES to set this parameter.
- allowed
Integration List<String>Types - Type(s) of integrations for which you are enabling replication and failover from the source account to the target account. This property requires that the OBJECT_TYPES list include INTEGRATIONS to set this parameter. The following integration types are supported: "SECURITY INTEGRATIONS", "API INTEGRATIONS", "STORAGE INTEGRATIONS", "EXTERNAL ACCESS INTEGRATIONS", "NOTIFICATION INTEGRATIONS"
- List<String>
- Specifies the share or list of shares for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include SHARES to set this parameter.
- from
Replica FailoverGroup From Replica - Specifies the name of the replica to use as the source for the failover group.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- ignore
Edition BooleanCheck - (Default:
false) Allows replicating objects to accounts on lower editions. - name String
- Specifies the identifier for the failover group. The identifier must start with an alphabetic character and cannot contain spaces or special characters unless the identifier string is enclosed in double quotes (e.g. "My object"). Identifiers enclosed in double quotes are also case-sensitive.
- object
Types List<String> - Type(s) of objects for which you are enabling replication and failover from the source account to the target account. The following object types are supported: "ACCOUNT PARAMETERS", "DATABASES", "INTEGRATIONS", "NETWORK POLICIES", "RESOURCE MONITORS", "ROLES", "SHARES", "USERS", "WAREHOUSES"
- replication
Schedule FailoverGroup Replication Schedule - Specifies the schedule for refreshing secondary failover groups.
- allowed
Accounts string[] - Specifies the target account or list of target accounts to which replication and failover of specified objects from the source account is enabled. Secondary failover groups in the target accounts in this list can be promoted to serve as the primary failover group in case of failover. Expected in the form
<org_name>.<target_account_name>. This value is case-sensitive. - allowed
Databases string[] - Specifies the database or list of databases for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include DATABASES to set this parameter.
- allowed
Integration string[]Types - Type(s) of integrations for which you are enabling replication and failover from the source account to the target account. This property requires that the OBJECT_TYPES list include INTEGRATIONS to set this parameter. The following integration types are supported: "SECURITY INTEGRATIONS", "API INTEGRATIONS", "STORAGE INTEGRATIONS", "EXTERNAL ACCESS INTEGRATIONS", "NOTIFICATION INTEGRATIONS"
- string[]
- Specifies the share or list of shares for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include SHARES to set this parameter.
- from
Replica FailoverGroup From Replica - Specifies the name of the replica to use as the source for the failover group.
- fully
Qualified stringName - Fully qualified name of the resource. For more information, see object name resolution.
- ignore
Edition booleanCheck - (Default:
false) Allows replicating objects to accounts on lower editions. - name string
- Specifies the identifier for the failover group. The identifier must start with an alphabetic character and cannot contain spaces or special characters unless the identifier string is enclosed in double quotes (e.g. "My object"). Identifiers enclosed in double quotes are also case-sensitive.
- object
Types string[] - Type(s) of objects for which you are enabling replication and failover from the source account to the target account. The following object types are supported: "ACCOUNT PARAMETERS", "DATABASES", "INTEGRATIONS", "NETWORK POLICIES", "RESOURCE MONITORS", "ROLES", "SHARES", "USERS", "WAREHOUSES"
- replication
Schedule FailoverGroup Replication Schedule - Specifies the schedule for refreshing secondary failover groups.
- allowed_
accounts Sequence[str] - Specifies the target account or list of target accounts to which replication and failover of specified objects from the source account is enabled. Secondary failover groups in the target accounts in this list can be promoted to serve as the primary failover group in case of failover. Expected in the form
<org_name>.<target_account_name>. This value is case-sensitive. - allowed_
databases Sequence[str] - Specifies the database or list of databases for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include DATABASES to set this parameter.
- allowed_
integration_ Sequence[str]types - Type(s) of integrations for which you are enabling replication and failover from the source account to the target account. This property requires that the OBJECT_TYPES list include INTEGRATIONS to set this parameter. The following integration types are supported: "SECURITY INTEGRATIONS", "API INTEGRATIONS", "STORAGE INTEGRATIONS", "EXTERNAL ACCESS INTEGRATIONS", "NOTIFICATION INTEGRATIONS"
- Sequence[str]
- Specifies the share or list of shares for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include SHARES to set this parameter.
- from_
replica FailoverGroup From Replica Args - Specifies the name of the replica to use as the source for the failover group.
- fully_
qualified_ strname - Fully qualified name of the resource. For more information, see object name resolution.
- ignore_
edition_ boolcheck - (Default:
false) Allows replicating objects to accounts on lower editions. - name str
- Specifies the identifier for the failover group. The identifier must start with an alphabetic character and cannot contain spaces or special characters unless the identifier string is enclosed in double quotes (e.g. "My object"). Identifiers enclosed in double quotes are also case-sensitive.
- object_
types Sequence[str] - Type(s) of objects for which you are enabling replication and failover from the source account to the target account. The following object types are supported: "ACCOUNT PARAMETERS", "DATABASES", "INTEGRATIONS", "NETWORK POLICIES", "RESOURCE MONITORS", "ROLES", "SHARES", "USERS", "WAREHOUSES"
- replication_
schedule FailoverGroup Replication Schedule Args - Specifies the schedule for refreshing secondary failover groups.
- allowed
Accounts List<String> - Specifies the target account or list of target accounts to which replication and failover of specified objects from the source account is enabled. Secondary failover groups in the target accounts in this list can be promoted to serve as the primary failover group in case of failover. Expected in the form
<org_name>.<target_account_name>. This value is case-sensitive. - allowed
Databases List<String> - Specifies the database or list of databases for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include DATABASES to set this parameter.
- allowed
Integration List<String>Types - Type(s) of integrations for which you are enabling replication and failover from the source account to the target account. This property requires that the OBJECT_TYPES list include INTEGRATIONS to set this parameter. The following integration types are supported: "SECURITY INTEGRATIONS", "API INTEGRATIONS", "STORAGE INTEGRATIONS", "EXTERNAL ACCESS INTEGRATIONS", "NOTIFICATION INTEGRATIONS"
- List<String>
- Specifies the share or list of shares for which you are enabling replication and failover from the source account to the target account. The OBJECT_TYPES list must include SHARES to set this parameter.
- from
Replica Property Map - Specifies the name of the replica to use as the source for the failover group.
- fully
Qualified StringName - Fully qualified name of the resource. For more information, see object name resolution.
- ignore
Edition BooleanCheck - (Default:
false) Allows replicating objects to accounts on lower editions. - name String
- Specifies the identifier for the failover group. The identifier must start with an alphabetic character and cannot contain spaces or special characters unless the identifier string is enclosed in double quotes (e.g. "My object"). Identifiers enclosed in double quotes are also case-sensitive.
- object
Types List<String> - Type(s) of objects for which you are enabling replication and failover from the source account to the target account. The following object types are supported: "ACCOUNT PARAMETERS", "DATABASES", "INTEGRATIONS", "NETWORK POLICIES", "RESOURCE MONITORS", "ROLES", "SHARES", "USERS", "WAREHOUSES"
- replication
Schedule Property Map - Specifies the schedule for refreshing secondary failover groups.
Supporting Types
FailoverGroupFromReplica, FailoverGroupFromReplicaArgs
- Name string
- Identifier for the primary failover group in the source account.
- Organization
Name string - Name of your Snowflake organization.
- Source
Account stringName - Source account from which you are enabling replication and failover of the specified objects.
- Name string
- Identifier for the primary failover group in the source account.
- Organization
Name string - Name of your Snowflake organization.
- Source
Account stringName - Source account from which you are enabling replication and failover of the specified objects.
- name String
- Identifier for the primary failover group in the source account.
- organization
Name String - Name of your Snowflake organization.
- source
Account StringName - Source account from which you are enabling replication and failover of the specified objects.
- name string
- Identifier for the primary failover group in the source account.
- organization
Name string - Name of your Snowflake organization.
- source
Account stringName - Source account from which you are enabling replication and failover of the specified objects.
- name str
- Identifier for the primary failover group in the source account.
- organization_
name str - Name of your Snowflake organization.
- source_
account_ strname - Source account from which you are enabling replication and failover of the specified objects.
- name String
- Identifier for the primary failover group in the source account.
- organization
Name String - Name of your Snowflake organization.
- source
Account StringName - Source account from which you are enabling replication and failover of the specified objects.
FailoverGroupReplicationSchedule, FailoverGroupReplicationScheduleArgs
- Cron
Failover
Group Replication Schedule Cron - Specifies the cron expression for the replication schedule. The cron expression must be in the following format: "minute hour day-of-month month day-of-week". The following values are supported: minute: 0-59 hour: 0-23 day-of-month: 1-31 month: 1-12 day-of-week: 0-6 (0 is Sunday)
- Interval int
- Specifies the interval in minutes for the replication schedule. The interval must be greater than 0 and less than 1440 (24 hours).
- Cron
Failover
Group Replication Schedule Cron - Specifies the cron expression for the replication schedule. The cron expression must be in the following format: "minute hour day-of-month month day-of-week". The following values are supported: minute: 0-59 hour: 0-23 day-of-month: 1-31 month: 1-12 day-of-week: 0-6 (0 is Sunday)
- Interval int
- Specifies the interval in minutes for the replication schedule. The interval must be greater than 0 and less than 1440 (24 hours).
- cron
Failover
Group Replication Schedule Cron - Specifies the cron expression for the replication schedule. The cron expression must be in the following format: "minute hour day-of-month month day-of-week". The following values are supported: minute: 0-59 hour: 0-23 day-of-month: 1-31 month: 1-12 day-of-week: 0-6 (0 is Sunday)
- interval Integer
- Specifies the interval in minutes for the replication schedule. The interval must be greater than 0 and less than 1440 (24 hours).
- cron
Failover
Group Replication Schedule Cron - Specifies the cron expression for the replication schedule. The cron expression must be in the following format: "minute hour day-of-month month day-of-week". The following values are supported: minute: 0-59 hour: 0-23 day-of-month: 1-31 month: 1-12 day-of-week: 0-6 (0 is Sunday)
- interval number
- Specifies the interval in minutes for the replication schedule. The interval must be greater than 0 and less than 1440 (24 hours).
- cron
Failover
Group Replication Schedule Cron - Specifies the cron expression for the replication schedule. The cron expression must be in the following format: "minute hour day-of-month month day-of-week". The following values are supported: minute: 0-59 hour: 0-23 day-of-month: 1-31 month: 1-12 day-of-week: 0-6 (0 is Sunday)
- interval int
- Specifies the interval in minutes for the replication schedule. The interval must be greater than 0 and less than 1440 (24 hours).
- cron Property Map
- Specifies the cron expression for the replication schedule. The cron expression must be in the following format: "minute hour day-of-month month day-of-week". The following values are supported: minute: 0-59 hour: 0-23 day-of-month: 1-31 month: 1-12 day-of-week: 0-6 (0 is Sunday)
- interval Number
- Specifies the interval in minutes for the replication schedule. The interval must be greater than 0 and less than 1440 (24 hours).
FailoverGroupReplicationScheduleCron, FailoverGroupReplicationScheduleCronArgs
- Expression string
- Specifies the cron expression for the replication schedule. The cron expression must be in the following format: "minute hour day-of-month month day-of-week". The following values are supported: minute: 0-59 hour: 0-23 day-of-month: 1-31 month: 1-12 day-of-week: 0-6 (0 is Sunday)
- Time
Zone string - Specifies the time zone for secondary group refresh.
- Expression string
- Specifies the cron expression for the replication schedule. The cron expression must be in the following format: "minute hour day-of-month month day-of-week". The following values are supported: minute: 0-59 hour: 0-23 day-of-month: 1-31 month: 1-12 day-of-week: 0-6 (0 is Sunday)
- Time
Zone string - Specifies the time zone for secondary group refresh.
- expression String
- Specifies the cron expression for the replication schedule. The cron expression must be in the following format: "minute hour day-of-month month day-of-week". The following values are supported: minute: 0-59 hour: 0-23 day-of-month: 1-31 month: 1-12 day-of-week: 0-6 (0 is Sunday)
- time
Zone String - Specifies the time zone for secondary group refresh.
- expression string
- Specifies the cron expression for the replication schedule. The cron expression must be in the following format: "minute hour day-of-month month day-of-week". The following values are supported: minute: 0-59 hour: 0-23 day-of-month: 1-31 month: 1-12 day-of-week: 0-6 (0 is Sunday)
- time
Zone string - Specifies the time zone for secondary group refresh.
- expression str
- Specifies the cron expression for the replication schedule. The cron expression must be in the following format: "minute hour day-of-month month day-of-week". The following values are supported: minute: 0-59 hour: 0-23 day-of-month: 1-31 month: 1-12 day-of-week: 0-6 (0 is Sunday)
- time_
zone str - Specifies the time zone for secondary group refresh.
- expression String
- Specifies the cron expression for the replication schedule. The cron expression must be in the following format: "minute hour day-of-month month day-of-week". The following values are supported: minute: 0-59 hour: 0-23 day-of-month: 1-31 month: 1-12 day-of-week: 0-6 (0 is Sunday)
- time
Zone String - Specifies the time zone for secondary group refresh.
Import
$ pulumi import snowflake:index/failoverGroup:FailoverGroup example 'fg1'
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Snowflake pulumi/pulumi-snowflake
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
snowflakeTerraform Provider.
published on Thursday, Feb 26, 2026 by Pulumi
