Package software.amazon.awscdk.services.datasync

Class CfnLocationSMB

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.datasync.CfnLocationSMB
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)", date="2025-06-13T09:19:35.287Z") @Stability(Stable) public class CfnLocationSMB extends CfnResource implements IInspectable, ITaggable
The AWS::DataSync::LocationSMB resource specifies a Server Message Block (SMB) location that AWS DataSync can use as a transfer source or destination.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.datasync.*;
 CfnLocationSMB cfnLocationSMB = CfnLocationSMB.Builder.create(this, "MyCfnLocationSMB")
         .agentArns(List.of("agentArns"))
         // the properties below are optional
         .authenticationType("authenticationType")
         .dnsIpAddresses(List.of("dnsIpAddresses"))
         .domain("domain")
         .kerberosKeytab("kerberosKeytab")
         .kerberosKrb5Conf("kerberosKrb5Conf")
         .kerberosPrincipal("kerberosPrincipal")
         .mountOptions(MountOptionsProperty.builder()
                 .version("version")
                 .build())
         .password("password")
         .serverHostname("serverHostname")
         .subdirectory("subdirectory")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .user("user")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnLocationSMB

      protected CfnLocationSMB(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnLocationSMB

      protected CfnLocationSMB(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnLocationSMB

      @Stability(Stable) public CfnLocationSMB(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLocationSMBProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrLocationArn

      @Stability(Stable) @NotNull public String getAttrLocationArn()
      The Amazon Resource Name (ARN) of the specified SMB location.

    • getAttrLocationUri

      @Stability(Stable) @NotNull public String getAttrLocationUri()
      The URI of the specified SMB location.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAgentArns

      @Stability(Stable) @NotNull public List<String> getAgentArns()
      Specifies the DataSync agent (or agents) that can connect to your SMB file server.

    • setAgentArns

      @Stability(Stable) public void setAgentArns(@NotNull List<String> value)
      Specifies the DataSync agent (or agents) that can connect to your SMB file server.

    • getAuthenticationType

      @Stability(Stable) @Nullable public String getAuthenticationType()
      The authentication mode used to determine identity of user.

    • setAuthenticationType

      @Stability(Stable) public void setAuthenticationType(@Nullable String value)
      The authentication mode used to determine identity of user.

    • getDnsIpAddresses

      @Stability(Stable) @Nullable public List<String> getDnsIpAddresses()
      Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to.

    • setDnsIpAddresses

      @Stability(Stable) public void setDnsIpAddresses(@Nullable List<String> value)
      Specifies the IPv4 addresses for the DNS servers that your SMB file server belongs to.

    • getDomain

      @Stability(Stable) @Nullable public String getDomain()
      Specifies the Windows domain name that your SMB file server belongs to.

    • setDomain

      @Stability(Stable) public void setDomain(@Nullable String value)
      Specifies the Windows domain name that your SMB file server belongs to.

    • getKerberosKeytab

      @Stability(Stable) @Nullable public String getKerberosKeytab()
      The Base64 string representation of the Keytab file.

    • setKerberosKeytab

      @Stability(Stable) public void setKerberosKeytab(@Nullable String value)
      The Base64 string representation of the Keytab file.

    • getKerberosKrb5Conf

      @Stability(Stable) @Nullable public String getKerberosKrb5Conf()
      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.

    • setKerberosKrb5Conf

      @Stability(Stable) public void setKerberosKrb5Conf(@Nullable String value)
      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.

    • getKerberosPrincipal

      @Stability(Stable) @Nullable public String getKerberosPrincipal()
      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.

    • setKerberosPrincipal

      @Stability(Stable) public void setKerberosPrincipal(@Nullable String value)
      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.

    • getMountOptions

      @Stability(Stable) @Nullable public Object getMountOptions()
      Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

    • setMountOptions

      @Stability(Stable) public void setMountOptions(@Nullable IResolvable value)
      Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

    • setMountOptions

      @Stability(Stable) public void setMountOptions(@Nullable CfnLocationSMB.MountOptionsProperty value)
      Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.

    • getPassword

      @Stability(Stable) @Nullable public String getPassword()
      Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.

    • setPassword

      @Stability(Stable) public void setPassword(@Nullable String value)
      Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer.

    • getServerHostname

      @Stability(Stable) @Nullable public String getServerHostname()
      Specifies the domain name or IP address of the SMB file server that your DataSync agent connects to.

    • setServerHostname

      @Stability(Stable) public void setServerHostname(@Nullable String value)
      Specifies the domain name or IP address of the SMB file server that your DataSync agent connects to.

    • getSubdirectory

      @Stability(Stable) @Nullable public String getSubdirectory()
      Specifies the name of the share exported by your SMB file server where DataSync will read or write data.

    • setSubdirectory

      @Stability(Stable) public void setSubdirectory(@Nullable String value)
      Specifies the name of the share exported by your SMB file server where DataSync will read or write data.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Specifies labels that help you categorize, filter, and search for your AWS resources.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Specifies labels that help you categorize, filter, and search for your AWS resources.

    • getUser

      @Stability(Stable) @Nullable public String getUser()
      Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.

    • setUser

      @Stability(Stable) public void setUser(@Nullable String value)
      Specifies the user that can mount and access the files, folders, and file metadata in your SMB file server.