LocationFsxOntapFileSystem class

Resource for managing an AWS DataSync Location FSx Ontap File System.

Example Usage

Basic Usage

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

const test = new aws.datasync.LocationFsxOntapFileSystem("test", {
    protocol: {
        nfs: {
            mountOptions: {
                version: "NFS3",
            },
        },
    },
    fsxFilesystemArn: testAwsFsxOntapFileSystem.arn,
    securityGroupArns: [testAwsSecurityGroup.arn],
    storageVirtualMachineArn: testAwsFsxOntapStorageVirtualMachine.arn,
});

import pulumi
import pulumi_aws as aws

test = aws.datasync.LocationFsxOntapFileSystem("test",
    protocol={
        "nfs": {
            "mount_options": {
                "version": "NFS3",
            },
        },
    },
    fsx_filesystem_arn=test_aws_fsx_ontap_file_system["arn"],
    security_group_arns=[test_aws_security_group["arn"]],
    storage_virtual_machine_arn=test_aws_fsx_ontap_storage_virtual_machine["arn"])

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

return await Deployment.RunAsync(() =>
{
    var test = new Aws.DataSync.LocationFsxOntapFileSystem("test", new()
    {
        Protocol = new Aws.DataSync.Inputs.LocationFsxOntapFileSystemProtocolArgs
        {
            Nfs = new Aws.DataSync.Inputs.LocationFsxOntapFileSystemProtocolNfsArgs
            {
                MountOptions = new Aws.DataSync.Inputs.LocationFsxOntapFileSystemProtocolNfsMountOptionsArgs
                {
                    Version = "NFS3",
                },
            },
        },
        FsxFilesystemArn = testAwsFsxOntapFileSystem.Arn,
        SecurityGroupArns = new[]
        {
            testAwsSecurityGroup.Arn,
        },
        StorageVirtualMachineArn = testAwsFsxOntapStorageVirtualMachine.Arn,
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/datasync"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datasync.NewLocationFsxOntapFileSystem(ctx, "test", &datasync.LocationFsxOntapFileSystemArgs{
			Protocol: &datasync.LocationFsxOntapFileSystemProtocolArgs{
				Nfs: &datasync.LocationFsxOntapFileSystemProtocolNfsArgs{
					MountOptions: &datasync.LocationFsxOntapFileSystemProtocolNfsMountOptionsArgs{
						Version: pulumi.String("NFS3"),
					},
				},
			},
			FsxFilesystemArn: testAwsFsxOntapFileSystem.Arn,
			SecurityGroupArns: pulumi.StringArray{
				testAwsSecurityGroup.Arn,
			},
			StorageVirtualMachineArn: pulumi.Any(testAwsFsxOntapStorageVirtualMachine.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_datasync_locationfsxontapfilesystem" "test" {
  protocol = {
    nfs = {
      mount_options = {
        version = "NFS3"
      }
    }
  }
  fsx_filesystem_arn          = testAwsFsxOntapFileSystem.arn
  security_group_arns         = [testAwsSecurityGroup.arn]
  storage_virtual_machine_arn = testAwsFsxOntapStorageVirtualMachine.arn
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.datasync.LocationFsxOntapFileSystem;
import com.pulumi.aws.datasync.LocationFsxOntapFileSystemArgs;
import com.pulumi.aws.datasync.inputs.LocationFsxOntapFileSystemProtocolArgs;
import com.pulumi.aws.datasync.inputs.LocationFsxOntapFileSystemProtocolNfsArgs;
import com.pulumi.aws.datasync.inputs.LocationFsxOntapFileSystemProtocolNfsMountOptionsArgs;
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 test = new LocationFsxOntapFileSystem("test", LocationFsxOntapFileSystemArgs.builder()
            .protocol(LocationFsxOntapFileSystemProtocolArgs.builder()
                .nfs(LocationFsxOntapFileSystemProtocolNfsArgs.builder()
                    .mountOptions(LocationFsxOntapFileSystemProtocolNfsMountOptionsArgs.builder()
                        .version("NFS3")
                        .build())
                    .build())
                .build())
            .fsxFilesystemArn(testAwsFsxOntapFileSystem.arn())
            .securityGroupArns(testAwsSecurityGroup.arn())
            .storageVirtualMachineArn(testAwsFsxOntapStorageVirtualMachine.arn())
            .build());

    }
}

resources:
  test:
    type: aws:datasync:LocationFsxOntapFileSystem
    properties:
      protocol:
        nfs:
          mountOptions:
            version: NFS3
      fsxFilesystemArn: ${testAwsFsxOntapFileSystem.arn}
      securityGroupArns:
        - ${testAwsSecurityGroup.arn}
      storageVirtualMachineArn: ${testAwsFsxOntapStorageVirtualMachine.arn}

Import

Using pulumi import, import aws.datasync.LocationFsxOntapFileSystem using the DataSync-ARN#FSx-ontap-svm-ARN. For example:

$ pulumi import aws:datasync/locationFsxOntapFileSystem:LocationFsxOntapFileSystem example arn:aws:datasync:us-west-2:123456789012:location/loc-12345678901234567#arn:aws:fsx:us-west-2:123456789012:storage-virtual-machine/svm-12345678abcdef123

Constructors

LocationFsxOntapFileSystem(String name, {LocationFsxOntapFileSystemArgs? args, CustomResourceOptions? options})
Creates a new LocationFsxOntapFileSystem. name The Pulumi resource name. args Arguments used to configure this LocationFsxOntapFileSystem. The set of arguments for LocationFsxOntapFileSystem. options Resource options controlling this resource's behavior.
LocationFsxOntapFileSystem.reference(String urn)
Creates a typed reference to an existing LocationFsxOntapFileSystem resource.

Properties

arn ↔ Output<String>
ARN of the DataSync Location for the FSx Ontap File System.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
creationTime ↔ Output<String>
latefinal
fsxFilesystemArn ↔ Output<String>
ARN of the FSx Ontap File System.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
protocol ↔ Output<LocationFsxOntapFileSystemProtocol>
The data transfer protocol that DataSync uses to access your Amazon FSx file system. See Protocol below.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityGroupArns ↔ Output<List<String>>
The security groups that provide access to your file system's preferred subnet. The security groups must allow outbbound traffic on the following ports (depending on the protocol you use):
latefinal
storageVirtualMachineArn ↔ Output<String>
The ARN of the SVM in your file system where you want to copy data to of from.
latefinal
subdirectory ↔ Output<String>
Path to the file share in the SVM where you'll copy your data. You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares) (e.g. /vol1, /vol1/tree1, share1).
latefinal
tags ↔ Output<Map<String, String>?>
Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
uri ↔ Output<String>
URI of the FSx ONTAP file system location
latefinal
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {LocationFsxOntapFileSystemState? state, CustomResourceOptions? options}) → LocationFsxOntapFileSystem
Gets an existing LocationFsxOntapFileSystem resource's state with the given name and id.