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

Description

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

Synopsis

Creating a Request

data UpdateLocationHdfs Source #

See: newUpdateLocationHdfs smart constructor.

Constructors

UpdateLocationHdfs' 

Fields

  • agentArns :: Maybe (NonEmpty Text)

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

  • authenticationType :: Maybe HdfsAuthenticationType

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

  • blockSize :: Maybe Natural

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

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

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

  • kerberosPrincipal :: Maybe Text

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

  • kmsKeyProviderUri :: Maybe Text

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

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

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

  • replicationFactor :: Maybe Natural

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

  • simpleUser :: Maybe Text

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

  • subdirectory :: Maybe Text

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

  • locationArn :: Text

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

Instances

Instances details
ToJSON UpdateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.UpdateLocationHdfs

ToHeaders UpdateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.UpdateLocationHdfs

ToPath UpdateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.UpdateLocationHdfs

ToQuery UpdateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.UpdateLocationHdfs

AWSRequest UpdateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.UpdateLocationHdfs

Associated Types

type AWSResponse UpdateLocationHdfs #

Generic UpdateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.UpdateLocationHdfs

Associated Types

type Rep UpdateLocationHdfs :: Type -> Type #

Read UpdateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.UpdateLocationHdfs

Show UpdateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.UpdateLocationHdfs

NFData UpdateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.UpdateLocationHdfs

Methods

rnf :: UpdateLocationHdfs -> () #

Eq UpdateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.UpdateLocationHdfs

Hashable UpdateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.UpdateLocationHdfs

type AWSResponse UpdateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.UpdateLocationHdfs

type Rep UpdateLocationHdfs Source # 
Instance details

Defined in Amazonka.DataSync.UpdateLocationHdfs

type Rep UpdateLocationHdfs = D1 ('MetaData "UpdateLocationHdfs" "Amazonka.DataSync.UpdateLocationHdfs" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "UpdateLocationHdfs'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "agentArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: (S1 ('MetaSel ('Just "authenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HdfsAuthenticationType)) :*: 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 "nameNodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty HdfsNameNode))) :*: 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 "locationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateLocationHdfs Source #

Create a value of UpdateLocationHdfs 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:

UpdateLocationHdfs, updateLocationHdfs_agentArns - The ARNs of the agents that are used to connect to the HDFS cluster.

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

$sel:blockSize:UpdateLocationHdfs', updateLocationHdfs_blockSize - The size of the data blocks to write into the HDFS cluster.

$sel:kerberosKeytab:UpdateLocationHdfs', updateLocationHdfs_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 CLI, it performs base64 encoding for you. Otherwise, provide the base64-encoded text.-- -- 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:UpdateLocationHdfs', updateLocationHdfs_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.-- -- 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:UpdateLocationHdfs', updateLocationHdfs_kerberosPrincipal - The Kerberos principal with access to the files and folders on the HDFS cluster.

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

$sel:nameNodes:UpdateLocationHdfs', updateLocationHdfs_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:qopConfiguration:UpdateLocationHdfs', updateLocationHdfs_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.

$sel:replicationFactor:UpdateLocationHdfs', updateLocationHdfs_replicationFactor - The number of DataNodes to replicate the data to when writing to the HDFS cluster.

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

$sel:subdirectory:UpdateLocationHdfs', updateLocationHdfs_subdirectory - A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster.

UpdateLocationHdfs, updateLocationHdfs_locationArn - The Amazon Resource Name (ARN) of the source HDFS cluster location.

Request Lenses

updateLocationHdfs_agentArns :: Lens' UpdateLocationHdfs (Maybe (NonEmpty Text)) Source #

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

updateLocationHdfs_authenticationType :: Lens' UpdateLocationHdfs (Maybe HdfsAuthenticationType) Source #

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

updateLocationHdfs_blockSize :: Lens' UpdateLocationHdfs (Maybe Natural) Source #

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

updateLocationHdfs_kerberosKeytab :: Lens' UpdateLocationHdfs (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 use the CLI, it performs base64 encoding for you. Otherwise, provide the base64-encoded text.-- -- 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.

updateLocationHdfs_kerberosKrb5Conf :: Lens' UpdateLocationHdfs (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.-- -- 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.

updateLocationHdfs_kerberosPrincipal :: Lens' UpdateLocationHdfs (Maybe Text) Source #

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

updateLocationHdfs_kmsKeyProviderUri :: Lens' UpdateLocationHdfs (Maybe Text) Source #

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

updateLocationHdfs_nameNodes :: Lens' UpdateLocationHdfs (Maybe (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.

updateLocationHdfs_qopConfiguration :: Lens' UpdateLocationHdfs (Maybe QopConfiguration) Source #

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.

updateLocationHdfs_replicationFactor :: Lens' UpdateLocationHdfs (Maybe Natural) Source #

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

updateLocationHdfs_simpleUser :: Lens' UpdateLocationHdfs (Maybe Text) Source #

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

updateLocationHdfs_subdirectory :: Lens' UpdateLocationHdfs (Maybe Text) Source #

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

updateLocationHdfs_locationArn :: Lens' UpdateLocationHdfs Text Source #

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

Destructuring the Response

data UpdateLocationHdfsResponse Source #

See: newUpdateLocationHdfsResponse smart constructor.

Constructors

UpdateLocationHdfsResponse' 

Fields

Instances

Instances details
Generic UpdateLocationHdfsResponse Source # 
Instance details

Defined in Amazonka.DataSync.UpdateLocationHdfs

Associated Types

type Rep UpdateLocationHdfsResponse :: Type -> Type #

Read UpdateLocationHdfsResponse Source # 
Instance details

Defined in Amazonka.DataSync.UpdateLocationHdfs

Show UpdateLocationHdfsResponse Source # 
Instance details

Defined in Amazonka.DataSync.UpdateLocationHdfs

NFData UpdateLocationHdfsResponse Source # 
Instance details

Defined in Amazonka.DataSync.UpdateLocationHdfs

Eq UpdateLocationHdfsResponse Source # 
Instance details

Defined in Amazonka.DataSync.UpdateLocationHdfs

type Rep UpdateLocationHdfsResponse Source # 
Instance details

Defined in Amazonka.DataSync.UpdateLocationHdfs

type Rep UpdateLocationHdfsResponse = D1 ('MetaData "UpdateLocationHdfsResponse" "Amazonka.DataSync.UpdateLocationHdfs" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "UpdateLocationHdfsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateLocationHdfsResponse Source #

Create a value of UpdateLocationHdfsResponse 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:httpStatus:UpdateLocationHdfsResponse', updateLocationHdfsResponse_httpStatus - The response's http status code.

Response Lenses