Package 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, ILocationFSxWindowsRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-27T13:11:57.304Z") @Stability(Stable) public class CfnLocationFSxWindows extends CfnResource implements IInspectable, ILocationFSxWindowsRef, ITaggable
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
         .cmkSecretConfig(CmkSecretConfigProperty.builder()
                 .kmsKeyArn("kmsKeyArn")
                 .secretArn("secretArn")
                 .build())
         .customSecretConfig(CustomSecretConfigProperty.builder()
                 .secretAccessRoleArn("secretAccessRoleArn")
                 .secretArn("secretArn")
                 .build())
         .domain("domain")
         .fsxFilesystemArn("fsxFilesystemArn")
         .password("password")
         .subdirectory("subdirectory")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • 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 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 - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnLocationFSxWindows

      @Stability(Stable) @NotNull public static Boolean isCfnLocationFSxWindows(@NotNull Object x)
      Checks whether the given object is a CfnLocationFSxWindows.

      Parameters:
      x - This parameter is required.

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

    • getAttrCmkSecretConfigSecretArn

      @Stability(Stable) @NotNull public String getAttrCmkSecretConfigSecretArn()
      Specifies the ARN for an AWS Secrets Manager secret, managed by DataSync.

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

    • getAttrManagedSecretConfig

      @Stability(Stable) @NotNull public IResolvable getAttrManagedSecretConfig()
      Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location.

      DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.

    • getCfnProperties

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

    • getLocationFSxWindowsRef

      @Stability(Stable) @NotNull public LocationFSxWindowsReference getLocationFSxWindowsRef()
      A reference to a LocationFSxWindows resource.
      Specified by:
      getLocationFSxWindowsRef in interface ILocationFSxWindowsRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

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

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

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

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

    • getCmkSecretConfig

      @Stability(Stable) @Nullable public Object getCmkSecretConfig()
      Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.

      Returns union: either IResolvable or CfnLocationFSxWindows.CmkSecretConfigProperty

    • setCmkSecretConfig

      @Stability(Stable) public void setCmkSecretConfig(@Nullable IResolvable value)
      Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.

    • setCmkSecretConfig

      @Stability(Stable) public void setCmkSecretConfig(@Nullable CfnLocationFSxWindows.CmkSecretConfigProperty value)
      Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed AWS KMS key.

    • getCustomSecretConfig

      @Stability(Stable) @Nullable public Object getCustomSecretConfig()
      Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.

      Returns union: either IResolvable or CfnLocationFSxWindows.CustomSecretConfigProperty

    • setCustomSecretConfig

      @Stability(Stable) public void setCustomSecretConfig(@Nullable IResolvable value)
      Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.

    • setCustomSecretConfig

      @Stability(Stable) public void setCustomSecretConfig(@Nullable CfnLocationFSxWindows.CustomSecretConfigProperty value)
      Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and an IAM role that DataSync can assume and access the customer-managed secret.

    • getDomain

      @Stability(Stable) @Nullable public String getDomain()
      Specifies the name of the Windows domain that the FSx for Windows File Server file system 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 file system 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 with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.

    • setPassword

      @Stability(Stable) public void setPassword(@Nullable String value)
      Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.

    • getSubdirectory

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

    • setSubdirectory

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

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