amazonka-datasync-2.0: Amazon DataSync SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.DataSync.CreateLocationHdfs

Description

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

Synopsis

Creating a Request

data CreateLocationHdfs Source #

See: newCreateLocationHdfs smart constructor.

Constructors

CreateLocationHdfs' 

Fields

  • blockSize :: Maybe Natural

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

  • kerberosKeytab :: Maybe Base64

    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.

    If KERBEROS is specified for AuthenticationType, this parameter is required.

  • kerberosKrb5Conf :: Maybe Base64

    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.

    If KERBEROS is specified for AuthenticationType, this parameter is required.

  • kerberosPrincipal :: Maybe Text

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

    If KERBEROS is specified for AuthenticationType, this parameter is required.

  • kmsKeyProviderUri :: Maybe Text

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

  • qopConfiguration :: Maybe 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.

  • replicationFactor :: Maybe Natural

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

  • simpleUser :: Maybe Text

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

    If SIMPLE is specified for AuthenticationType, this parameter is required.

  • subdirectory :: Maybe Text

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

  • tags :: Maybe [TagListEntry]

    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.

  • nameNodes :: NonEmpty HdfsNameNode

    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.

  • authenticationType :: HdfsAuthenticationType

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

  • agentArns :: NonEmpty Text

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

Instances

Instances details
ToJSON CreateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationHdfs

ToHeaders CreateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationHdfs

ToPath CreateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationHdfs

ToQuery CreateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationHdfs

AWSRequest CreateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationHdfs

Associated Types

type AWSResponse CreateLocationHdfs #

Generic CreateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationHdfs

Associated Types

type Rep CreateLocationHdfs :: Type -> Type #

Read CreateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationHdfs

Show CreateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationHdfs

NFData CreateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationHdfs

Methods

rnf :: CreateLocationHdfs -> () #

Eq CreateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationHdfs

Hashable CreateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationHdfs

type AWSResponse CreateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationHdfs

type Rep CreateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationHdfs

type Rep CreateLocationHdfs = D1 ('MetaData "CreateLocationHdfs" "Amazonka.DataSync.CreateLocationHdfs" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "CreateLocationHdfs'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "blockSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "kerberosKeytab") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64)) :*: S1 ('MetaSel ('Just "kerberosKrb5Conf") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64)))) :*: (S1 ('MetaSel ('Just "kerberosPrincipal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "kmsKeyProviderUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "qopConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QopConfiguration))))) :*: ((S1 ('MetaSel ('Just "replicationFactor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "simpleUser") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "subdirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagListEntry])) :*: S1 ('MetaSel ('Just "nameNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty HdfsNameNode))) :*: (S1 ('MetaSel ('Just "authenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HdfsAuthenticationType) :*: S1 ('MetaSel ('Just "agentArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)))))))

newCreateLocationHdfs Source #

Create a value of CreateLocationHdfs with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:blockSize:CreateLocationHdfs', createLocationHdfs_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).

$sel:kerberosKeytab:CreateLocationHdfs', createLocationHdfs_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.

If KERBEROS is specified for AuthenticationType, this parameter is required.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:kerberosKrb5Conf:CreateLocationHdfs', createLocationHdfs_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.

If KERBEROS is specified for AuthenticationType, this parameter is required.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:kerberosPrincipal:CreateLocationHdfs', createLocationHdfs_kerberosPrincipal - The Kerberos principal with access to the files and folders on the HDFS cluster.

If KERBEROS is specified for AuthenticationType, this parameter is required.

$sel:kmsKeyProviderUri:CreateLocationHdfs', createLocationHdfs_kmsKeyProviderUri - The URI of the HDFS cluster's Key Management Server (KMS).

$sel:qopConfiguration:CreateLocationHdfs', createLocationHdfs_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.

$sel:replicationFactor:CreateLocationHdfs', createLocationHdfs_replicationFactor - The number of DataNodes to replicate the data to when writing to the HDFS cluster. By default, data is replicated to three DataNodes.

$sel:simpleUser:CreateLocationHdfs', createLocationHdfs_simpleUser - The user name used to identify the client on the host operating system.

If SIMPLE is specified for AuthenticationType, this parameter is required.

$sel:subdirectory:CreateLocationHdfs', createLocationHdfs_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 /.

$sel:tags:CreateLocationHdfs', createLocationHdfs_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.

$sel:nameNodes:CreateLocationHdfs', createLocationHdfs_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.

$sel:authenticationType:CreateLocationHdfs', createLocationHdfs_authenticationType - The type of authentication used to determine the identity of the user.

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

Request Lenses

createLocationHdfs_blockSize :: Lens' CreateLocationHdfs (Maybe Natural) Source #

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

createLocationHdfs_kerberosKeytab :: Lens' CreateLocationHdfs (Maybe ByteString) Source #

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.

If KERBEROS is specified for AuthenticationType, this parameter is required.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

createLocationHdfs_kerberosKrb5Conf :: Lens' CreateLocationHdfs (Maybe ByteString) Source #

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.

If KERBEROS is specified for AuthenticationType, this parameter is required.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

createLocationHdfs_kerberosPrincipal :: Lens' CreateLocationHdfs (Maybe Text) Source #

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

If KERBEROS is specified for AuthenticationType, this parameter is required.

createLocationHdfs_kmsKeyProviderUri :: Lens' CreateLocationHdfs (Maybe Text) Source #

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

createLocationHdfs_qopConfiguration :: Lens' CreateLocationHdfs (Maybe QopConfiguration) Source #

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.

createLocationHdfs_replicationFactor :: Lens' CreateLocationHdfs (Maybe Natural) Source #

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

createLocationHdfs_simpleUser :: Lens' CreateLocationHdfs (Maybe Text) Source #

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

If SIMPLE is specified for AuthenticationType, this parameter is required.

createLocationHdfs_subdirectory :: Lens' CreateLocationHdfs (Maybe Text) Source #

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

createLocationHdfs_tags :: Lens' CreateLocationHdfs (Maybe [TagListEntry]) Source #

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.

createLocationHdfs_nameNodes :: Lens' CreateLocationHdfs (NonEmpty HdfsNameNode) Source #

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.

createLocationHdfs_authenticationType :: Lens' CreateLocationHdfs HdfsAuthenticationType Source #

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

createLocationHdfs_agentArns :: Lens' CreateLocationHdfs (NonEmpty Text) Source #

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

Destructuring the Response

data CreateLocationHdfsResponse Source #

See: newCreateLocationHdfsResponse smart constructor.

Constructors

CreateLocationHdfsResponse' 

Fields

Instances

Instances details
Generic CreateLocationHdfsResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationHdfs

Associated Types

type Rep CreateLocationHdfsResponse :: Type -> Type #

Read CreateLocationHdfsResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationHdfs

Show CreateLocationHdfsResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationHdfs

NFData CreateLocationHdfsResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationHdfs

Eq CreateLocationHdfsResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationHdfs

type Rep CreateLocationHdfsResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationHdfs

type Rep CreateLocationHdfsResponse = D1 ('MetaData "CreateLocationHdfsResponse" "Amazonka.DataSync.CreateLocationHdfs" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "CreateLocationHdfsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "locationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateLocationHdfsResponse Source #

Create a value of CreateLocationHdfsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateLocationHdfsResponse, createLocationHdfsResponse_locationArn - The ARN of the source HDFS cluster location that's created.

$sel:httpStatus:CreateLocationHdfsResponse', createLocationHdfsResponse_httpStatus - The response's http status code.

Response Lenses

createLocationHdfsResponse_locationArn :: Lens' CreateLocationHdfsResponse (Maybe Text) Source #

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