Package software.amazon.awscdk.services.dynamodb

Class CfnExport

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.CfnExport
All Implemented Interfaces:
IInspectable, IExportRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-08-10T14:51:01.348Z") @Stability(Stable) public class CfnExport extends CfnResource implements IInspectable, IExportRef
Represents a completed or in-progress DynamoDB table export to S3.

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.*;
 CfnExport cfnExport = CfnExport.Builder.create(this, "MyCfnExport")
         .s3Bucket("s3Bucket")
         .tableArn("tableArn")
         // the properties below are optional
         .exportFormat("exportFormat")
         .exportType("exportType")
         .s3BucketOwner("s3BucketOwner")
         .s3Prefix("s3Prefix")
         .s3SseAlgorithm("s3SseAlgorithm")
         .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

    • CfnExport

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

    • CfnExport

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

    • CfnExport

      @Stability(Stable) public CfnExport(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnExportProps props)
      Create a new AWS::DynamoDB::Export.

      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

    • arnForExport

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

    • isCfnExport

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

      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.

    • getAttrBilledSizeBytes

      @Stability(Stable) @NotNull public Number getAttrBilledSizeBytes()
      The billable size of the table export.

    • getAttrEndTime

      @Stability(Stable) @NotNull public String getAttrEndTime()
      The time at which the export task completed, in ISO 8601 format.

    • getAttrExportArn

      @Stability(Stable) @NotNull public String getAttrExportArn()
      The Amazon Resource Name (ARN) of the export.

    • getAttrExportId

      @Stability(Stable) @NotNull public String getAttrExportId()
      The unique identifier of the export.

    • getAttrExportManifest

      @Stability(Stable) @NotNull public String getAttrExportManifest()
      The name of the manifest file for the export task.

    • getAttrExportStatus

      @Stability(Stable) @NotNull public String getAttrExportStatus()
      Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.

    • getAttrExportTime

      @Stability(Stable) @NotNull public String getAttrExportTime()
      Point in time from which table data was exported, in ISO 8601 format.

    • getAttrItemCount

      @Stability(Stable) @NotNull public Number getAttrItemCount()
      The number of items exported.

    • getAttrStartTime

      @Stability(Stable) @NotNull public String getAttrStartTime()
      The time at which the export task began, in ISO 8601 format.

    • getAttrTableId

      @Stability(Stable) @NotNull public String getAttrTableId()
      Unique ID of the table that was exported.

    • getAttrTableName

      @Stability(Stable) @NotNull public String getAttrTableName()
      The name of the table that was exported.

    • 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

    • getExportRef

      @Stability(Stable) @NotNull public ExportReference getExportRef()
      A reference to a Export resource.
      Specified by:
      getExportRef in interface IExportRef

    • getS3Bucket

      @Stability(Stable) @NotNull public String getS3Bucket()
      The name of the Amazon S3 bucket containing the export.

    • setS3Bucket

      @Stability(Stable) public void setS3Bucket(@NotNull String value)
      The name of the Amazon S3 bucket containing the export.

    • getTableArn

      @Stability(Stable) @NotNull public String getTableArn()
      The Amazon Resource Name (ARN) of the table that was exported.

    • setTableArn

      @Stability(Stable) public void setTableArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the table that was exported.

    • getExportFormat

      @Stability(Stable) @Nullable public String getExportFormat()
      The format of the exported data.

    • setExportFormat

      @Stability(Stable) public void setExportFormat(@Nullable String value)
      The format of the exported data.

    • getExportType

      @Stability(Stable) @Nullable public String getExportType()
      The type of export that was performed.

    • setExportType

      @Stability(Stable) public void setExportType(@Nullable String value)
      The type of export that was performed.

    • getS3BucketOwner

      @Stability(Stable) @Nullable public String getS3BucketOwner()
      The ID of the Amazon Web Services account that owns the bucket containing the export.

    • setS3BucketOwner

      @Stability(Stable) public void setS3BucketOwner(@Nullable String value)
      The ID of the Amazon Web Services account that owns the bucket containing the export.

    • getS3Prefix

      @Stability(Stable) @Nullable public String getS3Prefix()
      The Amazon S3 bucket prefix used as the file name and path of the exported snapshot.

    • setS3Prefix

      @Stability(Stable) public void setS3Prefix(@Nullable String value)
      The Amazon S3 bucket prefix used as the file name and path of the exported snapshot.

    • getS3SseAlgorithm

      @Stability(Stable) @Nullable public String getS3SseAlgorithm()
      Type of encryption used on the bucket where export data is stored.

    • setS3SseAlgorithm

      @Stability(Stable) public void setS3SseAlgorithm(@Nullable String value)
      Type of encryption used on the bucket where export data is stored.