Amazonka.DataSync.CreateLocationObjectStorage

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.

Creating a Request

data CreateLocationObjectStorage

CreateLocationObjectStorageRequest

See: newCreateLocationObjectStorage smart constructor.

Constructors

CreateLocationObjectStorage'

Fields

• accessKey :: Maybe Text

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

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

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

• tags :: Maybe [TagListEntry]

  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.

• serverHostname :: Text

  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.

• bucketName :: Text

  Specifies the name of the object storage bucket involved in the transfer.

• agentArns :: NonEmpty Text

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

Instances

ToJSON CreateLocationObjectStorage

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

toJSON :: CreateLocationObjectStorage -> Value

toEncoding :: CreateLocationObjectStorage -> Encoding

toJSONList :: [CreateLocationObjectStorage] -> Value

toEncodingList :: [CreateLocationObjectStorage] -> Encoding

ToHeaders CreateLocationObjectStorage

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

toHeaders :: CreateLocationObjectStorage -> [Header]

ToPath CreateLocationObjectStorage

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

toPath :: CreateLocationObjectStorage -> ByteString

ToQuery CreateLocationObjectStorage

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

toQuery :: CreateLocationObjectStorage -> QueryString

AWSRequest CreateLocationObjectStorage

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Associated Types

type AWSResponse CreateLocationObjectStorage

Methods

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

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

Generic CreateLocationObjectStorage

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Associated Types

type Rep CreateLocationObjectStorage :: Type -> Type

Methods

from :: CreateLocationObjectStorage -> Rep CreateLocationObjectStorage x

to :: Rep CreateLocationObjectStorage x -> CreateLocationObjectStorage

Show CreateLocationObjectStorage

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

showsPrec :: Int -> CreateLocationObjectStorage -> ShowS

show :: CreateLocationObjectStorage -> String

showList :: [CreateLocationObjectStorage] -> ShowS

NFData CreateLocationObjectStorage

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

rnf :: CreateLocationObjectStorage -> ()

Eq CreateLocationObjectStorage

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

(==) :: CreateLocationObjectStorage -> CreateLocationObjectStorage -> Bool

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

Hashable CreateLocationObjectStorage

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

hashWithSalt :: Int -> CreateLocationObjectStorage -> Int

hash :: CreateLocationObjectStorage -> Int

type AWSResponse CreateLocationObjectStorage

Defined in Amazonka.DataSync.CreateLocationObjectStorage

type AWSResponse CreateLocationObjectStorage = CreateLocationObjectStorageResponse

type Rep CreateLocationObjectStorage

Defined in Amazonka.DataSync.CreateLocationObjectStorage

type Rep CreateLocationObjectStorage = D1 ('MetaData "CreateLocationObjectStorage" "Amazonka.DataSync.CreateLocationObjectStorage" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "CreateLocationObjectStorage'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "accessKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe 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 "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagListEntry]))) :*: (S1 ('MetaSel ('Just "serverHostname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "bucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "agentArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)))))))

newCreateLocationObjectStorage

Arguments

:: Text

$sel:serverHostname:CreateLocationObjectStorage'

-> Text

$sel:bucketName:CreateLocationObjectStorage'

-> NonEmpty Text

CreateLocationObjectStorage

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

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)

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)

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)

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

createLocationObjectStorage_serverProtocol :: Lens' CreateLocationObjectStorage (Maybe ObjectStorageServerProtocol)

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

createLocationObjectStorage_subdirectory :: Lens' CreateLocationObjectStorage (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.

createLocationObjectStorage_tags :: Lens' CreateLocationObjectStorage (Maybe [TagListEntry])

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

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

Specifies the name of the object storage bucket involved in the transfer.

createLocationObjectStorage_agentArns :: Lens' CreateLocationObjectStorage (NonEmpty Text)

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

Destructuring the Response

data CreateLocationObjectStorageResponse

CreateLocationObjectStorageResponse

See: newCreateLocationObjectStorageResponse smart constructor.

Constructors

CreateLocationObjectStorageResponse'

Fields

• locationArn :: Maybe Text

  Specifies the ARN of the object storage system location that you create.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateLocationObjectStorageResponse

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Associated Types

type Rep CreateLocationObjectStorageResponse :: Type -> Type

Methods

from :: CreateLocationObjectStorageResponse -> Rep CreateLocationObjectStorageResponse x

to :: Rep CreateLocationObjectStorageResponse x -> CreateLocationObjectStorageResponse

Read CreateLocationObjectStorageResponse

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

readsPrec :: Int -> ReadS CreateLocationObjectStorageResponse

readList :: ReadS [CreateLocationObjectStorageResponse]

readPrec :: ReadPrec CreateLocationObjectStorageResponse

readListPrec :: ReadPrec [CreateLocationObjectStorageResponse]

Show CreateLocationObjectStorageResponse

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

showsPrec :: Int -> CreateLocationObjectStorageResponse -> ShowS

show :: CreateLocationObjectStorageResponse -> String

showList :: [CreateLocationObjectStorageResponse] -> ShowS

NFData CreateLocationObjectStorageResponse

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

rnf :: CreateLocationObjectStorageResponse -> ()

Eq CreateLocationObjectStorageResponse

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

(==) :: CreateLocationObjectStorageResponse -> CreateLocationObjectStorageResponse -> Bool

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

type Rep CreateLocationObjectStorageResponse

Defined in Amazonka.DataSync.CreateLocationObjectStorage

type Rep CreateLocationObjectStorageResponse = D1 ('MetaData "CreateLocationObjectStorageResponse" "Amazonka.DataSync.CreateLocationObjectStorage" "amazonka-datasync-2.0-LCcm4ddRe2z4CES4wun76Z" 'False) (C1 ('MetaCons "CreateLocationObjectStorageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "locationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateLocationObjectStorageResponse

Arguments

:: Int

$sel:httpStatus:CreateLocationObjectStorageResponse'

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

Specifies the ARN of the object storage system location that you create.

createLocationObjectStorageResponse_httpStatus :: Lens' CreateLocationObjectStorageResponse Int

The response's http status code.