libZSservicesZSamazonka-datasyncZSamazonka-datasync
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DataSync.CreateLocationObjectStorage

Description

Creates an endpoint for a self-managed object storage bucket. For more information about self-managed object storage locations, see Creating a location for object storage.

Synopsis

Creating a Request

data CreateLocationObjectStorage Source #

CreateLocationObjectStorageRequest

See: newCreateLocationObjectStorage smart constructor.

Constructors

CreateLocationObjectStorage' 

Fields

  • serverPort :: Maybe Natural

    The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.

  • serverProtocol :: Maybe ObjectStorageServerProtocol

    The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.

  • secretKey :: Maybe (Sensitive Text)

    Optional. The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

  • subdirectory :: Maybe Text

    The subdirectory in the self-managed object storage server that is used to read data from.

  • accessKey :: Maybe Text

    Optional. The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

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

  • serverHostname :: Text

    The name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server. An agent uses this host name to mount the object storage server in a network.

  • bucketName :: Text

    The bucket on the self-managed object storage server that is used to read data from.

  • agentArns :: NonEmpty Text

    The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

Instances

Instances details
Eq CreateLocationObjectStorage Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

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

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

Show CreateLocationObjectStorage Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

showsPrec :: Int -> CreateLocationObjectStorage -> ShowS #

show :: CreateLocationObjectStorage -> String #

showList :: [CreateLocationObjectStorage] -> ShowS #

Generic CreateLocationObjectStorage Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Associated Types

type Rep CreateLocationObjectStorage :: Type -> Type #

Methods

from :: CreateLocationObjectStorage -> Rep CreateLocationObjectStorage x #

to :: Rep CreateLocationObjectStorage x -> CreateLocationObjectStorage #

NFData CreateLocationObjectStorage Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

rnf :: CreateLocationObjectStorage -> () #

Hashable CreateLocationObjectStorage Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

hashWithSalt :: Int -> CreateLocationObjectStorage -> Int #

hash :: CreateLocationObjectStorage -> Int #

ToJSON CreateLocationObjectStorage Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

toJSON :: CreateLocationObjectStorage -> Value #

toEncoding :: CreateLocationObjectStorage -> Encoding #

toJSONList :: [CreateLocationObjectStorage] -> Value #

toEncodingList :: [CreateLocationObjectStorage] -> Encoding #

AWSRequest CreateLocationObjectStorage Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Associated Types

type AWSResponse CreateLocationObjectStorage #

Methods

request :: CreateLocationObjectStorage -> Request CreateLocationObjectStorage #

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

ToHeaders CreateLocationObjectStorage Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

toHeaders :: CreateLocationObjectStorage -> [Header] #

ToPath CreateLocationObjectStorage Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

toPath :: CreateLocationObjectStorage -> ByteString #

ToQuery CreateLocationObjectStorage Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

toQuery :: CreateLocationObjectStorage -> QueryString #

type Rep CreateLocationObjectStorage Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationObjectStorage

