EfsLocation

Manages an AWS DataSync EFS Location.

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

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.DataSync.EfsLocation("example", new Aws.DataSync.EfsLocationArgs
        {
            Ec2Config = new Aws.DataSync.Inputs.EfsLocationEc2ConfigArgs
            {
                SecurityGroupArns = 
                {
                    aws_security_group.Example.Arn,
                },
                SubnetArn = aws_subnet.Example.Arn,
            },
            EfsFileSystemArn = aws_efs_mount_target.Example.File_system_arn,
        });
    }

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := datasync.NewEfsLocation(ctx, "example", &datasync.EfsLocationArgs{
            Ec2Config: &datasync.EfsLocationEc2ConfigArgs{
                SecurityGroupArns: pulumi.StringArray{
                    pulumi.String(aws_security_group.Example.Arn),
                },
                SubnetArn: pulumi.String(aws_subnet.Example.Arn),
            },
            EfsFileSystemArn: pulumi.String(aws_efs_mount_target.Example.File_system_arn),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

example = aws.datasync.EfsLocation("example",
    ec2_config={
        "securityGroupArns": [aws_security_group["example"]["arn"]],
        "subnetArn": aws_subnet["example"]["arn"],
    },
    efs_file_system_arn=aws_efs_mount_target["example"]["file_system_arn"])

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

const example = new aws.datasync.EfsLocation("example", {
    ec2Config: {
        securityGroupArns: [aws_security_group_example.arn],
        subnetArn: aws_subnet_example.arn,
    },
    // The below example uses aws_efs_mount_target as a reference to ensure a mount target already exists when resource creation occurs.
    // You can accomplish the same behavior with depends_on or an aws_efs_mount_target data source reference.
    efsFileSystemArn: aws_efs_mount_target_example.fileSystemArn,
});

Create a EfsLocation Resource

new EfsLocation(name: string, args: EfsLocationArgs, opts?: CustomResourceOptions);

def EfsLocation(resource_name, opts=None, ec2_config=None, efs_file_system_arn=None, subdirectory=None, tags=None, __props__=None);

func NewEfsLocation(ctx *Context, name string, args EfsLocationArgs, opts ...ResourceOption) (*EfsLocation, error)

public EfsLocation(string name, EfsLocationArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args EfsLocationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args EfsLocationArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args EfsLocationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

EfsLocation Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The EfsLocation resource accepts the following input properties:

Ec2Config EfsLocationEc2ConfigArgs: Configuration block containing EC2 configurations for connecting to the EFS File System.
EfsFileSystemArn string: Amazon Resource Name (ARN) of EFS File System.
Subdirectory string: Subdirectory to perform actions as source or destination. Default /.
Tags Dictionary<string, string>: Key-value pairs of resource tags to assign to the DataSync Location.

Ec2Config EfsLocationEc2Config: Configuration block containing EC2 configurations for connecting to the EFS File System.
EfsFileSystemArn string: Amazon Resource Name (ARN) of EFS File System.
Subdirectory string: Subdirectory to perform actions as source or destination. Default /.
Tags map[string]string: Key-value pairs of resource tags to assign to the DataSync Location.

ec2Config EfsLocationEc2Config: Configuration block containing EC2 configurations for connecting to the EFS File System.
efsFileSystemArn ARN: Amazon Resource Name (ARN) of EFS File System.
subdirectory string: Subdirectory to perform actions as source or destination. Default /.
tags {[key: string]: string}: Key-value pairs of resource tags to assign to the DataSync Location.

ec2_config Dict[EfsLocationEc2Config]: Configuration block containing EC2 configurations for connecting to the EFS File System.
efs_file_system_arn str: Amazon Resource Name (ARN) of EFS File System.
subdirectory str: Subdirectory to perform actions as source or destination. Default /.
tags Dict[str, str]: Key-value pairs of resource tags to assign to the DataSync Location.

Outputs

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

Arn string: Amazon Resource Name (ARN) of the DataSync Location.
Id string: The provider-assigned unique ID for this managed resource.
Uri string

Arn string: Amazon Resource Name (ARN) of the DataSync Location.
Id string: The provider-assigned unique ID for this managed resource.
Uri string

arn string: Amazon Resource Name (ARN) of the DataSync Location.
id string: The provider-assigned unique ID for this managed resource.
uri string

arn str: Amazon Resource Name (ARN) of the DataSync Location.
id str: The provider-assigned unique ID for this managed resource.
uri str

Look up an Existing EfsLocation Resource

Get an existing EfsLocation 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?: EfsLocationState, opts?: CustomResourceOptions): EfsLocation

static get(resource_name, id, opts=None, arn=None, ec2_config=None, efs_file_system_arn=None, subdirectory=None, tags=None, uri=None, __props__=None);

func GetEfsLocation(ctx *Context, name string, id IDInput, state *EfsLocationState, opts ...ResourceOption) (*EfsLocation, error)

public static EfsLocation Get(string name, Input<string> id, EfsLocationState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

Arn string: Amazon Resource Name (ARN) of the DataSync Location.
Ec2Config EfsLocationEc2ConfigArgs: Configuration block containing EC2 configurations for connecting to the EFS File System.
EfsFileSystemArn string: Amazon Resource Name (ARN) of EFS File System.
Subdirectory string: Subdirectory to perform actions as source or destination. Default /.
Tags Dictionary<string, string>: Key-value pairs of resource tags to assign to the DataSync Location.
Uri string

Arn string: Amazon Resource Name (ARN) of the DataSync Location.
Ec2Config EfsLocationEc2Config: Configuration block containing EC2 configurations for connecting to the EFS File System.
EfsFileSystemArn string: Amazon Resource Name (ARN) of EFS File System.
Subdirectory string: Subdirectory to perform actions as source or destination. Default /.
Tags map[string]string: Key-value pairs of resource tags to assign to the DataSync Location.
Uri string

arn string: Amazon Resource Name (ARN) of the DataSync Location.
ec2Config EfsLocationEc2Config: Configuration block containing EC2 configurations for connecting to the EFS File System.
efsFileSystemArn ARN: Amazon Resource Name (ARN) of EFS File System.
subdirectory string: Subdirectory to perform actions as source or destination. Default /.
tags {[key: string]: string}: Key-value pairs of resource tags to assign to the DataSync Location.
uri string

arn str: Amazon Resource Name (ARN) of the DataSync Location.
ec2_config Dict[EfsLocationEc2Config]: Configuration block containing EC2 configurations for connecting to the EFS File System.
efs_file_system_arn str: Amazon Resource Name (ARN) of EFS File System.
subdirectory str: Subdirectory to perform actions as source or destination. Default /.
tags Dict[str, str]: Key-value pairs of resource tags to assign to the DataSync Location.
uri str

Supporting Types

EfsLocationEc2Config

See the input and output API doc for this type.

SecurityGroupArns List<string>: List of Amazon Resource Names (ARNs) of the EC2 Security Groups that are associated with the EFS Mount Target.
SubnetArn string: Amazon Resource Name (ARN) of the EC2 Subnet that is associated with the EFS Mount Target.

SecurityGroupArns []string: List of Amazon Resource Names (ARNs) of the EC2 Security Groups that are associated with the EFS Mount Target.
SubnetArn string: Amazon Resource Name (ARN) of the EC2 Subnet that is associated with the EFS Mount Target.

securityGroupArns string[]: List of Amazon Resource Names (ARNs) of the EC2 Security Groups that are associated with the EFS Mount Target.
subnetArn string: Amazon Resource Name (ARN) of the EC2 Subnet that is associated with the EFS Mount Target.

securityGroupArns List[str]: List of Amazon Resource Names (ARNs) of the EC2 Security Groups that are associated with the EFS Mount Target.
subnetArn str: Amazon Resource Name (ARN) of the EC2 Subnet that is associated with the EFS Mount Target.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud