Amazonka.DataSync.UpdateLocationObjectStorage

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.

Creating a Request

data UpdateLocationObjectStorage

See: newUpdateLocationObjectStorage smart constructor.

Constructors

UpdateLocationObjectStorage'

Fields

• accessKey :: Maybe Text

  Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

• agentArns :: Maybe (NonEmpty Text)

  Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.

• secretKey :: Maybe (Sensitive Text)

  Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

• serverCertificate :: Maybe Base64

  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.

• serverPort :: Maybe Natural

  Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

• serverProtocol :: Maybe ObjectStorageServerProtocol

  Specifies the protocol that your object storage server uses to communicate.

• subdirectory :: Maybe Text

  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.

• locationArn :: Text

  Specifies the ARN of the object storage system location that you're updating.

Instances

ToJSON UpdateLocationObjectStorage

Defined in Amazonka.DataSync.UpdateLocationObjectStorage

Methods

toJSON :: UpdateLocationObjectStorage -> Value

toEncoding :: UpdateLocationObjectStorage -> Encoding

toJSONList :: [UpdateLocationObjectStorage] -> Value

toEncodingList :: [UpdateLocationObjectStorage] -> Encoding

ToHeaders UpdateLocationObjectStorage

Defined in Amazonka.DataSync.UpdateLocationObjectStorage

Methods

toHeaders :: UpdateLocationObjectStorage -> [Header]

ToPath UpdateLocationObjectStorage

Defined in Amazonka.DataSync.UpdateLocationObjectStorage

Methods

toPath :: UpdateLocationObjectStorage -> ByteString

ToQuery UpdateLocationObjectStorage

Defined in Amazonka.DataSync.UpdateLocationObjectStorage

Methods

toQuery :: UpdateLocationObjectStorage -> QueryString

AWSRequest UpdateLocationObjectStorage

Defined in Amazonka.DataSync.UpdateLocationObjectStorage

Associated Types

type AWSResponse UpdateLocationObjectStorage

Methods

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

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

Generic UpdateLocationObjectStorage

Defined in Amazonka.DataSync.UpdateLocationObjectStorage

Associated Types

type Rep UpdateLocationObjectStorage :: Type -> Type

Methods

from :: UpdateLocationObjectStorage -> Rep UpdateLocationObjectStorage x

to :: Rep UpdateLocationObjectStorage x -> UpdateLocationObjectStorage

Show UpdateLocationObjectStorage

Defined in Amazonka.DataSync.UpdateLocationObjectStorage

Methods

showsPrec :: Int -> UpdateLocationObjectStorage -> ShowS

show :: UpdateLocationObjectStorage -> String

showList :: [UpdateLocationObjectStorage] -> ShowS

NFData UpdateLocationObjectStorage

Defined in Amazonka.DataSync.UpdateLocationObjectStorage

Methods

rnf :: UpdateLocationObjectStorage -> ()

Eq UpdateLocationObjectStorage

Defined in Amazonka.DataSync.UpdateLocationObjectStorage

Methods

(==) :: UpdateLocationObjectStorage -> UpdateLocationObjectStorage -> Bool

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

Hashable UpdateLocationObjectStorage

Defined in Amazonka.DataSync.UpdateLocationObjectStorage

Methods

hashWithSalt :: Int -> UpdateLocationObjectStorage -> Int

hash :: UpdateLocationObjectStorage -> Int

type AWSResponse UpdateLocationObjectStorage

Defined in Amazonka.DataSync.UpdateLocationObjectStorage

type AWSResponse UpdateLocationObjectStorage = UpdateLocationObjectStorageResponse

type Rep UpdateLocationObjectStorage

Defined in Amazonka.DataSync.UpdateLocationObjectStorage

type Rep UpdateLocationObjectStorage = D1 ('MetaData "UpdateLocationObjectStorage" "Amazonka.DataSync.UpdateLocationObjectStorage" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "UpdateLocationObjectStorage'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "accessKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "agentArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))) :*: (S1 ('MetaSel ('Just "secretKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "serverCertificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64)))) :*: ((S1 ('MetaSel ('Just "serverPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "serverProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectStorageServerProtocol))) :*: (S1 ('MetaSel ('Just "subdirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "locationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateLocationObjectStorage

Arguments

:: Text

UpdateLocationObjectStorage

-> UpdateLocationObjectStorage

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)

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

Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.

updateLocationObjectStorage_secretKey :: Lens' UpdateLocationObjectStorage (Maybe Text)

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)

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)

Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

updateLocationObjectStorage_serverProtocol :: Lens' UpdateLocationObjectStorage (Maybe ObjectStorageServerProtocol)

Specifies the protocol that your object storage server uses to communicate.

updateLocationObjectStorage_subdirectory :: Lens' UpdateLocationObjectStorage (Maybe Text)

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

Specifies the ARN of the object storage system location that you're updating.

Destructuring the Response

data UpdateLocationObjectStorageResponse

See: newUpdateLocationObjectStorageResponse smart constructor.

Constructors

UpdateLocationObjectStorageResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic UpdateLocationObjectStorageResponse

Defined in Amazonka.DataSync.UpdateLocationObjectStorage

Associated Types

type Rep UpdateLocationObjectStorageResponse :: Type -> Type

Methods

from :: UpdateLocationObjectStorageResponse -> Rep UpdateLocationObjectStorageResponse x

to :: Rep UpdateLocationObjectStorageResponse x -> UpdateLocationObjectStorageResponse

Read UpdateLocationObjectStorageResponse

Defined in Amazonka.DataSync.UpdateLocationObjectStorage

Methods

readsPrec :: Int -> ReadS UpdateLocationObjectStorageResponse

readList :: ReadS [UpdateLocationObjectStorageResponse]

readPrec :: ReadPrec UpdateLocationObjectStorageResponse

readListPrec :: ReadPrec [UpdateLocationObjectStorageResponse]

Show UpdateLocationObjectStorageResponse

Defined in Amazonka.DataSync.UpdateLocationObjectStorage

Methods

showsPrec :: Int -> UpdateLocationObjectStorageResponse -> ShowS

show :: UpdateLocationObjectStorageResponse -> String

showList :: [UpdateLocationObjectStorageResponse] -> ShowS

NFData UpdateLocationObjectStorageResponse

Defined in Amazonka.DataSync.UpdateLocationObjectStorage

Methods

rnf :: UpdateLocationObjectStorageResponse -> ()

Eq UpdateLocationObjectStorageResponse

Defined in Amazonka.DataSync.UpdateLocationObjectStorage

Methods

(==) :: UpdateLocationObjectStorageResponse -> UpdateLocationObjectStorageResponse -> Bool

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

type Rep UpdateLocationObjectStorageResponse

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

Arguments

:: Int

$sel:httpStatus:UpdateLocationObjectStorageResponse'

-> UpdateLocationObjectStorageResponse

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

The response's http status code.