Skip to content

aws.datasync.describe_location_fsx_ontap

Example SQL Queries

SELECT * FROM
aws.datasync.describe_location_fsx_ontap
WHERE
"location_arn" = 'VALUE';

Description

Provides details about how an DataSync transfer location for an Amazon FSx for NetApp ONTAP file system is configured.

If your location uses SMB, the DescribeLocationFsxOntap operation doesn't actually return a Password.

Table Definition

Column NameColumn Data Type
location_arn Required Input Column

The ARN of the FSx for ONTAP file system location.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
creation_time

The time that the location was created.

TIMESTAMP_S
fsx_filesystem_arn

The ARN of the FSx for ONTAP file system.

VARCHAR
location_uri

The uniform resource identifier (URI) of the FSx for ONTAP file system location.

VARCHAR
protocol

Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.

STRUCT(
"nfs" STRUCT(
"mount_options" STRUCT(
"version" VARCHAR
)
),
"smb" STRUCT(
"domain" VARCHAR,
"mount_options" STRUCT(
"version" VARCHAR
),
"password" VARCHAR,
"user" VARCHAR
)
)
Show child fields
protocol.nfs

Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for OpenZFS file system or FSx for ONTAP file system's storage virtual machine (SVM).

Show child fields
protocol.nfs.mount_options

Specifies how DataSync can access a location using the NFS protocol.

Show child fields
protocol.nfs.mount_options.version

Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.

You can specify the following options:

  • AUTOMATIC (default): DataSync chooses NFS version 4.1.

  • NFS3: Stateless protocol version that allows for asynchronous writes on the server.

  • NFSv4_0: Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems.

  • NFSv4_1: Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.

DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.

protocol.smb

Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM.

Show child fields
protocol.smb.domain

Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.

If you have multiple domains in your environment, configuring this setting makes sure that DataSync connects to the right SVM.

protocol.smb.mount_options

Specifies the version of the Server Message Block (SMB) protocol that DataSync uses to access an SMB file server.

Show child fields
protocol.smb.mount_options.version

By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.

These are the following options for configuring the SMB version:

  • AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1.

    This is the recommended option. If you instead choose a specific version that your file server doesn't support, you may get an Operation Not Supported error.

  • SMB3: Restricts the protocol negotiation to only SMB version 3.0.2.

  • SMB2: Restricts the protocol negotiation to only SMB version 2.1.

  • SMB2_0: Restricts the protocol negotiation to only SMB version 2.0.

  • SMB1: Restricts the protocol negotiation to only SMB version 1.0.

    The SMB1 option isn't available when creating an Amazon FSx for NetApp ONTAP location.

protocol.smb.password

Specifies the password of a user who has permission to access your SVM.

protocol.smb.user

Specifies a user that can mount and access the files, folders, and metadata in your SVM.

For information about choosing a user with the right level of access for your transfer, see Using the SMB protocol.

security_group_arns

The security groups that DataSync uses to access your FSx for ONTAP file system.

VARCHAR[]
Show child fields
security_group_arns[]
storage_virtual_machine_arn

The ARN of the storage virtual machine (SVM) on your FSx for ONTAP file system where you're copying data to or from.

VARCHAR