location_fsx_windows

Creates, updates, deletes, gets or lists a location_fsx_windows resource.

Overview

Name	location_fsx_windows
Type	Resource
Id	aws.datasync.location_fsx_windows

Fields

The following fields are returned by SELECT queries:

describe_location_fsx_windows

Name	Datatype	Description
cmk_secret_config	object	Describes configuration information for a DataSync-managed secret, such as a Password that DataSync uses to access a specific storage location, with a customer-managed KMS key.
creation_time	string (date-time)	The time that the FSx for Windows File Server location was created.
custom_secret_config	object	Describes configuration information for a customer-managed secret, such as a Password that DataSync uses to access a specific storage location, with a customer-managed Identity and Access Management (IAM) role that provides access to the secret.
domain	string	The name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to. (pattern: <code>^[A-Za-z0-9]((.|-+)?[A-Za-z0-9]){0,252}$</code>)
location_arn	string	The ARN of the FSx for Windows File Server location. (pattern: <code>^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$</code>)
location_uri	string	The uniform resource identifier (URI) of the FSx for Windows File Server location. (pattern: <code>^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+):​//[a-zA-Z0-9.:/-]+$</code>)
managed_secret_config	object	Describes configuration information for a DataSync-managed secret, such as a Password that DataSync uses to access a specific storage location. DataSync uses the default Amazon Web Services-managed KMS key to encrypt this secret in Secrets Manager.
security_group_arns	array	The ARNs of the Amazon EC2 security groups that provide access to your file system's preferred subnet. For information about configuring security groups for file system access, see the Amazon FSx for Windows File Server User Guide .
user	string	The user with the permissions to mount and access the FSx for Windows File Server file system. (pattern: <code>^[^\x22\x5B\x5D/\:;|=,+*?\x3C\x3E]{1,104}$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_location_fsx_windows	select	region		Provides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.
create_location_fsx_windows	insert	region, FsxFilesystemArn, SecurityGroupArns		Creates a transfer location for an Amazon FSx for Windows File Server file system. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses FSx for Windows File Server file systems.
update_location_fsx_windows	update	region, LocationArn		Modifies the following configuration parameters of the Amazon FSx for Windows File Server transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with FSx for Windows File Server.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_location_fsx_windows

Provides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.

SELECT
cmk_secret_config,
creation_time,
custom_secret_config,
domain,
location_arn,
location_uri,
managed_secret_config,
security_group_arns,
user
FROM aws.datasync.location_fsx_windows
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_location_fsx_windows

Creates a transfer location for an Amazon FSx for Windows File Server file system. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses FSx for Windows File Server file systems.

INSERT INTO aws.datasync.location_fsx_windows (
Subdirectory,
FsxFilesystemArn,
SecurityGroupArns,
Tags,
User,
Domain,
Password,
CmkSecretConfig,
CustomSecretConfig,
region
)
SELECT 
'{{ Subdirectory }}',
'{{ FsxFilesystemArn }}' /* required */,
'{{ SecurityGroupArns }}' /* required */,
'{{ Tags }}',
'{{ User }}',
'{{ Domain }}',
'{{ Password }}',
'{{ CmkSecretConfig }}',
'{{ CustomSecretConfig }}',
'{{ region }}'
RETURNING
location_arn
;

Manifest

# Description fields are for documentation purposes
- name: location_fsx_windows
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the location_fsx_windows resource.
  - name: Subdirectory
    value: "{{ Subdirectory }}"
    description: |
      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).
  - name: FsxFilesystemArn
    value: "{{ FsxFilesystemArn }}"
    description: |
      Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
  - name: SecurityGroupArns
    value:
      - "{{ SecurityGroupArns }}"
    description: |
      Specifies the ARNs of the Amazon EC2 security groups that provide access to your file system's preferred subnet. The security groups that you specify must be able to communicate with your file system's security groups. For information about configuring security groups for file system access, see the Amazon FSx for Windows File Server User Guide . If you choose a security group that doesn't allow connections from within itself, do one of the following: Configure the security group to allow it to communicate within itself. Choose a different security group that can communicate with the mount target's security group.
  - name: Tags
    description: |
      Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: User
    value: "{{ User }}"
    description: |
      Specifies the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system. For information about choosing a user with the right level of access for your transfer, see required permissions for FSx for Windows File Server locations.
  - name: Domain
    value: "{{ Domain }}"
    description: |
      Specifies the name of the Windows domain that the FSx for Windows File Server file system belongs to. If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.
  - name: Password
    value: "{{ Password }}"
    description: |
      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.
  - name: CmkSecretConfig
    description: |
      Specifies configuration information for a DataSync-managed secret, which includes the password that DataSync uses to access a specific FSx Windows storage location, with a customer-managed KMS key. When you include this parameter as part of a CreateLocationFsxWindows request, you provide only the KMS key ARN. DataSync uses this KMS key together with the Password you specify for to create a DataSync-managed secret to store the location access credentials. Make sure that DataSync has permission to access the KMS key that you specify. For more information, see Using a service-managed secret encrypted with a custom KMS key. You can use either CmkSecretConfig (with Password) or CustomSecretConfig (without Password) to provide credentials for a CreateLocationFsxWindows request. Do not provide both parameters for the same request.
    value:
      SecretArn: "{{ SecretArn }}"
      KmsKeyArn: "{{ KmsKeyArn }}"
  - name: CustomSecretConfig
    description: |
      Specifies configuration information for a customer-managed Secrets Manager secret where the password for an FSx for Windows File Server storage location is stored in plain text, in Secrets Manager. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. For more information, see Using a secret that you manage. You can use either CmkSecretConfig (with Password) or CustomSecretConfig (without Password) to provide credentials for a CreateLocationFsxWindows request. Do not provide both parameters for the same request.
    value:
      SecretArn: "{{ SecretArn }}"
      SecretAccessRoleArn: "{{ SecretAccessRoleArn }}"

UPDATE examples

update_location_fsx_windows

Modifies the following configuration parameters of the Amazon FSx for Windows File Server transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with FSx for Windows File Server.

UPDATE aws.datasync.location_fsx_windows
SET 
LocationArn = '{{ LocationArn }}',
Subdirectory = '{{ Subdirectory }}',
Domain = '{{ Domain }}',
User = '{{ User }}',
Password = '{{ Password }}',
CmkSecretConfig = '{{ CmkSecretConfig }}',
CustomSecretConfig = '{{ CustomSecretConfig }}'
WHERE 
region = '{{ region }}' --required
AND LocationArn = '{{ LocationArn }}' --required;