create_location_hdfs async ¶

async def create_location_hdfs(
    self,
    name_nodes: "capo_datasync.types.hdfs_name_node_list.HdfsNameNodeList",
    authentication_type: "capo_datasync.types.hdfs_authentication_type.HdfsAuthenticationType",
    agent_arns: "capo_datasync.types.agent_arn_list.AgentArnList",
    *,
    config_overrides: Optional[AsyncDataSyncClientConfig] = None,
    subdirectory: Optional[
        "capo_datasync.types.hdfs_subdirectory.HdfsSubdirectory"
    ] = None,
    block_size: Optional[
        "capo_datasync.types.hdfs_block_size.HdfsBlockSize"
    ] = None,
    replication_factor: Optional[
        "capo_datasync.types.hdfs_replication_factor.HdfsReplicationFactor"
    ] = None,
    kms_key_provider_uri: Optional[
        "capo_datasync.types.kms_key_provider_uri.KmsKeyProviderUri"
    ] = None,
    qop_configuration: Optional[
        "capo_datasync.types.qop_configuration.QopConfiguration"
    ] = None,
    simple_user: Optional["capo_datasync.types.hdfs_user.HdfsUser"] = None,
    kerberos_principal: Optional[
        "capo_datasync.types.kerberos_principal.KerberosPrincipal"
    ] = None,
    kerberos_keytab: Optional[
        "capo_datasync.types.kerberos_keytab_file.KerberosKeytabFile"
    ] = None,
    kerberos_krb5_conf: Optional[
        "capo_datasync.types.kerberos_krb5_conf_file.KerberosKrb5ConfFile"
    ] = None,
    tags: Optional["capo_datasync.types.input_tag_list.InputTagList"] = None,
    cmk_secret_config: Optional[
        "capo_datasync.types.cmk_secret_config.CmkSecretConfig"
    ] = None,
    custom_secret_config: Optional[
        "capo_datasync.types.custom_secret_config.CustomSecretConfig"
    ] = None,
) -> "capo_datasync.types.create_location_hdfs_response.CreateLocationHdfsResponse":
    """<p>Creates a transfer <i>location</i> for a Hadoop Distributed File System (HDFS). DataSync can use this location as a source or destination for transferring data.</p> <p>Before you begin, make sure that you understand how DataSync <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-hdfs-location.html#accessing-hdfs">accesses HDFS clusters</a>.</p>

    Args:
        subdirectory: <p>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 <code>/</code>.</p>
        name_nodes: <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: <p>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).</p>
        replication_factor: <p>The number of DataNodes to replicate the data to when writing to the HDFS cluster. By default, data is replicated to three DataNodes.</p>
        kms_key_provider_uri: <p>The URI of the HDFS cluster's Key Management Server (KMS). </p>
        qop_configuration: <p>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 <code>QopConfiguration</code> isn't specified, <code>RpcProtection</code> and <code>DataTransferProtection</code> default to <code>PRIVACY</code>. If you set <code>RpcProtection</code> or <code>DataTransferProtection</code>, the other parameter assumes the same value. </p>
        authentication_type: <p>The type of authentication used to determine the identity of the user. </p>
        simple_user: <p>The user name used to identify the client on the host operating system. </p> <note> <p>If <code>SIMPLE</code> is specified for <code>AuthenticationType</code>, this parameter is required. </p> </note>
        kerberos_principal: <p>The Kerberos principal with access to the files and folders on the HDFS cluster. </p> <note> <p>If <code>KERBEROS</code> is specified for <code>AuthenticationType</code>, this parameter is required.</p> </note>
        kerberos_keytab: <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> <note> <p>If <code>KERBEROS</code> is specified for <code>AuthenticationType</code>, this parameter is required. </p> </note>
        kerberos_krb5_conf: <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> <note> <p>If <code>KERBEROS</code> is specified for <code>AuthenticationType</code>, this parameter is required.</p> </note>
        agent_arns: <p>The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your HDFS cluster.</p>
        tags: <p>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. </p>
        cmk_secret_config: <p>Specifies configuration information for a DataSync-managed secret, which includes the Kerberos keytab that DataSync uses to access a specific Hadoop Distributed File System (HDFS) storage location, with a customer-managed KMS key.</p> <p>When you include this parameter as part of a <code>CreateLocationHdfs</code> request, you provide only the KMS key ARN. DataSync uses this KMS key together with the <code>KerberosKeytab</code> you specify for to create a DataSync-managed secret to store the location access credentials.</p> <p>Make sure that DataSync has permission to access the KMS key that you specify. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#service-secret-custom-key"> Using a service-managed secret encrypted with a custom KMS key</a>.</p> <note> <p>You can use either <code>CmkSecretConfig</code> (with <code>KerberosKeytab</code>) or <code>CustomSecretConfig</code> (without <code>KerberosKeytab</code>) to provide credentials for a <code>CreateLocationHdfs</code> request. Do not provide both parameters for the same request.</p> </note>
        custom_secret_config: <p>Specifies configuration information for a customer-managed Secrets Manager secret where the Kerberos keytab for the HDFS storage location is stored in binary, in Secrets Manager. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#custom-secret-custom-key"> Using a secret that you manage</a>.</p> <note> <p>You can use either <code>CmkSecretConfig</code> (with <code>KerberosKeytab</code>) or <code>CustomSecretConfig</code> (without <code>KerberosKeytab</code>) to provide credentials for a <code>CreateLocationHdfs</code> request. Do not provide both parameters for the same request.</p> </note>

    Raises:
        capo_datasync.errors.internal_exception.InternalException: <p>This exception is thrown when an error occurs in the DataSync service.</p>
        capo_datasync.errors.invalid_request_exception.InvalidRequestException: <p>This exception is thrown when the client submits a malformed request.</p>
        capo_datasync.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_datasync.types.create_location_hdfs_request.CreateLocationHdfsRequest]",
    ) -> AsyncOperationResponse[
        "capo_datasync.types.create_location_hdfs_response.CreateLocationHdfsResponse"
    ]:
        import capo_datasync._operations.fmrs_service.create_location_hdfs

        (
            output,
            http_response,
        ) = await capo_datasync._operations.fmrs_service.create_location_hdfs.async_create_location_hdfs(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateLocationHdfs")
    )
    input_: capo_datasync.types.create_location_hdfs_request.CreateLocationHdfsRequest = {
        "name_nodes": name_nodes,
        "authentication_type": authentication_type,
        "agent_arns": agent_arns,
    }
    if subdirectory is not None:
        input_["subdirectory"] = subdirectory
    if block_size is not None:
        input_["block_size"] = block_size
    if replication_factor is not None:
        input_["replication_factor"] = replication_factor
    if kms_key_provider_uri is not None:
        input_["kms_key_provider_uri"] = kms_key_provider_uri
    if qop_configuration is not None:
        input_["qop_configuration"] = qop_configuration
    if simple_user is not None:
        input_["simple_user"] = simple_user
    if kerberos_principal is not None:
        input_["kerberos_principal"] = kerberos_principal
    if kerberos_keytab is not None:
        input_["kerberos_keytab"] = kerberos_keytab
    if kerberos_krb5_conf is not None:
        input_["kerberos_krb5_conf"] = kerberos_krb5_conf
    if tags is not None:
        input_["tags"] = tags
    if cmk_secret_config is not None:
        input_["cmk_secret_config"] = cmk_secret_config
    if custom_secret_config is not None:
        input_["custom_secret_config"] = custom_secret_config

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output