CfnLocationHDFS

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.datasync.CfnLocationHDFS

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:32.088Z")
public class CfnLocationHDFS
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DataSync::LocationHDFS`.

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

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.*;
 CfnLocationHDFS cfnLocationHDFS = CfnLocationHDFS.Builder.create(this, "MyCfnLocationHDFS")
         .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	Class and Description
`static class`	`CfnLocationHDFS.Builder` A fluent builder for `CfnLocationHDFS`.
`static interface`	`CfnLocationHDFS.NameNodeProperty` The NameNode of the Hadoop Distributed File System (HDFS).
`static interface`	`CfnLocationHDFS.QopConfigurationProperty` 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.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnLocationHDFS(Construct scope, java.lang.String id, CfnLocationHDFSProps props)` Create a new `AWS::DataSync::LocationHDFS`.
`protected`	`CfnLocationHDFS(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnLocationHDFS(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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`	`getAttrLocationArn()` The Amazon Resource Name (ARN) of the HDFS cluster location to describe.
`java.lang.String`	`getAttrLocationUri()` The URI of the HDFS cluster location.
`java.lang.String`	`getAuthenticationType()` `AWS::DataSync::LocationHDFS.AuthenticationType`.
`java.lang.Number`	`getBlockSize()` The size of data blocks to write into the HDFS cluster.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getKerberosKeytab()` The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys.
`java.lang.String`	`getKerberosKrb5Conf()` The `krb5.conf` file that contains the Kerberos configuration information.
`java.lang.String`	`getKerberosPrincipal()` The Kerberos principal with access to the files and folders on the HDFS cluster.
`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.
`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.
`java.lang.Number`	`getReplicationFactor()` The number of DataNodes to replicate the data to when writing to the HDFS cluster.
`java.lang.String`	`getSimpleUser()` The user name used to identify the client on the host operating system.
`java.lang.String`	`getSubdirectory()` A subdirectory in the HDFS cluster.
`TagManager`	`getTags()` The key-value pair that represents the tag that you want to add to the location.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setAgentArns(java.util.List<java.lang.String> value)` The Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS cluster.
`void`	`setAuthenticationType(java.lang.String value)` `AWS::DataSync::LocationHDFS.AuthenticationType`.
`void`	`setBlockSize(java.lang.Number value)` The size of data blocks to write into the HDFS cluster.
`void`	`setKerberosKeytab(java.lang.String value)` The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys.
`void`	`setKerberosKrb5Conf(java.lang.String value)` The `krb5.conf` file that contains the Kerberos configuration information.
`void`	`setKerberosPrincipal(java.lang.String value)` The Kerberos principal with access to the files and folders on the HDFS cluster.
`void`	`setKmsKeyProviderUri(java.lang.String value)` The URI of the HDFS cluster's Key Management Server (KMS).
`void`	`setNameNodes(IResolvable value)` The NameNode that manages the HDFS namespace.
`void`	`setNameNodes(java.util.List<java.lang.Object> value)` The NameNode that manages the HDFS namespace.
`void`	`setQopConfiguration(CfnLocationHDFS.QopConfigurationProperty value)` 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.
`void`	`setQopConfiguration(IResolvable value)` 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.
`void`	`setReplicationFactor(java.lang.Number value)` The number of DataNodes to replicate the data to when writing to the HDFS cluster.
`void`	`setSimpleUser(java.lang.String value)` The user name used to identify the client on the host operating system.
`void`	`setSubdirectory(java.lang.String value)` A subdirectory in the HDFS cluster.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnLocationHDFS
```
protected CfnLocationHDFS(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnLocationHDFS
```
protected CfnLocationHDFS(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnLocationHDFS
```
public CfnLocationHDFS(Construct scope,
                       java.lang.String id,
                       CfnLocationHDFSProps props)
```
    Create a new `AWS::DataSync::LocationHDFS`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrLocationArn
```
public java.lang.String getAttrLocationArn()
```
    The Amazon Resource Name (ARN) of the HDFS cluster location to describe.
  - getAttrLocationUri
```
public java.lang.String getAttrLocationUri()
```
    The URI of the HDFS cluster location.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager 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.
  - getAgentArns
```
public java.util.List<java.lang.String> getAgentArns()
```
    The Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS cluster.
  - setAgentArns
```
public void setAgentArns(java.util.List<java.lang.String> value)
```
    The Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS cluster.
  - getAuthenticationType
```
public java.lang.String getAuthenticationType()
```
    `AWS::DataSync::LocationHDFS.AuthenticationType`.
  - setAuthenticationType
```
public void setAuthenticationType(java.lang.String value)
```
    `AWS::DataSync::LocationHDFS.AuthenticationType`.
  - getNameNodes
```
public 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.
  - setNameNodes
```
public void setNameNodes(IResolvable value)
```
    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.
  - setNameNodes
```
public void setNameNodes(java.util.List<java.lang.Object> value)
```
    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
```
public 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).
  - setBlockSize
```
public void setBlockSize(java.lang.Number value)
```
    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
```
public 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.
  - setKerberosKeytab
```
public void setKerberosKeytab(java.lang.String value)
```
    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
```
public 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.
  - setKerberosKrb5Conf
```
public void setKerberosKrb5Conf(java.lang.String value)
```
    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
```
public 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.
  - setKerberosPrincipal
```
public void setKerberosPrincipal(java.lang.String value)
```
    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
```
public java.lang.String getKmsKeyProviderUri()
```
    The URI of the HDFS cluster's Key Management Server (KMS).
  - setKmsKeyProviderUri
```
public void setKmsKeyProviderUri(java.lang.String value)
```
    The URI of the HDFS cluster's Key Management Server (KMS).
  - getQopConfiguration
```
public 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.
  - setQopConfiguration
```
public void setQopConfiguration(IResolvable value)
```
    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.
  - setQopConfiguration
```
public void setQopConfiguration(CfnLocationHDFS.QopConfigurationProperty value)
```
    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
```
public 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.
  - setReplicationFactor
```
public void setReplicationFactor(java.lang.Number value)
```
    The number of DataNodes to replicate the data to when writing to the HDFS cluster.
    By default, data is replicated to three DataNodes.
  - getSimpleUser
```
public 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.
  - setSimpleUser
```
public void setSimpleUser(java.lang.String value)
```
    The user name used to identify the client on the host operating system.
    
    If SIMPLE is specified for AuthenticationType , this parameter is required.
  - getSubdirectory
```
public 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 / .
  - setSubdirectory
```
public void setSubdirectory(java.lang.String value)
```
    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 / .

Class CfnLocationHDFS

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnLocationHDFS

CfnLocationHDFS

CfnLocationHDFS

Method Detail

inspect

renderProperties

getAttrLocationArn

getAttrLocationUri

getCfnProperties

getTags

getAgentArns

setAgentArns

getAuthenticationType

setAuthenticationType

getNameNodes

setNameNodes

setNameNodes

getBlockSize

setBlockSize

getKerberosKeytab

setKerberosKeytab

getKerberosKrb5Conf

setKerberosKrb5Conf

getKerberosPrincipal

setKerberosPrincipal

getKmsKeyProviderUri

setKmsKeyProviderUri

getQopConfiguration

setQopConfiguration

setQopConfiguration

getReplicationFactor

setReplicationFactor

getSimpleUser

setSimpleUser

getSubdirectory

setSubdirectory