interface CfnLocationHDFSProps

Language	Type name
.NET	`Amazon.CDK.AWS.DataSync.CfnLocationHDFSProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsdatasync#CfnLocationHDFSProps`
Java	`software.amazon.awscdk.services.datasync.CfnLocationHDFSProps`
Python	`aws_cdk.aws_datasync.CfnLocationHDFSProps`
TypeScript	`aws-cdk-lib` » `aws_datasync` » `CfnLocationHDFSProps`

Properties for defining a CfnLocationHDFS.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_datasync as datasync } from 'aws-cdk-lib';
const cfnLocationHDFSProps: datasync.CfnLocationHDFSProps = {
  agentArns: ['agentArns'],
  authenticationType: 'authenticationType',
  nameNodes: [{
    hostname: 'hostname',
    port: 123,
  }],

  // the properties below are optional
  blockSize: 123,
  kerberosKeytab: 'kerberosKeytab',
  kerberosKrb5Conf: 'kerberosKrb5Conf',
  kerberosPrincipal: 'kerberosPrincipal',
  kmsKeyProviderUri: 'kmsKeyProviderUri',
  qopConfiguration: {
    dataTransferProtection: 'dataTransferProtection',
    rpcProtection: 'rpcProtection',
  },
  replicationFactor: 123,
  simpleUser: 'simpleUser',
  subdirectory: 'subdirectory',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
agentArns	`string[]`	The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your HDFS cluster.
authenticationType	`string`	The authentication mode used to determine identity of user.
nameNodes	`IResolvable` `\|` `IResolvable` `\|` `NameNodeProperty[]`	The NameNode that manages the HDFS namespace.
blockSize?	`number`	The size of data blocks to write into the HDFS cluster.
kerberosKeytab?	`string`	The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys.
kerberosKrb5Conf?	`string`	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. If `KERBEROS` is specified for `AuthType` , this value is required.
kerberosPrincipal?	`string`	The Kerberos principal with access to the files and folders on the HDFS cluster.
kmsKeyProviderUri?	`string`	The URI of the HDFS cluster's Key Management Server (KMS).
qopConfiguration?	`IResolvable` `\|` `QopConfigurationProperty`	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.
replicationFactor?	`number`	The number of DataNodes to replicate the data to when writing to the HDFS cluster.
simpleUser?	`string`	The user name used to identify the client on the host operating system.
subdirectory?	`string`	A subdirectory in the HDFS cluster.
tags?	`CfnTag[]`	The key-value pair that represents the tag that you want to add to the location.

agentArns

Type: string[]

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

authenticationType

Type: string

The authentication mode used to determine identity of user.

nameNodes

Type: IResolvable | IResolvable | NameNodeProperty[]

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.

blockSize?

Type: number (optional)

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

kerberosKeytab?

Type: string (optional)

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.

kerberosKrb5Conf?

Type: string (optional)

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. If KERBEROS is specified for AuthType , this value is required.

kerberosPrincipal?

Type: string (optional)

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

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

kmsKeyProviderUri?

Type: string (optional)

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

qopConfiguration?

Type: IResolvable | QopConfigurationProperty (optional)

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.

replicationFactor?

Type: number (optional, default: 3)

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

By default, data is replicated to three DataNodes.

simpleUser?

Type: string (optional)

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

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

subdirectory?

Type: string (optional)

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

tags?

Type: CfnTag[] (optional)

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.