Package software.amazon.awscdk.services.datasync

Class CfnLocationFSxWindows

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.datasync.CfnLocationFSxWindows
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.180Z") @Stability(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")
         .securityGroupArns(List.of("securityGroupArns"))
         .user("user")
         // the properties below are optional
         .domain("domain")
         .fsxFilesystemArn("fsxFilesystemArn")
         .password("password")
         .subdirectory("subdirectory")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • 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

    • CfnLocationFSxWindows

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

    • CfnLocationFSxWindows

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

    • CfnLocationFSxWindows

      @Stability(Stable) public CfnLocationFSxWindows(@NotNull 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 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 ARN of the specified FSx for Windows Server file system location.

    • getAttrLocationUri

      @Stability(Stable) @NotNull public String getAttrLocationUri()
      The URI of the specified FSx for Windows Server file system location.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager 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.

    • getSecurityGroupArns

      @Stability(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(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(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(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(Stable) @Nullable public String getDomain()
      Specifies the name of the Windows domain that the FSx for Windows File Server belongs to.

    • setDomain

      @Stability(Stable) public void setDomain(@Nullable String value)
      Specifies the name of the Windows domain that the FSx for Windows File Server belongs to.

    • getFsxFilesystemArn

      @Stability(Stable) @Nullable public String getFsxFilesystemArn()
      Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.

    • setFsxFilesystemArn

      @Stability(Stable) public void setFsxFilesystemArn(@Nullable String value)
      Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.

    • getPassword

      @Stability(Stable) @Nullable public String getPassword()
      Specifies the password of the user who has the permissions to access files and folders in the file system.

    • setPassword

      @Stability(Stable) public void setPassword(@Nullable String value)
      Specifies the password of the user who has the permissions to access files and folders in the file system.

    • getSubdirectory

      @Stability(Stable) @Nullable public String getSubdirectory()
      Specifies a mount path for your file system using forward slashes.

      This is where DataSync reads or writes data (depending on if this is a source or destination location).

    • setSubdirectory

      @Stability(Stable) public void setSubdirectory(@Nullable String value)
      Specifies a mount path for your file system using forward slashes.

      This is where DataSync reads or writes data (depending on if this is a source or destination location).