locationf_sx_windows

Creates, updates, deletes or gets a locationf_sx_window resource or lists locationf_sx_windows in a region

Overview

Name	locationf_sx_windows
Type	Resource
Description	Resource schema for AWS::DataSync::LocationFSxWindows.
Id	awscc.datasync.locationf_sx_windows

Fields

get (all properties)

Name	Datatype	Description
domain	string	The name of the Windows domain that the FSx for Windows server belongs to.
fsx_filesystem_arn	string	The Amazon Resource Name (ARN) for the FSx for Windows file system.
password	string	The password of the user who has the permissions to access files and folders in the FSx for Windows file system.
security_group_arns	array	The ARNs of the security groups that are to use to configure the FSx for Windows file system.
subdirectory	string	A subdirectory in the location's path.
user	string	The user who has the permissions to access files and folders in the FSx for Windows file system.
▶tags	array	An array of key-value pairs to apply to this resource.
location_arn	string	The Amazon Resource Name (ARN) of the Amazon FSx for Windows file system location that is created.
location_uri	string	The URL of the FSx for Windows location that was described.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
location_arn	string	The Amazon Resource Name (ARN) of the Amazon FSx for Windows file system location that is created.
region	string	AWS region.

For more information, see AWS::DataSync::LocationFSxWindows.

Methods

Name	Resource	Accessible by	Required Params
create_resource	locationf_sx_windows	INSERT	User, SecurityGroupArns, region
delete_resource	locationf_sx_windows	DELETE	Identifier, region
update_resource	locationf_sx_windows	UPDATE	Identifier, PatchDocument, region
list_resources	locationf_sx_windows_list_only	SELECT	region
get_resource	locationf_sx_windows	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual locationf_sx_window.

SELECT
  region,
  domain,
  fsx_filesystem_arn,
  password,
  security_group_arns,
  subdirectory,
  user,
  tags,
  location_arn,
  location_uri
FROM awscc.datasync.locationf_sx_windows
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ location_arn }}';

list (identifiers only)

Lists all locationf_sx_windows in a region.

SELECT
  region,
  location_arn
FROM awscc.datasync.locationf_sx_windows_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new locationf_sx_window resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.datasync.locationf_sx_windows (
  SecurityGroupArns,
  User,
  region
)
SELECT
  '{{ security_group_arns }}',
  '{{ user }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.datasync.locationf_sx_windows (
  Domain,
  FsxFilesystemArn,
  Password,
  SecurityGroupArns,
  Subdirectory,
  User,
  Tags,
  region
)
SELECT
  '{{ domain }}',
  '{{ fsx_filesystem_arn }}',
  '{{ password }}',
  '{{ security_group_arns }}',
  '{{ subdirectory }}',
  '{{ user }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: locationf_sx_window
  props:
    - name: domain
      value: '{{ domain }}'
    - name: fsx_filesystem_arn
      value: '{{ fsx_filesystem_arn }}'
    - name: password
      value: '{{ password }}'
    - name: security_group_arns
      value:
        - '{{ security_group_arns[0] }}'
    - name: subdirectory
      value: '{{ subdirectory }}'
    - name: user
      value: '{{ user }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a locationf_sx_window resource, using stack-deploy.

/*+ update */
UPDATE awscc.datasync.locationf_sx_windows
SET PatchDocument = string('{{ {
    "Domain": domain,
    "Password": password,
    "Subdirectory": subdirectory,
    "User": user,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ location_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.datasync.locationf_sx_windows
WHERE
  Identifier = '{{ location_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the locationf_sx_windows resource, the following permissions are required:

Create

datasync:CreateLocationFsxWindows,
datasync:DescribeLocationFsxWindows,
datasync:ListTagsForResource,
datasync:TagResource,
fsx:DescribeFileSystems,
ec2:DescribeNetworkInterfaces,
ec2:DescribeSubnets,
ec2:DescribeSecurityGroups

Read

datasync:DescribeLocationFsxWindows,
datasync:ListTagsForResource

Update

datasync:DescribeLocationFsxWindows,
datasync:UpdateLocationFsxWindows,
datasync:ListTagsForResource,
datasync:TagResource,
datasync:UntagResource,
fsx:DescribeFileSystems,
ec2:DescribeNetworkInterfaces

Delete

datasync:DeleteLocation

List

datasync:ListLocations