Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. fsx
  5. Backup
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.fsx.Backup

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a FSx Backup resource.

    Lustre Example

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleLustreFileSystem = new aws.fsx.LustreFileSystem("example", {
    storageCapacity: 1200,
    subnetIds: exampleAwsSubnet.id,
    deploymentType: "PERSISTENT_1",
    perUnitStorageThroughput: 50,
});
const example = new aws.fsx.Backup("example", {fileSystemId: exampleLustreFileSystem.id});

    import pulumi
import pulumi_aws as aws

example_lustre_file_system = aws.fsx.LustreFileSystem("example",
    storage_capacity=1200,
    subnet_ids=example_aws_subnet["id"],
    deployment_type="PERSISTENT_1",
    per_unit_storage_throughput=50)
example = aws.fsx.Backup("example", file_system_id=example_lustre_file_system.id)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/fsx"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleLustreFileSystem, err := fsx.NewLustreFileSystem(ctx, "example", &fsx.LustreFileSystemArgs{
			StorageCapacity:          pulumi.Int(1200),
			SubnetIds:                pulumi.Any(exampleAwsSubnet.Id),
			DeploymentType:           pulumi.String("PERSISTENT_1"),
			PerUnitStorageThroughput: pulumi.Int(50),
		})
		if err != nil {
			return err
		}
		_, err = fsx.NewBackup(ctx, "example", &fsx.BackupArgs{
			FileSystemId: exampleLustreFileSystem.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var exampleLustreFileSystem = new Aws.Fsx.LustreFileSystem("example", new()
    {
        StorageCapacity = 1200,
        SubnetIds = exampleAwsSubnet.Id,
        DeploymentType = "PERSISTENT_1",
        PerUnitStorageThroughput = 50,
    });

    var example = new Aws.Fsx.Backup("example", new()
    {
        FileSystemId = exampleLustreFileSystem.Id,
    });

});

    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.List;
import java.util.ArrayList;
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());

    }
}

    resources:
  example:
    type: aws:fsx:Backup
    properties:
      fileSystemId: ${exampleLustreFileSystem.id}
  exampleLustreFileSystem:
    type: aws:fsx:LustreFileSystem
    name: example
    properties:
      storageCapacity: 1200
      subnetIds: ${exampleAwsSubnet.id}
      deploymentType: PERSISTENT_1
      perUnitStorageThroughput: 50

    Windows Example

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleWindowsFileSystem = new aws.fsx.WindowsFileSystem("example", {
    activeDirectoryId: eample.id,
    skipFinalBackup: true,
    storageCapacity: 32,
    subnetIds: [example1.id],
    throughputCapacity: 8,
});
const example = new aws.fsx.Backup("example", {fileSystemId: exampleWindowsFileSystem.id});

    import pulumi
import pulumi_aws as aws

example_windows_file_system = aws.fsx.WindowsFileSystem("example",
    active_directory_id=eample["id"],
    skip_final_backup=True,
    storage_capacity=32,
    subnet_ids=[example1["id"]],
    throughput_capacity=8)
example = aws.fsx.Backup("example", file_system_id=example_windows_file_system.id)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/fsx"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleWindowsFileSystem, err := fsx.NewWindowsFileSystem(ctx, "example", &fsx.WindowsFileSystemArgs{
			ActiveDirectoryId: pulumi.Any(eample.Id),
			SkipFinalBackup:   pulumi.Bool(true),
			StorageCapacity:   pulumi.Int(32),
			SubnetIds: pulumi.StringArray{
				example1.Id,
			},
			ThroughputCapacity: pulumi.Int(8),
		})
		if err != nil {
			return err
		}
		_, err = fsx.NewBackup(ctx, "example", &fsx.BackupArgs{
			FileSystemId: exampleWindowsFileSystem.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var exampleWindowsFileSystem = new Aws.Fsx.WindowsFileSystem("example", new()
    {
        ActiveDirectoryId = eample.Id,
        SkipFinalBackup = true,
        StorageCapacity = 32,
        SubnetIds = new[]
        {
            example1.Id,
        },
        ThroughputCapacity = 8,
    });

    var example = new Aws.Fsx.Backup("example", new()
    {
        FileSystemId = exampleWindowsFileSystem.Id,
    });

});

    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.List;
