update-location-hdfs¶

Description¶

Modifies the following configuration parameters of the Hadoop Distributed File System (HDFS) transfer location that you’re using with DataSync.

For more information, see Configuring DataSync transfers with an HDFS cluster .

Synopsis¶

  update-location-hdfs
--location-arn <value>
[--subdirectory <value>]
[--name-nodes <value>]
[--block-size <value>]
[--replication-factor <value>]
[--kms-key-provider-uri <value>]
[--qop-configuration <value>]
[--authentication-type <value>]
[--simple-user <value>]
[--kerberos-principal <value>]
[--kerberos-keytab <value>]
[--kerberos-krb5-conf <value>]
[--agent-arns <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--location-arn (string)

The Amazon Resource Name (ARN) of the source HDFS cluster location.

--subdirectory (string)

A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster.

--name-nodes (list)

The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. You can use only one NameNode.

(structure)

The NameNode of the Hadoop Distributed File System (HDFS). The NameNode manages the file system’s namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes.

Hostname -> (string)

The hostname of the NameNode in the HDFS cluster. This value is the IP address or Domain Name Service (DNS) name of the NameNode. An agent that’s installed on-premises uses this hostname to communicate with the NameNode in the network.

Port -> (integer)

The port that the NameNode uses to listen to client requests.

Shorthand Syntax:

Hostname=string,Port=integer ...

JSON Syntax:

[
  {
    "Hostname": "string",
    "Port": integer
  }
  ...
]

--block-size (integer)

The size of the data blocks to write into the HDFS cluster.

--replication-factor (integer)

The number of DataNodes to replicate the data to when writing to the HDFS cluster.

--kms-key-provider-uri (string)

The URI of the HDFS cluster’s Key Management Server (KMS).

--qop-configuration (structure)

The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer privacy settings configured on the Hadoop Distributed File System (HDFS) cluster.

RpcProtection -> (string)

The RPC protection setting configured on the HDFS cluster. This setting corresponds to your hadoop.rpc.protection setting in your core-site.xml file on your Hadoop cluster.

DataTransferProtection -> (string)

The data transfer protection setting configured on the HDFS cluster. This setting corresponds to your dfs.data.transfer.protection setting in the hdfs-site.xml file on your Hadoop cluster.

Shorthand Syntax:

RpcProtection=string,DataTransferProtection=string

JSON Syntax:

{
  "RpcProtection": "DISABLED"|"AUTHENTICATION"|"INTEGRITY"|"PRIVACY",
  "DataTransferProtection": "DISABLED"|"AUTHENTICATION"|"INTEGRITY"|"PRIVACY"
}

--authentication-type (string)

The type of authentication used to determine the identity of the user.

Possible values:

SIMPLE

KERBEROS

--simple-user (string)

The user name used to identify the client on the host operating system.

--kerberos-principal (string)

The Kerberos principal with access to the files and folders on the HDFS cluster.

--kerberos-keytab (blob)

The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file’s address. If you use the CLI, it performs base64 encoding for you. Otherwise, provide the base64-encoded text.

--kerberos-krb5-conf (blob)

The krb5.conf file that contains the Kerberos configuration information. You can load the krb5.conf file by providing the file’s address. If you’re using the CLI, it performs the base64 encoding for you. Otherwise, provide the base64-encoded text.

--agent-arns (list)

The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your HDFS cluster.

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To update your transfer location with a new agent

The following update-location-hdfs example updates your DataSync HDFS location with a new agent. You only need the --kerberos-keytab and --kerberos-krb5-conf options if your HDFS cluster uses Kerberos authentication.

aws datasync update-location-hdfs \
    --location-arn arn:aws:datasync:us-west-2:123456789012:location/loc-abcdef01234567890 \
    --agent-arns arn:aws:datasync:us-west-2:123456789012:agent/agent-1234567890abcdef0 \
    --kerberos-keytab file://hdfs.keytab
    --kerberos-krb5-conf file://krb5.conf

Contents of hdfs.keytab:

N/A. The content of this file is encrypted and not human readable.

Contents of krb5.conf:

[libdefaults]
    default_realm = EXAMPLE.COM
    dns_lookup_realm = false
    dns_lookup_kdc = false
    rdns = true
    ticket_lifetime = 24h
    forwardable = true
    udp_preference_limit = 1000000
    default_tkt_enctypes = aes256-cts-hmac-sha1-96 aes128-cts-hmac-sha1-96 des3-cbc-sha1
    default_tgs_enctypes = aes256-cts-hmac-sha1-96 aes128-cts-hmac-sha1-96 des3-cbc-sha1
    permitted_enctypes = aes256-cts-hmac-sha1-96 aes128-cts-hmac-sha1-96 des3-cbc-sha1

[realms]
    EXAMPLE.COM = {
      kdc = kdc1.example.com
      admin_server = krbadmin.example.com
      default_domain = example.com
    }

[domain_realm]
    .example.com = EXAMPLE.COM
    example.com = EXAMPLE.COM

[logging]
    kdc = FILE:/var/log/krb5kdc.log
    admin_server = FILE:/var/log/kerberos/kadmin.log
    default = FILE:/var/log/krb5libs.log

This command produces no output.

For more information, see Replacing your agent in the AWS DataSync User Guide.

Output¶

None

Table of Contents

Feedback

User Guide