Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Snowflake Provider
  3. API Docs
  4. FailoverGroup
Snowflake v1.3.0 published on Wednesday, Apr 23, 2025 by Pulumi
pulumi/pulumi-snowflake

snowflake.FailoverGroup

Explore with Pulumi AI

Snowflake v1.3.0 published on Wednesday, Apr 23, 2025 by Pulumi
pulumi/pulumi-snowflake

Import

$ pulumi import snowflake:index/failoverGroup:FailoverGroup example 'fg1'
Copy

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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
The unique name of the resource.
args This property is required. 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,
    },
});
Copy
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),
	},
})
Copy
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());
Copy
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,
    })
Copy
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,
    },
});
Copy
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
Copy

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:

AllowedAccounts 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 \n\n.\n\n
AllowedDatabases 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.
AllowedIntegrationTypes List<string>
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"
AllowedShares 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.
FromReplica Changes to this property will trigger replacement. FailoverGroupFromReplica
Specifies the name of the replica to use as the source for the failover group.
IgnoreEditionCheck bool
(Default: false) Allows replicating objects to accounts on lower editions.
Name Changes to this property will trigger replacement. 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.
ObjectTypes 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"
ReplicationSchedule FailoverGroupReplicationSchedule
Specifies the schedule for refreshing secondary failover groups.
AllowedAccounts []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 \n\n.\n\n
AllowedDatabases []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.
AllowedIntegrationTypes []string
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"
AllowedShares []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.
FromReplica Changes to this property will trigger replacement. FailoverGroupFromReplicaArgs
Specifies the name of the replica to use as the source for the failover group.
IgnoreEditionCheck bool
(Default: false) Allows replicating objects to accounts on lower editions.
Name Changes to this property will trigger replacement. 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.
ObjectTypes []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"
ReplicationSchedule FailoverGroupReplicationScheduleArgs
Specifies the schedule for refreshing secondary failover groups.
allowedAccounts 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 \n\n.\n\n
allowedDatabases 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.
allowedIntegrationTypes List<String>
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"
allowedShares 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.
fromReplica Changes to this property will trigger replacement. FailoverGroupFromReplica
Specifies the name of the replica to use as the source for the failover group.
ignoreEditionCheck Boolean
(Default: false) Allows replicating objects to accounts on lower editions.
name Changes to this property will trigger replacement. 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.
objectTypes 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"
replicationSchedule FailoverGroupReplicationSchedule
Specifies the schedule for refreshing secondary failover groups.
allowedAccounts 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 \n\n.\n\n
allowedDatabases 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.
allowedIntegrationTypes string[]
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"
allowedShares 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.
fromReplica Changes to this property will trigger replacement. FailoverGroupFromReplica
Specifies the name of the replica to use as the source for the failover group.
ignoreEditionCheck boolean
(Default: false) Allows replicating objects to accounts on lower editions.
name Changes to this property will trigger replacement. 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.
objectTypes 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"
replicationSchedule FailoverGroupReplicationSchedule
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 \n\n.\n\n
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_types Sequence[str]
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"
allowed_shares 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 Changes to this property will trigger replacement. FailoverGroupFromReplicaArgs
Specifies the name of the replica to use as the source for the failover group.
ignore_edition_check bool
(Default: false) Allows replicating objects to accounts on lower editions.
name Changes to this property will trigger replacement. 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 FailoverGroupReplicationScheduleArgs
Specifies the schedule for refreshing secondary failover groups.
allowedAccounts 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 \n\n.\n\n
allowedDatabases 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.
allowedIntegrationTypes List<String>
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"
allowedShares 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.
fromReplica Changes to this property will trigger replacement. Property Map
Specifies the name of the replica to use as the source for the failover group.
ignoreEditionCheck Boolean
(Default: false) Allows replicating objects to accounts on lower editions.
name Changes to this property will trigger replacement. 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.
objectTypes 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"
replicationSchedule 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:

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.
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.
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.
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.
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.
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.

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) -> FailoverGroup
func 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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AllowedAccounts 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 \n\n.\n\n
AllowedDatabases 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.
AllowedIntegrationTypes List<string>
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"
AllowedShares 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.
FromReplica Changes to this property will trigger replacement. FailoverGroupFromReplica
Specifies the name of the replica to use as the source for the failover group.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
IgnoreEditionCheck bool
(Default: false) Allows replicating objects to accounts on lower editions.
Name Changes to this property will trigger replacement. 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.
ObjectTypes 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"
ReplicationSchedule FailoverGroupReplicationSchedule
Specifies the schedule for refreshing secondary failover groups.
AllowedAccounts []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 \n\n.\n\n
AllowedDatabases []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.
AllowedIntegrationTypes []string
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"
AllowedShares []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.
FromReplica Changes to this property will trigger replacement. FailoverGroupFromReplicaArgs
Specifies the name of the replica to use as the source for the failover group.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
IgnoreEditionCheck bool
(Default: false) Allows replicating objects to accounts on lower editions.
Name Changes to this property will trigger replacement. 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.
ObjectTypes []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"
ReplicationSchedule FailoverGroupReplicationScheduleArgs
Specifies the schedule for refreshing secondary failover groups.
allowedAccounts 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 \n\n.\n\n
allowedDatabases 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.
allowedIntegrationTypes List<String>
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"
allowedShares 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.
fromReplica Changes to this property will trigger replacement. FailoverGroupFromReplica
Specifies the name of the replica to use as the source for the failover group.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
ignoreEditionCheck Boolean
(Default: false) Allows replicating objects to accounts on lower editions.
name Changes to this property will trigger replacement. 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.
objectTypes 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"
replicationSchedule FailoverGroupReplicationSchedule
Specifies the schedule for refreshing secondary failover groups.
allowedAccounts 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 \n\n.\n\n
allowedDatabases 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.
allowedIntegrationTypes string[]
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"
allowedShares 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.
fromReplica Changes to this property will trigger replacement. FailoverGroupFromReplica
Specifies the name of the replica to use as the source for the failover group.
fullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
ignoreEditionCheck boolean
(Default: false) Allows replicating objects to accounts on lower editions.
name Changes to this property will trigger replacement. 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.
objectTypes 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"
replicationSchedule FailoverGroupReplicationSchedule
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 \n\n.\n\n
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_types Sequence[str]
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"
allowed_shares 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 Changes to this property will trigger replacement. FailoverGroupFromReplicaArgs
Specifies the name of the replica to use as the source for the failover group.
fully_qualified_name str
Fully qualified name of the resource. For more information, see object name resolution.
ignore_edition_check bool
(Default: false) Allows replicating objects to accounts on lower editions.
name Changes to this property will trigger replacement. 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 FailoverGroupReplicationScheduleArgs
Specifies the schedule for refreshing secondary failover groups.
allowedAccounts 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 \n\n.\n\n
allowedDatabases 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.
allowedIntegrationTypes List<String>
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"
allowedShares 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.
fromReplica Changes to this property will trigger replacement. Property Map
Specifies the name of the replica to use as the source for the failover group.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
ignoreEditionCheck Boolean
(Default: false) Allows replicating objects to accounts on lower editions.
name Changes to this property will trigger replacement. 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.
objectTypes 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"
replicationSchedule Property Map
Specifies the schedule for refreshing secondary failover groups.

