AWS DataSync

2021/11/03 - AWS DataSync - 3 new api methods

Changes  AWS DataSync now supports Hadoop Distributed File System (HDFS) Locations

DescribeLocationHdfs (new) Link ¶

Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.

See also: AWS API Documentation

Request Syntax

client.describe_location_hdfs(
    LocationArn='string'
)
type LocationArn:

string

param LocationArn:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'LocationArn': 'string',
    'LocationUri': 'string',
    'NameNodes': [
        {
            'Hostname': 'string',
            'Port': 123
        },
    ],
    'BlockSize': 123,
    'ReplicationFactor': 123,
    'KmsKeyProviderUri': 'string',
    'QopConfiguration': {
        'RpcProtection': 'DISABLED'|'AUTHENTICATION'|'INTEGRITY'|'PRIVACY',
        'DataTransferProtection': 'DISABLED'|'AUTHENTICATION'|'INTEGRITY'|'PRIVACY'
    },
    'AuthenticationType': 'SIMPLE'|'KERBEROS',
    'SimpleUser': 'string',
    'KerberosPrincipal': 'string',
    'AgentArns': [
        'string',
    ],
    'CreationTime': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --

    • LocationArn (string) --

      The ARN of the HDFS cluster location.

    • LocationUri (string) --

      The URI of the HDFS cluster location.

    • NameNodes (list) --

      The NameNode that manage the HDFS namespace.

      • (dict) --

        The NameNode of the Hadoop Distributed File System (HDFS). The NameNode manages the file system's 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.

        • Hostname (string) --

          The hostname of the NameNode in the HDFS cluster. This value is the IP address or Domain Name Service (DNS) name of the NameNode. An agent that's installed on-premises uses this hostname to communicate with the NameNode in the network.

        • Port (integer) --

          The port that the NameNode uses to listen to client requests.

    • BlockSize (integer) --

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

    • ReplicationFactor (integer) --

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

    • KmsKeyProviderUri (string) --

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

    • QopConfiguration (dict) --

      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.

      • RpcProtection (string) --

        The RPC protection setting configured on the HDFS cluster. This setting corresponds to your hadoop.rpc.protection setting in your core-site.xml file on your Hadoop cluster.

      • DataTransferProtection (string) --

        The data transfer protection setting configured on the HDFS cluster. This setting corresponds to your dfs.data.transfer.protection setting in the hdfs-site.xml file on your Hadoop cluster.

    • AuthenticationType (string) --

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

    • SimpleUser (string) --

      The user name used to identify the client on the host operating system. This parameter is used if the AuthenticationType is defined as SIMPLE.

    • KerberosPrincipal (string) --

      The Kerberos principal with access to the files and folders on the HDFS cluster. This parameter is used if the AuthenticationType is defined as KERBEROS.

    • AgentArns (list) --

      The ARNs of the agents that are used to connect to the HDFS cluster.

      • (string) --

    • CreationTime (datetime) --

      The time that the HDFS location was created.

UpdateLocationHdfs (new) Link ¶

Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.

See also: AWS API Documentation

Request Syntax

client.update_location_hdfs(
    LocationArn='string',
    Subdirectory='string',
    NameNodes=[
        {
            'Hostname': 'string',
            'Port': 123
        },
    ],
    BlockSize=123,
    ReplicationFactor=123,
    KmsKeyProviderUri='string',
    QopConfiguration={
        'RpcProtection': 'DISABLED'|'AUTHENTICATION'|'INTEGRITY'|'PRIVACY',
        'DataTransferProtection': 'DISABLED'|'AUTHENTICATION'|'INTEGRITY'|'PRIVACY'
    },
    AuthenticationType='SIMPLE'|'KERBEROS',
    SimpleUser='string',
    KerberosPrincipal='string',
    KerberosKeytab=b'bytes',
    KerberosKrb5Conf=b'bytes',
    AgentArns=[
        'string',
    ]
)
type LocationArn:

string

param LocationArn:

[REQUIRED]

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

type Subdirectory:

string

param Subdirectory:

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

type NameNodes:

list

param NameNodes:

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.

  • (dict) --

    The NameNode of the Hadoop Distributed File System (HDFS). The NameNode manages the file system's 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.

    • Hostname (string) -- [REQUIRED]

      The hostname of the NameNode in the HDFS cluster. This value is the IP address or Domain Name Service (DNS) name of the NameNode. An agent that's installed on-premises uses this hostname to communicate with the NameNode in the network.

    • Port (integer) -- [REQUIRED]

      The port that the NameNode uses to listen to client requests.

type BlockSize:

integer

param BlockSize:

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

type ReplicationFactor:

integer

param ReplicationFactor:

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

