1. Packages
  2. Snowflake
  3. API Docs
  4. getFailoverGroups
Snowflake v0.55.0 published on Friday, Jun 7, 2024 by Pulumi

snowflake.getFailoverGroups

Explore with Pulumi AI

snowflake logo
Snowflake v0.55.0 published on Friday, Jun 7, 2024 by Pulumi

    Using getFailoverGroups

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getFailoverGroups(args: GetFailoverGroupsArgs, opts?: InvokeOptions): Promise<GetFailoverGroupsResult>
    function getFailoverGroupsOutput(args: GetFailoverGroupsOutputArgs, opts?: InvokeOptions): Output<GetFailoverGroupsResult>
    def get_failover_groups(in_account: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetFailoverGroupsResult
    def get_failover_groups_output(in_account: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetFailoverGroupsResult]
    func GetFailoverGroups(ctx *Context, args *GetFailoverGroupsArgs, opts ...InvokeOption) (*GetFailoverGroupsResult, error)
    func GetFailoverGroupsOutput(ctx *Context, args *GetFailoverGroupsOutputArgs, opts ...InvokeOption) GetFailoverGroupsResultOutput

    > Note: This function is named GetFailoverGroups in the Go SDK.

    public static class GetFailoverGroups 
    {
        public static Task<GetFailoverGroupsResult> InvokeAsync(GetFailoverGroupsArgs args, InvokeOptions? opts = null)
        public static Output<GetFailoverGroupsResult> Invoke(GetFailoverGroupsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetFailoverGroupsResult> getFailoverGroups(GetFailoverGroupsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: snowflake:index/getFailoverGroups:getFailoverGroups
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InAccount string
    Specifies the identifier for the account
    InAccount string
    Specifies the identifier for the account
    inAccount String
    Specifies the identifier for the account
    inAccount string
    Specifies the identifier for the account
    in_account str
    Specifies the identifier for the account
    inAccount String
    Specifies the identifier for the account

    getFailoverGroups Result

    The following output properties are available:

    FailoverGroups List<GetFailoverGroupsFailoverGroup>
    List of all the failover groups available in the system.
    Id string
    The provider-assigned unique ID for this managed resource.
    InAccount string
    Specifies the identifier for the account
    FailoverGroups []GetFailoverGroupsFailoverGroup
    List of all the failover groups available in the system.
    Id string
    The provider-assigned unique ID for this managed resource.
    InAccount string
    Specifies the identifier for the account
    failoverGroups List<GetFailoverGroupsFailoverGroup>
    List of all the failover groups available in the system.
    id String
    The provider-assigned unique ID for this managed resource.
    inAccount String
    Specifies the identifier for the account
    failoverGroups GetFailoverGroupsFailoverGroup[]
    List of all the failover groups available in the system.
    id string
    The provider-assigned unique ID for this managed resource.
    inAccount string
    Specifies the identifier for the account
    failover_groups Sequence[GetFailoverGroupsFailoverGroup]
    List of all the failover groups available in the system.
    id str
    The provider-assigned unique ID for this managed resource.
    in_account str
    Specifies the identifier for the account
    failoverGroups List<Property Map>
    List of all the failover groups available in the system.
    id String
    The provider-assigned unique ID for this managed resource.
    inAccount String
    Specifies the identifier for the account

    Supporting Types

    GetFailoverGroupsFailoverGroup

    AccountLocator string
    Account locator in a region.
    AccountName string
    Name of the account.
    AllowedAccounts List<object>
    List of accounts enabled for replication and failover.
    AllowedIntegrationTypes List<object>
    A list of integration types that are enabled for replication.
    Comment string
    Comment string.
    CreatedOn string
    Date and time failover group was created.
    IsPrimary bool
    Indicates whether the failover group is the primary group.
    NextScheduledRefresh string
    Date and time of the next scheduled refresh.
    ObjectTypes List<object>
    List of specified object types enabled for replication and failover.
    OrganizationName string
    Name of your Snowflake organization.
    Owner string
    Name of the role with the OWNERSHIP privilege on the failover group. NULL if the failover group is in a different region.
    Primary string
    Name of the primary group.
    RegionGroup string
    Region group where the account is located. Note: this column is only visible to organizations that span multiple Region Groups.
    ReplicationSchedule string
    Scheduled interval for refresh; NULL if no replication schedule is set.
    SecondaryState string
    Current state of scheduled refresh. Valid values are started or suspended. NULL if no replication schedule is set.
    SnowflakeRegion string
    Snowflake Region where the account is located. A Snowflake Region is a distinct location within a cloud platform region that is isolated from other Snowflake Regions. A Snowflake Region can be either multi-tenant or single-tenant (for a Virtual Private Snowflake account).
    Type string
    Type of group. Valid value is FAILOVER.
    AccountLocator string
    Account locator in a region.
    AccountName string
    Name of the account.
    AllowedAccounts []interface{}
    List of accounts enabled for replication and failover.
    AllowedIntegrationTypes []interface{}
    A list of integration types that are enabled for replication.
    Comment string
    Comment string.
    CreatedOn string
    Date and time failover group was created.
    IsPrimary bool
    Indicates whether the failover group is the primary group.
    NextScheduledRefresh string
    Date and time of the next scheduled refresh.
    ObjectTypes []interface{}
    List of specified object types enabled for replication and failover.
    OrganizationName string
    Name of your Snowflake organization.
    Owner string
    Name of the role with the OWNERSHIP privilege on the failover group. NULL if the failover group is in a different region.
    Primary string
    Name of the primary group.
    RegionGroup string
    Region group where the account is located. Note: this column is only visible to organizations that span multiple Region Groups.
    ReplicationSchedule string
    Scheduled interval for refresh; NULL if no replication schedule is set.
    SecondaryState string
    Current state of scheduled refresh. Valid values are started or suspended. NULL if no replication schedule is set.
    SnowflakeRegion string
    Snowflake Region where the account is located. A Snowflake Region is a distinct location within a cloud platform region that is isolated from other Snowflake Regions. A Snowflake Region can be either multi-tenant or single-tenant (for a Virtual Private Snowflake account).
    Type string
    Type of group. Valid value is FAILOVER.
    accountLocator String
    Account locator in a region.
    accountName String
    Name of the account.
    allowedAccounts List<Object>
    List of accounts enabled for replication and failover.
    allowedIntegrationTypes List<Object>
    A list of integration types that are enabled for replication.
    comment String
    Comment string.
    createdOn String
    Date and time failover group was created.
    isPrimary Boolean
    Indicates whether the failover group is the primary group.
    nextScheduledRefresh String
    Date and time of the next scheduled refresh.
    objectTypes List<Object>
    List of specified object types enabled for replication and failover.
    organizationName String
    Name of your Snowflake organization.
    owner String
    Name of the role with the OWNERSHIP privilege on the failover group. NULL if the failover group is in a different region.
    primary String
    Name of the primary group.
    regionGroup String
    Region group where the account is located. Note: this column is only visible to organizations that span multiple Region Groups.
    replicationSchedule String
    Scheduled interval for refresh; NULL if no replication schedule is set.
    secondaryState String
    Current state of scheduled refresh. Valid values are started or suspended. NULL if no replication schedule is set.
    snowflakeRegion String
    Snowflake Region where the account is located. A Snowflake Region is a distinct location within a cloud platform region that is isolated from other Snowflake Regions. A Snowflake Region can be either multi-tenant or single-tenant (for a Virtual Private Snowflake account).
    type String
    Type of group. Valid value is FAILOVER.
    accountLocator string
    Account locator in a region.
    accountName string
    Name of the account.
    allowedAccounts any[]
    List of accounts enabled for replication and failover.
    allowedIntegrationTypes any[]
    A list of integration types that are enabled for replication.
    comment string
    Comment string.
    createdOn string
    Date and time failover group was created.
    isPrimary boolean
    Indicates whether the failover group is the primary group.
    nextScheduledRefresh string
    Date and time of the next scheduled refresh.
    objectTypes any[]
    List of specified object types enabled for replication and failover.
    organizationName string
    Name of your Snowflake organization.
    owner string
    Name of the role with the OWNERSHIP privilege on the failover group. NULL if the failover group is in a different region.
    primary string
    Name of the primary group.
    regionGroup string
    Region group where the account is located. Note: this column is only visible to organizations that span multiple Region Groups.
    replicationSchedule string
    Scheduled interval for refresh; NULL if no replication schedule is set.
    secondaryState string
    Current state of scheduled refresh. Valid values are started or suspended. NULL if no replication schedule is set.
    snowflakeRegion string
    Snowflake Region where the account is located. A Snowflake Region is a distinct location within a cloud platform region that is isolated from other Snowflake Regions. A Snowflake Region can be either multi-tenant or single-tenant (for a Virtual Private Snowflake account).
    type string
    Type of group. Valid value is FAILOVER.
    account_locator str
    Account locator in a region.
    account_name str
    Name of the account.
    allowed_accounts Sequence[Any]
    List of accounts enabled for replication and failover.
    allowed_integration_types Sequence[Any]
    A list of integration types that are enabled for replication.
    comment str
    Comment string.
    created_on str
    Date and time failover group was created.
    is_primary bool
    Indicates whether the failover group is the primary group.
    next_scheduled_refresh str
    Date and time of the next scheduled refresh.
    object_types Sequence[Any]
    List of specified object types enabled for replication and failover.
    organization_name str
    Name of your Snowflake organization.
    owner str
    Name of the role with the OWNERSHIP privilege on the failover group. NULL if the failover group is in a different region.
    primary str
    Name of the primary group.
    region_group str
    Region group where the account is located. Note: this column is only visible to organizations that span multiple Region Groups.
    replication_schedule str
    Scheduled interval for refresh; NULL if no replication schedule is set.
    secondary_state str
    Current state of scheduled refresh. Valid values are started or suspended. NULL if no replication schedule is set.
    snowflake_region str
    Snowflake Region where the account is located. A Snowflake Region is a distinct location within a cloud platform region that is isolated from other Snowflake Regions. A Snowflake Region can be either multi-tenant or single-tenant (for a Virtual Private Snowflake account).
    type str
    Type of group. Valid value is FAILOVER.
    accountLocator String
    Account locator in a region.
    accountName String
    Name of the account.
    allowedAccounts List<Any>
    List of accounts enabled for replication and failover.
    allowedIntegrationTypes List<Any>
    A list of integration types that are enabled for replication.
    comment String
    Comment string.
    createdOn String
    Date and time failover group was created.
    isPrimary Boolean
    Indicates whether the failover group is the primary group.
    nextScheduledRefresh String
    Date and time of the next scheduled refresh.
    objectTypes List<Any>
    List of specified object types enabled for replication and failover.
    organizationName String
    Name of your Snowflake organization.
    owner String
    Name of the role with the OWNERSHIP privilege on the failover group. NULL if the failover group is in a different region.
    primary String
    Name of the primary group.
    regionGroup String
    Region group where the account is located. Note: this column is only visible to organizations that span multiple Region Groups.
    replicationSchedule String
    Scheduled interval for refresh; NULL if no replication schedule is set.
    secondaryState String
    Current state of scheduled refresh. Valid values are started or suspended. NULL if no replication schedule is set.
    snowflakeRegion String
    Snowflake Region where the account is located. A Snowflake Region is a distinct location within a cloud platform region that is isolated from other Snowflake Regions. A Snowflake Region can be either multi-tenant or single-tenant (for a Virtual Private Snowflake account).
    type String
    Type of group. Valid value is FAILOVER.

    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.55.0 published on Friday, Jun 7, 2024 by Pulumi