getBackups

AWS v7.24.0, Mar 31 26

Viewing docs for AWS v7.24.0
published on Tuesday, Mar 31, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws

Viewing docs for AWS v7.24.0
published on Tuesday, Mar 31, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws

Example Usage

Basic Usage

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

const example = aws.dynamodb.getBackups({
    tableName: "my-table",
});

import pulumi
import pulumi_aws as aws

example = aws.dynamodb.get_backups(table_name="my-table")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dynamodb.GetBackups(ctx, &dynamodb.GetBackupsArgs{
			TableName: pulumi.StringRef("my-table"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.DynamoDB.GetBackups.Invoke(new()
    {
        TableName = "my-table",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.dynamodb.DynamodbFunctions;
import com.pulumi.aws.dynamodb.inputs.GetBackupsArgs;
import java.util.List;
import java.util.ArrayList;
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 = DynamodbFunctions.getBackups(GetBackupsArgs.builder()
            .tableName("my-table")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: aws:dynamodb:getBackups
      arguments:
        tableName: my-table

Using getBackups

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 getBackups(args: GetBackupsArgs, opts?: InvokeOptions): Promise<GetBackupsResult>
function getBackupsOutput(args: GetBackupsOutputArgs, opts?: InvokeOptions): Output<GetBackupsResult>

def get_backups(backup_type: Optional[str] = None,
                region: Optional[str] = None,
                table_name: Optional[str] = None,
                time_range_lower_bound: Optional[str] = None,
                time_range_upper_bound: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetBackupsResult
def get_backups_output(backup_type: Optional[pulumi.Input[str]] = None,
                region: Optional[pulumi.Input[str]] = None,
                table_name: Optional[pulumi.Input[str]] = None,
                time_range_lower_bound: Optional[pulumi.Input[str]] = None,
                time_range_upper_bound: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetBackupsResult]

func GetBackups(ctx *Context, args *GetBackupsArgs, opts ...InvokeOption) (*GetBackupsResult, error)
func GetBackupsOutput(ctx *Context, args *GetBackupsOutputArgs, opts ...InvokeOption) GetBackupsResultOutput

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

public static class GetBackups 
{
    public static Task<GetBackupsResult> InvokeAsync(GetBackupsArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupsResult> Invoke(GetBackupsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetBackupsResult> getBackups(GetBackupsArgs args, InvokeOptions options)
public static Output<GetBackupsResult> getBackups(GetBackupsArgs args, InvokeOptions options)

fn::invoke:
  function: aws:dynamodb/getBackups:getBackups
  arguments:
    # arguments dictionary

The following arguments are supported:

BackupType string: Backup type. Valid values: USER, SYSTEM, AWS_BACKUP, ALL.
Region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
TableName string: Name of the table to list backups for.
TimeRangeLowerBound string: Only backups created after this time are listed. Time must be in RFC3339 format.
TimeRangeUpperBound string: Only backups created before this time are listed. Time must be in RFC3339 format.

BackupType string: Backup type. Valid values: USER, SYSTEM, AWS_BACKUP, ALL.
Region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
TableName string: Name of the table to list backups for.
TimeRangeLowerBound string: Only backups created after this time are listed. Time must be in RFC3339 format.
TimeRangeUpperBound string: Only backups created before this time are listed. Time must be in RFC3339 format.

backupType String: Backup type. Valid values: USER, SYSTEM, AWS_BACKUP, ALL.
region String: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tableName String: Name of the table to list backups for.
timeRangeLowerBound String: Only backups created after this time are listed. Time must be in RFC3339 format.
timeRangeUpperBound String: Only backups created before this time are listed. Time must be in RFC3339 format.

backupType string: Backup type. Valid values: USER, SYSTEM, AWS_BACKUP, ALL.
region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tableName string: Name of the table to list backups for.
timeRangeLowerBound string: Only backups created after this time are listed. Time must be in RFC3339 format.
timeRangeUpperBound string: Only backups created before this time are listed. Time must be in RFC3339 format.

backup_type str: Backup type. Valid values: USER, SYSTEM, AWS_BACKUP, ALL.
region str: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
table_name str: Name of the table to list backups for.
time_range_lower_bound str: Only backups created after this time are listed. Time must be in RFC3339 format.
time_range_upper_bound str: Only backups created before this time are listed. Time must be in RFC3339 format.

backupType String: Backup type. Valid values: USER, SYSTEM, AWS_BACKUP, ALL.
region String: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tableName String: Name of the table to list backups for.
timeRangeLowerBound String: Only backups created after this time are listed. Time must be in RFC3339 format.
timeRangeUpperBound String: Only backups created before this time are listed. Time must be in RFC3339 format.

getBackups Result

The following output properties are available:

BackupSummaries List<GetBackupsBackupSummary>: List of backups. See below.
Id string: The provider-assigned unique ID for this managed resource.
Region string
BackupType string: BackupType: USER, SYSTEM, AWS_BACKUP.
TableName string: Name of the table.
TimeRangeLowerBound string
TimeRangeUpperBound string

BackupSummaries []GetBackupsBackupSummary: List of backups. See below.
Id string: The provider-assigned unique ID for this managed resource.
Region string
BackupType string: BackupType: USER, SYSTEM, AWS_BACKUP.
TableName string: Name of the table.
TimeRangeLowerBound string
TimeRangeUpperBound string

backupSummaries List<GetBackupsBackupSummary>: List of backups. See below.
id String: The provider-assigned unique ID for this managed resource.
region String
backupType String: BackupType: USER, SYSTEM, AWS_BACKUP.
tableName String: Name of the table.
timeRangeLowerBound String
timeRangeUpperBound String

backupSummaries GetBackupsBackupSummary[]: List of backups. See below.
id string: The provider-assigned unique ID for this managed resource.
region string
backupType string: BackupType: USER, SYSTEM, AWS_BACKUP.
tableName string: Name of the table.
timeRangeLowerBound string
timeRangeUpperBound string

backup_summaries Sequence[GetBackupsBackupSummary]: List of backups. See below.
id str: The provider-assigned unique ID for this managed resource.
region str
backup_type str: BackupType: USER, SYSTEM, AWS_BACKUP.
table_name str: Name of the table.
time_range_lower_bound str
time_range_upper_bound str

backupSummaries List<Property Map>: List of backups. See below.
id String: The provider-assigned unique ID for this managed resource.
region String
backupType String: BackupType: USER, SYSTEM, AWS_BACKUP.
tableName String: Name of the table.
timeRangeLowerBound String
timeRangeUpperBound String

Supporting Types

GetBackupsBackupSummary

BackupArn string: ARN of the backup.
BackupCreationDateTime string: Time at which the backup was created.
BackupExpiryDateTime string: Time at which the automatic on-demand backup created by DynamoDB will expire.
BackupName string: Name of the specified backup.
BackupSizeBytes int: Size of the backup in bytes.
BackupStatus string: Backup can be in one of the following states: CREATING, DELETED, AVAILABLE.
BackupType string: Backup type. Valid values: USER, SYSTEM, AWS_BACKUP, ALL.
TableArn string: ARN associated with the table.
TableId string: Unique identifier for the table.
TableName string: Name of the table to list backups for.

BackupArn string: ARN of the backup.
BackupCreationDateTime string: Time at which the backup was created.
BackupExpiryDateTime string: Time at which the automatic on-demand backup created by DynamoDB will expire.
BackupName string: Name of the specified backup.
BackupSizeBytes int: Size of the backup in bytes.
BackupStatus string: Backup can be in one of the following states: CREATING, DELETED, AVAILABLE.
BackupType string: Backup type. Valid values: USER, SYSTEM, AWS_BACKUP, ALL.
TableArn string: ARN associated with the table.
TableId string: Unique identifier for the table.
TableName string: Name of the table to list backups for.

backupArn String: ARN of the backup.
backupCreationDateTime String: Time at which the backup was created.
backupExpiryDateTime String: Time at which the automatic on-demand backup created by DynamoDB will expire.
backupName String: Name of the specified backup.
backupSizeBytes Integer: Size of the backup in bytes.
backupStatus String: Backup can be in one of the following states: CREATING, DELETED, AVAILABLE.
backupType String: Backup type. Valid values: USER, SYSTEM, AWS_BACKUP, ALL.
tableArn String: ARN associated with the table.
tableId String: Unique identifier for the table.
tableName String: Name of the table to list backups for.

backupArn string: ARN of the backup.
backupCreationDateTime string: Time at which the backup was created.
backupExpiryDateTime string: Time at which the automatic on-demand backup created by DynamoDB will expire.
backupName string: Name of the specified backup.
backupSizeBytes number: Size of the backup in bytes.
backupStatus string: Backup can be in one of the following states: CREATING, DELETED, AVAILABLE.
backupType string: Backup type. Valid values: USER, SYSTEM, AWS_BACKUP, ALL.
tableArn string: ARN associated with the table.
tableId string: Unique identifier for the table.
tableName string: Name of the table to list backups for.

backup_arn str: ARN of the backup.
backup_creation_date_time str: Time at which the backup was created.
backup_expiry_date_time str: Time at which the automatic on-demand backup created by DynamoDB will expire.
backup_name str: Name of the specified backup.
backup_size_bytes int: Size of the backup in bytes.
backup_status str: Backup can be in one of the following states: CREATING, DELETED, AVAILABLE.
backup_type str: Backup type. Valid values: USER, SYSTEM, AWS_BACKUP, ALL.
table_arn str: ARN associated with the table.
table_id str: Unique identifier for the table.
table_name str: Name of the table to list backups for.

backupArn String: ARN of the backup.
backupCreationDateTime String: Time at which the backup was created.
backupExpiryDateTime String: Time at which the automatic on-demand backup created by DynamoDB will expire.
backupName String: Name of the specified backup.
backupSizeBytes Number: Size of the backup in bytes.
backupStatus String: Backup can be in one of the following states: CREATING, DELETED, AVAILABLE.
backupType String: Backup type. Valid values: USER, SYSTEM, AWS_BACKUP, ALL.
tableArn String: ARN associated with the table.
tableId String: Unique identifier for the table.
tableName String: Name of the table to list backups for.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

Viewing docs for AWS v7.24.0
published on Tuesday, Mar 31, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws

aws.dynamodb.getBackups

On this page

On this page

Example Usage

Basic Usage

Using getBackups

getBackups Result

Supporting Types

GetBackupsBackupSummary

Package Details

On this page

On this page