Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. dynamodb
  6. getBackup

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.78.0
published on Monday, Sep 7, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.dynamodb.getBackup

aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.78.0
published on Monday, Sep 7, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Creates an on-demand backup of a DynamoDB table.

    Using getBackup

    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 getBackup(args: GetBackupArgs, opts?: InvokeOptions): Promise<GetBackupResult>
function getBackupOutput(args: GetBackupOutputArgs, opts?: InvokeOutputOptions): Output<GetBackupResult>
    def get_backup(backup_arn: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetBackupResult
def get_backup_output(backup_arn: pulumi.Input[Optional[str]] = None,
               opts: Optional[InvokeOutputOptions] = None) -> Output[GetBackupResult]
    func LookupBackup(ctx *Context, args *LookupBackupArgs, opts ...InvokeOption) (*LookupBackupResult, error)
func LookupBackupOutput(ctx *Context, args *LookupBackupOutputArgs, opts ...InvokeOption) LookupBackupResultOutput

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

    public static class GetBackup 
{
    public static Task<GetBackupResult> InvokeAsync(GetBackupArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupResult> Invoke(GetBackupInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupResult> Invoke(GetBackupInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetBackupResult> getBackup(GetBackupArgs args, InvokeOptions options)
public static Output<GetBackupResult> getBackup(GetBackupArgs args, InvokeOptions options)
public static Output<GetBackupResult> getBackup(GetBackupArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws-native:dynamodb:getBackup
  arguments:
    # arguments dictionary
    data "aws-native_dynamodb_get_backup" "name" {
    # arguments
}

    The following arguments are supported:

    BackupArn string
    The ARN associated with the backup.
    BackupArn string
    The ARN associated with the backup.
    backup_arn string
    The ARN associated with the backup.
    backupArn String
    The ARN associated with the backup.
    backupArn string
    The ARN associated with the backup.
    backup_arn str
    The ARN associated with the backup.
    backupArn String
    The ARN associated with the backup.

    getBackup Result

    The following output properties are available:

    BackupArn string
    The ARN associated with the backup.
    BackupCreationDateTime string
    The time at which the backup was created.
    BackupId string
    The identifier portion of the backup ARN (server-generated).
    BackupSizeBytes int
    The size of the backup in bytes.
    BackupStatus Pulumi.AwsNative.DynamoDb.BackupStatus
    The current state of the backup.
    BackupType Pulumi.AwsNative.DynamoDb.BackupType
    The type of backup (USER, SYSTEM, or AWS_BACKUP).
    BackupArn string
    The ARN associated with the backup.
    BackupCreationDateTime string
    The time at which the backup was created.
    BackupId string
    The identifier portion of the backup ARN (server-generated).
    BackupSizeBytes int
    The size of the backup in bytes.
    BackupStatus BackupStatus
    The current state of the backup.
    BackupType BackupType
    The type of backup (USER, SYSTEM, or AWS_BACKUP).
    backup_arn string
    The ARN associated with the backup.
    backup_creation_date_time string
    The time at which the backup was created.
    backup_id string
    The identifier portion of the backup ARN (server-generated).
    backup_size_bytes number
    The size of the backup in bytes.
    backup_status "CREATING" | "DELETED" | "AVAILABLE"
    The current state of the backup.
    backup_type "USER" | "SYSTEM" | "AWS_BACKUP"
    The type of backup (USER, SYSTEM, or AWS_BACKUP).
    backupArn String
    The ARN associated with the backup.
    backupCreationDateTime String
    The time at which the backup was created.
    backupId String
    The identifier portion of the backup ARN (server-generated).
    backupSizeBytes Integer
    The size of the backup in bytes.
    backupStatus BackupStatus
    The current state of the backup.
    backupType BackupType
    The type of backup (USER, SYSTEM, or AWS_BACKUP).
    backupArn string
    The ARN associated with the backup.
    backupCreationDateTime string
    The time at which the backup was created.
    backupId string
    The identifier portion of the backup ARN (server-generated).
    backupSizeBytes number
    The size of the backup in bytes.
    backupStatus BackupStatus
    The current state of the backup.
    backupType BackupType
    The type of backup (USER, SYSTEM, or AWS_BACKUP).
    backup_arn str
    The ARN associated with the backup.
    backup_creation_date_time str
    The time at which the backup was created.
    backup_id str
    The identifier portion of the backup ARN (server-generated).
    backup_size_bytes int
    The size of the backup in bytes.
    backup_status BackupStatus
    The current state of the backup.
    backup_type BackupType
    The type of backup (USER, SYSTEM, or AWS_BACKUP).
    backupArn String
    The ARN associated with the backup.
    backupCreationDateTime String
    The time at which the backup was created.
    backupId String
    The identifier portion of the backup ARN (server-generated).
    backupSizeBytes Number
    The size of the backup in bytes.
    backupStatus "CREATING" | "DELETED" | "AVAILABLE"
    The current state of the backup.
    backupType "USER" | "SYSTEM" | "AWS_BACKUP"
    The type of backup (USER, SYSTEM, or AWS_BACKUP).

    Supporting Types

    BackupStatus

    BackupType

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.78.0
    published on Monday, Sep 7, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial