@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-14T16:25:21.361Z") public class CfnLocationSMB extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnLocationSMB.Builder
A fluent builder for
CfnLocationSMB . |
static interface |
CfnLocationSMB.MountOptionsProperty
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnLocationSMB(Construct scope,
java.lang.String id,
CfnLocationSMBProps props)
Create a new `AWS::DataSync::LocationSMB`.
|
protected |
CfnLocationSMB(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnLocationSMB(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.util.List<java.lang.String> |
getAgentArns()
The Amazon Resource Names (ARNs) of agents to use for a Server Message Block (SMB) location.
|
java.lang.String |
getAttrLocationArn()
The Amazon Resource Name (ARN) of the specified SMB file system.
|
java.lang.String |
getAttrLocationUri()
The URI of the specified SMB location.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDomain()
Specifies the Windows domain name that your SMB file server belongs to.
|
java.lang.Object |
getMountOptions()
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
|
java.lang.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.
|
java.lang.String |
getServerHostname()
Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.
|
java.lang.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.
|
TagManager |
getTags()
Specifies labels that help you categorize, filter, and search for your AWS resources.
|
java.lang.String |
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.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAgentArns(java.util.List<java.lang.String> value)
The Amazon Resource Names (ARNs) of agents to use for a Server Message Block (SMB) location.
|
void |
setDomain(java.lang.String value)
Specifies the Windows domain name that your SMB file server belongs to.
|
void |
setMountOptions(CfnLocationSMB.MountOptionsProperty value)
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
|
void |
setMountOptions(IResolvable value)
Specifies the version of the SMB protocol that DataSync uses to access your SMB file server.
|
void |
setPassword(java.lang.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(java.lang.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(java.lang.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 |
setUser(java.lang.String value)
The user who can mount the share and has the permissions to access files and folders in the SMB share.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnLocationSMB(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnLocationSMB(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnLocationSMB(Construct scope, java.lang.String id, CfnLocationSMBProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrLocationArn()
public java.lang.String getAttrLocationUri()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
We recommend creating at least a name tag for your location.
public java.util.List<java.lang.String> getAgentArns()
public void setAgentArns(java.util.List<java.lang.String> value)
public java.lang.String getUser()
For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user .
public void setUser(java.lang.String value)
For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user .
public java.lang.String getDomain()
For more information, see required permissions for SMB locations.
public void setDomain(java.lang.String value)
For more information, see required permissions for SMB locations.
public java.lang.Object getMountOptions()
public void setMountOptions(IResolvable value)
public void setMountOptions(CfnLocationSMB.MountOptionsProperty value)
public java.lang.String getPassword()
public void setPassword(java.lang.String value)
public java.lang.String getServerHostname()
You can't specify an IP version 6 (IPv6) address.
public void setServerHostname(java.lang.String value)
You can't specify an IP version 6 (IPv6) address.
public java.lang.String getSubdirectory()
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.
public void setSubdirectory(java.lang.String value)
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.