com.pulumi.aws.datasync.kotlin.LocationSmbArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-kotlin Show documentation
Show all versions of pulumi-aws-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.aws.datasync.kotlin
import com.pulumi.aws.datasync.LocationSmbArgs.builder
import com.pulumi.aws.datasync.kotlin.inputs.LocationSmbMountOptionsArgs
import com.pulumi.aws.datasync.kotlin.inputs.LocationSmbMountOptionsArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* Manages a SMB Location within AWS DataSync.
* > **NOTE:** The DataSync Agents must be available before creating this resource.
* ## Example Usage
*
* ```typescript
* 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],
* });
* ```
* ```python
* 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"]])
* ```
* ```csharp
* 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,
* },
* });
* });
* ```
* ```go
* 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
* })
* }
* ```
* ```java
* 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());
* }
* }
* ```
* ```yaml
* 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:
* ```sh
* $ pulumi import aws:datasync/locationSmb:LocationSmb example arn:aws:datasync:us-east-1:123456789012:location/loc-12345678901234567
* ```
* @property agentArns A list of DataSync Agent ARNs with which this location will be associated.
* @property domain The name of the Windows domain the SMB server belongs to.
* @property mountOptions Configuration block containing mount options used by DataSync to access the SMB Server. Can be `AUTOMATIC`, `SMB2`, or `SMB3`.
* @property password The password of the user who can mount the share and has file permissions in the SMB.
* @property serverHostname Specifies the IP address or DNS name of the SMB server. The DataSync Agent(s) use this to mount the SMB share.
* @property subdirectory Subdirectory to perform actions as source or destination. Should be exported by the NFS server.
* @property tags 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.
* @property user The user who can mount the share and has file and folder permissions in the SMB share.
*/
public data class LocationSmbArgs(
public val agentArns: Output>? = null,
public val domain: Output? = null,
public val mountOptions: Output? = null,
public val password: Output? = null,
public val serverHostname: Output? = null,
public val subdirectory: Output? = null,
public val tags: Output>? = null,
public val user: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.aws.datasync.LocationSmbArgs =
com.pulumi.aws.datasync.LocationSmbArgs.builder()
.agentArns(agentArns?.applyValue({ args0 -> args0.map({ args0 -> args0 }) }))
.domain(domain?.applyValue({ args0 -> args0 }))
.mountOptions(mountOptions?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.password(password?.applyValue({ args0 -> args0 }))
.serverHostname(serverHostname?.applyValue({ args0 -> args0 }))
.subdirectory(subdirectory?.applyValue({ args0 -> args0 }))
.tags(tags?.applyValue({ args0 -> args0.map({ args0 -> args0.key.to(args0.value) }).toMap() }))
.user(user?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [LocationSmbArgs].
*/
@PulumiTagMarker
public class LocationSmbArgsBuilder internal constructor() {
private var agentArns: Output>? = null
private var domain: Output? = null
private var mountOptions: Output? = null
private var password: Output? = null
private var serverHostname: Output? = null
private var subdirectory: Output? = null
private var tags: Output>? = null
private var user: Output? = null
/**
* @param value A list of DataSync Agent ARNs with which this location will be associated.
*/
@JvmName("okxexcsyqkygamdj")
public suspend fun agentArns(`value`: Output>) {
this.agentArns = value
}
@JvmName("wdehtlaxlbmxewnr")
public suspend fun agentArns(vararg values: Output) {
this.agentArns = Output.all(values.asList())
}
/**
* @param values A list of DataSync Agent ARNs with which this location will be associated.
*/
@JvmName("hoxgnvqwaokgatnm")
public suspend fun agentArns(values: List>) {
this.agentArns = Output.all(values)
}
/**
* @param value The name of the Windows domain the SMB server belongs to.
*/
@JvmName("iualgdrktuobmepu")
public suspend fun domain(`value`: Output) {
this.domain = value
}
/**
* @param value Configuration block containing mount options used by DataSync to access the SMB Server. Can be `AUTOMATIC`, `SMB2`, or `SMB3`.
*/
@JvmName("lugmjxsubllargle")
public suspend fun mountOptions(`value`: Output) {
this.mountOptions = value
}
/**
* @param value The password of the user who can mount the share and has file permissions in the SMB.
*/
@JvmName("ikquenyhsxhqlniy")
public suspend fun password(`value`: Output) {
this.password = value
}
/**
* @param value Specifies the IP address or DNS name of the SMB server. The DataSync Agent(s) use this to mount the SMB share.
*/
@JvmName("ryxlxdxecgmgwvom")
public suspend fun serverHostname(`value`: Output) {
this.serverHostname = value
}
/**
* @param value Subdirectory to perform actions as source or destination. Should be exported by the NFS server.
*/
@JvmName("pjkyicifxspqnyck")
public suspend fun subdirectory(`value`: Output) {
this.subdirectory = value
}
/**
* @param value 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.
*/
@JvmName("wqxucfpgddsjelki")
public suspend fun tags(`value`: Output>) {
this.tags = value
}
/**
* @param value The user who can mount the share and has file and folder permissions in the SMB share.
*/
@JvmName("dcqtvkkgfgvrmhol")
public suspend fun user(`value`: Output) {
this.user = value
}
/**
* @param value A list of DataSync Agent ARNs with which this location will be associated.
*/
@JvmName("pvryoqrypnlexlwt")
public suspend fun agentArns(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.agentArns = mapped
}
/**
* @param values A list of DataSync Agent ARNs with which this location will be associated.
*/
@JvmName("iaohbafyjntwspep")
public suspend fun agentArns(vararg values: String) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.agentArns = mapped
}
/**
* @param value The name of the Windows domain the SMB server belongs to.
*/
@JvmName("vjqxwabefgnedhib")
public suspend fun domain(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.domain = mapped
}
/**
* @param value Configuration block containing mount options used by DataSync to access the SMB Server. Can be `AUTOMATIC`, `SMB2`, or `SMB3`.
*/
@JvmName("xbhpryxxqmqtutau")
public suspend fun mountOptions(`value`: LocationSmbMountOptionsArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.mountOptions = mapped
}
/**
* @param argument Configuration block containing mount options used by DataSync to access the SMB Server. Can be `AUTOMATIC`, `SMB2`, or `SMB3`.
*/
@JvmName("ixvwfjmfdcecvbym")
public suspend fun mountOptions(argument: suspend LocationSmbMountOptionsArgsBuilder.() -> Unit) {
val toBeMapped = LocationSmbMountOptionsArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.mountOptions = mapped
}
/**
* @param value The password of the user who can mount the share and has file permissions in the SMB.
*/
@JvmName("rbaogvswmjiobdww")
public suspend fun password(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.password = mapped
}
/**
* @param value Specifies the IP address or DNS name of the SMB server. The DataSync Agent(s) use this to mount the SMB share.
*/
@JvmName("dwgaqvplyieginwa")
public suspend fun serverHostname(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.serverHostname = mapped
}
/**
* @param value Subdirectory to perform actions as source or destination. Should be exported by the NFS server.
*/
@JvmName("lfdwgefqmdthvejj")
public suspend fun subdirectory(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.subdirectory = mapped
}
/**
* @param value 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.
*/
@JvmName("bagrjvecwlqhrrdx")
public suspend fun tags(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.tags = mapped
}
/**
* @param values 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.
*/
@JvmName("vjkboruwyptgidbi")
public fun tags(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.tags = mapped
}
/**
* @param value The user who can mount the share and has file and folder permissions in the SMB share.
*/
@JvmName("arrvgpipbnaeeyoo")
public suspend fun user(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.user = mapped
}
internal fun build(): LocationSmbArgs = LocationSmbArgs(
agentArns = agentArns,
domain = domain,
mountOptions = mountOptions,
password = password,
serverHostname = serverHostname,
subdirectory = subdirectory,
tags = tags,
user = user,
)
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy