CfnLocationHDFSProps

All Known Implementing Classes:: CfnLocationHDFSProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.766Z")
public interface 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 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

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

- Method Detail
  - getAgentArns
```
java.util.List<java.lang.String> getAgentArns()
```
    The Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS cluster.
  - getAuthenticationType
```
java.lang.String getAuthenticationType()
```
    `AWS::DataSync::LocationHDFS.AuthenticationType`.
  - getNameNodes
```
java.lang.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
```
default java.lang.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
```
default java.lang.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
```
default java.lang.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
```
default java.lang.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
```
default java.lang.String getKmsKeyProviderUri()
```
    The URI of the HDFS cluster's Key Management Server (KMS).
  - getQopConfiguration
```
default java.lang.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
```
default java.lang.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
```
default java.lang.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
```
default java.lang.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
```
default java.util.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
```
static CfnLocationHDFSProps.Builder builder()
```
    Returns:
    
    a CfnLocationHDFSProps.Builder of CfnLocationHDFSProps

Interface CfnLocationHDFSProps

Nested Class Summary

Method Summary

Method Detail

getAgentArns

getAuthenticationType

getNameNodes

getBlockSize

getKerberosKeytab

getKerberosKrb5Conf

getKerberosPrincipal

getKmsKeyProviderUri

getQopConfiguration

getReplicationFactor

getSimpleUser

getSubdirectory

getTags

builder