Class CfnLocationSMB
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
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();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forCfnLocationSMB
.static interface
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionCfnLocationSMB
(Construct scope, String id, CfnLocationSMBProps props) Create a newAWS::DataSync::LocationSMB
.protected
CfnLocationSMB
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnLocationSMB
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Names (ARNs) of agents to use for a Server Message Block (SMB) location.The Amazon Resource Name (ARN) of the specified SMB file system.The URI of the specified SMB location.Specifies the Windows domain name that your SMB file server belongs to.Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.The password of the user who can mount the share and has the permissions to access files and folders in the SMB share.Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.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.getTags()
Specifies labels that help you categorize, filter, and search for your AWS resources.getUser()
The user who can mount the share and has the permissions to access files and folders in the SMB share.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAgentArns
(List<String> value) The Amazon Resource Names (ARNs) of agents to use for a Server Message Block (SMB) location.void
Specifies the Windows domain name that your SMB file server belongs to.void
setMountOptions
(IResolvable value) Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.void
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.void
setPassword
(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.void
setServerHostname
(String value) Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.void
setSubdirectory
(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.void
The user who can mount the share and has the permissions to access files and folders in the SMB share.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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 newAWS::DataSync::LocationSMB
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrLocationArn
The Amazon Resource Name (ARN) of the specified SMB file system. -
getAttrLocationUri
The URI of the specified SMB location. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
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
The Amazon Resource Names (ARNs) of agents to use for a Server Message Block (SMB) location. -
setAgentArns
The Amazon Resource Names (ARNs) of agents to use for a Server Message Block (SMB) location. -
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
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
Specifies the Windows domain name that your SMB file server belongs to.For more information, see required permissions for SMB locations.
-
setDomain
Specifies the Windows domain name that your SMB file server belongs to.For more information, see required permissions for SMB locations.
-
getMountOptions
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server. -
setMountOptions
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server. -
setMountOptions
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server. -
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
The password of the user who can mount the share and has the permissions to access files and folders in the SMB share. -
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
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
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
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.
-