Class Backup


  • public class Backup
    extends com.pulumi.resources.CustomResource
    Provides a FSx Backup resource. ## Example Usage ### Lustre Example
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.fsx.LustreFileSystem;
     import com.pulumi.aws.fsx.LustreFileSystemArgs;
     import com.pulumi.aws.fsx.Backup;
     import com.pulumi.aws.fsx.BackupArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var exampleLustreFileSystem = new LustreFileSystem("exampleLustreFileSystem", LustreFileSystemArgs.builder()
                 .storageCapacity(1200)
                 .subnetIds(exampleAwsSubnet.id())
                 .deploymentType("PERSISTENT_1")
                 .perUnitStorageThroughput(50)
                 .build());
     
             var example = new Backup("example", BackupArgs.builder()
                 .fileSystemId(exampleLustreFileSystem.id())
                 .build());
     
         }
     }
     
     
    ### Windows Example
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.fsx.WindowsFileSystem;
     import com.pulumi.aws.fsx.WindowsFileSystemArgs;
     import com.pulumi.aws.fsx.Backup;
     import com.pulumi.aws.fsx.BackupArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var exampleWindowsFileSystem = new WindowsFileSystem("exampleWindowsFileSystem", WindowsFileSystemArgs.builder()
                 .activeDirectoryId(exampleAwsDirectoryServiceDirectory.id())
                 .skipFinalBackup(true)
                 .storageCapacity(32)
                 .subnetIds(example1.id())
                 .throughputCapacity(8)
                 .build());
     
             var example = new Backup("example", BackupArgs.builder()
                 .fileSystemId(exampleWindowsFileSystem.id())
                 .build());
     
         }
     }
     
     
    ### ONTAP Example
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.fsx.OntapVolume;
     import com.pulumi.aws.fsx.OntapVolumeArgs;
     import com.pulumi.aws.fsx.Backup;
     import com.pulumi.aws.fsx.BackupArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var exampleOntapVolume = new OntapVolume("exampleOntapVolume", OntapVolumeArgs.builder()
                 .name("example")
                 .junctionPath("/example")
                 .sizeInMegabytes(1024)
                 .storageEfficiencyEnabled(true)
                 .storageVirtualMachineId(test.id())
                 .build());
     
             var example = new Backup("example", BackupArgs.builder()
                 .volumeId(exampleOntapVolume.id())
                 .build());
     
         }
     }
     
     
    ### OpenZFS Example
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.fsx.OpenZfsFileSystem;
     import com.pulumi.aws.fsx.OpenZfsFileSystemArgs;
     import com.pulumi.aws.fsx.Backup;
     import com.pulumi.aws.fsx.BackupArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var exampleOpenZfsFileSystem = new OpenZfsFileSystem("exampleOpenZfsFileSystem", OpenZfsFileSystemArgs.builder()
                 .storageCapacity(64)
                 .subnetIds(exampleAwsSubnet.id())
                 .deploymentType("SINGLE_AZ_1")
                 .throughputCapacity(64)
                 .build());
     
             var example = new Backup("example", BackupArgs.builder()
                 .fileSystemId(exampleOpenZfsFileSystem.id())
                 .build());
     
         }
     }
     
     
    ## Import Using `pulumi import`, import FSx Backups using the `id`. For example: ```sh $ pulumi import aws:fsx/backup:Backup example fs-543ab12b1ca672f33 ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Constructor Summary

      Constructors 
      Constructor Description
      Backup​(java.lang.String name)  
      Backup​(java.lang.String name, BackupArgs args)  
      Backup​(java.lang.String name, BackupArgs args, com.pulumi.resources.CustomResourceOptions options)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> fileSystemId()  
      static Backup get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, BackupState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> kmsKeyId()  
      com.pulumi.core.Output<java.lang.String> ownerId()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> type()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> volumeId()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Backup

        public Backup​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • Backup

        public Backup​(java.lang.String name,
                      @Nullable
                      BackupArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • Backup

        public Backup​(java.lang.String name,
                      @Nullable
                      BackupArgs args,
                      @Nullable
                      com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the backup.
      • fileSystemId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> fileSystemId()
        Returns:
        ID of the file system to back up. Required if backing up Lustre or Windows file systems.
      • kmsKeyId

        public com.pulumi.core.Output<java.lang.String> kmsKeyId()
        Returns:
        ID of the KMS key used to encrypt the backup of the Amazon FSx file system's data at rest.
      • ownerId

        public com.pulumi.core.Output<java.lang.String> ownerId()
        Returns:
        AWS account identifier that created the file system.
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the file system. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have set `copyTagsToBackups` to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup.
      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
      • type

        public com.pulumi.core.Output<java.lang.String> type()
        Returns:
        Type of the file system backup.
      • volumeId

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> volumeId()
        Returns:
        ID of the volume to back up. Required if backing up a ONTAP Volume.
      • get

        public static Backup get​(java.lang.String name,
                                 com.pulumi.core.Output<java.lang.String> id,
                                 @Nullable
                                 BackupState state,
                                 @Nullable
                                 com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.