Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Snowflake Provider
  4. API Docs
  5. getBackupPolicies
Viewing docs for Snowflake v2.23.0
published on Friday, Nov 6, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-snowflake

snowflake.getBackupPolicies

snowflake logo
Viewing docs for Snowflake v2.23.0
published on Friday, Nov 6, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-snowflake

    Caution: Preview Feature This feature is considered a preview feature in the provider, regardless of the state of the resource in Snowflake. We do not guarantee its stability. It will be reworked and marked as a stable feature in future releases. Breaking changes are expected, even without bumping the major version. To use this feature, add the relevant feature name to previewFeaturesEnabled field in the provider configuration. Please always refer to the Getting Help section in our Github repo to best determine how to get help for your questions.

    Data source used to get details of filtered backup policies. Filtering is aligned with the current possibilities for SHOW BACKUP POLICIES query. The results of SHOW and DESCRIBE are encapsulated in one output collection backupPolicies.

    Using getBackupPolicies

    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 getBackupPolicies(args: GetBackupPoliciesArgs, opts?: InvokeOptions): Promise<GetBackupPoliciesResult>
function getBackupPoliciesOutput(args: GetBackupPoliciesOutputArgs, opts?: InvokeOutputOptions): Output<GetBackupPoliciesResult>
    def get_backup_policies(in_: Optional[GetBackupPoliciesIn] = None,
                        like: Optional[str] = None,
                        limit: Optional[GetBackupPoliciesLimit] = None,
                        starts_with: Optional[str] = None,
                        with_describe: Optional[bool] = None,
                        opts: Optional[InvokeOptions] = None) -> GetBackupPoliciesResult
def get_backup_policies_output(in_: pulumi.Input[Optional[GetBackupPoliciesInArgs]] = None,
                        like: pulumi.Input[Optional[str]] = None,
                        limit: pulumi.Input[Optional[GetBackupPoliciesLimitArgs]] = None,
                        starts_with: pulumi.Input[Optional[str]] = None,
                        with_describe: pulumi.Input[Optional[bool]] = None,
                        opts: Optional[InvokeOutputOptions] = None) -> Output[GetBackupPoliciesResult]
    func GetBackupPolicies(ctx *Context, args *GetBackupPoliciesArgs, opts ...InvokeOption) (*GetBackupPoliciesResult, error)
