LocationSmb

class LocationSmb : KotlinCustomResource

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/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{
exampleAwsDatasyncAgent.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(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

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

Properties

Link copied to clipboard
val agentArns: Output<List<String>>

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

Link copied to clipboard
val arn: Output<String>

Amazon Resource Name (ARN) of the DataSync Location.

Link copied to clipboard
val domain: Output<String>

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

Link copied to clipboard
val id: Output<String>
Link copied to clipboard

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

Link copied to clipboard
val password: Output<String>

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

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val 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.

Link copied to clipboard
val subdirectory: Output<String>

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

Link copied to clipboard
val tags: Output<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.

Link copied to clipboard
val tagsAll: Output<Map<String, String>>

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

Link copied to clipboard
val uri: Output<String>
Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val user: Output<String>

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