import java.util.ArrayList;
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(eample.id())
            .skipFinalBackup(true)
            .storageCapacity(32)
            .subnetIds(example1.id())
            .throughputCapacity(8)
            .build());

        var example = new Backup("example", BackupArgs.builder()
            .fileSystemId(exampleWindowsFileSystem.id())
            .build());

    }
}

    resources:
  example:
    type: aws:fsx:Backup
    properties:
      fileSystemId: ${exampleWindowsFileSystem.id}
  exampleWindowsFileSystem:
    type: aws:fsx:WindowsFileSystem
    name: example
    properties:
      activeDirectoryId: ${eample.id}
      skipFinalBackup: true
      storageCapacity: 32
      subnetIds:
        - ${example1.id}
      throughputCapacity: 8

    ONTAP Example

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleOntapVolume = new aws.fsx.OntapVolume("example", {
    name: "example",
    junctionPath: "/example",
    sizeInMegabytes: 1024,
    storageEfficiencyEnabled: true,
    storageVirtualMachineId: test.id,
});
const example = new aws.fsx.Backup("example", {volumeId: exampleOntapVolume.id});

    import pulumi
import pulumi_aws as aws

example_ontap_volume = aws.fsx.OntapVolume("example",
    name="example",
    junction_path="/example",
    size_in_megabytes=1024,
    storage_efficiency_enabled=True,
    storage_virtual_machine_id=test["id"])
example = aws.fsx.Backup("example", volume_id=example_ontap_volume.id)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/fsx"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleOntapVolume, err := fsx.NewOntapVolume(ctx, "example", &fsx.OntapVolumeArgs{
			Name:                     pulumi.String("example"),
			JunctionPath:             pulumi.String("/example"),
			SizeInMegabytes:          pulumi.Int(1024),
			StorageEfficiencyEnabled: pulumi.Bool(true),
			StorageVirtualMachineId:  pulumi.Any(test.Id),
		})
		if err != nil {
			return err
		}
		_, err = fsx.NewBackup(ctx, "example", &fsx.BackupArgs{
			VolumeId: exampleOntapVolume.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var exampleOntapVolume = new Aws.Fsx.OntapVolume("example", new()
    {
        Name = "example",
        JunctionPath = "/example",
        SizeInMegabytes = 1024,
        StorageEfficiencyEnabled = true,
        StorageVirtualMachineId = test.Id,
    });

    var example = new Aws.Fsx.Backup("example", new()
    {
        VolumeId = exampleOntapVolume.Id,
    });

});

    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.List;
import java.util.ArrayList;
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());

    }
}

    resources:
  example:
    type: aws:fsx:Backup
    properties:
      volumeId: ${exampleOntapVolume.id}
  exampleOntapVolume:
    type: aws:fsx:OntapVolume
    name: example
    properties:
      name: example
      junctionPath: /example
      sizeInMegabytes: 1024
      storageEfficiencyEnabled: true
      storageVirtualMachineId: ${test.id}

    OpenZFS Example

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const exampleOpenZfsFileSystem = new aws.fsx.OpenZfsFileSystem("example", {
    storageCapacity: 64,
    subnetIds: [exampleAwsSubnet.id],
    deploymentType: "SINGLE_AZ_1",
    throughputCapacity: 64,
});
const example = new aws.fsx.Backup("example", {fileSystemId: exampleOpenZfsFileSystem.id});

    import pulumi
import pulumi_aws as aws

example_open_zfs_file_system = aws.fsx.OpenZfsFileSystem("example",
    storage_capacity=64,
    subnet_ids=[example_aws_subnet["id"]],
    deployment_type="SINGLE_AZ_1",
    throughput_capacity=64)
example = aws.fsx.Backup("example", file_system_id=example_open_zfs_file_system.id)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/fsx"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleOpenZfsFileSystem, err := fsx.NewOpenZfsFileSystem(ctx, "example", &fsx.OpenZfsFileSystemArgs{
			StorageCapacity: pulumi.Int(64),
			SubnetIds: pulumi.StringArray{
				exampleAwsSubnet.Id,
			},
			DeploymentType:     pulumi.String("SINGLE_AZ_1"),
			ThroughputCapacity: pulumi.Int(64),
		})
		if err != nil {
			return err
		}
		_, err = fsx.NewBackup(ctx, "example", &fsx.BackupArgs{
			FileSystemId: exampleOpenZfsFileSystem.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var exampleOpenZfsFileSystem = new Aws.Fsx.OpenZfsFileSystem("example", new()
    {
        StorageCapacity = 64,
        SubnetIds = new[]
        {
            exampleAwsSubnet.Id,
        },
        DeploymentType = "SINGLE_AZ_1",
        ThroughputCapacity = 64,
    });

    var example = new Aws.Fsx.Backup("example", new()
    {
        FileSystemId = exampleOpenZfsFileSystem.Id,
    });

});

    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.List;
