Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DataSync.CreateLocationS3

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an endpoint for an Amazon S3 bucket.

For more information, see Create an Amazon S3 location in the DataSync User Guide.

Synopsis

data CreateLocationS3 = CreateLocationS3' {
- agentArns :: Maybe (NonEmpty Text)
- s3StorageClass :: Maybe S3StorageClass
- subdirectory :: Maybe Text
- tags :: Maybe [TagListEntry]
- s3BucketArn :: Text
- s3Config :: S3Config
}
newCreateLocationS3 :: Text -> S3Config -> CreateLocationS3
createLocationS3_agentArns :: Lens' CreateLocationS3 (Maybe (NonEmpty Text))
createLocationS3_s3StorageClass :: Lens' CreateLocationS3 (Maybe S3StorageClass)
createLocationS3_subdirectory :: Lens' CreateLocationS3 (Maybe Text)
createLocationS3_tags :: Lens' CreateLocationS3 (Maybe [TagListEntry])
createLocationS3_s3BucketArn :: Lens' CreateLocationS3 Text
createLocationS3_s3Config :: Lens' CreateLocationS3 S3Config
data CreateLocationS3Response = CreateLocationS3Response' {
- locationArn :: Maybe Text
- httpStatus :: Int
}
newCreateLocationS3Response :: Int -> CreateLocationS3Response
createLocationS3Response_locationArn :: Lens' CreateLocationS3Response (Maybe Text)
createLocationS3Response_httpStatus :: Lens' CreateLocationS3Response Int

Creating a Request

data CreateLocationS3 Source #

CreateLocationS3Request

See: newCreateLocationS3 smart constructor.

Constructors

CreateLocationS3'

Fields

agentArns :: Maybe (NonEmpty Text)
If you are using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.
s3StorageClass :: Maybe S3StorageClass
The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For buckets in Amazon Web Services Regions, the storage class defaults to Standard. For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.
For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.
subdirectory :: Maybe Text
A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.
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.
s3BucketArn :: Text
The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost, this must be an access point ARN.
s3Config :: S3Config

Instances

Instances details

Eq CreateLocationS3 Source #
Instance details Defined in Amazonka.DataSync.CreateLocationS3 Methods (==) :: CreateLocationS3 -> CreateLocationS3 -> Bool # (/=) :: CreateLocationS3 -> CreateLocationS3 -> Bool #
Read CreateLocationS3 Source #
Instance details Defined in Amazonka.DataSync.CreateLocationS3 Methods readsPrec :: Int -> ReadS CreateLocationS3 # readList :: ReadS [CreateLocationS3] # readPrec :: ReadPrec CreateLocationS3 # readListPrec :: ReadPrec [CreateLocationS3] #
Show CreateLocationS3 Source #
Instance details Defined in Amazonka.DataSync.CreateLocationS3 Methods showsPrec :: Int -> CreateLocationS3 -> ShowS # show :: CreateLocationS3 -> String # showList :: [CreateLocationS3] -> ShowS #
Generic CreateLocationS3 Source #
Instance details Defined in Amazonka.DataSync.CreateLocationS3 Associated Types type Rep CreateLocationS3 :: Type -> Type # Methods from :: CreateLocationS3 -> Rep CreateLocationS3 x # to :: Rep CreateLocationS3 x -> CreateLocationS3 #
NFData CreateLocationS3 Source #
Instance details Defined in Amazonka.DataSync.CreateLocationS3 Methods rnf :: CreateLocationS3 -> () #
Hashable CreateLocationS3 Source #
Instance details Defined in Amazonka.DataSync.CreateLocationS3 Methods hashWithSalt :: Int -> CreateLocationS3 -> Int # hash :: CreateLocationS3 -> Int #
ToJSON CreateLocationS3 Source #
Instance details Defined in Amazonka.DataSync.CreateLocationS3 Methods toJSON :: CreateLocationS3 -> Value # toEncoding :: CreateLocationS3 -> Encoding # toJSONList :: [CreateLocationS3] -> Value # toEncodingList :: [CreateLocationS3] -> Encoding #
AWSRequest CreateLocationS3 Source #
Instance details Defined in Amazonka.DataSync.CreateLocationS3 Associated Types type AWSResponse CreateLocationS3 # Methods request :: CreateLocationS3 -> Request CreateLocationS3 # response :: MonadResource m => Logger -> Service -> Proxy CreateLocationS3 -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateLocationS3))) #
ToHeaders CreateLocationS3 Source #
Instance details Defined in Amazonka.DataSync.CreateLocationS3 Methods toHeaders :: CreateLocationS3 -> [Header] #
ToPath CreateLocationS3 Source #
Instance details Defined in Amazonka.DataSync.CreateLocationS3 Methods toPath :: CreateLocationS3 -> ByteString #
ToQuery CreateLocationS3 Source #
Instance details Defined in Amazonka.DataSync.CreateLocationS3 Methods toQuery :: CreateLocationS3 -> QueryString #
type Rep CreateLocationS3 Source #
Instance details Defined in Amazonka.DataSync.CreateLocationS3 type Rep CreateLocationS3 = D1 ('MetaData "CreateLocationS3" "Amazonka.DataSync.CreateLocationS3" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" 'False) (C1 ('MetaCons "CreateLocationS3'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "agentArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: (S1 ('MetaSel ('Just "s3StorageClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3StorageClass)) :: S1 ('MetaSel ('Just "subdirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagListEntry])) :: (S1 ('MetaSel ('Just "s3BucketArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "s3Config") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3Config)))))
type AWSResponse CreateLocationS3 Source #
Instance details Defined in Amazonka.DataSync.CreateLocationS3 type AWSResponse CreateLocationS3 = CreateLocationS3Response

