LocationSmb

Manages a SMB Location within AWS DataSync.

NOTE: The DataSync Agents must be available before creating this resource.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.DataSync.LocationSmb("example", new Aws.DataSync.LocationSmbArgs
        {
            AgentArns = 
            {
                aws_datasync_agent.Example.Arn,
            },
            Password = "ANotGreatPassword",
            ServerHostname = "smb.example.com",
            Subdirectory = "/exported/path",
            User = "Guest",
        });
    }

}

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.NewLocationSmb(ctx, "example", &datasync.LocationSmbArgs{
            AgentArns: pulumi.StringArray{
                pulumi.String(aws_datasync_agent.Example.Arn),
            },
            Password:       pulumi.String("ANotGreatPassword"),
            ServerHostname: pulumi.String("smb.example.com"),
            Subdirectory:   pulumi.String("/exported/path"),
            User:           pulumi.String("Guest"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

example = aws.datasync.LocationSmb("example",
    agent_arns=[aws_datasync_agent["example"]["arn"]],
    password="ANotGreatPassword",
    server_hostname="smb.example.com",
    subdirectory="/exported/path",
    user="Guest")

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

const example = new aws.datasync.LocationSmb("example", {
    agentArns: [aws_datasync_agent_example.arn],
    password: "ANotGreatPassword",
    serverHostname: "smb.example.com",
    subdirectory: "/exported/path",
    user: "Guest",
});

Create a LocationSmb Resource

new LocationSmb(name: string, args: LocationSmbArgs, opts?: CustomResourceOptions);

def LocationSmb(resource_name, opts=None, agent_arns=None, domain=None, mount_options=None, password=None, server_hostname=None, subdirectory=None, tags=None, user=None, __props__=None);

func NewLocationSmb(ctx *Context, name string, args LocationSmbArgs, opts ...ResourceOption) (*LocationSmb, error)

public LocationSmb(string name, LocationSmbArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args LocationSmbArgs: 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 LocationSmbArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

LocationSmb Resource Properties

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

Inputs

The LocationSmb resource accepts the following input properties:

AgentArns List<string>: A list of DataSync Agent ARNs with which this location will be associated.
Password string: The password of the user who can mount the share and has file permissions in the SMB.
ServerHostname string: Specifies the IP address or DNS name of the SMB server. The DataSync Agent(s) use this to mount the SMB share.
Subdirectory string: Subdirectory to perform actions as source or destination. Should be exported by the NFS server.
User string: The user who can mount the share and has file and folder permissions in the SMB share.
Domain string: The name of the Windows domain the SMB server belongs to.
MountOptions LocationSmbMountOptionsArgs: Configuration block containing mount options used by DataSync to access the SMB Server. Can be AUTOMATIC, SMB2, or SMB3.
Tags Dictionary<string, string>: Key-value pairs of resource tags to assign to the DataSync Location.

AgentArns []string: A list of DataSync Agent ARNs with which this location will be associated.
Password string: The password of the user who can mount the share and has file permissions in the SMB.
ServerHostname string: Specifies the IP address or DNS name of the SMB server. The DataSync Agent(s) use this to mount the SMB share.
Subdirectory string: Subdirectory to perform actions as source or destination. Should be exported by the NFS server.
User string: The user who can mount the share and has file and folder permissions in the SMB share.
Domain string: The name of the Windows domain the SMB server belongs to.
MountOptions LocationSmbMountOptions: Configuration block containing mount options used by DataSync to access the SMB Server. Can be AUTOMATIC, SMB2, or SMB3.
Tags map[string]string: Key-value pairs of resource tags to assign to the DataSync Location.

agentArns string[]: A list of DataSync Agent ARNs with which this location will be associated.
password string: The password of the user who can mount the share and has file permissions in the SMB.
serverHostname string: Specifies the IP address or DNS name of the SMB server. The DataSync Agent(s) use this to mount the SMB share.
subdirectory string: Subdirectory to perform actions as source or destination. Should be exported by the NFS server.
user string: The user who can mount the share and has file and folder permissions in the SMB share.
domain string: The name of the Windows domain the SMB server belongs to.
mountOptions LocationSmbMountOptions: Configuration block containing mount options used by DataSync to access the SMB Server. Can be AUTOMATIC, SMB2, or SMB3.
tags {[key: string]: string}: Key-value pairs of resource tags to assign to the DataSync Location.

agent_arns List[str]: A list of DataSync Agent ARNs with which this location will be associated.
password str: The password of the user who can mount the share and has file permissions in the SMB.
server_hostname str: Specifies the IP address or DNS name of the SMB server. The DataSync Agent(s) use this to mount the SMB share.
subdirectory str: Subdirectory to perform actions as source or destination. Should be exported by the NFS server.
user str: The user who can mount the share and has file and folder permissions in the SMB share.
domain str: The name of the Windows domain the SMB server belongs to.
mount_options Dict[LocationSmbMountOptions]: Configuration block containing mount options used by DataSync to access the SMB Server. Can be AUTOMATIC, SMB2, or SMB3.
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 LocationSmb 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 LocationSmb Resource

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

static get(resource_name, id, opts=None, agent_arns=None, arn=None, domain=None, mount_options=None, password=None, server_hostname=None, subdirectory=None, tags=None, uri=None, user=None, __props__=None);

func GetLocationSmb(ctx *Context, name string, id IDInput, state *LocationSmbState, opts ...ResourceOption) (*LocationSmb, error)

public static LocationSmb Get(string name, Input<string> id, LocationSmbState? 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:

AgentArns List<string>: A list of DataSync Agent ARNs with which this location will be associated.
Arn string: Amazon Resource Name (ARN) of the DataSync Location.
Domain string: The name of the Windows domain the SMB server belongs to.
MountOptions LocationSmbMountOptionsArgs: Configuration block containing mount options used by DataSync to access the SMB Server. Can be AUTOMATIC, SMB2, or SMB3.
Password string: The password of the user who can mount the share and has file permissions in the SMB.
ServerHostname string: Specifies the IP address or DNS name of the SMB server. The DataSync Agent(s) use this to mount the SMB share.
Subdirectory string: Subdirectory to perform actions as source or destination. Should be exported by the NFS server.
Tags Dictionary<string, string>: Key-value pairs of resource tags to assign to the DataSync Location.
Uri string
User string: The user who can mount the share and has file and folder permissions in the SMB share.

AgentArns []string: A list of DataSync Agent ARNs with which this location will be associated.
Arn string: Amazon Resource Name (ARN) of the DataSync Location.
Domain string: The name of the Windows domain the SMB server belongs to.
MountOptions LocationSmbMountOptions: Configuration block containing mount options used by DataSync to access the SMB Server. Can be AUTOMATIC, SMB2, or SMB3.
Password string: The password of the user who can mount the share and has file permissions in the SMB.
ServerHostname string: Specifies the IP address or DNS name of the SMB server. The DataSync Agent(s) use this to mount the SMB share.
Subdirectory string: Subdirectory to perform actions as source or destination. Should be exported by the NFS server.
Tags map[string]string: Key-value pairs of resource tags to assign to the DataSync Location.
Uri string
User string: The user who can mount the share and has file and folder permissions in the SMB share.

agentArns string[]: A list of DataSync Agent ARNs with which this location will be associated.
arn string: Amazon Resource Name (ARN) of the DataSync Location.
domain string: The name of the Windows domain the SMB server belongs to.
mountOptions LocationSmbMountOptions: Configuration block containing mount options used by DataSync to access the SMB Server. Can be AUTOMATIC, SMB2, or SMB3.
password string: The password of the user who can mount the share and has file permissions in the SMB.
serverHostname string: Specifies the IP address or DNS name of the SMB server. The DataSync Agent(s) use this to mount the SMB share.
subdirectory string: Subdirectory to perform actions as source or destination. Should be exported by the NFS server.
tags {[key: string]: string}: Key-value pairs of resource tags to assign to the DataSync Location.
uri string
user string: The user who can mount the share and has file and folder permissions in the SMB share.

agent_arns List[str]: A list of DataSync Agent ARNs with which this location will be associated.
arn str: Amazon Resource Name (ARN) of the DataSync Location.
domain str: The name of the Windows domain the SMB server belongs to.
mount_options Dict[LocationSmbMountOptions]: Configuration block containing mount options used by DataSync to access the SMB Server. Can be AUTOMATIC, SMB2, or SMB3.
password str: The password of the user who can mount the share and has file permissions in the SMB.
server_hostname str: Specifies the IP address or DNS name of the SMB server. The DataSync Agent(s) use this to mount the SMB share.
subdirectory str: Subdirectory to perform actions as source or destination. Should be exported by the NFS server.
tags Dict[str, str]: Key-value pairs of resource tags to assign to the DataSync Location.
uri str
user str: The user who can mount the share and has file and folder permissions in the SMB share.

Supporting Types

LocationSmbMountOptions

See the input and output API doc for this type.

Version string: The specific SMB version that you want DataSync to use for mounting your SMB share. Valid values: AUTOMATIC, SMB2, and SMB3. Default: AUTOMATIC

Version string: The specific SMB version that you want DataSync to use for mounting your SMB share. Valid values: AUTOMATIC, SMB2, and SMB3. Default: AUTOMATIC

version string: The specific SMB version that you want DataSync to use for mounting your SMB share. Valid values: AUTOMATIC, SMB2, and SMB3. Default: AUTOMATIC

version str: The specific SMB version that you want DataSync to use for mounting your SMB share. Valid values: AUTOMATIC, SMB2, and SMB3. Default: AUTOMATIC

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