EfsLocation class

Manages an AWS DataSync EFS Location.

> NOTE: The EFS File System must have a mounted EFS Mount Target before creating this resource.

Example Usage

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

const example = new aws.datasync.EfsLocation("example", {
    ec2Config: {
        securityGroupArns: [exampleAwsSecurityGroup.arn],
        subnetArn: exampleAwsSubnet.arn,
    },
    efsFileSystemArn: exampleAwsEfsMountTarget.fileSystemArn,
});
import pulumi
import pulumi_aws as aws

example = aws.datasync.EfsLocation("example",
    ec2_config={
        "security_group_arns": [example_aws_security_group["arn"]],
        "subnet_arn": example_aws_subnet["arn"],
    },
    efs_file_system_arn=example_aws_efs_mount_target["fileSystemArn"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.DataSync.EfsLocation("example", new()
    {
        Ec2Config = new Aws.DataSync.Inputs.EfsLocationEc2ConfigArgs
        {
            SecurityGroupArns = new[]
            {
                exampleAwsSecurityGroup.Arn,
            },
            SubnetArn = exampleAwsSubnet.Arn,
        },
        EfsFileSystemArn = exampleAwsEfsMountTarget.FileSystemArn,
    });

});
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.NewEfsLocation(ctx, "example", &datasync.EfsLocationArgs{
			Ec2Config: &datasync.EfsLocationEc2ConfigArgs{
				SecurityGroupArns: pulumi.StringArray{
					exampleAwsSecurityGroup.Arn,
				},
				SubnetArn: pulumi.Any(exampleAwsSubnet.Arn),
			},
			EfsFileSystemArn: pulumi.Any(exampleAwsEfsMountTarget.FileSystemArn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_datasync_efslocation" "example" {
  ec2_config = {
    security_group_arns = [exampleAwsSecurityGroup.arn]
    subnet_arn          = exampleAwsSubnet.arn
  }
  efs_file_system_arn = exampleAwsEfsMountTarget.fileSystemArn
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.datasync.EfsLocation;
import com.pulumi.aws.datasync.EfsLocationArgs;
import com.pulumi.aws.datasync.inputs.EfsLocationEc2ConfigArgs;
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 example = new EfsLocation("example", EfsLocationArgs.builder()
            .ec2Config(EfsLocationEc2ConfigArgs.builder()
                .securityGroupArns(exampleAwsSecurityGroup.arn())
                .subnetArn(exampleAwsSubnet.arn())
                .build())
            .efsFileSystemArn(exampleAwsEfsMountTarget.fileSystemArn())
            .build());

    }
}
resources:
  example:
    type: aws:datasync:EfsLocation
    properties:
      ec2Config:
        securityGroupArns:
          - ${exampleAwsSecurityGroup.arn}
        subnetArn: ${exampleAwsSubnet.arn}
      efsFileSystemArn: ${exampleAwsEfsMountTarget.fileSystemArn}

Import

Identity Schema

Required

  • arn (String) ARN of the DataSync EFS location.

Using pulumi import, import aws.datasync.EfsLocation using the DataSync Task ARN. For example:

$ pulumi import aws:datasync/efsLocation:EfsLocation example arn:aws:datasync:us-east-1:123456789012:location/loc-12345678901234567

Constructors

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

Properties

accessPointArn ↔ Output<String?>
ARN of the access point that DataSync uses to access the Amazon EFS file system.
latefinal
arn ↔ Output<String>
ARN of the DataSync Location.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
ec2Config ↔ Output<EfsLocationEc2Config>
Configuration block containing EC2 configurations for connecting to the EFS File System.
latefinal
efsFileSystemArn ↔ Output<String>
ARN of EFS File System.
latefinal
fileSystemAccessRoleArn ↔ Output<String?>
Specifies an Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
inTransitEncryption ↔ Output<String?>
Specifies whether you want DataSync to use TLS encryption when transferring data to or from your Amazon EFS file system. Valid values are NONE and TLS1_2.
latefinal
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
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
subdirectory ↔ Output<String?>
Subdirectory to perform actions as source or destination. Default /.
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>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
uri ↔ Output<String>
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, {EfsLocationState? state, CustomResourceOptions? options}) → EfsLocation
Gets an existing EfsLocation resource's state with the given name and id.