AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . datasync ]

create-location-fsx-windows

Description

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 .

See also: AWS API Documentation

Synopsis

  create-location-fsx-windows
[--subdirectory <value>]
--fsx-filesystem-arn <value>
--security-group-arns <value>
[--tags <value>]
--user <value>
[--domain <value>]
[--password <value>]
[--cmk-secret-config <value>]
[--custom-secret-config <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--subdirectory (string)

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

--fsx-filesystem-arn (string)

Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.

--security-group-arns (list)

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 https://docs.aws.amazon.com/fsx/latest/WindowsGuide/limit-access-security-groups.html`__ .

Note

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.

(string)

Syntax:

"string" "string" ...

--tags (list)

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.

(structure)

A key-value pair representing a single tag that’s been applied to an Amazon Web Services resource.

Key -> (string)

The key for an Amazon Web Services resource tag.

Value -> (string)

The value for an Amazon Web Services resource tag.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--user (string)

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.

--domain (string)

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.

--password (string)

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.

--cmk-secret-config (structure)

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 .

Note

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.

SecretArn -> (string)

Specifies the ARN for the DataSync-managed Secrets Manager secret that that is used to access a specific storage location. This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for KmsKeyArn .

KmsKeyArn -> (string)

Specifies the ARN for the customer-managed KMS key that DataSync uses to encrypt the DataSync-managed secret stored for SecretArn . DataSync provides this key to Secrets Manager.

Shorthand Syntax:

SecretArn=string,KmsKeyArn=string

JSON Syntax:

{
  "SecretArn": "string",
  "KmsKeyArn": "string"
}

--custom-secret-config (structure)

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 .

Note

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.

SecretArn -> (string)

Specifies the ARN for an Secrets Manager secret.

SecretAccessRoleArn -> (string)

Specifies the ARN for the Identity and Access Management role that DataSync uses to access the secret specified for SecretArn .

Shorthand Syntax:

SecretArn=string,SecretAccessRoleArn=string

JSON Syntax:

{
  "SecretArn": "string",
  "SecretAccessRoleArn": "string"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

LocationArn -> (string)

The ARN of the FSx for Windows File Server file system location you created.