getSnapshots function

Future<GetSnapshotsResult> getSnapshots(
  1. GetSnapshotsArgs args, {
  2. InvokeOptions? options,
})

Provides details about an AWS RDS (Relational Database) Snapshots.

Example Usage

Basic Usage

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

const example = aws.rds.getSnapshots({
    dbInstanceIdentifier: "my-db-instance",
});
import pulumi
import pulumi_aws as aws

example = aws.rds.get_snapshots(db_instance_identifier="my-db-instance")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = Aws.Rds.GetSnapshots.Invoke(new()
    {
        DbInstanceIdentifier = "my-db-instance",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds.GetSnapshots(ctx, &rds.GetSnapshotsArgs{
			DbInstanceIdentifier: pulumi.StringRef("my-db-instance"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_rds_getsnapshots" "example" {
  db_instance_identifier = "my-db-instance"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.RdsFunctions;
import com.pulumi.aws.rds.inputs.GetSnapshotsArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        final var example = RdsFunctions.getSnapshots(GetSnapshotsArgs.builder()
            .dbInstanceIdentifier("my-db-instance")
            .build());

    }
}
variables:
  example:
    fn::invoke:
      function: aws:rds:getSnapshots
      arguments:
        dbInstanceIdentifier: my-db-instance

Filter by Snapshot ID

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"],
    }],
});
import pulumi
import pulumi_aws as aws

example = aws.rds.get_snapshots(filters=[{
    "name": "db-snapshot-id",
    "values": ["my-snapshot-id"],
}])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = Aws.Rds.GetSnapshots.Invoke(new()
    {
        Filters = new[]
        {
            new Aws.Rds.Inputs.GetSnapshotsFilterInputArgs
            {
                Name = "db-snapshot-id",
                Values = new[]
                {
                    "my-snapshot-id",
                },
            },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds.GetSnapshots(ctx, &rds.GetSnapshotsArgs{
			Filters: []rds.GetSnapshotsFilter{
				{
					Name: "db-snapshot-id",
					Values: []string{
						"my-snapshot-id",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_rds_getsnapshots" "example" {
  filters {
    name   = "db-snapshot-id"
    values = ["my-snapshot-id"]
  }
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.RdsFunctions;
import com.pulumi.aws.rds.inputs.GetSnapshotsArgs;
import com.pulumi.aws.rds.inputs.GetSnapshotsFilterArgs;
import java.util.ArrayList;
import java.util.Arrays;
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) {
        final var example = RdsFunctions.getSnapshots(GetSnapshotsArgs.builder()
            .filters(GetSnapshotsFilterArgs.builder()
                .name("db-snapshot-id")
                .values("my-snapshot-id")
                .build())
            .build());

    }
}
variables:
  example:
    fn::invoke:
      function: aws:rds:getSnapshots
      arguments:
        filters:
          - name: db-snapshot-id
            values:
              - my-snapshot-id

args Arguments passed to this invoke. Arguments for getSnapshots. options Invoke options controlling this call.

Implementation

Future<GetSnapshotsResult> getSnapshots(
  GetSnapshotsArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'aws:rds/getSnapshots:getSnapshots',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetSnapshotsResult.fromMap(result);
}