type Rep CreateLocationObjectStorage = D1 ('MetaData "CreateLocationObjectStorage" "Amazonka.DataSync.CreateLocationObjectStorage" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" 'False) (C1 ('MetaCons "CreateLocationObjectStorage'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "serverPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "serverProtocol") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectStorageServerProtocol))) :*: (S1 ('MetaSel ('Just "secretKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "subdirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "accessKey") '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)))))))
type AWSResponse CreateLocationObjectStorage Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationObjectStorage

type AWSResponse CreateLocationObjectStorage = CreateLocationObjectStorageResponse

newCreateLocationObjectStorage Source #

Arguments

:: Text

$sel:serverHostname:CreateLocationObjectStorage'

-> Text

$sel:bucketName:CreateLocationObjectStorage'

-> NonEmpty Text

$sel:agentArns: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:serverPort:CreateLocationObjectStorage', createLocationObjectStorage_serverPort - The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.

$sel:serverProtocol:CreateLocationObjectStorage', createLocationObjectStorage_serverProtocol - The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.

$sel:secretKey:CreateLocationObjectStorage', createLocationObjectStorage_secretKey - Optional. The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

$sel:subdirectory:CreateLocationObjectStorage', createLocationObjectStorage_subdirectory - The subdirectory in the self-managed object storage server that is used to read data from.

$sel:accessKey:CreateLocationObjectStorage', createLocationObjectStorage_accessKey - Optional. The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

$sel:tags:CreateLocationObjectStorage', createLocationObjectStorage_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:serverHostname:CreateLocationObjectStorage', createLocationObjectStorage_serverHostname - The name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server. An agent uses this host name to mount the object storage server in a network.

$sel:bucketName:CreateLocationObjectStorage', createLocationObjectStorage_bucketName - The bucket on the self-managed object storage server that is used to read data from.

$sel:agentArns:CreateLocationObjectStorage', createLocationObjectStorage_agentArns - The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

Request Lenses

createLocationObjectStorage_serverPort :: Lens' CreateLocationObjectStorage (Maybe Natural) Source #

The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.

createLocationObjectStorage_serverProtocol :: Lens' CreateLocationObjectStorage (Maybe ObjectStorageServerProtocol) Source #

The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.

createLocationObjectStorage_secretKey :: Lens' CreateLocationObjectStorage (Maybe Text) Source #

Optional. The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

createLocationObjectStorage_subdirectory :: Lens' CreateLocationObjectStorage (Maybe Text) Source #

The subdirectory in the self-managed object storage server that is used to read data from.

createLocationObjectStorage_accessKey :: Lens' CreateLocationObjectStorage (Maybe Text) Source #

Optional. The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

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

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.

createLocationObjectStorage_serverHostname :: Lens' CreateLocationObjectStorage Text Source #

The name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server. An agent uses this host name to mount the object storage server in a network.

createLocationObjectStorage_bucketName :: Lens' CreateLocationObjectStorage Text Source #

The bucket on the self-managed object storage server that is used to read data from.

createLocationObjectStorage_agentArns :: Lens' CreateLocationObjectStorage (NonEmpty Text) Source #

The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

Destructuring the Response

data CreateLocationObjectStorageResponse Source #

CreateLocationObjectStorageResponse

See: newCreateLocationObjectStorageResponse smart constructor.

Constructors

CreateLocationObjectStorageResponse' 

Fields

  • locationArn :: Maybe Text

    The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq CreateLocationObjectStorageResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

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

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

Read CreateLocationObjectStorageResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

readsPrec :: Int -> ReadS CreateLocationObjectStorageResponse #

readList :: ReadS [CreateLocationObjectStorageResponse] #

readPrec :: ReadPrec CreateLocationObjectStorageResponse #

readListPrec :: ReadPrec [CreateLocationObjectStorageResponse] #

Show CreateLocationObjectStorageResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

showsPrec :: Int -> CreateLocationObjectStorageResponse -> ShowS #

show :: CreateLocationObjectStorageResponse -> String #

showList :: [CreateLocationObjectStorageResponse] -> ShowS #

Generic CreateLocationObjectStorageResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Associated Types

type Rep CreateLocationObjectStorageResponse :: Type -> Type #

Methods

from :: CreateLocationObjectStorageResponse -> Rep CreateLocationObjectStorageResponse x #

to :: Rep CreateLocationObjectStorageResponse x -> CreateLocationObjectStorageResponse #

NFData CreateLocationObjectStorageResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationObjectStorage

Methods

rnf :: CreateLocationObjectStorageResponse -> () #

type Rep CreateLocationObjectStorageResponse Source # 
Instance details

Defined in Amazonka.DataSync.CreateLocationObjectStorage

type Rep CreateLocationObjectStorageResponse = D1 ('MetaData "CreateLocationObjectStorageResponse" "Amazonka.DataSync.CreateLocationObjectStorage" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" '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 Source #

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:

$sel:locationArn:CreateLocationObjectStorageResponse', createLocationObjectStorageResponse_locationArn - The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

$sel:httpStatus:CreateLocationObjectStorageResponse', createLocationObjectStorageResponse_httpStatus - The response's http status code.

Response Lenses

createLocationObjectStorageResponse_locationArn :: Lens' CreateLocationObjectStorageResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

createLocationObjectStorageResponse_httpStatus :: Lens' CreateLocationObjectStorageResponse Int Source #

The response's http status code.