snowflake.getPostgresMirrors

Snowflake v2.23.0, Nov 6 26

Viewing docs for Snowflake v2.23.0
published on Friday, Nov 6, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-snowflake

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.

Note LIST_MIRRORS returns only the mirrors on Postgres instances that the role used by the provider owns. For an instance owned by another role, the data source returns no mirrors.

Note When the source Postgres instance cannot be reached, DESCRIBE_MIRROR returns no tables or schemas, so describeOutput shows empty postgresTables and postgresSchemas, and the data source reports a warning.

Data source used to get details of filtered Postgres mirrors. Filtering is aligned with the current possibilities for the LIST_MIRRORS procedure. The results of LIST_MIRRORS and DESCRIBE_MIRROR are encapsulated in one output collection postgresMirrors.

Using getPostgresMirrors

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 getPostgresMirrors(args: GetPostgresMirrorsArgs, opts?: InvokeOptions): Promise<GetPostgresMirrorsResult>
function getPostgresMirrorsOutput(args: GetPostgresMirrorsOutputArgs, opts?: InvokeOutputOptions): Output<GetPostgresMirrorsResult>

def get_postgres_mirrors(postgres_instance: Optional[str] = None,
                         with_describe: Optional[bool] = None,
                         opts: Optional[InvokeOptions] = None) -> GetPostgresMirrorsResult
def get_postgres_mirrors_output(postgres_instance: pulumi.Input[Optional[str]] = None,
                         with_describe: pulumi.Input[Optional[bool]] = None,
                         opts: Optional[InvokeOutputOptions] = None) -> Output[GetPostgresMirrorsResult]

func GetPostgresMirrors(ctx *Context, args *GetPostgresMirrorsArgs, opts ...InvokeOption) (*GetPostgresMirrorsResult, error)
func GetPostgresMirrorsOutput(ctx *Context, args *GetPostgresMirrorsOutputArgs, opts ...InvokeOption) GetPostgresMirrorsResultOutput

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

