| 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 |
Amazonka.DataSync.CreateLocationObjectStorage
Description
Creates an endpoint for an object storage system that DataSync can access for a transfer. For more information, see Creating a location for object storage.
Synopsis
- data CreateLocationObjectStorage = CreateLocationObjectStorage' {}
- newCreateLocationObjectStorage :: Text -> Text -> NonEmpty Text -> CreateLocationObjectStorage
- createLocationObjectStorage_accessKey :: Lens' CreateLocationObjectStorage (Maybe Text)
- createLocationObjectStorage_secretKey :: Lens' CreateLocationObjectStorage (Maybe Text)
- createLocationObjectStorage_serverCertificate :: Lens' CreateLocationObjectStorage (Maybe ByteString)
- createLocationObjectStorage_serverPort :: Lens' CreateLocationObjectStorage (Maybe Natural)
- createLocationObjectStorage_serverProtocol :: Lens' CreateLocationObjectStorage (Maybe ObjectStorageServerProtocol)
- createLocationObjectStorage_subdirectory :: Lens' CreateLocationObjectStorage (Maybe Text)
- createLocationObjectStorage_tags :: Lens' CreateLocationObjectStorage (Maybe [TagListEntry])
- createLocationObjectStorage_serverHostname :: Lens' CreateLocationObjectStorage Text
- createLocationObjectStorage_bucketName :: Lens' CreateLocationObjectStorage Text
- createLocationObjectStorage_agentArns :: Lens' CreateLocationObjectStorage (NonEmpty Text)
- data CreateLocationObjectStorageResponse = CreateLocationObjectStorageResponse' {
- locationArn :: Maybe Text
- httpStatus :: Int
- newCreateLocationObjectStorageResponse :: Int -> CreateLocationObjectStorageResponse
- createLocationObjectStorageResponse_locationArn :: Lens' CreateLocationObjectStorageResponse (Maybe Text)
- createLocationObjectStorageResponse_httpStatus :: Lens' CreateLocationObjectStorageResponse Int
Creating a Request
data CreateLocationObjectStorage Source #
CreateLocationObjectStorageRequest
See: newCreateLocationObjectStorage smart constructor.
Constructors
| CreateLocationObjectStorage' | |
Fields
| |
Instances
newCreateLocationObjectStorage Source #
Arguments
| :: Text | |
| -> Text | |
| -> NonEmpty Text | |
| -> CreateLocationObjectStorage |
Create a value of CreateLocationObjectStorage 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:CreateLocationObjectStorage', createLocationObjectStorage_accessKey - Specifies the access key (for example, a user name) if credentials are
required to authenticate with the object storage server.
$sel:secretKey:CreateLocationObjectStorage', createLocationObjectStorage_secretKey - Specifies the secret key (for example, a password) if credentials are
required to authenticate with the object storage server.
$sel:serverCertificate:CreateLocationObjectStorage', createLocationObjectStorage_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.--
-- 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:CreateLocationObjectStorage', createLocationObjectStorage_serverPort - Specifies the port that your object storage server accepts inbound
network traffic on (for example, port 443).
$sel:serverProtocol:CreateLocationObjectStorage', createLocationObjectStorage_serverProtocol - Specifies the protocol that your object storage server uses to
communicate.
$sel:subdirectory:CreateLocationObjectStorage', createLocationObjectStorage_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.
$sel:tags:CreateLocationObjectStorage', createLocationObjectStorage_tags - Specifies the key-value pair that represents a tag that you want to add
to the resource. Tags can help you manage, filter, and search for your
resources. We recommend creating a name tag for your location.
$sel:serverHostname:CreateLocationObjectStorage', createLocationObjectStorage_serverHostname - Specifies the domain name or IP address of the object storage server. A
DataSync agent uses this hostname to mount the object storage server in
a network.
$sel:bucketName:CreateLocationObjectStorage', createLocationObjectStorage_bucketName - Specifies the name of the object storage bucket involved in the
transfer.
CreateLocationObjectStorage, createLocationObjectStorage_agentArns - Specifies the Amazon Resource Names (ARNs) of the DataSync agents that
can securely connect with your location.
Request Lenses
createLocationObjectStorage_accessKey :: Lens' CreateLocationObjectStorage (Maybe Text) Source #
Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
createLocationObjectStorage_secretKey :: Lens' CreateLocationObjectStorage (Maybe Text) Source #
Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
createLocationObjectStorage_serverCertificate :: Lens' CreateLocationObjectStorage (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.--
-- 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.
createLocationObjectStorage_serverPort :: Lens' CreateLocationObjectStorage (Maybe Natural) Source #
Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
createLocationObjectStorage_serverProtocol :: Lens' CreateLocationObjectStorage (Maybe ObjectStorageServerProtocol) Source #
Specifies the protocol that your object storage server uses to communicate.
createLocationObjectStorage_subdirectory :: Lens' CreateLocationObjectStorage (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.
createLocationObjectStorage_tags :: Lens' CreateLocationObjectStorage (Maybe [TagListEntry]) Source #
Specifies the key-value pair that represents a tag that you want to add to the resource. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.
createLocationObjectStorage_serverHostname :: Lens' CreateLocationObjectStorage Text Source #
Specifies the domain name or IP address of the object storage server. A DataSync agent uses this hostname to mount the object storage server in a network.
createLocationObjectStorage_bucketName :: Lens' CreateLocationObjectStorage Text Source #
Specifies the name of the object storage bucket involved in the transfer.
createLocationObjectStorage_agentArns :: Lens' CreateLocationObjectStorage (NonEmpty Text) Source #
Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.
Destructuring the Response
data CreateLocationObjectStorageResponse Source #
CreateLocationObjectStorageResponse
See: newCreateLocationObjectStorageResponse smart constructor.
Constructors
| CreateLocationObjectStorageResponse' | |
Fields
| |
Instances
newCreateLocationObjectStorageResponse Source #
Arguments
| :: Int | |
| -> CreateLocationObjectStorageResponse |
Create a value of CreateLocationObjectStorageResponse 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:
CreateLocationObjectStorageResponse, createLocationObjectStorageResponse_locationArn - Specifies the ARN of the object storage system location that you create.
$sel:httpStatus:CreateLocationObjectStorageResponse', createLocationObjectStorageResponse_httpStatus - The response's http status code.
Response Lenses
createLocationObjectStorageResponse_locationArn :: Lens' CreateLocationObjectStorageResponse (Maybe Text) Source #
Specifies the ARN of the object storage system location that you create.
createLocationObjectStorageResponse_httpStatus :: Lens' CreateLocationObjectStorageResponse Int Source #
The response's http status code.