Package software.amazon.awscdk.services.fsx

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.fsx.CfnBackup
All Implemented Interfaces:
IInspectable, IBackupRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-09-30T11:04:52.577Z") @Stability(Stable) public class CfnBackup extends CfnResource implements IInspectable, IBackupRef, ITaggableV2
Creates a backup of an existing Amazon FSx for Windows File Server file system, Amazon FSx for Lustre file system, Amazon FSx for NetApp ONTAP volume, or Amazon FSx for OpenZFS file system.

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.fsx.*;
 CfnBackup cfnBackup = CfnBackup.Builder.create(this, "MyCfnBackup")
         .fileSystemId("fileSystemId")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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::FSx::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.

    • fromBackupId

      @Stability(Stable) @NotNull public static IBackupRef fromBackupId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String backupId)
      Creates a new IBackupRef from a backupId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      backupId - 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.

    • getAttrBackupId

      @Stability(Stable) @NotNull public String getAttrBackupId()
      The ID of the backup.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      The time when the backup was created.

    • getAttrLifecycle

      @Stability(Stable) @NotNull public String getAttrLifecycle()
      The lifecycle status of the backup.

    • getAttrResourceArn

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

    • getAttrType

      @Stability(Stable) @NotNull public String getAttrType()
      The type of the backup.

    • getBackupRef

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

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • 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

    • getFileSystemId

      @Stability(Stable) @NotNull public String getFileSystemId()
      The ID of the file system to back up.

    • setFileSystemId

      @Stability(Stable) public void setFileSystemId(@NotNull String value)
      The ID of the file system to back up.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags to apply to the backup at backup creation.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags to apply to the backup at backup creation.