type KmsKeyProviderUri:

string

param KmsKeyProviderUri:

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

type QopConfiguration:

dict

param 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.

  • RpcProtection (string) --

    The RPC protection setting configured on the HDFS cluster. This setting corresponds to your hadoop.rpc.protection setting in your core-site.xml file on your Hadoop cluster.

  • DataTransferProtection (string) --

    The data transfer protection setting configured on the HDFS cluster. This setting corresponds to your dfs.data.transfer.protection setting in the hdfs-site.xml file on your Hadoop cluster.

type AuthenticationType:

string

param AuthenticationType:

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

type SimpleUser:

string

param SimpleUser:

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

type KerberosPrincipal:

string

param KerberosPrincipal:

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

type KerberosKeytab:

bytes

param KerberosKeytab:

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. If you use the AWS CLI, it performs base64 encoding for you. Otherwise, provide the base64-encoded text.

type KerberosKrb5Conf:

bytes

param KerberosKrb5Conf:

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 AWS CLI, it performs the base64 encoding for you. Otherwise, provide the base64-encoded text.

type AgentArns:

list

param AgentArns:

The ARNs of the agents that are used to connect to the HDFS cluster.

  • (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

CreateLocationHdfs (new) Link ¶

Creates an endpoint for a Hadoop Distributed File System (HDFS).

See also: AWS API Documentation

Request Syntax

client.create_location_hdfs(
    Subdirectory='string',
    NameNodes=[
        {
            'Hostname': 'string',
            'Port': 123
        },
    ],
    BlockSize=123,
    ReplicationFactor=123,
    KmsKeyProviderUri='string',
    QopConfiguration={
        'RpcProtection': 'DISABLED'|'AUTHENTICATION'|'INTEGRITY'|'PRIVACY',
        'DataTransferProtection': 'DISABLED'|'AUTHENTICATION'|'INTEGRITY'|'PRIVACY'
    },
    AuthenticationType='SIMPLE'|'KERBEROS',
    SimpleUser='string',
    KerberosPrincipal='string',
    KerberosKeytab=b'bytes',
    KerberosKrb5Conf=b'bytes',
    AgentArns=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type Subdirectory:

string

param Subdirectory:

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 /.

type NameNodes:

list

param NameNodes:

[REQUIRED]

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.

  • (dict) --

    The NameNode of the Hadoop Distributed File System (HDFS). The NameNode manages the file system's 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.

    • Hostname (string) -- [REQUIRED]

      The hostname of the NameNode in the HDFS cluster. This value is the IP address or Domain Name Service (DNS) name of the NameNode. An agent that's installed on-premises uses this hostname to communicate with the NameNode in the network.

    • Port (integer) -- [REQUIRED]

      The port that the NameNode uses to listen to client requests.

type BlockSize:

integer

param BlockSize:

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).

type ReplicationFactor:

integer

param ReplicationFactor:

The number of DataNodes to replicate the data to when writing to the HDFS cluster. By default, data is replicated to three DataNodes.

type KmsKeyProviderUri:

string

param KmsKeyProviderUri:

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

type QopConfiguration:

dict

param QopConfiguration:

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.

  • RpcProtection (string) --

    The RPC protection setting configured on the HDFS cluster. This setting corresponds to your hadoop.rpc.protection setting in your core-site.xml file on your Hadoop cluster.

  • DataTransferProtection (string) --

    The data transfer protection setting configured on the HDFS cluster. This setting corresponds to your dfs.data.transfer.protection setting in the hdfs-site.xml file on your Hadoop cluster.

type AuthenticationType:

string

param AuthenticationType:

[REQUIRED]

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

type SimpleUser:

string

param SimpleUser:

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

type KerberosPrincipal:

string

param KerberosPrincipal:

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

type KerberosKeytab:

bytes

param KerberosKeytab:

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. If you're using the CLI, it performs base64 encoding for you. Otherwise, provide the base64-encoded text.

type KerberosKrb5Conf:

bytes

param KerberosKrb5Conf:

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.

type AgentArns:

list

param AgentArns:

[REQUIRED]

The Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS cluster.

  • (string) --

type Tags:

list

param Tags:

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.

  • (dict) --

    Represents a single entry in a list of Amazon Web Services resource tags. TagListEntry returns an array that contains a list of tasks when the ListTagsForResource operation is called.

    • Key (string) -- [REQUIRED]

      The key for an Amazon Web Services resource tag.

    • Value (string) --

      The value for an Amazon Web Services resource tag.

rtype:

dict

returns:

Response Syntax

{
    'LocationArn': 'string'
}

Response Structure

  • (dict) --

    • LocationArn (string) --

      The ARN of the source HDFS cluster location that's created.