func GetBackupPoliciesOutput(ctx *Context, args *GetBackupPoliciesOutputArgs, opts ...InvokeOption) GetBackupPoliciesResultOutput

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

    public static class GetBackupPolicies 
{
    public static Task<GetBackupPoliciesResult> InvokeAsync(GetBackupPoliciesArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupPoliciesResult> Invoke(GetBackupPoliciesInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupPoliciesResult> Invoke(GetBackupPoliciesInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetBackupPoliciesResult> getBackupPolicies(GetBackupPoliciesArgs args, InvokeOptions options)
public static Output<GetBackupPoliciesResult> getBackupPolicies(GetBackupPoliciesArgs args, InvokeOptions options)
public static Output<GetBackupPoliciesResult> getBackupPolicies(GetBackupPoliciesArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: snowflake:index/getBackupPolicies:getBackupPolicies
  arguments:
    # arguments dictionary
    data "snowflake_get_backup_policies" "name" {
    # arguments
}

    The following arguments are supported:

    In GetBackupPoliciesIn
    IN clause to filter the list of objects
    Like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    Limit GetBackupPoliciesLimit
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with startsWith or like.
    StartsWith string
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    WithDescribe bool
    (Default: true) Runs DESC BACKUP POLICY for each backup policy returned by SHOW BACKUP POLICIES. The output of describe is saved to the describeOutput field. By default this value is set to true.
    In GetBackupPoliciesIn
    IN clause to filter the list of objects
    Like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    Limit GetBackupPoliciesLimit
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with startsWith or like.
    StartsWith string
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    WithDescribe bool
    (Default: true) Runs DESC BACKUP POLICY for each backup policy returned by SHOW BACKUP POLICIES. The output of describe is saved to the describeOutput field. By default this value is set to true.
    in object
    IN clause to filter the list of objects
    like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit object
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with startsWith or like.
    starts_with string
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    with_describe bool
    (Default: true) Runs DESC BACKUP POLICY for each backup policy returned by SHOW BACKUP POLICIES. The output of describe is saved to the describeOutput field. By default this value is set to true.
    in GetBackupPoliciesIn
    IN clause to filter the list of objects
    like String
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit GetBackupPoliciesLimit
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with startsWith or like.
    startsWith String
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    withDescribe Boolean
    (Default: true) Runs DESC BACKUP POLICY for each backup policy returned by SHOW BACKUP POLICIES. The output of describe is saved to the describeOutput field. By default this value is set to true.
    in GetBackupPoliciesIn
    IN clause to filter the list of objects
    like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit GetBackupPoliciesLimit
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with startsWith or like.
    startsWith string
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    withDescribe boolean
    (Default: true) Runs DESC BACKUP POLICY for each backup policy returned by SHOW BACKUP POLICIES. The output of describe is saved to the describeOutput field. By default this value is set to true.
    in_ GetBackupPoliciesIn
    IN clause to filter the list of objects
    like str
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit GetBackupPoliciesLimit
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with startsWith or like.
    starts_with str
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    with_describe bool
    (Default: true) Runs DESC BACKUP POLICY for each backup policy returned by SHOW BACKUP POLICIES. The output of describe is saved to the describeOutput field. By default this value is set to true.
    in Property Map
    IN clause to filter the list of objects
    like String
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit Property Map
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with startsWith or like.
    startsWith String
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    withDescribe Boolean
    (Default: true) Runs DESC BACKUP POLICY for each backup policy returned by SHOW BACKUP POLICIES. The output of describe is saved to the describeOutput field. By default this value is set to true.

    getBackupPolicies Result

    The following output properties are available:

    BackupPolicies List<GetBackupPoliciesBackupPolicy>
    Holds the aggregated output of all backup policy details queries.
    Id string
    The provider-assigned unique ID for this managed resource.
    In GetBackupPoliciesIn
    IN clause to filter the list of objects
    Like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    Limit GetBackupPoliciesLimit
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with startsWith or like.
    StartsWith string
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    WithDescribe bool
    (Default: true) Runs DESC BACKUP POLICY for each backup policy returned by SHOW BACKUP POLICIES. The output of describe is saved to the describeOutput field. By default this value is set to true.
    BackupPolicies []GetBackupPoliciesBackupPolicy
    Holds the aggregated output of all backup policy details queries.
    Id string
    The provider-assigned unique ID for this managed resource.
    In GetBackupPoliciesIn
    IN clause to filter the list of objects
    Like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    Limit GetBackupPoliciesLimit
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with startsWith or like.
    StartsWith string
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    WithDescribe bool
    (Default: true) Runs DESC BACKUP POLICY for each backup policy returned by SHOW BACKUP POLICIES. The output of describe is saved to the describeOutput field. By default this value is set to true.
    backup_policies list(object)
    Holds the aggregated output of all backup policy details queries.
    id string
    The provider-assigned unique ID for this managed resource.
    in object
    IN clause to filter the list of objects
    like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit object
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with startsWith or like.
    starts_with string
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    with_describe bool
    (Default: true) Runs DESC BACKUP POLICY for each backup policy returned by SHOW BACKUP POLICIES. The output of describe is saved to the describeOutput field. By default this value is set to true.
    backupPolicies List<GetBackupPoliciesBackupPolicy>
    Holds the aggregated output of all backup policy details queries.
    id String
    The provider-assigned unique ID for this managed resource.
    in GetBackupPoliciesIn
    IN clause to filter the list of objects
    like String
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit GetBackupPoliciesLimit
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with startsWith or like.
    startsWith String
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    withDescribe Boolean
    (Default: true) Runs DESC BACKUP POLICY for each backup policy returned by SHOW BACKUP POLICIES. The output of describe is saved to the describeOutput field. By default this value is set to true.
    backupPolicies GetBackupPoliciesBackupPolicy[]
    Holds the aggregated output of all backup policy details queries.
    id string
    The provider-assigned unique ID for this managed resource.
    in GetBackupPoliciesIn
    IN clause to filter the list of objects
    like string
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit GetBackupPoliciesLimit
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with startsWith or like.
    startsWith string
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    withDescribe boolean
    (Default: true) Runs DESC BACKUP POLICY for each backup policy returned by SHOW BACKUP POLICIES. The output of describe is saved to the describeOutput field. By default this value is set to true.
    backup_policies Sequence[GetBackupPoliciesBackupPolicy]
    Holds the aggregated output of all backup policy details queries.
    id str
    The provider-assigned unique ID for this managed resource.
    in_ GetBackupPoliciesIn
    IN clause to filter the list of objects
    like str
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit GetBackupPoliciesLimit
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with startsWith or like.
    starts_with str
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    with_describe bool
    (Default: true) Runs DESC BACKUP POLICY for each backup policy returned by SHOW BACKUP POLICIES. The output of describe is saved to the describeOutput field. By default this value is set to true.
    backupPolicies List<Property Map>
    Holds the aggregated output of all backup policy details queries.
    id String
    The provider-assigned unique ID for this managed resource.
    in Property Map
    IN clause to filter the list of objects
    like String
    Filters the output with case-insensitive pattern, with support for SQL wildcard characters (% and _).
    limit Property Map
    Limits the number of rows returned. If the limit.from is set, then the limit will start from the first element matched by the expression. The expression is only used to match with the first element, later on the elements are not matched by the prefix, but you can enforce a certain pattern with startsWith or like.
    startsWith String
    Filters the output with case-sensitive characters indicating the beginning of the object name.
    withDescribe Boolean
    (Default: true) Runs DESC BACKUP POLICY for each backup policy returned by SHOW BACKUP POLICIES. The output of describe is saved to the describeOutput field. By default this value is set to true.

    Supporting Types

    GetBackupPoliciesBackupPolicy

    DescribeOutputs List<GetBackupPoliciesBackupPolicyDescribeOutput>
    Holds the output of DESCRIBE BACKUP POLICY.
    ShowOutputs List<GetBackupPoliciesBackupPolicyShowOutput>
    Holds the output of SHOW BACKUP POLICIES.
    DescribeOutputs []GetBackupPoliciesBackupPolicyDescribeOutput
    Holds the output of DESCRIBE BACKUP POLICY.
    ShowOutputs []GetBackupPoliciesBackupPolicyShowOutput
    Holds the output of SHOW BACKUP POLICIES.
    describe_outputs list(object)
    Holds the output of DESCRIBE BACKUP POLICY.
    show_outputs list(object)
    Holds the output of SHOW BACKUP POLICIES.
    describeOutputs List<GetBackupPoliciesBackupPolicyDescribeOutput>
    Holds the output of DESCRIBE BACKUP POLICY.
    showOutputs List<GetBackupPoliciesBackupPolicyShowOutput>
    Holds the output of SHOW BACKUP POLICIES.
    describeOutputs GetBackupPoliciesBackupPolicyDescribeOutput[]
    Holds the output of DESCRIBE BACKUP POLICY.
    showOutputs GetBackupPoliciesBackupPolicyShowOutput[]
    Holds the output of SHOW BACKUP POLICIES.
    describeOutputs List<Property Map>
    Holds the output of DESCRIBE BACKUP POLICY.
    showOutputs List<Property Map>
    Holds the output of SHOW BACKUP POLICIES.

    GetBackupPoliciesBackupPolicyDescribeOutput

    comment String
    createdOn String
    databaseName String
    expireAfterDays Integer
    hasRetentionLock Boolean
    name String
    owner String
    ownerRoleType String
    schedule String
    schemaName String
    comment string
    createdOn string
    databaseName string
    expireAfterDays number
    hasRetentionLock boolean
    name string
    owner string
    ownerRoleType string
    schedule string
    schemaName string
    comment String
    createdOn String
    databaseName String
    expireAfterDays Number
    hasRetentionLock Boolean
    name String
    owner String
    ownerRoleType String
    schedule String
    schemaName String

    GetBackupPoliciesBackupPolicyShowOutput

    comment String
    createdOn String
    databaseName String
    expireAfterDays Integer
    hasRetentionLock Boolean
    name String
    owner String
    ownerRoleType String
    schedule String
    schemaName String
    comment string
    createdOn string
    databaseName string
    expireAfterDays number
    hasRetentionLock boolean
    name string
    owner string
    ownerRoleType string
    schedule string
    schemaName string
    comment String
    createdOn String
    databaseName String
    expireAfterDays Number
    hasRetentionLock Boolean
    name String
    owner String
    ownerRoleType String
    schedule String
    schemaName String

    GetBackupPoliciesIn

    Account bool
    Returns records for the entire account.
    Database string
    Returns records for the current database in use or for a specified database.
    Schema string
    Returns records for the current schema in use or a specified schema. Use fully qualified name.
    Account bool
    Returns records for the entire account.
    Database string
    Returns records for the current database in use or for a specified database.
    Schema string
    Returns records for the current schema in use or a specified schema. Use fully qualified name.
    account bool
    Returns records for the entire account.
    database string
    Returns records for the current database in use or for a specified database.
    schema string
    Returns records for the current schema in use or a specified schema. Use fully qualified name.
    account Boolean
    Returns records for the entire account.
    database String
    Returns records for the current database in use or for a specified database.
    schema String
    Returns records for the current schema in use or a specified schema. Use fully qualified name.
    account boolean
    Returns records for the entire account.
    database string
    Returns records for the current database in use or for a specified database.
    schema string
    Returns records for the current schema in use or a specified schema. Use fully qualified name.
    account bool
    Returns records for the entire account.
    database str
    Returns records for the current database in use or for a specified database.
    schema str
    Returns records for the current schema in use or a specified schema. Use fully qualified name.
    account Boolean
    Returns records for the entire account.
    database String
    Returns records for the current database in use or for a specified database.
    schema String
    Returns records for the current schema in use or a specified schema. Use fully qualified name.

    GetBackupPoliciesLimit

    Rows int
    The maximum number of rows to return.
    From string
    Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.
    Rows int
    The maximum number of rows to return.
    From string
    Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.
    rows number
    The maximum number of rows to return.
    from string
    Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.
    rows Integer
    The maximum number of rows to return.
    from String
    Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.
    rows number
    The maximum number of rows to return.
    from string
    Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.
    rows int
    The maximum number of rows to return.
    from_ str
    Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.
    rows Number
    The maximum number of rows to return.
    from String
    Specifies a case-sensitive pattern that is used to match object name. After the first match, the limit on the number of rows will be applied.

    Package Details

    Repository
    Snowflake pulumi/pulumi-snowflake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the snowflake Terraform Provider.
    snowflake logo
    Viewing docs for Snowflake v2.23.0
    published on Friday, Nov 6, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-snowflake

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial