Docs Packages
  1. Packages
  2. Snowflake
  3. API Docs
  4. FailoverGroup
Snowflake v0.52.0 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-snowflake

snowflake.FailoverGroup

Explore with Pulumi AI

snowflake logo
Snowflake v0.52.0 published on Thursday, Apr 18, 2024 by Pulumi
pulumi/pulumi-snowflake

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as snowflake from "@pulumi/snowflake";

const db = new snowflake.Database("db", {});
const sourceFailoverGroup = new snowflake.FailoverGroup("sourceFailoverGroup", {
    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 account2 = new snowflake.Provider("account2", {});
const targetFailoverGroup = new snowflake.FailoverGroup("targetFailoverGroup", {fromReplica: {
    organizationName: "...",
    sourceAccountName: "...",
    name: snowflake_failover_group.fg.name,
}}, {
    provider: snowflake.account2,
});

    import pulumi
import pulumi_snowflake as snowflake

db = snowflake.Database("db")
source_failover_group = snowflake.FailoverGroup("sourceFailoverGroup",
    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=snowflake.FailoverGroupReplicationScheduleArgs(
        cron=snowflake.FailoverGroupReplicationScheduleCronArgs(
            expression="0 0 10-20 * TUE,THU",
            time_zone="UTC",
        ),
    ))
account2 = snowflake.Provider("account2")
target_failover_group = snowflake.FailoverGroup("targetFailoverGroup", from_replica=snowflake.FailoverGroupFromReplicaArgs(
    organization_name="...",
    source_account_name="...",
    name=snowflake_failover_group["fg"]["name"],
),
opts=pulumi.ResourceOptions(provider=snowflake["account2"]))

    package main

import (
	"github.com/pulumi/pulumi-snowflake/sdk/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", nil)
		if err != nil {
			return err
		}
		_, err = snowflake.NewFailoverGroup(ctx, "sourceFailoverGroup", &snowflake.FailoverGroupArgs{
			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.NewProvider(ctx, "account2", nil)
		if err != nil {
			return err
		}
		_, err = snowflake.NewFailoverGroup(ctx, "targetFailoverGroup", &snowflake.FailoverGroupArgs{
			FromReplica: &snowflake.FailoverGroupFromReplicaArgs{
				OrganizationName:  pulumi.String("..."),
				SourceAccountName: pulumi.String("..."),
				Name:              pulumi.Any(snowflake_failover_group.Fg.Name),
			},
		}, pulumi.Provider(snowflake.Account2))
		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");

    var sourceFailoverGroup = new Snowflake.FailoverGroup("sourceFailoverGroup", new()
    {
        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 account2 = new Snowflake.Provider("account2");

    var targetFailoverGroup = new Snowflake.FailoverGroup("targetFailoverGroup", new()
    {
        FromReplica = new Snowflake.Inputs.FailoverGroupFromReplicaArgs
        {
            OrganizationName = "...",
            SourceAccountName = "...",
            Name = snowflake_failover_group.Fg.Name,
        },
    }, new CustomResourceOptions
    {
        Provider = snowflake.Account2,
    });

});

    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.FailoverGroup;
import com.pulumi.snowflake.FailoverGroupArgs;
import com.pulumi.snowflake.inputs.FailoverGroupReplicationScheduleArgs;
import com.pulumi.snowflake.inputs.FailoverGroupReplicationScheduleCronArgs;
import com.pulumi.snowflake.Provider;
import com.pulumi.snowflake.inputs.FailoverGroupFromReplicaArgs;
import com.pulumi.resources.CustomResourceOptions;
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");

        var sourceFailoverGroup = new FailoverGroup("sourceFailoverGroup", FailoverGroupArgs.builder()        
            .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 account2 = new Provider("account2");

        var targetFailoverGroup = new FailoverGroup("targetFailoverGroup", FailoverGroupArgs.builder()        
            .fromReplica(FailoverGroupFromReplicaArgs.builder()
                .organizationName("...")
                .sourceAccountName("...")
                .name(snowflake_failover_group.fg().name())
                .build())
            .build(), CustomResourceOptions.builder()
                .provider(snowflake.account2())
                .build());

    }
}

    resources:
  db:
    type: snowflake:Database
  sourceFailoverGroup:
    type: snowflake:FailoverGroup
    properties:
      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
  account2:
    type: pulumi:providers:snowflake
  targetFailoverGroup:
    type: snowflake:FailoverGroup
    properties:
      fromReplica:
        organizationName: '...'
        sourceAccountName: '...'
        name: ${snowflake_failover_group.fg.name}
    options:
      provider: ${snowflake.account2}

    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.

    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=snowflake.FailoverGroupFromReplicaArgs(
        name="string",
        organization_name="string",
        source_account_name="string",
    ),
    ignore_edition_check=False,
    name="string",
    object_types=["string"],
    replication_schedule=snowflake.FailoverGroupReplicationScheduleArgs(
        cron=snowflake.FailoverGroupReplicationScheduleCronArgs(
            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

    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"
    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 FailoverGroupFromReplica
    Specifies the name of the replica to use as the source for the failover group.
    IgnoreEditionCheck bool
    Allows replicating objects to accounts on lower editions.
    Name string
    Identifier for the primary failover group in the source account.
    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"
    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 FailoverGroupFromReplicaArgs
    Specifies the name of the replica to use as the source for the failover group.
    IgnoreEditionCheck bool
    Allows replicating objects to accounts on lower editions.
    Name string
    Identifier for the primary failover group in the source account.
    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"
    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 FailoverGroupFromReplica
    Specifies the name of the replica to use as the source for the failover group.
    ignoreEditionCheck Boolean
    Allows replicating objects to accounts on lower editions.
    name String
    Identifier for the primary failover group in the source account.
    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"
    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 FailoverGroupFromReplica
    Specifies the name of the replica to use as the source for the failover group.
    ignoreEditionCheck boolean
    Allows replicating objects to accounts on lower editions.
    name string
    Identifier for the primary failover group in the source account.
    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"
    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 FailoverGroupFromReplicaArgs
    Specifies the name of the replica to use as the source for the failover group.
    ignore_edition_check bool
    Allows replicating objects to accounts on lower editions.
    name str
    Identifier for the primary failover group in the source account.
    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"
    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 Property Map
    Specifies the name of the replica to use as the source for the failover group.
    ignoreEditionCheck Boolean
    Allows replicating objects to accounts on lower editions.
    name String
    Identifier for the primary failover group in the source account.
    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:

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

    Look up Existing 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,
        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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    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"
    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 FailoverGroupFromReplica
    Specifies the name of the replica to use as the source for the failover group.
    IgnoreEditionCheck bool
    Allows replicating objects to accounts on lower editions.
    Name string
    Identifier for the primary failover group in the source account.
    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"
    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 FailoverGroupFromReplicaArgs
    Specifies the name of the replica to use as the source for the failover group.
    IgnoreEditionCheck bool
    Allows replicating objects to accounts on lower editions.
    Name string
    Identifier for the primary failover group in the source account.
    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"
    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 FailoverGroupFromReplica
    Specifies the name of the replica to use as the source for the failover group.
    ignoreEditionCheck Boolean
    Allows replicating objects to accounts on lower editions.
    name String
    Identifier for the primary failover group in the source account.
    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"
    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 FailoverGroupFromReplica
    Specifies the name of the replica to use as the source for the failover group.
    ignoreEditionCheck boolean
    Allows replicating objects to accounts on lower editions.
    name string
    Identifier for the primary failover group in the source account.
    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"
    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 FailoverGroupFromReplicaArgs
    Specifies the name of the replica to use as the source for the failover group.
    ignore_edition_check bool
    Allows replicating objects to accounts on lower editions.
    name str
    Identifier for the primary failover group in the source account.
    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"
    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 Property Map
    Specifies the name of the replica to use as the source for the failover group.
    ignoreEditionCheck Boolean
    Allows replicating objects to accounts on lower editions.
    name String
    Identifier for the primary failover group in the source account.
    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 string
    Identifier for the primary failover group in the source account.
    OrganizationName string
    Name of your Snowflake organization.
    SourceAccountName string
    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.
    OrganizationName string
    Name of your Snowflake organization.
    SourceAccountName string
    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.
    organizationName String
    Name of your Snowflake organization.
    sourceAccountName String
    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.
    organizationName string
    Name of your Snowflake organization.
    sourceAccountName string
    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_name str
    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.
    organizationName String
    Name of your Snowflake organization.
    sourceAccountName 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 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 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)
    TimeZone 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)
    timeZone 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)
    timeZone 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)
    timeZone 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 snowflake Terraform Provider.
    snowflake logo
    Snowflake v0.52.0 published on Thursday, Apr 18, 2024 by Pulumi
    pulumi/pulumi-snowflake