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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.894Z")
 @Stability(value=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"))
         .password("password")
         .serverHostname("serverHostname")
         .subdirectory("subdirectory")
         .user("user")
         // the properties below are optional
         .domain("domain")
         .mountOptions(MountOptionsProperty.builder()
                 .version("version")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnLocationSMB.Builder A fluent builder for CfnLocationSMB.
static interface	CfnLocationSMB.MountOptionsProperty The mount options used by DataSync to access the SMB 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.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnLocationSMB(software.constructs.Construct scope, 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)

Method Summary

Modifier and Type	Method and Description
List<String>	getAgentArns() The Amazon Resource Names (ARNs) of agents to use for a Server Message Block (SMB) location.
String	getAttrLocationArn() The Amazon Resource Name (ARN) of the specified SMB file system.
String	getAttrLocationUri() The URI of the specified SMB location.
protected Map<String,Object>	getCfnProperties()
String	getDomain() The name of the Windows domain that the SMB server belongs to.
Object	getMountOptions() The mount options used by DataSync to access the SMB server.
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.
String	getServerHostname() The name of the SMB server.
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() The key-value pair that represents the tag that you want to add to the location.
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 Map<String,Object>	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	setDomain(String value) The name of the Windows domain that the SMB server belongs to.
void	setMountOptions(CfnLocationSMB.MountOptionsProperty value) The mount options used by DataSync to access the SMB server.
void	setMountOptions(IResolvable value) The mount options used by DataSync to access the SMB 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) The name of the SMB server.
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	setUser(String value) 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.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnLocationSMB

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

CfnLocationSMB

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

CfnLocationSMB

@Stability(value=Stable)
public CfnLocationSMB(@NotNull
                                               software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrLocationArn()

The Amazon Resource Name (ARN) of the specified SMB file system.

getAttrLocationUri

@Stability(value=Stable)
 @NotNull
public String getAttrLocationUri()

The URI of the specified SMB location.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The key-value pair that represents the tag that you want to add to the location.

The value can be an empty string. We recommend using tags to name your resources.

getAgentArns

@Stability(value=Stable)
 @NotNull
public List<String> getAgentArns()

The Amazon Resource Names (ARNs) of agents to use for a Server Message Block (SMB) location.

setAgentArns

@Stability(value=Stable)
public void setAgentArns(@NotNull
                                                  List<String> value)

The Amazon Resource Names (ARNs) of agents to use for a Server Message Block (SMB) location.

getPassword

@Stability(value=Stable)
 @NotNull
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(value=Stable)
public void setPassword(@NotNull
                                                 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(value=Stable)
 @NotNull
public String getServerHostname()

The name of the SMB server.

This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

setServerHostname

@Stability(value=Stable)
public void setServerHostname(@NotNull
                                                       String value)

The name of the SMB server.

This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

getSubdirectory

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

getUser

@Stability(value=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(value=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(value=Stable)
 @Nullable
public String getDomain()

The name of the Windows domain that the SMB server belongs to.

setDomain

@Stability(value=Stable)
public void setDomain(@Nullable
                                               String value)

The name of the Windows domain that the SMB server belongs to.

getMountOptions

@Stability(value=Stable)
 @Nullable
public Object getMountOptions()

The mount options used by DataSync to access the SMB server.

setMountOptions

@Stability(value=Stable)
public void setMountOptions(@Nullable
                                                     CfnLocationSMB.MountOptionsProperty value)

The mount options used by DataSync to access the SMB server.

setMountOptions

@Stability(value=Stable)
public void setMountOptions(@Nullable
                                                     IResolvable value)

The mount options used by DataSync to access the SMB server.