software.amazon.awscdk.services.datasync

Interface CfnLocationHDFSProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnLocationHDFSProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.874Z")
 @Stability(value=Stable)
public interface CfnLocationHDFSProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.datasync.*;
 CfnLocationHDFSProps cfnLocationHDFSProps = CfnLocationHDFSProps.builder()
         .agentArns(List.of("agentArns"))
         .authenticationType("authenticationType")
         .nameNodes(List.of(NameNodeProperty.builder()
                 .hostname("hostname")
                 .port(123)
                 .build()))
         // the properties below are optional
         .blockSize(123)
         .kerberosKeytab("kerberosKeytab")
         .kerberosKrb5Conf("kerberosKrb5Conf")
         .kerberosPrincipal("kerberosPrincipal")
         .kmsKeyProviderUri("kmsKeyProviderUri")
         .qopConfiguration(QopConfigurationProperty.builder()
                 .dataTransferProtection("dataTransferProtection")
                 .rpcProtection("rpcProtection")
                 .build())
         .replicationFactor(123)
         .simpleUser("simpleUser")
         .subdirectory("subdirectory")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnLocationHDFSProps.Builder A builder for CfnLocationHDFSProps
static class	CfnLocationHDFSProps.Jsii$Proxy An implementation for CfnLocationHDFSProps

Method Summary

Modifier and Type	Method and Description
static CfnLocationHDFSProps.Builder	builder()
List<String>	getAgentArns() The Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS cluster.
String	getAuthenticationType() `AWS::DataSync::LocationHDFS.AuthenticationType`.
default Number	getBlockSize() The size of data blocks to write into the HDFS cluster.
default String	getKerberosKeytab() The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys.
default String	getKerberosKrb5Conf() The `krb5.conf` file that contains the Kerberos configuration information.
default String	getKerberosPrincipal() The Kerberos principal with access to the files and folders on the HDFS cluster.
default String	getKmsKeyProviderUri() The URI of the HDFS cluster's Key Management Server (KMS).
Object	getNameNodes() The NameNode that manages the HDFS namespace.
default Object	getQopConfiguration() 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.
default Number	getReplicationFactor() The number of DataNodes to replicate the data to when writing to the HDFS cluster.
default String	getSimpleUser() The user name used to identify the client on the host operating system.
default String	getSubdirectory() A subdirectory in the HDFS cluster.
default List<CfnTag>	getTags() The key-value pair that represents the tag that you want to add to the location.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAgentArns

@Stability(value=Stable)
 @NotNull
List<String> getAgentArns()

The Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS cluster.

getAuthenticationType

@Stability(value=Stable)
 @NotNull
String getAuthenticationType()

`AWS::DataSync::LocationHDFS.AuthenticationType`.

getNameNodes

@Stability(value=Stable)
 @NotNull
Object getNameNodes()

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.

getBlockSize

@Stability(value=Stable)
 @Nullable
default Number getBlockSize()

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

getKerberosKeytab

@Stability(value=Stable)
 @Nullable
default String getKerberosKeytab()

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.

getKerberosKrb5Conf

@Stability(value=Stable)
 @Nullable
default String getKerberosKrb5Conf()

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.

getKerberosPrincipal

@Stability(value=Stable)
 @Nullable
default String getKerberosPrincipal()

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

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

getKmsKeyProviderUri

@Stability(value=Stable)
 @Nullable
default String getKmsKeyProviderUri()

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

getQopConfiguration

@Stability(value=Stable)
 @Nullable
default Object getQopConfiguration()

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.

getReplicationFactor

@Stability(value=Stable)
 @Nullable
default Number getReplicationFactor()

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

By default, data is replicated to three DataNodes.

getSimpleUser

@Stability(value=Stable)
 @Nullable
default String getSimpleUser()

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

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

getSubdirectory

@Stability(value=Stable)
 @Nullable
default String getSubdirectory()

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

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

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.

builder

@Stability(value=Stable)
static CfnLocationHDFSProps.Builder builder()

Returns:

a CfnLocationHDFSProps.Builder of CfnLocationHDFSProps