import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Provides details about an AWS RDS (Relational Database) Snapshots. * * ## Example Usage * * ### Basic Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = aws.rds.getSnapshots({ * dbInstanceIdentifier: "my-db-instance", * }); * ``` * * ### Filter by Snapshot ID * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = aws.rds.getSnapshots({ * filters: [{ * name: "db-snapshot-id", * values: ["my-snapshot-id"], * }], * }); * ``` */ export declare function getSnapshots(args?: GetSnapshotsArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getSnapshots. */ export interface GetSnapshotsArgs { /** * Returns the list of snapshots created by the specific db_instance. */ dbInstanceIdentifier?: string; /** * Returns information on a specific snapshot_id. */ dbSnapshotIdentifier?: string; /** * Configuration block(s) used to filter snapshots with AWS supported attributes. Detailed below. */ filters?: inputs.rds.GetSnapshotsFilter[]; /** * Set this value to `true` to include manual DB snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to `false`. The default is `false`. */ includePublic?: boolean; /** * Set this value to `true` to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to `false`. The default is `false`. */ includeShared?: boolean; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: string; /** * Type of snapshots to be returned. If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. Possible values are `automated`, `manual`, `shared`, `public` and `awsbackup`. */ snapshotType?: string; } /** * A collection of values returned by getSnapshots. */ export interface GetSnapshotsResult { /** * Identifier of the DB instance from which the snapshot was taken. */ readonly dbInstanceIdentifier?: string; /** * Identifier of the DB snapshot. */ readonly dbSnapshotIdentifier?: string; readonly filters?: outputs.rds.GetSnapshotsFilter[]; readonly includePublic?: boolean; readonly includeShared?: boolean; readonly region: string; /** * Type of the DB snapshot. */ readonly snapshotType?: string; /** * List of snapshots. */ readonly snapshots: outputs.rds.GetSnapshotsSnapshot[]; } /** * Provides details about an AWS RDS (Relational Database) Snapshots. * * ## Example Usage * * ### Basic Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = aws.rds.getSnapshots({ * dbInstanceIdentifier: "my-db-instance", * }); * ``` * * ### Filter by Snapshot ID * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = aws.rds.getSnapshots({ * filters: [{ * name: "db-snapshot-id", * values: ["my-snapshot-id"], * }], * }); * ``` */ export declare function getSnapshotsOutput(args?: GetSnapshotsOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getSnapshots. */ export interface GetSnapshotsOutputArgs { /** * Returns the list of snapshots created by the specific db_instance. */ dbInstanceIdentifier?: pulumi.Input; /** * Returns information on a specific snapshot_id. */ dbSnapshotIdentifier?: pulumi.Input; /** * Configuration block(s) used to filter snapshots with AWS supported attributes. Detailed below. */ filters?: pulumi.Input[] | undefined>; /** * Set this value to `true` to include manual DB snapshots that are public and can be copied or restored by any AWS account, otherwise set this value to `false`. The default is `false`. */ includePublic?: pulumi.Input; /** * Set this value to `true` to include shared manual DB snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to `false`. The default is `false`. */ includeShared?: pulumi.Input; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input; /** * Type of snapshots to be returned. If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. Possible values are `automated`, `manual`, `shared`, `public` and `awsbackup`. */ snapshotType?: pulumi.Input; } //# sourceMappingURL=getSnapshots.d.ts.map