We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 7, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
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:
- Table
Name string - The name of the table to back up.
- Backup
Name 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.
- table_
name string - The name of the table to back up.
- backup_
name 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.
- table
Name string - The name of the table to back up.
- backup
Name 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.
- table
Name String - The name of the table to back up.
- backup
Name 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:
- Backup
Arn string - The ARN associated with the backup.
- Backup
Creation stringDate Time - The time at which the backup was created.
- Backup
Id string - The identifier portion of the backup ARN (server-generated).
- Backup
Size intBytes - The size of the backup in bytes.
- Backup
Status Pulumi.Aws Native. Dynamo Db. Backup Status - The current state of the backup.
- Backup
Type Pulumi.Aws Native. Dynamo Db. Backup Type - 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 stringDate Time - The time at which the backup was created.
- Backup
Id string - The identifier portion of the backup ARN (server-generated).
- Backup
Size intBytes - 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 string
- The provider-assigned unique ID for this managed resource.
- backup_
arn string - The ARN associated with the backup.
- backup_
creation_ stringdate_ time - The time at which the backup was created.
- backup_
id string - The identifier portion of the backup ARN (server-generated).
- backup_
size_ numberbytes - 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.
- backup
Arn String - The ARN associated with the backup.
- backup
Creation StringDate Time - The time at which the backup was created.
- backup
Id String - The identifier portion of the backup ARN (server-generated).
- backup
Size IntegerBytes - 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 String
- The provider-assigned unique ID for this managed resource.
- backup
Arn string - The ARN associated with the backup.
- backup
Creation stringDate Time - The time at which the backup was created.
- backup
Id string - The identifier portion of the backup ARN (server-generated).
- backup
Size numberBytes - 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 string
- The provider-assigned unique ID for this managed resource.
- backup_
arn str - The ARN associated with the backup.
- backup_
creation_ strdate_ time - The time at which the backup was created.
- backup_
id str - The identifier portion of the backup ARN (server-generated).
- backup_
size_ intbytes - 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.
- backup
Arn String - The ARN associated with the backup.
- backup
Creation StringDate Time - The time at which the backup was created.
- backup
Id String - The identifier portion of the backup ARN (server-generated).
- backup
Size NumberBytes - 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.
Supporting Types
BackupStatus, BackupStatusArgs
- Creating
CREATING- Deleted
DELETED- Available
AVAILABLE
- Backup
Status Creating CREATING- Backup
Status Deleted DELETED- Backup
Status 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
- "CREATING"
CREATING- "DELETED"
DELETED- "AVAILABLE"
AVAILABLE
BackupType, BackupTypeArgs
- User
USER- System
SYSTEM- Aws
Backup AWS_BACKUP
- Backup
Type User USER- Backup
Type System SYSTEM- Backup
Type Aws Backup AWS_BACKUP
- "USER"
USER- "SYSTEM"
SYSTEM- "AWS_BACKUP"
AWS_BACKUP
- User
USER- System
SYSTEM- Aws
Backup AWS_BACKUP
- User
USER- System
SYSTEM- Aws
Backup 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
We recommend new projects start with resources from the AWS provider.
published on Monday, Sep 7, 2026 by Pulumi