software.amazon.awscdk.services.datasync

Class CfnLocationFSxWindows

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.CfnLocationFSxWindows

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.871Z")
 @Stability(value=Stable)
public class CfnLocationFSxWindows
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DataSync::LocationFSxWindows`.

The AWS::DataSync::LocationFSxWindows resource specifies an endpoint for an Amazon FSx for Windows Server file system.

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.*;
 CfnLocationFSxWindows cfnLocationFSxWindows = CfnLocationFSxWindows.Builder.create(this, "MyCfnLocationFSxWindows")
         .fsxFilesystemArn("fsxFilesystemArn")
         .password("password")
         .securityGroupArns(List.of("securityGroupArns"))
         .user("user")
         // the properties below are optional
         .domain("domain")
         .subdirectory("subdirectory")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnLocationFSxWindows.Builder A fluent builder for CfnLocationFSxWindows.

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
	CfnLocationFSxWindows(software.constructs.Construct scope, String id, CfnLocationFSxWindowsProps props) Create a new `AWS::DataSync::LocationFSxWindows`.
protected	CfnLocationFSxWindows(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnLocationFSxWindows(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrLocationArn() The ARN of the specified FSx for Windows Server file system location.
String	getAttrLocationUri() The URI of the specified FSx for Windows Server file system location.
protected Map<String,Object>	getCfnProperties()
String	getDomain() The name of the Windows domain that the FSx for Windows File Server belongs to.
String	getFsxFilesystemArn() The Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
String	getPassword() The password of the user who has the permissions to access files and folders in the FSx for Windows File Server file system.
List<String>	getSecurityGroupArns() The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Windows File Server file system.
String	getSubdirectory() A subdirectory in the location's path.
TagManager	getTags() The key-value pair that represents a tag that you want to add to the resource.
String	getUser() The user who has the permissions to access files and folders in the FSx for Windows File Server file system.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDomain(String value) The name of the Windows domain that the FSx for Windows File Server belongs to.
void	setFsxFilesystemArn(String value) The Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
void	setPassword(String value) The password of the user who has the permissions to access files and folders in the FSx for Windows File Server file system.
void	setSecurityGroupArns(List<String> value) The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Windows File Server file system.
void	setSubdirectory(String value) A subdirectory in the location's path.
void	setUser(String value) The user who has the permissions to access files and folders in the FSx for Windows File Server file system.

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

CfnLocationFSxWindows

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

CfnLocationFSxWindows

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

CfnLocationFSxWindows

@Stability(value=Stable)
public CfnLocationFSxWindows(@NotNull
                                                      software.constructs.Construct scope,
                                                      @NotNull
                                                      String id,
                                                      @NotNull
                                                      CfnLocationFSxWindowsProps props)

Create a new `AWS::DataSync::LocationFSxWindows`.

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 ARN of the specified FSx for Windows Server file system location.

getAttrLocationUri

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

The URI of the specified FSx for Windows Server file system 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 a tag that you want to add to the resource.

The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.

getFsxFilesystemArn

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

The Amazon Resource Name (ARN) for the FSx for Windows File Server file system.

setFsxFilesystemArn

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

The Amazon Resource Name (ARN) for the FSx for Windows File Server file system.

getPassword

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

The password of the user who has the permissions to access files and folders in the FSx for Windows File Server file system.

setPassword

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

The password of the user who has the permissions to access files and folders in the FSx for Windows File Server file system.

getSecurityGroupArns

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

The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Windows File Server file system.

Pattern : ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/.*$

Length constraints : Maximum length of 128.

setSecurityGroupArns

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

The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Windows File Server file system.

Pattern : ^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/.*$

Length constraints : Maximum length of 128.

getUser

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

The user who has the permissions to access files and folders in the FSx for Windows File Server file system.

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 has the permissions to access files and folders in the FSx for Windows File Server file system.

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 FSx for Windows File Server belongs to.

setDomain

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

The name of the Windows domain that the FSx for Windows File Server belongs to.

getSubdirectory

@Stability(value=Stable)
 @Nullable
public String getSubdirectory()

A subdirectory in the location's path.

This subdirectory in the Amazon FSx for Windows File Server file system is used to read data from the Amazon FSx for Windows File Server source location or write data to the FSx for Windows File Server destination.

setSubdirectory

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

A subdirectory in the location's path.

This subdirectory in the Amazon FSx for Windows File Server file system is used to read data from the Amazon FSx for Windows File Server source location or write data to the FSx for Windows File Server destination.