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

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

Explore with Pulumi AI

aws-native logo

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.

    Create LocationSmb Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LocationSmb(name: string, args: LocationSmbArgs, opts?: CustomResourceOptions);
    @overload
def LocationSmb(resource_name: str,
                args: LocationSmbArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def LocationSmb(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                agent_arns: Optional[Sequence[str]] = None,
                authentication_type: Optional[LocationSmbAuthenticationType] = None,
                dns_ip_addresses: Optional[Sequence[str]] = None,
                domain: Optional[str] = None,
                kerberos_keytab: Optional[str] = None,
                kerberos_krb5_conf: Optional[str] = None,
                kerberos_principal: Optional[str] = None,
                mount_options: Optional[LocationSmbMountOptionsArgs] = None,
                password: Optional[str] = None,
                server_hostname: Optional[str] = None,
                subdirectory: Optional[str] = None,
                tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                user: Optional[str] = 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-native:datasync:LocationSmb
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The LocationSmb resource accepts the following input properties:

    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.
    KerberosKeytab string
    The Base64 string representation of the Keytab file. Specifies your Kerberos key table (keytab) file, which includes mappings between your service principal name (SPN) and encryption keys. To avoid task execution errors, make sure that the SPN in the keytab file matches exactly what you specify for KerberosPrincipal and in your krb5.conf file.
    KerberosKrb5Conf string
    The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket. Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration. To avoid task execution errors, make sure that the service principal name (SPN) in the krb5.conf file matches exactly what you specify for KerberosPrincipal and in your keytab file.
    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.
    MountOptions Pulumi.AwsNative.DataSync.Inputs.LocationSmbMountOptions
    Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
    Password string
    The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
    ServerHostname string
    The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.
    Subdirectory string
    The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination
    Tags List<Pulumi.AwsNative.Inputs.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.
    KerberosKeytab string
    The Base64 string representation of the Keytab file. Specifies your Kerberos key table (keytab) file, which includes mappings between your service principal name (SPN) and encryption keys. To avoid task execution errors, make sure that the SPN in the keytab file matches exactly what you specify for KerberosPrincipal and in your krb5.conf file.
    KerberosKrb5Conf string
    The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket. Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration. To avoid task execution errors, make sure that the service principal name (SPN) in the krb5.conf file matches exactly what you specify for KerberosPrincipal and in your keytab file.
    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.
    MountOptions LocationSmbMountOptionsArgs
    Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
    Password string
    The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
    ServerHostname string
    The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.
    Subdirectory string
    The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination
    Tags TagArgs
    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.
    kerberosKeytab String
    The Base64 string representation of the Keytab file. Specifies your Kerberos key table (keytab) file, which includes mappings between your service principal name (SPN) and encryption keys. To avoid task execution errors, make sure that the SPN in the keytab file matches exactly what you specify for KerberosPrincipal and in your krb5.conf file.
    kerberosKrb5Conf String
    The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket. Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration. To avoid task execution errors, make sure that the service principal name (SPN) in the krb5.conf file matches exactly what you specify for KerberosPrincipal and in your keytab file.
    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.
    mountOptions LocationSmbMountOptions
    Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
    password String
    The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
    serverHostname String
    The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.
    subdirectory String
    The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination
    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.
    kerberosKeytab string
    The Base64 string representation of the Keytab file. Specifies your Kerberos key table (keytab) file, which includes mappings between your service principal name (SPN) and encryption keys. To avoid task execution errors, make sure that the SPN in the keytab file matches exactly what you specify for KerberosPrincipal and in your krb5.conf file.
    kerberosKrb5Conf string
    The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket. Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration. To avoid task execution errors, make sure that the service principal name (SPN) in the krb5.conf file matches exactly what you specify for KerberosPrincipal and in your keytab file.
    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.
    mountOptions LocationSmbMountOptions
    Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
    password string
    The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
    serverHostname string
    The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.
    subdirectory string
    The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination
    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_keytab str
    The Base64 string representation of the Keytab file. Specifies your Kerberos key table (keytab) file, which includes mappings between your service principal name (SPN) and encryption keys. To avoid task execution errors, make sure that the SPN in the keytab file matches exactly what you specify for KerberosPrincipal and in your krb5.conf file.
    kerberos_krb5_conf str
    The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket. Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration. To avoid task execution errors, make sure that the service principal name (SPN) in the krb5.conf file matches exactly what you specify for KerberosPrincipal and in your keytab file.
    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.
    mount_options LocationSmbMountOptionsArgs
    Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
    password str
    The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
    server_hostname str
    The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.
    subdirectory str
    The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination
    tags Sequence[TagArgs]
    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.
    kerberosKeytab String
    The Base64 string representation of the Keytab file. Specifies your Kerberos key table (keytab) file, which includes mappings between your service principal name (SPN) and encryption keys. To avoid task execution errors, make sure that the SPN in the keytab file matches exactly what you specify for KerberosPrincipal and in your krb5.conf file.
    kerberosKrb5Conf String
    The string representation of the Krb5Conf file, or the presigned URL to access the Krb5.conf file within an S3 bucket. Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration. To avoid task execution errors, make sure that the service principal name (SPN) in the krb5.conf file matches exactly what you specify for KerberosPrincipal and in your keytab file.
    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.
    mountOptions Property Map
    Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
    password String
    The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.
    serverHostname String
    The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server.
    subdirectory String
    The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LocationSmb resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.

    Supporting Types

    LocationSmbAuthenticationType, LocationSmbAuthenticationTypeArgs

    Ntlm
    NTLM
    Kerberos
    KERBEROS
    LocationSmbAuthenticationTypeNtlm
    NTLM
    LocationSmbAuthenticationTypeKerberos
    KERBEROS
    Ntlm
    NTLM
    Kerberos
    KERBEROS
    Ntlm
    NTLM
    Kerberos
    KERBEROS
    NTLM
    NTLM
    KERBEROS
    KERBEROS
    "NTLM"
    NTLM
    "KERBEROS"
    KERBEROS

    LocationSmbMountOptions, LocationSmbMountOptionsArgs

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

    Automatic
    AUTOMATIC
    Smb1
    SMB1
    Smb20
    SMB2_0
    Smb2
    SMB2
    Smb3
    SMB3
    LocationSmbMountOptionsVersionAutomatic
    AUTOMATIC
    LocationSmbMountOptionsVersionSmb1
    SMB1
    LocationSmbMountOptionsVersionSmb20
    SMB2_0
    LocationSmbMountOptionsVersionSmb2
    SMB2
    LocationSmbMountOptionsVersionSmb3
    SMB3
    Automatic
    AUTOMATIC
    Smb1
    SMB1
    Smb20
    SMB2_0
    Smb2
    SMB2
    Smb3
    SMB3
    Automatic
    AUTOMATIC
    Smb1
    SMB1
    Smb20
    SMB2_0
    Smb2
    SMB2
    Smb3
    SMB3
    AUTOMATIC
    AUTOMATIC
    SMB1
    SMB1
    SMB20
    SMB2_0
    SMB2
    SMB2
    SMB3
    SMB3
    "AUTOMATIC"
    AUTOMATIC
    "SMB1"
    SMB1
    "SMB2_0"
    SMB2_0
    "SMB2"
    SMB2
    "SMB3"
    SMB3

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    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