LocationSmb class

Manages a SMB Location within AWS DataSync.

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

Example Usage

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: [exampleAwsDatasyncAgent.arn],
});
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=[example_aws_datasync_agent["arn"]])
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[]
        {
            exampleAwsDatasyncAgent.Arn,
        },
    });

});
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.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{
				exampleAwsDatasyncAgent.Arn,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_datasync_locationsmb" "example" {
  server_hostname = "smb.example.com"
  subdirectory    = "/exported/path"
  user            = "Guest"
  password        = "ANotGreatPassword"
  agent_arns      = [exampleAwsDatasyncAgent.arn]
}
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.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 LocationSmb("example", LocationSmbArgs.builder()
            .serverHostname("smb.example.com")
            .subdirectory("/exported/path")
            .user("Guest")
            .password("ANotGreatPassword")
            .agentArns(exampleAwsDatasyncAgent.arn())
            .build());

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

Import

Identity Schema

Required

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

Using pulumi import, import aws.datasync.LocationSmb using the ARN. For example:

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

Constructors

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

Properties

agentArns ↔ Output<List<String>>
A list of DataSync Agent ARNs with which this location will be associated.
latefinal
arn ↔ Output<String>
ARN of the DataSync Location.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
domain ↔ Output<String>
The name of the Windows domain the SMB server belongs to.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
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
mountOptions ↔ Output<LocationSmbMountOptions?>
Configuration block containing mount options used by DataSync to access the SMB Server. Can be AUTOMATIC, SMB2, or SMB3.
latefinal
password ↔ Output<String>
The password of the user who can mount the share and has file permissions in the SMB.
latefinal
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
serverHostname ↔ Output<String>
Specifies the IP address or DNS name of the SMB server. The DataSync Agent(s) use this to mount the SMB share.
latefinal
subdirectory ↔ Output<String>
Subdirectory to perform actions as source or destination. Should be exported by the NFS server.
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
user ↔ Output<String>
The user who can mount the share and has file and folder permissions in the SMB share.
latefinal

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, {LocationSmbState? state, CustomResourceOptions? options}) → LocationSmb
Gets an existing LocationSmb resource's state with the given name and id.