Amazonka.DataSync.CreateLocationHdfs

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

Creating a Request

data CreateLocationHdfs

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

ToJSON CreateLocationHdfs

Defined in Amazonka.DataSync.CreateLocationHdfs

Methods

toJSON :: CreateLocationHdfs -> Value

toEncoding :: CreateLocationHdfs -> Encoding

toJSONList :: [CreateLocationHdfs] -> Value

toEncodingList :: [CreateLocationHdfs] -> Encoding

ToHeaders CreateLocationHdfs

Defined in Amazonka.DataSync.CreateLocationHdfs

Methods

toHeaders :: CreateLocationHdfs -> [Header]

ToPath CreateLocationHdfs

Defined in Amazonka.DataSync.CreateLocationHdfs

Methods

toPath :: CreateLocationHdfs -> ByteString

ToQuery CreateLocationHdfs

Defined in Amazonka.DataSync.CreateLocationHdfs

Methods

toQuery :: CreateLocationHdfs -> QueryString

AWSRequest CreateLocationHdfs

Defined in Amazonka.DataSync.CreateLocationHdfs

Associated Types

type AWSResponse CreateLocationHdfs

Methods

request :: (Service -> Service) -> CreateLocationHdfs -> Request CreateLocationHdfs

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateLocationHdfs -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateLocationHdfs)))

Generic CreateLocationHdfs

Defined in Amazonka.DataSync.CreateLocationHdfs

Associated Types

type Rep CreateLocationHdfs :: Type -> Type

Methods

from :: CreateLocationHdfs -> Rep CreateLocationHdfs x

to :: Rep CreateLocationHdfs x -> CreateLocationHdfs

Read CreateLocationHdfs

Defined in Amazonka.DataSync.CreateLocationHdfs

Methods

readsPrec :: Int -> ReadS CreateLocationHdfs

readList :: ReadS [CreateLocationHdfs]

readPrec :: ReadPrec CreateLocationHdfs

readListPrec :: ReadPrec [CreateLocationHdfs]

Show CreateLocationHdfs

Defined in Amazonka.DataSync.CreateLocationHdfs

Methods

showsPrec :: Int -> CreateLocationHdfs -> ShowS

show :: CreateLocationHdfs -> String

showList :: [CreateLocationHdfs] -> ShowS

NFData CreateLocationHdfs

Defined in Amazonka.DataSync.CreateLocationHdfs

Methods

rnf :: CreateLocationHdfs -> ()

Eq CreateLocationHdfs

Defined in Amazonka.DataSync.CreateLocationHdfs

Methods

(==) :: CreateLocationHdfs -> CreateLocationHdfs -> Bool

(/=) :: CreateLocationHdfs -> CreateLocationHdfs -> Bool

Hashable CreateLocationHdfs

Defined in Amazonka.DataSync.CreateLocationHdfs

Methods

hashWithSalt :: Int -> CreateLocationHdfs -> Int

hash :: CreateLocationHdfs -> Int

type AWSResponse CreateLocationHdfs

Defined in Amazonka.DataSync.CreateLocationHdfs

type AWSResponse CreateLocationHdfs = CreateLocationHdfsResponse

type Rep CreateLocationHdfs

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

Arguments

:: NonEmpty HdfsNameNode

$sel:nameNodes:CreateLocationHdfs'

-> HdfsAuthenticationType

$sel:authenticationType:CreateLocationHdfs'

-> NonEmpty Text

CreateLocationHdfs

-> CreateLocationHdfs

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)

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)

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)

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)

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)

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

createLocationHdfs_qopConfiguration :: Lens' CreateLocationHdfs (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.

createLocationHdfs_replicationFactor :: Lens' CreateLocationHdfs (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.

createLocationHdfs_simpleUser :: Lens' CreateLocationHdfs (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.

createLocationHdfs_subdirectory :: Lens' CreateLocationHdfs (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 /.

createLocationHdfs_tags :: Lens' CreateLocationHdfs (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.

createLocationHdfs_nameNodes :: Lens' CreateLocationHdfs (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.

createLocationHdfs_authenticationType :: Lens' CreateLocationHdfs HdfsAuthenticationType

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

createLocationHdfs_agentArns :: Lens' CreateLocationHdfs (NonEmpty Text)

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

Destructuring the Response

data CreateLocationHdfsResponse

See: newCreateLocationHdfsResponse smart constructor.

Constructors

CreateLocationHdfsResponse'

Fields

• locationArn :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateLocationHdfsResponse

Defined in Amazonka.DataSync.CreateLocationHdfs

Associated Types

type Rep CreateLocationHdfsResponse :: Type -> Type

Methods

from :: CreateLocationHdfsResponse -> Rep CreateLocationHdfsResponse x

to :: Rep CreateLocationHdfsResponse x -> CreateLocationHdfsResponse

Read CreateLocationHdfsResponse

Defined in Amazonka.DataSync.CreateLocationHdfs

Methods

readsPrec :: Int -> ReadS CreateLocationHdfsResponse

readList :: ReadS [CreateLocationHdfsResponse]

readPrec :: ReadPrec CreateLocationHdfsResponse

readListPrec :: ReadPrec [CreateLocationHdfsResponse]

Show CreateLocationHdfsResponse

Defined in Amazonka.DataSync.CreateLocationHdfs

Methods

showsPrec :: Int -> CreateLocationHdfsResponse -> ShowS

show :: CreateLocationHdfsResponse -> String

showList :: [CreateLocationHdfsResponse] -> ShowS

NFData CreateLocationHdfsResponse

Defined in Amazonka.DataSync.CreateLocationHdfs

Methods

rnf :: CreateLocationHdfsResponse -> ()

Eq CreateLocationHdfsResponse

Defined in Amazonka.DataSync.CreateLocationHdfs

Methods

(==) :: CreateLocationHdfsResponse -> CreateLocationHdfsResponse -> Bool

(/=) :: CreateLocationHdfsResponse -> CreateLocationHdfsResponse -> Bool

type Rep CreateLocationHdfsResponse

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

Arguments

:: Int

$sel:httpStatus:CreateLocationHdfsResponse'

-> CreateLocationHdfsResponse

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)

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

createLocationHdfsResponse_httpStatus :: Lens' CreateLocationHdfsResponse Int

The response's http status code.