Package software.amazon.awscdk.services.datasync

Class CfnLocationSMB

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.datasync.CfnLocationSMB
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.208Z") @Stability(Stable) public class CfnLocationSMB extends CfnResource implements IInspectable
A CloudFormation AWS::DataSync::LocationSMB.

The AWS::DataSync::LocationSMB resource specifies a Server Message Block (SMB) location.

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"))
         .user("user")
         // the properties below are optional
         .domain("domain")
         .mountOptions(MountOptionsProperty.builder()
                 .version("version")
                 .build())
         .password("password")
         .serverHostname("serverHostname")
         .subdirectory("subdirectory")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • 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 Construct scope, @NotNull String id, @NotNull CfnLocationSMBProps props)
      Create a new AWS::DataSync::LocationSMB.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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 file system.

    • 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()
      Specifies labels that help you categorize, filter, and search for your AWS resources.

      We recommend creating at least a name tag for your location.

    • getAgentArns

      @Stability(Stable) @NotNull public List<String> getAgentArns()
      The Amazon Resource Names (ARNs) of agents to use for a Server Message Block (SMB) location.

    • setAgentArns

      @Stability(Stable) public void setAgentArns(@NotNull List<String> value)
      The Amazon Resource Names (ARNs) of agents to use for a Server Message Block (SMB) location.

    • getUser

      @Stability(Stable) @NotNull public String getUser()
      The user who can mount the share and has the permissions to access files and folders in the SMB share.

      For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user .

    • setUser

      @Stability(Stable) public void setUser(@NotNull String value)
      The user who can mount the share and has the permissions to access files and folders in the SMB share.

      For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user .

    • getDomain

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

      For more information, see required permissions for SMB locations.

    • setDomain

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

      For more information, see required permissions for SMB locations.

    • 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()
      The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.

    • setPassword

      @Stability(Stable) public void setPassword(@Nullable String value)
      The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.

    • getServerHostname

      @Stability(Stable) @Nullable public String getServerHostname()
      Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.

      You can't specify an IP version 6 (IPv6) address.

    • setServerHostname

      @Stability(Stable) public void setServerHostname(@Nullable String value)
      Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.

      You can't specify an IP version 6 (IPv6) address.

    • getSubdirectory

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

      The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

      Subdirectory must be specified with forward slashes. For example, /path/to/folder .

      To transfer all the data in the folder you specified, DataSync must have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either make sure that the user name and password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either one enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

    • setSubdirectory

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

      The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

      Subdirectory must be specified with forward slashes. For example, /path/to/folder .

      To transfer all the data in the folder you specified, DataSync must have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either make sure that the user name and password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either one enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.