Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. datasync
  5. LocationSmb

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.13.1 published on Tuesday, Dec 5, 2023 by Pulumi
pulumi/pulumi-aws

aws.datasync.LocationSmb

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.13.1 published on Tuesday, Dec 5, 2023 by Pulumi
pulumi/pulumi-aws

    Manages a SMB Location within AWS DataSync.

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

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = new Aws.DataSync.LocationSmb("example", new()
    {
        ServerHostname = "smb.example.com",
        Subdirectory = "/exported/path",
        User = "Guest",
        Password = "ANotGreatPassword",
        AgentArns = new[]
        {
            aws_datasync_agent.Example.Arn,
        },
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datasync.NewLocationSmb(ctx, "example", &datasync.LocationSmbArgs{
			ServerHostname: pulumi.String("smb.example.com"),
			Subdirectory:   pulumi.String("/exported/path"),
			User:           pulumi.String("Guest"),
			Password:       pulumi.String("ANotGreatPassword"),
			AgentArns: pulumi.StringArray{
				aws_datasync_agent.Example.Arn,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.datasync.LocationSmb;
import com.pulumi.aws.datasync.LocationSmbArgs;
import java.util.List;
import java.util.ArrayList;
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 LocationSmb("example", LocationSmbArgs.builder()        
            .serverHostname("smb.example.com")
            .subdirectory("/exported/path")
            .user("Guest")
            .password("ANotGreatPassword")
            .agentArns(aws_datasync_agent.example().arn())
            .build());

    }
}

    import pulumi
import pulumi_aws as aws

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

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

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

    resources:
  example:
    type: aws:datasync:LocationSmb
    properties:
      serverHostname: smb.example.com
      subdirectory: /exported/path
      user: Guest
      password: ANotGreatPassword
      agentArns:
        - ${aws_datasync_agent.example.arn}

    Create LocationSmb Resource

    new LocationSmb(name: string, args: LocationSmbArgs, opts?: CustomResourceOptions);
    @overload
def LocationSmb(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                agent_arns: Optional[Sequence[str]] = None,
                domain: Optional[str] = None,
                mount_options: Optional[LocationSmbMountOptionsArgs] = None,
                password: Optional[str] = None,
                server_hostname: Optional[str] = None,
                subdirectory: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                user: Optional[str] = None)
@overload
def LocationSmb(resource_name: str,
                args: LocationSmbArgs,
                opts: Optional[ResourceOptions] = None)
    func NewLocationSmb(ctx *Context, name string, args LocationSmbArgs, opts ...ResourceOption) (*LocationSmb, error)
    public LocationSmb(string name, LocationSmbArgs args, CustomResourceOptions? opts = null)
    public LocationSmb(String name, LocationSmbArgs args)
public LocationSmb(String name, LocationSmbArgs args, CustomResourceOptions options)

    type: aws:datasync:LocationSmb
properties: # The arguments to resource properties.
options: # 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.
    resource_name str
    The unique name of the resource.
    args LocationSmbArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args LocationSmbArgs
    The arguments to resource properties.
    options 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 Architecture and Concepts 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 LocationSmbMountOptions

    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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    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 LocationSmbMountOptionsArgs

    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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    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 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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    agent_arns Sequence[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 LocationSmbMountOptionsArgs

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

    tags Mapping[str, str]

    Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    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 Property Map

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

    tags Map<String>

    Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    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.

    TagsAll Dictionary<string, string>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Uri string
    Arn string

    Amazon Resource Name (ARN) of the DataSync Location.

    Id string

    The provider-assigned unique ID for this managed resource.

    TagsAll map[string]string

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Uri string
    arn String

    Amazon Resource Name (ARN) of the DataSync Location.

    id String

    The provider-assigned unique ID for this managed resource.

    tagsAll Map<String,String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    uri String
    arn string

    Amazon Resource Name (ARN) of the DataSync Location.

    id string

    The provider-assigned unique ID for this managed resource.

    tagsAll {[key: string]: string}

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    uri string
    arn str

    Amazon Resource Name (ARN) of the DataSync Location.

    id str

    The provider-assigned unique ID for this managed resource.

    tags_all Mapping[str, str]

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    uri str
    arn String

    Amazon Resource Name (ARN) of the DataSync Location.

    id String

    The provider-assigned unique ID for this managed resource.

    tagsAll Map<String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    uri String

    Look up 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        agent_arns: Optional[Sequence[str]] = None,
        arn: Optional[str] = None,
        domain: Optional[str] = None,
        mount_options: Optional[LocationSmbMountOptionsArgs] = None,
        password: Optional[str] = None,
        server_hostname: Optional[str] = None,
        subdirectory: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        uri: Optional[str] = None,
        user: Optional[str] = None) -> LocationSmb
    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)
    public static LocationSmb get(String name, Output<String> id, LocationSmbState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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 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 Dictionary<string, string>

    Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll Dictionary<string, string>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    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 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 map[string]string

    Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll map[string]string

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Uri string
    User string

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

    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 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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String,String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll {[key: string]: string}

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    uri string
    user string

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

    agent_arns Sequence[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 LocationSmbMountOptionsArgs

    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 Mapping[str, str]

    Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tags_all Mapping[str, str]

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    uri str
    user str

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

    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 Property Map

    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>

    Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    uri String
    user String

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

    Supporting Types

    LocationSmbMountOptions, LocationSmbMountOptionsArgs

    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 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

    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

    Import

    Using pulumi import, import aws_datasync_location_smb using the Amazon Resource Name (ARN). For example:

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

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.13.1 published on Tuesday, Dec 5, 2023 by Pulumi
    pulumi/pulumi-aws