Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Updates some parameters of an existing object storage location that DataSync accesses for a transfer. For information about creating a self-managed object storage location, see Creating a location for object storage.
Synopsis
- data UpdateLocationObjectStorage = UpdateLocationObjectStorage' {}
- newUpdateLocationObjectStorage :: Text -> UpdateLocationObjectStorage
- updateLocationObjectStorage_accessKey :: Lens' UpdateLocationObjectStorage (Maybe Text)
- updateLocationObjectStorage_agentArns :: Lens' UpdateLocationObjectStorage (Maybe (NonEmpty Text))
- updateLocationObjectStorage_secretKey :: Lens' UpdateLocationObjectStorage (Maybe Text)
- updateLocationObjectStorage_serverCertificate :: Lens' UpdateLocationObjectStorage (Maybe ByteString)
- updateLocationObjectStorage_serverPort :: Lens' UpdateLocationObjectStorage (Maybe Natural)
- updateLocationObjectStorage_serverProtocol :: Lens' UpdateLocationObjectStorage (Maybe ObjectStorageServerProtocol)
- updateLocationObjectStorage_subdirectory :: Lens' UpdateLocationObjectStorage (Maybe Text)
- updateLocationObjectStorage_locationArn :: Lens' UpdateLocationObjectStorage Text
- data UpdateLocationObjectStorageResponse = UpdateLocationObjectStorageResponse' {
- httpStatus :: Int
- newUpdateLocationObjectStorageResponse :: Int -> UpdateLocationObjectStorageResponse
- updateLocationObjectStorageResponse_httpStatus :: Lens' UpdateLocationObjectStorageResponse Int
Creating a Request
data UpdateLocationObjectStorage Source #
See: newUpdateLocationObjectStorage
smart constructor.
UpdateLocationObjectStorage' | |
|
Instances
newUpdateLocationObjectStorage Source #
Create a value of UpdateLocationObjectStorage
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:accessKey:UpdateLocationObjectStorage'
, updateLocationObjectStorage_accessKey
- Specifies the access key (for example, a user name) if credentials are
required to authenticate with the object storage server.
UpdateLocationObjectStorage
, updateLocationObjectStorage_agentArns
- Specifies the Amazon Resource Names (ARNs) of the DataSync agents that
can securely connect with your location.
$sel:secretKey:UpdateLocationObjectStorage'
, updateLocationObjectStorage_secretKey
- Specifies the secret key (for example, a password) if credentials are
required to authenticate with the object storage server.
$sel:serverCertificate:UpdateLocationObjectStorage'
, updateLocationObjectStorage_serverCertificate
- Specifies a certificate to authenticate with an object storage system
that uses a private or self-signed certificate authority (CA). You must
specify a Base64-encoded .pem
file (for example,
file:///home/user/.ssh/storage_sys_certificate.pem
). The
certificate can be up to 32768 bytes (before Base64 encoding).
To use this parameter, configure ServerProtocol
to HTTPS
.
Updating the certificate doesn't interfere with tasks that you have in
progress.--
-- 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:serverPort:UpdateLocationObjectStorage'
, updateLocationObjectStorage_serverPort
- Specifies the port that your object storage server accepts inbound
network traffic on (for example, port 443).
$sel:serverProtocol:UpdateLocationObjectStorage'
, updateLocationObjectStorage_serverProtocol
- Specifies the protocol that your object storage server uses to
communicate.
$sel:subdirectory:UpdateLocationObjectStorage'
, updateLocationObjectStorage_subdirectory
- Specifies the object prefix for your object storage server. If this is a
source location, DataSync only copies objects with this prefix. If this
is a destination location, DataSync writes all objects with this prefix.
UpdateLocationObjectStorage
, updateLocationObjectStorage_locationArn
- Specifies the ARN of the object storage system location that you're
updating.
Request Lenses
updateLocationObjectStorage_accessKey :: Lens' UpdateLocationObjectStorage (Maybe Text) Source #
Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
updateLocationObjectStorage_agentArns :: Lens' UpdateLocationObjectStorage (Maybe (NonEmpty Text)) Source #
Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.
updateLocationObjectStorage_secretKey :: Lens' UpdateLocationObjectStorage (Maybe Text) Source #
Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
updateLocationObjectStorage_serverCertificate :: Lens' UpdateLocationObjectStorage (Maybe ByteString) Source #
Specifies a certificate to authenticate with an object storage system
that uses a private or self-signed certificate authority (CA). You must
specify a Base64-encoded .pem
file (for example,
file:///home/user/.ssh/storage_sys_certificate.pem
). The
certificate can be up to 32768 bytes (before Base64 encoding).
To use this parameter, configure ServerProtocol
to HTTPS
.
Updating the certificate doesn't interfere with tasks that you have in
progress.--
-- 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.
updateLocationObjectStorage_serverPort :: Lens' UpdateLocationObjectStorage (Maybe Natural) Source #
Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
updateLocationObjectStorage_serverProtocol :: Lens' UpdateLocationObjectStorage (Maybe ObjectStorageServerProtocol) Source #
Specifies the protocol that your object storage server uses to communicate.
updateLocationObjectStorage_subdirectory :: Lens' UpdateLocationObjectStorage (Maybe Text) Source #
Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.
updateLocationObjectStorage_locationArn :: Lens' UpdateLocationObjectStorage Text Source #
Specifies the ARN of the object storage system location that you're updating.
Destructuring the Response
data UpdateLocationObjectStorageResponse Source #
See: newUpdateLocationObjectStorageResponse
smart constructor.
UpdateLocationObjectStorageResponse' | |
|
Instances
Generic UpdateLocationObjectStorageResponse Source # | |
Read UpdateLocationObjectStorageResponse Source # | |
Show UpdateLocationObjectStorageResponse Source # | |
NFData UpdateLocationObjectStorageResponse Source # | |
Defined in Amazonka.DataSync.UpdateLocationObjectStorage rnf :: UpdateLocationObjectStorageResponse -> () # | |
Eq UpdateLocationObjectStorageResponse Source # | |
type Rep UpdateLocationObjectStorageResponse Source # | |
Defined in Amazonka.DataSync.UpdateLocationObjectStorage type Rep UpdateLocationObjectStorageResponse = D1 ('MetaData "UpdateLocationObjectStorageResponse" "Amazonka.DataSync.UpdateLocationObjectStorage" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "UpdateLocationObjectStorageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))) |
newUpdateLocationObjectStorageResponse Source #
Create a value of UpdateLocationObjectStorageResponse
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:UpdateLocationObjectStorageResponse'
, updateLocationObjectStorageResponse_httpStatus
- The response's http status code.
Response Lenses
updateLocationObjectStorageResponse_httpStatus :: Lens' UpdateLocationObjectStorageResponse Int Source #
The response's http status code.