newCreateLocationS3 Source #

Arguments

:: Text	`$sel:s3BucketArn:CreateLocationS3'`
-> S3Config	`$sel:s3Config:CreateLocationS3'`
-> CreateLocationS3

Create a value of CreateLocationS3 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:agentArns:CreateLocationS3', createLocationS3_agentArns - If you are using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

$sel:s3StorageClass:CreateLocationS3', createLocationS3_s3StorageClass - The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For buckets in Amazon Web Services Regions, the storage class defaults to Standard. For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.

For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

$sel:subdirectory:CreateLocationS3', createLocationS3_subdirectory - A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.

$sel:tags:CreateLocationS3', createLocationS3_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:s3BucketArn:CreateLocationS3', createLocationS3_s3BucketArn - The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost, this must be an access point ARN.

$sel:s3Config:CreateLocationS3', createLocationS3_s3Config - Undocumented member.

Request Lenses

createLocationS3_agentArns :: Lens' CreateLocationS3 (Maybe (NonEmpty Text)) Source #

If you are using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

createLocationS3_s3StorageClass :: Lens' CreateLocationS3 (Maybe S3StorageClass) Source #

The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For buckets in Amazon Web Services Regions, the storage class defaults to Standard. For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.

For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

createLocationS3_subdirectory :: Lens' CreateLocationS3 (Maybe Text) Source #

A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.

createLocationS3_tags :: Lens' CreateLocationS3 (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.

createLocationS3_s3BucketArn :: Lens' CreateLocationS3 Text Source #

The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost, this must be an access point ARN.

createLocationS3_s3Config :: Lens' CreateLocationS3 S3Config Source #

Undocumented member.

Destructuring the Response

data CreateLocationS3Response Source #

CreateLocationS3Response

See: newCreateLocationS3Response smart constructor.

Constructors

CreateLocationS3Response'
Fields locationArn :: Maybe Text The Amazon Resource Name (ARN) of the source Amazon S3 bucket location that is created. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateLocationS3Response Source #
Instance details Defined in Amazonka.DataSync.CreateLocationS3 Methods (==) :: CreateLocationS3Response -> CreateLocationS3Response -> Bool # (/=) :: CreateLocationS3Response -> CreateLocationS3Response -> Bool #
Read CreateLocationS3Response Source #
Instance details Defined in Amazonka.DataSync.CreateLocationS3 Methods readsPrec :: Int -> ReadS CreateLocationS3Response # readList :: ReadS [CreateLocationS3Response] # readPrec :: ReadPrec CreateLocationS3Response # readListPrec :: ReadPrec [CreateLocationS3Response] #
Show CreateLocationS3Response Source #
Instance details Defined in Amazonka.DataSync.CreateLocationS3 Methods showsPrec :: Int -> CreateLocationS3Response -> ShowS # show :: CreateLocationS3Response -> String # showList :: [CreateLocationS3Response] -> ShowS #
Generic CreateLocationS3Response Source #
Instance details Defined in Amazonka.DataSync.CreateLocationS3 Associated Types type Rep CreateLocationS3Response :: Type -> Type # Methods from :: CreateLocationS3Response -> Rep CreateLocationS3Response x # to :: Rep CreateLocationS3Response x -> CreateLocationS3Response #
NFData CreateLocationS3Response Source #
Instance details Defined in Amazonka.DataSync.CreateLocationS3 Methods rnf :: CreateLocationS3Response -> () #
type Rep CreateLocationS3Response Source #
Instance details Defined in Amazonka.DataSync.CreateLocationS3 type Rep CreateLocationS3Response = D1 ('MetaData "CreateLocationS3Response" "Amazonka.DataSync.CreateLocationS3" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" 'False) (C1 ('MetaCons "CreateLocationS3Response'" 'PrefixI 'True) (S1 ('MetaSel ('Just "locationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateLocationS3Response Source #

Arguments

:: Int	`$sel:httpStatus:CreateLocationS3Response'`
-> CreateLocationS3Response

Create a value of CreateLocationS3Response 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:CreateLocationS3Response', createLocationS3Response_locationArn - The Amazon Resource Name (ARN) of the source Amazon S3 bucket location that is created.

$sel:httpStatus:CreateLocationS3Response', createLocationS3Response_httpStatus - The response's http status code.

Response Lenses

createLocationS3Response_locationArn :: Lens' CreateLocationS3Response (Maybe Text) Source #

The Amazon Resource Name (ARN) of the source Amazon S3 bucket location that is created.

createLocationS3Response_httpStatus :: Lens' CreateLocationS3Response Int Source #

The response's http status code.