Supporting Types

FailoverGroupFromReplica
, FailoverGroupFromReplicaArgs

Name This property is required. string
Identifier for the primary failover group in the source account.
OrganizationName This property is required. string
Name of your Snowflake organization.
SourceAccountName This property is required. string
Source account from which you are enabling replication and failover of the specified objects.
Name This property is required. string
Identifier for the primary failover group in the source account.
OrganizationName This property is required. string
Name of your Snowflake organization.
SourceAccountName This property is required. string
Source account from which you are enabling replication and failover of the specified objects.
name This property is required. String
Identifier for the primary failover group in the source account.
organizationName This property is required. String
Name of your Snowflake organization.
sourceAccountName This property is required. String
Source account from which you are enabling replication and failover of the specified objects.
name This property is required. string
Identifier for the primary failover group in the source account.
organizationName This property is required. string
Name of your Snowflake organization.
sourceAccountName This property is required. string
Source account from which you are enabling replication and failover of the specified objects.
name This property is required. str
Identifier for the primary failover group in the source account.
organization_name This property is required. str
Name of your Snowflake organization.
source_account_name This property is required. str
Source account from which you are enabling replication and failover of the specified objects.
name This property is required. String
Identifier for the primary failover group in the source account.
organizationName This property is required. String
Name of your Snowflake organization.
sourceAccountName This property is required. String
Source account from which you are enabling replication and failover of the specified objects.

FailoverGroupReplicationSchedule
, FailoverGroupReplicationScheduleArgs

Cron FailoverGroupReplicationScheduleCron
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 FailoverGroupReplicationScheduleCron
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 FailoverGroupReplicationScheduleCron
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 FailoverGroupReplicationScheduleCron
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 FailoverGroupReplicationScheduleCron
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 This property is required. 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)
TimeZone This property is required. string
Specifies the time zone for secondary group refresh.
Expression This property is required. 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)
TimeZone This property is required. string
Specifies the time zone for secondary group refresh.
expression This property is required. 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)
timeZone This property is required. String
Specifies the time zone for secondary group refresh.
expression This property is required. 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)
timeZone This property is required. string
Specifies the time zone for secondary group refresh.
expression This property is required. 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 This property is required. str
Specifies the time zone for secondary group refresh.
expression This property is required. 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)
timeZone This property is required. String
Specifies the time zone for secondary group refresh.

Package Details

Repository
Snowflake pulumi/pulumi-snowflake
License
Apache-2.0
Notes
This Pulumi package is based on the snowflake Terraform Provider.
Snowflake v1.3.0 published on Wednesday, Apr 23, 2025 by Pulumi
pulumi/pulumi-snowflake