1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. dynamodb
  6. Backup

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
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

    Creates an on-demand backup of a DynamoDB table.

    Create Backup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Backup(name: string, args: BackupArgs, opts?: CustomResourceOptions);
    @overload
    def Backup(resource_name: str,
               args: BackupArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Backup(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               table_name: Optional[str] = None,
               backup_name: Optional[str] = None)
    func NewBackup(ctx *Context, name string, args BackupArgs, opts ...ResourceOption) (*Backup, error)
    public Backup(string name, BackupArgs args, CustomResourceOptions? opts = null)
    public Backup(String name, BackupArgs args)
    public Backup(String name, BackupArgs args, CustomResourceOptions options)
    
    type: aws-native:dynamodb:Backup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_dynamodb_backup" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Backup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Backup resource accepts the following input properties:

    TableName string
    The name of the table to back up.
    BackupName string
    The name for the backup.
    TableName string
    The name of the table to back up.
    BackupName string
    The name for the backup.
    table_name string
    The name of the table to back up.
    backup_name string
    The name for the backup.
    tableName String
    The name of the table to back up.
    backupName String
    The name for the backup.
    tableName string
    The name of the table to back up.
    backupName string
    The name for the backup.
    table_name str
    The name of the table to back up.
    backup_name str
    The name for the backup.
    tableName String
    The name of the table to back up.
    backupName String
    The name for the backup.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Backup resource produces the following output properties:

    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).
    Id string
    The provider-assigned unique ID for this managed resource.
    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).
    Id string
    The provider-assigned unique ID for this managed resource.
    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).
    id string
    The provider-assigned unique ID for this managed resource.
    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).
    id String
    The provider-assigned unique ID for this managed resource.
    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).
    id string
    The provider-assigned unique ID for this managed resource.
    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).
    id str
    The provider-assigned unique ID for this managed resource.
    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).
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    BackupStatus, BackupStatusArgs

    Creating
    CREATING
    Deleted
    DELETED
    Available
    AVAILABLE
    BackupStatusCreating
    CREATING
    BackupStatusDeleted
    DELETED
    BackupStatusAvailable
    AVAILABLE
    "CREATING"
    CREATING
    "DELETED"
    DELETED
    "AVAILABLE"
    AVAILABLE
    Creating
    CREATING
    Deleted
    DELETED
    Available
    AVAILABLE
    Creating
    CREATING
    Deleted
    DELETED
    Available
    AVAILABLE
    CREATING
    CREATING
    DELETED
    DELETED
    AVAILABLE
    AVAILABLE
    "CREATING"
    CREATING
    "DELETED"
    DELETED
    "AVAILABLE"
    AVAILABLE

    BackupType, BackupTypeArgs

    User
    USER
    System
    SYSTEM
    AwsBackup
    AWS_BACKUP
    BackupTypeUser
    USER
    BackupTypeSystem
    SYSTEM
    BackupTypeAwsBackup
    AWS_BACKUP
    "USER"
    USER
    "SYSTEM"
    SYSTEM
    "AWS_BACKUP"
    AWS_BACKUP
    User
    USER
    System
    SYSTEM
    AwsBackup
    AWS_BACKUP
    User
    USER
    System
    SYSTEM
    AwsBackup
    AWS_BACKUP
    USER
    USER
    SYSTEM
    SYSTEM
    AWS_BACKUP
    AWS_BACKUP
    "USER"
    USER
    "SYSTEM"
    SYSTEM
    "AWS_BACKUP"
    AWS_BACKUP

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial