Package software.amazon.awscdk.services.dynamodb

Class CfnBackup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.dynamodb.CfnBackup
All Implemented Interfaces:
IInspectable, IBackupRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:07.902Z") @Stability(Stable) public class CfnBackup extends CfnResource implements IInspectable, IBackupRef
Creates an on-demand backup of a DynamoDB table.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dynamodb.*;
 CfnBackup cfnBackup = CfnBackup.Builder.create(this, "MyCfnBackup")
         .backupName("backupName")
         .tableName("tableName")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnBackup

      protected CfnBackup(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnBackup

      protected CfnBackup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnBackup

      @Stability(Stable) public CfnBackup(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnBackupProps props)
      Create a new AWS::DynamoDB::Backup.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForBackup

      @Stability(Stable) @NotNull public static String arnForBackup(@NotNull IBackupRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnBackup

      @Stability(Stable) @NotNull public static Boolean isCfnBackup(@NotNull Object x)
      Checks whether the given object is a CfnBackup.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrBackupArn

      @Stability(Stable) @NotNull public String getAttrBackupArn()
      The ARN associated with the backup.

    • getAttrBackupCreationDateTime

      @Stability(Stable) @NotNull public String getAttrBackupCreationDateTime()
      The time at which the backup was created.

    • getAttrBackupId

      @Stability(Stable) @NotNull public String getAttrBackupId()
      The identifier portion of the backup ARN (server-generated).

    • getAttrBackupSizeBytes

      @Stability(Stable) @NotNull public Number getAttrBackupSizeBytes()
      The size of the backup in bytes.

    • getAttrBackupStatus

      @Stability(Stable) @NotNull public String getAttrBackupStatus()
      The current state of the backup.

    • getAttrBackupType

      @Stability(Stable) @NotNull public String getAttrBackupType()
      The type of backup (USER, SYSTEM, or AWS_BACKUP).

    • getBackupRef

      @Stability(Stable) @NotNull public BackupReference getBackupRef()
      A reference to a Backup resource.
      Specified by:
      getBackupRef in interface IBackupRef

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getBackupName

      @Stability(Stable) @NotNull public String getBackupName()
      The name for the backup.

    • setBackupName

      @Stability(Stable) public void setBackupName(@NotNull String value)
      The name for the backup.

    • getTableName

      @Stability(Stable) @NotNull public String getTableName()
      The name of the table to back up.

    • setTableName

      @Stability(Stable) public void setTableName(@NotNull String value)
      The name of the table to back up.