Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. fsx
  6. getBackup

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.fsx.getBackup

aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.81.0
published on Monday, Sep 28, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    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.

    Using getBackup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBackup(args: GetBackupArgs, opts?: InvokeOptions): Promise<GetBackupResult>
function getBackupOutput(args: GetBackupOutputArgs, opts?: InvokeOutputOptions): Output<GetBackupResult>
    def get_backup(resource_arn: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetBackupResult
def get_backup_output(resource_arn: pulumi.Input[Optional[str]] = None,
               opts: Optional[InvokeOutputOptions] = None) -> Output[GetBackupResult]
    func LookupBackup(ctx *Context, args *LookupBackupArgs, opts ...InvokeOption) (*LookupBackupResult, error)
func LookupBackupOutput(ctx *Context, args *LookupBackupOutputArgs, opts ...InvokeOption) LookupBackupResultOutput

    > Note: This function is named LookupBackup in the Go SDK.

    public static class GetBackup 
{
    public static Task<GetBackupResult> InvokeAsync(GetBackupArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupResult> Invoke(GetBackupInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupResult> Invoke(GetBackupInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetBackupResult> getBackup(GetBackupArgs args, InvokeOptions options)
public static Output<GetBackupResult> getBackup(GetBackupArgs args, InvokeOptions options)
public static Output<GetBackupResult> getBackup(GetBackupArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws-native:fsx:getBackup
  arguments:
    # arguments dictionary
    data "aws-native_fsx_get_backup" "name" {
    # arguments
}

    The following arguments are supported:

    ResourceArn string
    The Amazon Resource Name (ARN) of the backup.
    ResourceArn string
    The Amazon Resource Name (ARN) of the backup.
    resource_arn string
    The Amazon Resource Name (ARN) of the backup.
    resourceArn String
    The Amazon Resource Name (ARN) of the backup.
    resourceArn string
    The Amazon Resource Name (ARN) of the backup.
    resource_arn str
    The Amazon Resource Name (ARN) of the backup.
    resourceArn String
    The Amazon Resource Name (ARN) of the backup.

    getBackup Result

    The following output properties are available:

    BackupId string
    The ID of the backup.
    CreationTime string
    The time when the backup was created.
    Lifecycle Pulumi.AwsNative.FSx.BackupLifecycle
    The lifecycle status of the backup.
    ResourceArn string
    The Amazon Resource Name (ARN) of the backup.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The tags to apply to the backup at backup creation.
    Type Pulumi.AwsNative.FSx.BackupType
    The type of the backup.
    BackupId string
    The ID of the backup.
    CreationTime string
    The time when the backup was created.
    Lifecycle BackupLifecycle
    The lifecycle status of the backup.
    ResourceArn string
    The Amazon Resource Name (ARN) of the backup.
    Tags Tag
    The tags to apply to the backup at backup creation.
    Type BackupType
    The type of the backup.
    backup_id string
    The ID of the backup.
    creation_time string
    The time when the backup was created.
    lifecycle "AVAILABLE" | "CREATING" | "TRANSFERRING" | "DELETED" | "FAILED" | "PENDING" | "COPYING"
    The lifecycle status of the backup.
    resource_arn string
    The Amazon Resource Name (ARN) of the backup.
    tags list(object)
    The tags to apply to the backup at backup creation.
    type "AUTOMATIC" | "USER_INITIATED" | "AWS_BACKUP"
    The type of the backup.
    backupId String
    The ID of the backup.
    creationTime String
    The time when the backup was created.
    lifecycle BackupLifecycle
    The lifecycle status of the backup.
    resourceArn String
    The Amazon Resource Name (ARN) of the backup.
    tags List<Tag>
    The tags to apply to the backup at backup creation.
    type BackupType
    The type of the backup.
    backupId string
    The ID of the backup.
    creationTime string
    The time when the backup was created.
    lifecycle BackupLifecycle
    The lifecycle status of the backup.
    resourceArn string
    The Amazon Resource Name (ARN) of the backup.
    tags Tag[]
    The tags to apply to the backup at backup creation.
    type BackupType
    The type of the backup.
    backup_id str
    The ID of the backup.
    creation_time str
    The time when the backup was created.
    lifecycle BackupLifecycle
    The lifecycle status of the backup.
    resource_arn str
    The Amazon Resource Name (ARN) of the backup.
    tags Sequence[root_Tag]
    The tags to apply to the backup at backup creation.
    type BackupType
    The type of the backup.
    backupId String
    The ID of the backup.
    creationTime String
    The time when the backup was created.
    lifecycle "AVAILABLE" | "CREATING" | "TRANSFERRING" | "DELETED" | "FAILED" | "PENDING" | "COPYING"
    The lifecycle status of the backup.
    resourceArn String
    The Amazon Resource Name (ARN) of the backup.
    tags List<Property Map>
    The tags to apply to the backup at backup creation.
    type "AUTOMATIC" | "USER_INITIATED" | "AWS_BACKUP"
    The type of the backup.

    Supporting Types

    BackupLifecycle

    BackupType

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.81.0
    published on Monday, Sep 28, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial