Class 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",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

LocationSmb

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.DataSync

Assembly: Pulumi.Aws.dll

Syntax

public class LocationSmb : CustomResource

Constructors

LocationSmb(String, LocationSmbArgs, CustomResourceOptions)

Create a LocationSmb resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
LocationSmbArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

AgentArns

A list of DataSync Agent ARNs with which this location will be associated.

Declaration

public Output<ImmutableArray<string>> AgentArns { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Arn

Amazon Resource Name (ARN) of the DataSync Location.

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

Domain

The name of the Windows domain the SMB server belongs to.

Declaration

public Output<string> Domain { get; }

Property Value

Type	Description
Output<System.String>

MountOptions

Configuration block containing mount options used by DataSync to access the SMB Server. Can be AUTOMATIC, SMB2, or SMB3.

Declaration

public Output<LocationSmbMountOptions> MountOptions { get; }

Property Value

Type	Description
Output<LocationSmbMountOptions>

Password

The password of the user who can mount the share and has file permissions in the SMB.

Declaration

public Output<string> Password { get; }

Property Value

Type	Description
Output<System.String>

ServerHostname

Specifies the IP address or DNS name of the SMB server. The DataSync Agent(s) use this to mount the SMB share.

Declaration

public Output<string> ServerHostname { get; }

Property Value

Type	Description
Output<System.String>

Subdirectory

Subdirectory to perform actions as source or destination. Should be exported by the NFS server.

Declaration

public Output<string> Subdirectory { get; }

Property Value

Type	Description
Output<System.String>

Tags

Key-value pairs of resource tags to assign to the DataSync Location.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Uri

Declaration

public Output<string> Uri { get; }

Property Value

Type	Description
Output<System.String>

User

The user who can mount the share and has file and folder permissions in the SMB share.

Declaration

public Output<string> User { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, LocationSmbState, CustomResourceOptions)

Get an existing LocationSmb resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static LocationSmb Get(string name, Input<string> id, LocationSmbState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
LocationSmbState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
LocationSmb