amazonka-lightsail-2.0: Amazon Lightsail SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Lightsail.UpdateBucket

Description

Updates an existing Amazon Lightsail bucket.

Use this action to update the configuration of an existing bucket, such as versioning, public accessibility, and the Amazon Web Services accounts that can access the bucket.

Synopsis

Creating a Request

data UpdateBucket Source #

See: newUpdateBucket smart constructor.

Constructors

UpdateBucket' 

Fields

  • accessLogConfig :: Maybe BucketAccessLogConfig

    An object that describes the access log configuration for the bucket.

  • accessRules :: Maybe AccessRules

    An object that sets the public accessibility of objects in the specified bucket.

  • readonlyAccessAccounts :: Maybe [Text]

    An array of strings to specify the Amazon Web Services account IDs that can access the bucket.

    You can give a maximum of 10 Amazon Web Services accounts access to a bucket.

  • versioning :: Maybe Text

    Specifies whether to enable or suspend versioning of objects in the bucket.

    The following options can be specified:

    • Enabled - Enables versioning of objects in the specified bucket.
    • Suspended - Suspends versioning of objects in the specified bucket. Existing object versions are retained.
  • bucketName :: Text

    The name of the bucket to update.

Instances

Instances details
ToJSON UpdateBucket Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateBucket

ToHeaders UpdateBucket Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateBucket

ToPath UpdateBucket Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateBucket

ToQuery UpdateBucket Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateBucket

AWSRequest UpdateBucket Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateBucket

Associated Types

type AWSResponse UpdateBucket #

Generic UpdateBucket Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateBucket

Associated Types

type Rep UpdateBucket :: Type -> Type #

Read UpdateBucket Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateBucket

Show UpdateBucket Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateBucket

NFData UpdateBucket Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateBucket

Methods

rnf :: UpdateBucket -> () #

Eq UpdateBucket Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateBucket

Hashable UpdateBucket Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateBucket

type AWSResponse UpdateBucket Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateBucket

type Rep UpdateBucket Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateBucket

type Rep UpdateBucket = D1 ('MetaData "UpdateBucket" "Amazonka.Lightsail.UpdateBucket" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "UpdateBucket'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessLogConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BucketAccessLogConfig)) :*: S1 ('MetaSel ('Just "accessRules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccessRules))) :*: (S1 ('MetaSel ('Just "readonlyAccessAccounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "versioning") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "bucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateBucket Source #

Create a value of UpdateBucket 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:

UpdateBucket, updateBucket_accessLogConfig - An object that describes the access log configuration for the bucket.

UpdateBucket, updateBucket_accessRules - An object that sets the public accessibility of objects in the specified bucket.

UpdateBucket, updateBucket_readonlyAccessAccounts - An array of strings to specify the Amazon Web Services account IDs that can access the bucket.

You can give a maximum of 10 Amazon Web Services accounts access to a bucket.

$sel:versioning:UpdateBucket', updateBucket_versioning - Specifies whether to enable or suspend versioning of objects in the bucket.

The following options can be specified:

  • Enabled - Enables versioning of objects in the specified bucket.
  • Suspended - Suspends versioning of objects in the specified bucket. Existing object versions are retained.

$sel:bucketName:UpdateBucket', updateBucket_bucketName - The name of the bucket to update.

Request Lenses

updateBucket_accessLogConfig :: Lens' UpdateBucket (Maybe BucketAccessLogConfig) Source #

An object that describes the access log configuration for the bucket.

updateBucket_accessRules :: Lens' UpdateBucket (Maybe AccessRules) Source #

An object that sets the public accessibility of objects in the specified bucket.

updateBucket_readonlyAccessAccounts :: Lens' UpdateBucket (Maybe [Text]) Source #

An array of strings to specify the Amazon Web Services account IDs that can access the bucket.

You can give a maximum of 10 Amazon Web Services accounts access to a bucket.

updateBucket_versioning :: Lens' UpdateBucket (Maybe Text) Source #

Specifies whether to enable or suspend versioning of objects in the bucket.

The following options can be specified:

  • Enabled - Enables versioning of objects in the specified bucket.
  • Suspended - Suspends versioning of objects in the specified bucket. Existing object versions are retained.

updateBucket_bucketName :: Lens' UpdateBucket Text Source #

The name of the bucket to update.

Destructuring the Response

data UpdateBucketResponse Source #

See: newUpdateBucketResponse smart constructor.

Constructors

UpdateBucketResponse' 

Fields

  • bucket :: Maybe Bucket

    An object that describes the bucket that is updated.

  • operations :: Maybe [Operation]

    An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic UpdateBucketResponse Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateBucket

Associated Types

type Rep UpdateBucketResponse :: Type -> Type #

Read UpdateBucketResponse Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateBucket

Show UpdateBucketResponse Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateBucket

NFData UpdateBucketResponse Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateBucket

Methods

rnf :: UpdateBucketResponse -> () #

Eq UpdateBucketResponse Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateBucket

type Rep UpdateBucketResponse Source # 
Instance details

Defined in Amazonka.Lightsail.UpdateBucket

type Rep UpdateBucketResponse = D1 ('MetaData "UpdateBucketResponse" "Amazonka.Lightsail.UpdateBucket" "amazonka-lightsail-2.0-77hvsZhtZFxFduYae8QaN0" 'False) (C1 ('MetaCons "UpdateBucketResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bucket)) :*: (S1 ('MetaSel ('Just "operations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Operation])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateBucketResponse Source #

Create a value of UpdateBucketResponse 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:bucket:UpdateBucketResponse', updateBucketResponse_bucket - An object that describes the bucket that is updated.

$sel:operations:UpdateBucketResponse', updateBucketResponse_operations - An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

$sel:httpStatus:UpdateBucketResponse', updateBucketResponse_httpStatus - The response's http status code.

Response Lenses

updateBucketResponse_bucket :: Lens' UpdateBucketResponse (Maybe Bucket) Source #

An object that describes the bucket that is updated.

updateBucketResponse_operations :: Lens' UpdateBucketResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.