Package software.amazon.awscdk.services.datasync

Class CfnLocationHDFS

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, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-11T03:45:52.365Z") @Stability(Stable) public class CfnLocationHDFS extends CfnResource implements IInspectable, ITaggable
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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnLocationHDFS

      protected CfnLocationHDFS(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnLocationHDFS

      protected CfnLocationHDFS(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnLocationHDFS

      @Stability(Stable) public CfnLocationHDFS(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLocationHDFSProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrLocationArn()
      The Amazon Resource Name (ARN) of the HDFS cluster location to describe.

    • getAttrLocationUri

      @Stability(Stable) @NotNull public String getAttrLocationUri()
      The URI of the HDFS cluster location.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAgentArns

      @Stability(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(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(Stable) @NotNull public String getAuthenticationType()
      The authentication mode used to determine identity of user.

    • setAuthenticationType

      @Stability(Stable) public void setAuthenticationType(@NotNull String value)
      The authentication mode used to determine identity of user.

    • getNameNodes

      @Stability(Stable) @NotNull public Object getNameNodes()
      The NameNode that manages the HDFS namespace.

    • setNameNodes

      @Stability(Stable) public void setNameNodes(@NotNull IResolvable value)
      The NameNode that manages the HDFS namespace.

    • setNameNodes

      @Stability(Stable) public void setNameNodes(@NotNull List<Object> value)
      The NameNode that manages the HDFS namespace.

    • getBlockSize

      @Stability(Stable) @Nullable public Number getBlockSize()
      The size of data blocks to write into the HDFS cluster.

    • setBlockSize

      @Stability(Stable) public void setBlockSize(@Nullable Number value)
      The size of data blocks to write into the HDFS cluster.

    • getKerberosKeytab

      @Stability(Stable) @Nullable public String getKerberosKeytab()
      The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys.

    • setKerberosKeytab

      @Stability(Stable) public void setKerberosKeytab(@Nullable String value)
      The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys.

    • getKerberosKrb5Conf

      @Stability(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(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(Stable) @Nullable public String getKerberosPrincipal()
      The Kerberos principal with access to the files and folders on the HDFS cluster.

    • setKerberosPrincipal

      @Stability(Stable) public void setKerberosPrincipal(@Nullable String value)
      The Kerberos principal with access to the files and folders on the HDFS cluster.

    • getKmsKeyProviderUri

      @Stability(Stable) @Nullable public String getKmsKeyProviderUri()
      The URI of the HDFS cluster's Key Management Server (KMS).

    • setKmsKeyProviderUri

      @Stability(Stable) public void setKmsKeyProviderUri(@Nullable String value)
      The URI of the HDFS cluster's Key Management Server (KMS).

    • getQopConfiguration

      @Stability(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.

    • setQopConfiguration

      @Stability(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.

    • setQopConfiguration

      @Stability(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.

    • getReplicationFactor

      @Stability(Stable) @Nullable public Number getReplicationFactor()
      The number of DataNodes to replicate the data to when writing to the HDFS cluster.

    • setReplicationFactor

      @Stability(Stable) public void setReplicationFactor(@Nullable Number value)
      The number of DataNodes to replicate the data to when writing to the HDFS cluster.

    • getSimpleUser

      @Stability(Stable) @Nullable public String getSimpleUser()
      The user name used to identify the client on the host operating system.

    • setSimpleUser

      @Stability(Stable) public void setSimpleUser(@Nullable String value)
      The user name used to identify the client on the host operating system.

    • getSubdirectory

      @Stability(Stable) @Nullable public String getSubdirectory()
      A subdirectory in the HDFS cluster.

    • setSubdirectory

      @Stability(Stable) public void setSubdirectory(@Nullable String value)
      A subdirectory in the HDFS cluster.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The key-value pair that represents the tag that you want to add to the location.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The key-value pair that represents the tag that you want to add to the location.