CfnLocationHDFS (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

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

All Implemented Interfaces:: IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.872Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode

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

Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

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

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnLocationHDFS(software.constructs.Construct scope, 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
`List<String>`	`getAgentArns()` The Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS cluster.
`String`	`getAttrLocationArn()` The Amazon Resource Name (ARN) of the HDFS cluster location to describe.
`String`	`getAttrLocationUri()` The URI of the HDFS cluster location.
`String`	`getAuthenticationType()` `AWS::DataSync::LocationHDFS.AuthenticationType`.
`Number`	`getBlockSize()` The size of data blocks to write into the HDFS cluster.
`protected Map<String,Object>`	`getCfnProperties()`
`String`	`getKerberosKeytab()` The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys.
`String`	`getKerberosKrb5Conf()` The `krb5.conf` file that contains the Kerberos configuration information.
`String`	`getKerberosPrincipal()` The Kerberos principal with access to the files and folders on the HDFS cluster.
`String`	`getKmsKeyProviderUri()` The URI of the HDFS cluster's Key Management Server (KMS).
`Object`	`getNameNodes()` The NameNode that manages the HDFS namespace.
`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.
`Number`	`getReplicationFactor()` The number of DataNodes to replicate the data to when writing to the HDFS cluster.
`String`	`getSimpleUser()` The user name used to identify the client on the host operating system.
`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 Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setAgentArns(List<String> value)` The Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS cluster.
`void`	`setAuthenticationType(String value)` `AWS::DataSync::LocationHDFS.AuthenticationType`.
`void`	`setBlockSize(Number value)` The size of data blocks to write into the HDFS cluster.
`void`	`setKerberosKeytab(String value)` The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys.
`void`	`setKerberosKrb5Conf(String value)` The `krb5.conf` file that contains the Kerberos configuration information.
`void`	`setKerberosPrincipal(String value)` The Kerberos principal with access to the files and folders on the HDFS cluster.
`void`	`setKmsKeyProviderUri(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(List<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(Number value)` The number of DataNodes to replicate the data to when writing to the HDFS cluster.
`void`	`setSimpleUser(String value)` The user name used to identify the client on the host operating system.
`void`	`setSubdirectory(String value)` A subdirectory in the HDFS cluster.

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

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

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

Methods inherited from class software.constructs.Construct
getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final 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
```
@Stability(value=Stable)
public CfnLocationHDFS(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                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
```
@Stability(value=Stable)
public void inspect(@NotNull
                                             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
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrLocationArn
```
@Stability(value=Stable)
 @NotNull
public String getAttrLocationArn()
```
    The Amazon Resource Name (ARN) of the HDFS cluster location to describe.
  - getAttrLocationUri
```
@Stability(value=Stable)
 @NotNull
public String getAttrLocationUri()
```
    The URI of the HDFS cluster location.
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
@Stability(value=Stable)
 @NotNull
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
```
@Stability(value=Stable)
 @NotNull
public List<String> getAgentArns()
```
    The Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS cluster.
  - setAgentArns
```
@Stability(value=Stable)
public void setAgentArns(@NotNull
                                                  List<String> value)
```
    The Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS cluster.
  - getAuthenticationType
```
@Stability(value=Stable)
 @NotNull
public String getAuthenticationType()
```
    `AWS::DataSync::LocationHDFS.AuthenticationType`.
  - setAuthenticationType
```
@Stability(value=Stable)
public void setAuthenticationType(@NotNull
                                                           String value)
```
    `AWS::DataSync::LocationHDFS.AuthenticationType`.
  - getNameNodes
```
@Stability(value=Stable)
 @NotNull
public 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
```
@Stability(value=Stable)
public void setNameNodes(@NotNull
                                                  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
```
@Stability(value=Stable)
public void setNameNodes(@NotNull
                                                  List<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
```
@Stability(value=Stable)
 @Nullable
public 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
```
@Stability(value=Stable)
public void setBlockSize(@Nullable
                                                  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
```
@Stability(value=Stable)
 @Nullable
public 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
```
@Stability(value=Stable)
public void setKerberosKeytab(@Nullable
                                                       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
```
@Stability(value=Stable)
 @Nullable
public 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
```
@Stability(value=Stable)
public void setKerberosKrb5Conf(@Nullable
                                                         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
```
@Stability(value=Stable)
 @Nullable
public 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
```
@Stability(value=Stable)
public void setKerberosPrincipal(@Nullable
                                                          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
```
@Stability(value=Stable)
 @Nullable
public String getKmsKeyProviderUri()
```
    The URI of the HDFS cluster's Key Management Server (KMS).
  - setKmsKeyProviderUri
```
@Stability(value=Stable)
public void setKmsKeyProviderUri(@Nullable
                                                          String value)
```
    The URI of the HDFS cluster's Key Management Server (KMS).
  - getQopConfiguration
```
@Stability(value=Stable)
 @Nullable
public 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
```
@Stability(value=Stable)
public void setQopConfiguration(@Nullable
                                                         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.
  - setQopConfiguration
```
@Stability(value=Stable)
public void setQopConfiguration(@Nullable
                                                         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.
  - getReplicationFactor
```
@Stability(value=Stable)
 @Nullable
public 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
```
@Stability(value=Stable)
public void setReplicationFactor(@Nullable
                                                          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
```
@Stability(value=Stable)
 @Nullable
public 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
```
@Stability(value=Stable)
public void setSimpleUser(@Nullable
                                                   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
```
@Stability(value=Stable)
 @Nullable
public 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
```
@Stability(value=Stable)
public void setSubdirectory(@Nullable
                                                     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 class software.amazon.jsii.JsiiObject

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

Nested classes/interfaces inherited from interface software.constructs.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.CfnResource

Methods inherited from class software.amazon.awscdk.CfnRefElement

Methods inherited from class software.amazon.awscdk.CfnElement

Methods inherited from class software.constructs.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

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