import java.util.ArrayList;
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());

    }
}

    resources:
  example:
    type: aws:fsx:Backup
    properties:
      fileSystemId: ${exampleOpenZfsFileSystem.id}
  exampleOpenZfsFileSystem:
    type: aws:fsx:OpenZfsFileSystem
    name: example
    properties:
      storageCapacity: 64
      subnetIds:
        - ${exampleAwsSubnet.id}
      deploymentType: SINGLE_AZ_1
      throughputCapacity: 64

    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: Optional[BackupArgs] = None,
           opts: Optional[ResourceOptions] = None)

@overload
def Backup(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           file_system_id: Optional[str] = None,
           tags: Optional[Mapping[str, str]] = None,
           volume_id: Optional[str] = None)
    func NewBackup(ctx *Context, name string, args *BackupArgs, opts ...ResourceOption) (*Backup, error)
    public Backup(string name, BackupArgs? args = null, CustomResourceOptions? opts = null)
    public Backup(String name, BackupArgs args)
public Backup(String name, BackupArgs args, CustomResourceOptions options)

    type: aws:fsx:Backup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var backupResource = new Aws.Fsx.Backup("backupResource", new()
{
    FileSystemId = "string",
    Tags = 
    {
        { "string", "string" },
    },
    VolumeId = "string",
});

    example, err := fsx.NewBackup(ctx, "backupResource", &fsx.BackupArgs{
	FileSystemId: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VolumeId: pulumi.String("string"),
})

    var backupResource = new Backup("backupResource", BackupArgs.builder()
    .fileSystemId("string")
    .tags(Map.of("string", "string"))
    .volumeId("string")
    .build());

    backup_resource = aws.fsx.Backup("backupResource",
    file_system_id="string",
    tags={
        "string": "string",
    },
    volume_id="string")

    const backupResource = new aws.fsx.Backup("backupResource", {
    fileSystemId: "string",
    tags: {
        string: "string",
    },
    volumeId: "string",
});

    type: aws:fsx:Backup
