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.103.1 (build bef2dea)",
           date="2024-10-10T18:25:21.248Z")
@Stability(Stable)
public class CfnLocationSMB
extends CfnResource
implements IInspectable, ITaggable

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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datasync-locationsmb.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final 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.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnLocationSMB(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnLocationSMB(software.amazon.jsii.JsiiObjectRef objRef)
	CfnLocationSMB(software.constructs.Construct scope, String id, CfnLocationSMBProps props)

Method Summary

Modifier and Type	Method	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()	Specifies the name of the Active Directory domain that your SMB file server belongs to.
Object	getMountOptions()	Specifies the version of the SMB protocol that DataSync uses to access your SMB file 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()	Specifies the Domain Name Service (DNS) name or IP address of the SMB file server that your DataSync agent will mount.
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()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	Specifies labels that help you categorize, filter, and search for your AWS resources.
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)	Specifies the name of the Active Directory domain 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	setMountOptions(CfnLocationSMB.MountOptionsProperty value)	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	setTagsRaw(List<CfnTag> value)	Specifies labels that help you categorize, filter, and search for your AWS resources.
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, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 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 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()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

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.

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.

getDomain

@Stability(Stable)
@Nullable
public String getDomain()

Specifies the name of the Active Directory domain that your SMB file server belongs to.

setDomain

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

Specifies the name of the Active Directory domain that your SMB file server belongs to.

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.

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.

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.

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.

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.