Skip to content

UpdateLocationHdfsRequest

Source code in docs_src/capo_datasync/types/update_location_hdfs_request.py
class UpdateLocationHdfsRequest(TypedDict, closed=True):
    location_arn: "capo_datasync.types.location_arn.LocationArn"
    """<p>The Amazon Resource Name (ARN) of the source HDFS cluster location.</p>"""
    subdirectory: NotRequired["capo_datasync.types.hdfs_subdirectory.HdfsSubdirectory"]
    """<p>A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster.</p>"""
    name_nodes: NotRequired["capo_datasync.types.hdfs_name_node_list.HdfsNameNodeList"]
    """<p>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.</p> <p>The number of NameNodes you can specify depends on the task mode:</p> <ul> <li> <p> <b>Enhanced mode</b> – You can specify multiple NameNodes for HDFS High Availability (HA) configurations.</p> </li> <li> <p> <b>Basic mode</b> – You can specify only one NameNode.</p> </li> </ul>"""
    block_size: NotRequired["capo_datasync.types.hdfs_block_size.HdfsBlockSize"]
    """<p>The size of the data blocks to write into the HDFS cluster. </p>"""
    replication_factor: NotRequired[
        "capo_datasync.types.hdfs_replication_factor.HdfsReplicationFactor"
    ]
    """<p>The number of DataNodes to replicate the data to when writing to the HDFS cluster. </p>"""
    kms_key_provider_uri: NotRequired[
        "capo_datasync.types.kms_key_provider_uri.KmsKeyProviderUri"
    ]
    """<p>The URI of the HDFS cluster's Key Management Server (KMS). </p>"""
    qop_configuration: NotRequired[
        "capo_datasync.types.qop_configuration.QopConfiguration"
    ]
    """<p>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. </p>"""
    authentication_type: NotRequired[
        "capo_datasync.types.hdfs_authentication_type.HdfsAuthenticationType"
    ]
    """<p>The type of authentication used to determine the identity of the user. </p>"""
    simple_user: NotRequired["capo_datasync.types.hdfs_user.HdfsUser"]
    """<p>The user name used to identify the client on the host operating system.</p>"""
    kerberos_principal: NotRequired[
        "capo_datasync.types.kerberos_principal.KerberosPrincipal"
    ]
    """<p>The Kerberos principal with access to the files and folders on the HDFS cluster. </p>"""
    kerberos_keytab: NotRequired[
        "capo_datasync.types.kerberos_keytab_file.KerberosKeytabFile"
    ]
    """<p>The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address.</p>"""
    kerberos_krb5_conf: NotRequired[
        "capo_datasync.types.kerberos_krb5_conf_file.KerberosKrb5ConfFile"
    ]
    """<p>The <code>krb5.conf</code> file that contains the Kerberos configuration information. You can load the <code>krb5.conf</code> file by providing the file's address. If you're using the CLI, it performs the base64 encoding for you. Otherwise, provide the base64-encoded text.</p>"""
    agent_arns: NotRequired["capo_datasync.types.agent_arn_list.AgentArnList"]
    """<p>The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your HDFS cluster.</p>"""
    cmk_secret_config: NotRequired[
        "capo_datasync.types.cmk_secret_config.CmkSecretConfig"
    ]
    """<p>Specifies configuration information for a DataSync-managed secret, such as a <code>KerberosKeytab</code> or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.</p>"""
    custom_secret_config: NotRequired[
        "capo_datasync.types.custom_secret_config.CustomSecretConfig"
    ]
    """<p>Specifies configuration information for a customer-managed secret, such as a <code>KerberosKeytab</code> or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed Identity and Access Management (IAM) role that provides access to the secret.</p>"""

agent_arns instance-attribute

agent_arns: NotRequired[AgentArnList]

The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your HDFS cluster.

authentication_type instance-attribute

authentication_type: NotRequired[HdfsAuthenticationType]

The type of authentication used to determine the identity of the user.

block_size instance-attribute

block_size: NotRequired[HdfsBlockSize]

The size of the data blocks to write into the HDFS cluster.

cmk_secret_config instance-attribute

cmk_secret_config: NotRequired[CmkSecretConfig]

Specifies configuration information for a DataSync-managed secret, such as a KerberosKeytab or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.

custom_secret_config instance-attribute

custom_secret_config: NotRequired[CustomSecretConfig]

Specifies configuration information for a customer-managed secret, such as a KerberosKeytab or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed Identity and Access Management (IAM) role that provides access to the secret.

kerberos_keytab instance-attribute

kerberos_keytab: NotRequired[KerberosKeytabFile]

The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address.

kerberos_krb5_conf instance-attribute

kerberos_krb5_conf: NotRequired[KerberosKrb5ConfFile]

The krb5.conf file that contains the Kerberos configuration information. You can load the krb5.conf file by providing the file's address. If you're using the CLI, it performs the base64 encoding for you. Otherwise, provide the base64-encoded text.

kerberos_principal instance-attribute

kerberos_principal: NotRequired[KerberosPrincipal]

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

kms_key_provider_uri instance-attribute

kms_key_provider_uri: NotRequired[KmsKeyProviderUri]

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

location_arn instance-attribute

location_arn: LocationArn

The Amazon Resource Name (ARN) of the source HDFS cluster location.

name_nodes instance-attribute

name_nodes: NotRequired[HdfsNameNodeList]

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.

The number of NameNodes you can specify depends on the task mode:

  • Enhanced mode – You can specify multiple NameNodes for HDFS High Availability (HA) configurations.

  • Basic mode – You can specify only one NameNode.

qop_configuration instance-attribute

qop_configuration: NotRequired[QopConfiguration]

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.

replication_factor instance-attribute

replication_factor: NotRequired[HdfsReplicationFactor]

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

simple_user instance-attribute

simple_user: NotRequired[HdfsUser]

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

subdirectory instance-attribute

subdirectory: NotRequired[HdfsSubdirectory]

A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster.