Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. datasync
  5. getLocationSmb

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.datasync.getLocationSmb

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource schema for AWS::DataSync::LocationSMB.

Using getLocationSmb

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getLocationSmb(args: GetLocationSmbArgs, opts?: InvokeOptions): Promise<GetLocationSmbResult>
function getLocationSmbOutput(args: GetLocationSmbOutputArgs, opts?: InvokeOptions): Output<GetLocationSmbResult>
Copy
def get_location_smb(location_arn: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetLocationSmbResult
def get_location_smb_output(location_arn: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetLocationSmbResult]
Copy
func LookupLocationSmb(ctx *Context, args *LookupLocationSmbArgs, opts ...InvokeOption) (*LookupLocationSmbResult, error)
func LookupLocationSmbOutput(ctx *Context, args *LookupLocationSmbOutputArgs, opts ...InvokeOption) LookupLocationSmbResultOutput
Copy

> Note: This function is named LookupLocationSmb in the Go SDK.

public static class GetLocationSmb 
{
    public static Task<GetLocationSmbResult> InvokeAsync(GetLocationSmbArgs args, InvokeOptions? opts = null)
    public static Output<GetLocationSmbResult> Invoke(GetLocationSmbInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetLocationSmbResult> getLocationSmb(GetLocationSmbArgs args, InvokeOptions options)
public static Output<GetLocationSmbResult> getLocationSmb(GetLocationSmbArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:datasync:getLocationSmb
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

LocationArn This property is required. string
The Amazon Resource Name (ARN) of the SMB location that is created.
LocationArn This property is required. string
The Amazon Resource Name (ARN) of the SMB location that is created.
locationArn This property is required. String
The Amazon Resource Name (ARN) of the SMB location that is created.
locationArn This property is required. string
The Amazon Resource Name (ARN) of the SMB location that is created.
location_arn This property is required. str
The Amazon Resource Name (ARN) of the SMB location that is created.
locationArn This property is required. String
The Amazon Resource Name (ARN) of the SMB location that is created.

getLocationSmb Result

The following output properties are available:

AgentArns List<string>
The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
AuthenticationType Pulumi.AwsNative.DataSync.LocationSmbAuthenticationType
The authentication mode used to determine identity of user.
DnsIpAddresses List<string>
Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS. If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.
Domain string
The name of the Windows domain that the SMB server belongs to.
KerberosPrincipal string
Specifies a service principal name (SPN), which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server. SPNs are case sensitive and must include a prepended cifs/. For example, an SPN might look like cifs/kerberosuser@EXAMPLE.COM. Your task execution will fail if the SPN that you provide for this parameter doesn't match exactly what's in your keytab or krb5.conf files.
LocationArn string
The Amazon Resource Name (ARN) of the SMB location that is created.
LocationUri string
The URL of the SMB location that was described.
MountOptions Pulumi.AwsNative.DataSync.Outputs.LocationSmbMountOptions
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
Tags List<Pulumi.AwsNative.Outputs.Tag>
An array of key-value pairs to apply to this resource.
User string
The user who can mount the share, has the permissions to access files and folders in the SMB share.
AgentArns []string
The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
AuthenticationType LocationSmbAuthenticationType
The authentication mode used to determine identity of user.
DnsIpAddresses []string
Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS. If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.
Domain string
The name of the Windows domain that the SMB server belongs to.
KerberosPrincipal string
Specifies a service principal name (SPN), which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server. SPNs are case sensitive and must include a prepended cifs/. For example, an SPN might look like cifs/kerberosuser@EXAMPLE.COM. Your task execution will fail if the SPN that you provide for this parameter doesn't match exactly what's in your keytab or krb5.conf files.
LocationArn string
The Amazon Resource Name (ARN) of the SMB location that is created.
LocationUri string
The URL of the SMB location that was described.
MountOptions LocationSmbMountOptions
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
Tags Tag
An array of key-value pairs to apply to this resource.
User string
The user who can mount the share, has the permissions to access files and folders in the SMB share.
agentArns List<String>
The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
authenticationType LocationSmbAuthenticationType
The authentication mode used to determine identity of user.
dnsIpAddresses List<String>
Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS. If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.
domain String
The name of the Windows domain that the SMB server belongs to.
kerberosPrincipal String
Specifies a service principal name (SPN), which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server. SPNs are case sensitive and must include a prepended cifs/. For example, an SPN might look like cifs/kerberosuser@EXAMPLE.COM. Your task execution will fail if the SPN that you provide for this parameter doesn't match exactly what's in your keytab or krb5.conf files.
locationArn String
The Amazon Resource Name (ARN) of the SMB location that is created.
locationUri String
The URL of the SMB location that was described.
mountOptions LocationSmbMountOptions
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
tags List<Tag>
An array of key-value pairs to apply to this resource.
user String
The user who can mount the share, has the permissions to access files and folders in the SMB share.
agentArns string[]
The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
authenticationType LocationSmbAuthenticationType
The authentication mode used to determine identity of user.
dnsIpAddresses string[]
Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS. If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.
domain string
The name of the Windows domain that the SMB server belongs to.
kerberosPrincipal string
Specifies a service principal name (SPN), which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server. SPNs are case sensitive and must include a prepended cifs/. For example, an SPN might look like cifs/kerberosuser@EXAMPLE.COM. Your task execution will fail if the SPN that you provide for this parameter doesn't match exactly what's in your keytab or krb5.conf files.
locationArn string
The Amazon Resource Name (ARN) of the SMB location that is created.
locationUri string
The URL of the SMB location that was described.
mountOptions LocationSmbMountOptions
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
tags Tag[]
An array of key-value pairs to apply to this resource.
user string
The user who can mount the share, has the permissions to access files and folders in the SMB share.
agent_arns Sequence[str]
The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
authentication_type LocationSmbAuthenticationType
The authentication mode used to determine identity of user.
dns_ip_addresses Sequence[str]
Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS. If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.
domain str
The name of the Windows domain that the SMB server belongs to.
kerberos_principal str
Specifies a service principal name (SPN), which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server. SPNs are case sensitive and must include a prepended cifs/. For example, an SPN might look like cifs/kerberosuser@EXAMPLE.COM. Your task execution will fail if the SPN that you provide for this parameter doesn't match exactly what's in your keytab or krb5.conf files.
location_arn str
The Amazon Resource Name (ARN) of the SMB location that is created.
location_uri str
The URL of the SMB location that was described.
mount_options LocationSmbMountOptions
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
tags Sequence[root_Tag]
An array of key-value pairs to apply to this resource.
user str
The user who can mount the share, has the permissions to access files and folders in the SMB share.
agentArns List<String>
The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
authenticationType "NTLM" | "KERBEROS"
The authentication mode used to determine identity of user.
dnsIpAddresses List<String>
Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS. If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.
domain String
The name of the Windows domain that the SMB server belongs to.
kerberosPrincipal String
Specifies a service principal name (SPN), which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server. SPNs are case sensitive and must include a prepended cifs/. For example, an SPN might look like cifs/kerberosuser@EXAMPLE.COM. Your task execution will fail if the SPN that you provide for this parameter doesn't match exactly what's in your keytab or krb5.conf files.
locationArn String
The Amazon Resource Name (ARN) of the SMB location that is created.
locationUri String
The URL of the SMB location that was described.
mountOptions Property Map
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
tags List<Property Map>
An array of key-value pairs to apply to this resource.
user String
The user who can mount the share, has the permissions to access files and folders in the SMB share.

Supporting Types

LocationSmbAuthenticationType

LocationSmbMountOptions

Version Pulumi.AwsNative.DataSync.LocationSmbMountOptionsVersion
The specific SMB version that you want DataSync to use to mount your SMB share.
Version LocationSmbMountOptionsVersion
The specific SMB version that you want DataSync to use to mount your SMB share.
version LocationSmbMountOptionsVersion
The specific SMB version that you want DataSync to use to mount your SMB share.
version LocationSmbMountOptionsVersion
The specific SMB version that you want DataSync to use to mount your SMB share.
version LocationSmbMountOptionsVersion
The specific SMB version that you want DataSync to use to mount your SMB share.
version "AUTOMATIC" | "SMB1" | "SMB2_0" | "SMB2" | "SMB3"
The specific SMB version that you want DataSync to use to mount your SMB share.

LocationSmbMountOptionsVersion

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native