AWS::DataSync::LocationHDFS

The AWS::DataSync::LocationHDFS resource specifies an endpoint for a Hadoop Distributed File System (HDFS).

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::DataSync::LocationHDFS",
  "Properties" : {
      "AgentArns" : [ String, ... ],
      "AuthenticationType" : String,
      "BlockSize" : Integer,
      "KerberosKeytab" : String,
      "KerberosKrb5Conf" : String,
      "KerberosPrincipal" : String,
      "KmsKeyProviderUri" : String,
      "NameNodes" : [ NameNode, ... ],
      "QopConfiguration" : QopConfiguration,
      "ReplicationFactor" : Integer,
      "SimpleUser" : String,
      "Subdirectory" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::DataSync::LocationHDFS
Properties:
  AgentArns: 
    - String
  AuthenticationType: String
  BlockSize: Integer
  KerberosKeytab: String
  KerberosKrb5Conf: String
  KerberosPrincipal: String
  KmsKeyProviderUri: String
  NameNodes: 
    - NameNode
  QopConfiguration: 
    QopConfiguration
  ReplicationFactor: Integer
  SimpleUser: String
  Subdirectory: String
  Tags: 
    - Tag

Properties

AgentArns

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

Required: Yes

Type: Array of String

Minimum: 1

Maximum: 128 | 4

Update requires: No interruption

AuthenticationType

Property description not available.

Required: Yes

Type: String

Allowed values: SIMPLE | KERBEROS

Update requires: No interruption

BlockSize

The size of data blocks to write into the HDFS cluster. The block size must be a multiple of 512 bytes. The default block size is 128 mebibytes (MiB).

Required: No

Type: Integer

Minimum: 1048576

Maximum: 1073741824

Update requires: No interruption

KerberosKeytab

The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. Provide the base64-encoded file text. If KERBEROS is specified for AuthType, this value is required.

Required: No

Type: String

Maximum: 87384

Update requires: No interruption

KerberosKrb5Conf

The krb5.conf file that contains the Kerberos configuration information. You can load the krb5.conf by providing a string of the file's contents or an Amazon S3 presigned URL of the file. IfKERBEROS is specified for AuthType, this value is required.

Required: No

Type: String

Maximum: 174764

Update requires: No interruption

KerberosPrincipal

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

Note

If KERBEROS is specified for AuthenticationType, this parameter is required.

Required: No

Type: String

Pattern: ^.+$

Minimum: 1

Maximum: 256

Update requires: No interruption

KmsKeyProviderUri

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

Required: No

Type: String

Pattern: ^kms:\/\/http[s]?@(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])(;(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9]))*:[0-9]{1,5}\/kms$

Minimum: 1

Maximum: 255

Update requires: No interruption

NameNodes

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.

Required: Yes

Type: Array of NameNode

Minimum: 1

Update requires: No interruption

QopConfiguration

The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer protection settings configured on the Hadoop Distributed File System (HDFS) cluster. If QopConfiguration isn't specified, RpcProtection and DataTransferProtection default to PRIVACY. If you set RpcProtection or DataTransferProtection, the other parameter assumes the same value.

Required: No

Type: QopConfiguration

Update requires: No interruption

ReplicationFactor

The number of DataNodes to replicate the data to when writing to the HDFS cluster. By default, data is replicated to three DataNodes.

Required: No

Type: Integer

Minimum: 1

Maximum: 512

Update requires: No interruption

SimpleUser

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

Note

If SIMPLE is specified for AuthenticationType, this parameter is required.

Required: No

Type: String

Pattern: ^[_.A-Za-z0-9][-_.A-Za-z0-9]*$

Minimum: 1

Maximum: 256

Update requires: No interruption

Subdirectory

A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to /.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9_\-\+\./\(\)\$\p{Zs}]+$

Maximum: 4096

Update requires: No interruption

Tags

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the location resource ARN. For example:

arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

LocationArn

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

LocationUri

The URI of the HDFS cluster location.