location_nfs

Creates, updates, deletes or gets a location_nf resource or lists location_nfs in a region

Overview

Name	location_nfs
Type	Resource
Description	Resource schema for AWS::DataSync::LocationNFS
Id	awscc.datasync.location_nfs

Fields

get (all properties)

Name	Datatype	Description
▶mount_options	object	The mount options used by DataSync to access the SMB server.
▶on_prem_config	object	Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect an NFS server.
server_hostname	string	The name of the NFS server. This value is the IP address or DNS name of the NFS server.
subdirectory	string	The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination.
▶tags	array	An array of key-value pairs to apply to this resource.
location_arn	string	The Amazon Resource Name (ARN) of the NFS location.
location_uri	string	The URL of the NFS location that was described.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
location_arn	string	The Amazon Resource Name (ARN) of the NFS location.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	location_nfs	INSERT	OnPremConfig, region
delete_resource	location_nfs	DELETE	Identifier, region
update_resource	location_nfs	UPDATE	Identifier, PatchDocument, region
list_resources	location_nfs_list_only	SELECT	region
get_resource	location_nfs	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual location_nf.

SELECT
  region,
  mount_options,
  on_prem_config,
  server_hostname,
  subdirectory,
  tags,
  location_arn,
  location_uri
FROM awscc.datasync.location_nfs
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ location_arn }}';

list (identifiers only)

Lists all location_nfs in a region.

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

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.datasync.location_nfs (
  OnPremConfig,
  region
)
SELECT
  '{{ on_prem_config }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.datasync.location_nfs (
  MountOptions,
  OnPremConfig,
  ServerHostname,
  Subdirectory,
  Tags,
  region
)
SELECT
  '{{ mount_options }}',
  '{{ on_prem_config }}',
  '{{ server_hostname }}',
  '{{ subdirectory }}',
  '{{ 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: location_nf
  props:
    - name: mount_options
      value:
        version: '{{ version }}'
    - name: on_prem_config
      value:
        agent_arns:
          - '{{ agent_arns[0] }}'
    - name: server_hostname
      value: '{{ server_hostname }}'
    - name: subdirectory
      value: '{{ subdirectory }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.datasync.location_nfs
SET PatchDocument = string('{{ {
    "MountOptions": mount_options,
    "OnPremConfig": on_prem_config,
    "ServerHostname": server_hostname,
    "Subdirectory": subdirectory,
    "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.location_nfs
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 location_nfs resource, the following permissions are required:

Create

datasync:CreateLocationNfs,
datasync:DescribeLocationNfs,
datasync:ListTagsForResource,
datasync:TagResource

Read

datasync:DescribeLocationNfs,
datasync:ListTagsForResource

Update

datasync:DescribeLocationNfs,
datasync:ListTagsForResource,
datasync:TagResource,
datasync:UntagResource,
datasync:UpdateLocationNfs

Delete

datasync:DeleteLocation

List

datasync:ListLocations