public static class GetPostgresMirrors 
{
    public static Task<GetPostgresMirrorsResult> InvokeAsync(GetPostgresMirrorsArgs args, InvokeOptions? opts = null)
    public static Output<GetPostgresMirrorsResult> Invoke(GetPostgresMirrorsInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetPostgresMirrorsResult> Invoke(GetPostgresMirrorsInvokeArgs args, InvokeOutputOptions opts)
}

public static CompletableFuture<GetPostgresMirrorsResult> getPostgresMirrors(GetPostgresMirrorsArgs args, InvokeOptions options)
public static Output<GetPostgresMirrorsResult> getPostgresMirrors(GetPostgresMirrorsArgs args, InvokeOptions options)
public static Output<GetPostgresMirrorsResult> getPostgresMirrors(GetPostgresMirrorsArgs args, InvokeOutputOptions options)

fn::invoke:
  function: snowflake:index/getPostgresMirrors:getPostgresMirrors
  arguments:
    # arguments dictionary

data "snowflake_get_postgres_mirrors" "name" {
    # arguments
}

The following arguments are supported:

PostgresInstance string: Lists only the mirrors that replicate from this Postgres instance. The name is case-sensitive. A quoted identifier, such as the instance's fullyQualifiedName, is also accepted.
WithDescribe bool: (Default: true) Runs DESCRIBEMIRROR for each mirror returned by LISTMIRRORS. The output of describe is saved to the describeOutput field. By default this value is set to true.

PostgresInstance string: Lists only the mirrors that replicate from this Postgres instance. The name is case-sensitive. A quoted identifier, such as the instance's fullyQualifiedName, is also accepted.
WithDescribe bool: (Default: true) Runs DESCRIBEMIRROR for each mirror returned by LISTMIRRORS. The output of describe is saved to the describeOutput field. By default this value is set to true.

postgres_instance string: Lists only the mirrors that replicate from this Postgres instance. The name is case-sensitive. A quoted identifier, such as the instance's fullyQualifiedName, is also accepted.
with_describe bool: (Default: true) Runs DESCRIBEMIRROR for each mirror returned by LISTMIRRORS. The output of describe is saved to the describeOutput field. By default this value is set to true.

postgresInstance String: Lists only the mirrors that replicate from this Postgres instance. The name is case-sensitive. A quoted identifier, such as the instance's fullyQualifiedName, is also accepted.
withDescribe Boolean: (Default: true) Runs DESCRIBEMIRROR for each mirror returned by LISTMIRRORS. The output of describe is saved to the describeOutput field. By default this value is set to true.

postgresInstance string: Lists only the mirrors that replicate from this Postgres instance. The name is case-sensitive. A quoted identifier, such as the instance's fullyQualifiedName, is also accepted.
withDescribe boolean: (Default: true) Runs DESCRIBEMIRROR for each mirror returned by LISTMIRRORS. The output of describe is saved to the describeOutput field. By default this value is set to true.

postgres_instance str: Lists only the mirrors that replicate from this Postgres instance. The name is case-sensitive. A quoted identifier, such as the instance's fullyQualifiedName, is also accepted.
with_describe bool: (Default: true) Runs DESCRIBEMIRROR for each mirror returned by LISTMIRRORS. The output of describe is saved to the describeOutput field. By default this value is set to true.

postgresInstance String: Lists only the mirrors that replicate from this Postgres instance. The name is case-sensitive. A quoted identifier, such as the instance's fullyQualifiedName, is also accepted.
withDescribe Boolean: (Default: true) Runs DESCRIBEMIRROR for each mirror returned by LISTMIRRORS. The output of describe is saved to the describeOutput field. By default this value is set to true.

getPostgresMirrors Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
PostgresMirrors List<GetPostgresMirrorsPostgresMirror>: Holds the aggregated output of all Postgres mirror details queries.
PostgresInstance string: Lists only the mirrors that replicate from this Postgres instance. The name is case-sensitive. A quoted identifier, such as the instance's fullyQualifiedName, is also accepted.
WithDescribe bool: (Default: true) Runs DESCRIBEMIRROR for each mirror returned by LISTMIRRORS. The output of describe is saved to the describeOutput field. By default this value is set to true.

Id string: The provider-assigned unique ID for this managed resource.
PostgresMirrors []GetPostgresMirrorsPostgresMirror: Holds the aggregated output of all Postgres mirror details queries.
PostgresInstance string: Lists only the mirrors that replicate from this Postgres instance. The name is case-sensitive. A quoted identifier, such as the instance's fullyQualifiedName, is also accepted.
WithDescribe bool: (Default: true) Runs DESCRIBEMIRROR for each mirror returned by LISTMIRRORS. The output of describe is saved to the describeOutput field. By default this value is set to true.

id string: The provider-assigned unique ID for this managed resource.
postgres_mirrors list(object): Holds the aggregated output of all Postgres mirror details queries.
postgres_instance string: Lists only the mirrors that replicate from this Postgres instance. The name is case-sensitive. A quoted identifier, such as the instance's fullyQualifiedName, is also accepted.
with_describe bool: (Default: true) Runs DESCRIBEMIRROR for each mirror returned by LISTMIRRORS. The output of describe is saved to the describeOutput field. By default this value is set to true.

id String: The provider-assigned unique ID for this managed resource.
postgresMirrors List<GetPostgresMirrorsPostgresMirror>: Holds the aggregated output of all Postgres mirror details queries.
postgresInstance String: Lists only the mirrors that replicate from this Postgres instance. The name is case-sensitive. A quoted identifier, such as the instance's fullyQualifiedName, is also accepted.
withDescribe Boolean: (Default: true) Runs DESCRIBEMIRROR for each mirror returned by LISTMIRRORS. The output of describe is saved to the describeOutput field. By default this value is set to true.

id string: The provider-assigned unique ID for this managed resource.
postgresMirrors GetPostgresMirrorsPostgresMirror[]: Holds the aggregated output of all Postgres mirror details queries.
postgresInstance string: Lists only the mirrors that replicate from this Postgres instance. The name is case-sensitive. A quoted identifier, such as the instance's fullyQualifiedName, is also accepted.
withDescribe boolean: (Default: true) Runs DESCRIBEMIRROR for each mirror returned by LISTMIRRORS. The output of describe is saved to the describeOutput field. By default this value is set to true.

id str: The provider-assigned unique ID for this managed resource.
postgres_mirrors Sequence[GetPostgresMirrorsPostgresMirror]: Holds the aggregated output of all Postgres mirror details queries.
postgres_instance str: Lists only the mirrors that replicate from this Postgres instance. The name is case-sensitive. A quoted identifier, such as the instance's fullyQualifiedName, is also accepted.
with_describe bool: (Default: true) Runs DESCRIBEMIRROR for each mirror returned by LISTMIRRORS. The output of describe is saved to the describeOutput field. By default this value is set to true.

id String: The provider-assigned unique ID for this managed resource.
postgresMirrors List<Property Map>: Holds the aggregated output of all Postgres mirror details queries.
postgresInstance String: Lists only the mirrors that replicate from this Postgres instance. The name is case-sensitive. A quoted identifier, such as the instance's fullyQualifiedName, is also accepted.
withDescribe Boolean: (Default: true) Runs DESCRIBEMIRROR for each mirror returned by LISTMIRRORS. The output of describe is saved to the describeOutput field. By default this value is set to true.