properties:
    fileSystemId: string
    tags:
        string: string
    volumeId: string

    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

    The Backup resource accepts the following input properties:

    FileSystemId string
    The ID of the file system to back up. Required if backing up Lustre or Windows file systems.
    Tags Dictionary<string, string>
    A map of tags to assign to the file system. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have set copy_tags_to_backups to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup.
    VolumeId string
    The ID of the volume to back up. Required if backing up a ONTAP Volume.
    FileSystemId string
    The ID of the file system to back up. Required if backing up Lustre or Windows file systems.
    Tags map[string]string
    A map of tags to assign to the file system. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have set copy_tags_to_backups to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup.
    VolumeId string
    The ID of the volume to back up. Required if backing up a ONTAP Volume.
    fileSystemId String
    The ID of the file system to back up. Required if backing up Lustre or Windows file systems.
    tags Map<String,String>
    A map of tags to assign to the file system. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have set copy_tags_to_backups to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup.
    volumeId String
    The ID of the volume to back up. Required if backing up a ONTAP Volume.
    fileSystemId string
    The ID of the file system to back up. Required if backing up Lustre or Windows file systems.
    tags {[key: string]: string}
    A map of tags to assign to the file system. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have set copy_tags_to_backups to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup.
    volumeId string
    The ID of the volume to back up. Required if backing up a ONTAP Volume.
    file_system_id str
    The ID of the file system to back up. Required if backing up Lustre or Windows file systems.
    tags Mapping[str, str]
    A map of tags to assign to the file system. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have set copy_tags_to_backups to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup.
    volume_id str
    The ID of the volume to back up. Required if backing up a ONTAP Volume.
    fileSystemId String
    The ID of the file system to back up. Required if backing up Lustre or Windows file systems.
    tags Map<String>
    A map of tags to assign to the file system. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have set copy_tags_to_backups to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup.
    volumeId String
    The ID of the volume to back up. Required if backing up a ONTAP Volume.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Backup resource produces the following output properties:

    Arn string
    Amazon Resource Name of the backup.
    Id string
    The provider-assigned unique ID for this managed resource.
    KmsKeyId string
    The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
    OwnerId string
    AWS account identifier that created the file system.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Type string
    The type of the file system backup.
    Arn string
    Amazon Resource Name of the backup.
    Id string
    The provider-assigned unique ID for this managed resource.
    KmsKeyId string
    The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
    OwnerId string
    AWS account identifier that created the file system.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Type string
    The type of the file system backup.
    arn String
    Amazon Resource Name of the backup.
    id String
    The provider-assigned unique ID for this managed resource.
    kmsKeyId String
    The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
    ownerId String
    AWS account identifier that created the file system.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type String
    The type of the file system backup.
    arn string
    Amazon Resource Name of the backup.
    id string
    The provider-assigned unique ID for this managed resource.
    kmsKeyId string
    The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
    ownerId string
    AWS account identifier that created the file system.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type string
    The type of the file system backup.
    arn str
    Amazon Resource Name of the backup.
    id str
    The provider-assigned unique ID for this managed resource.
    kms_key_id str
    The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
    owner_id str
    AWS account identifier that created the file system.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type str
    The type of the file system backup.
    arn String
    Amazon Resource Name of the backup.
    id String
    The provider-assigned unique ID for this managed resource.
    kmsKeyId String
    The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
    ownerId String
    AWS account identifier that created the file system.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type String
    The type of the file system backup.

    Look up Existing Backup Resource

    Get an existing Backup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: BackupState, opts?: CustomResourceOptions): Backup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        file_system_id: Optional[str] = None,
        kms_key_id: Optional[str] = None,
        owner_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        type: Optional[str] = None,
        volume_id: Optional[str] = None) -> Backup
    func GetBackup(ctx *Context, name string, id IDInput, state *BackupState, opts ...ResourceOption) (*Backup, error)
    public static Backup Get(string name, Input<string> id, BackupState? state, CustomResourceOptions? opts = null)
    public static Backup get(String name, Output<String> id, BackupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    Amazon Resource Name of the backup.
    FileSystemId string
    The ID of the file system to back up. Required if backing up Lustre or Windows file systems.
    KmsKeyId string
    The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
    OwnerId string
    AWS account identifier that created the file system.
    Tags Dictionary<string, string>
    A map of tags to assign to the file system. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have set copy_tags_to_backups to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Type string
    The type of the file system backup.
    VolumeId string
    The ID of the volume to back up. Required if backing up a ONTAP Volume.
    Arn string
    Amazon Resource Name of the backup.
    FileSystemId string
    The ID of the file system to back up. Required if backing up Lustre or Windows file systems.
    KmsKeyId string
    The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
    OwnerId string
    AWS account identifier that created the file system.
    Tags map[string]string
    A map of tags to assign to the file system. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have set copy_tags_to_backups to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Type string
    The type of the file system backup.
    VolumeId string
    The ID of the volume to back up. Required if backing up a ONTAP Volume.
    arn String
    Amazon Resource Name of the backup.
    fileSystemId String
    The ID of the file system to back up. Required if backing up Lustre or Windows file systems.
    kmsKeyId String
    The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
    ownerId String
    AWS account identifier that created the file system.
    tags Map<String,String>
    A map of tags to assign to the file system. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have set copy_tags_to_backups to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type String
    The type of the file system backup.
    volumeId String
    The ID of the volume to back up. Required if backing up a ONTAP Volume.
    arn string
    Amazon Resource Name of the backup.
    fileSystemId string
    The ID of the file system to back up. Required if backing up Lustre or Windows file systems.
    kmsKeyId string
    The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
    ownerId string
    AWS account identifier that created the file system.
    tags {[key: string]: string}
    A map of tags to assign to the file system. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have set copy_tags_to_backups to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type string
    The type of the file system backup.
    volumeId string
    The ID of the volume to back up. Required if backing up a ONTAP Volume.
    arn str
    Amazon Resource Name of the backup.
    file_system_id str
    The ID of the file system to back up. Required if backing up Lustre or Windows file systems.
    kms_key_id str
    The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
    owner_id str
    AWS account identifier that created the file system.
    tags Mapping[str, str]
    A map of tags to assign to the file system. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have set copy_tags_to_backups to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type str
    The type of the file system backup.
    volume_id str
    The ID of the volume to back up. Required if backing up a ONTAP Volume.
    arn String
    Amazon Resource Name of the backup.
    fileSystemId String
    The ID of the file system to back up. Required if backing up Lustre or Windows file systems.
    kmsKeyId String
    The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.
    ownerId String
    AWS account identifier that created the file system.
    tags Map<String>
    A map of tags to assign to the file system. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level. If you have set copy_tags_to_backups to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type String
    The type of the file system backup.
    volumeId String
    The ID of the volume to back up. Required if backing up a ONTAP Volume.

    Import

    Using pulumi import, import FSx Backups using the id. For example:

    $ pulumi import aws:fsx/backup:Backup example fs-543ab12b1ca672f33

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws