AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Lightsail UpdateBucket API operation.

Syntax

Update-LSBucket
-BucketName <String>
-AccessRules_AllowPublicOverride <Boolean>
-AccessLogConfig_Destination <String>
-AccessLogConfig_Enabled <Boolean>
-AccessRules_GetObject <AccessType>
-AccessLogConfig_Prefix <String>
-ReadonlyAccessAccount <String[]>
-Versioning <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

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.

Parameters

-AccessLogConfig_Destination <String>
The name of the bucket where the access logs are saved. The destination can be a Lightsail bucket in the same account, and in the same Amazon Web Services Region as the source bucket.This parameter is required when enabling the access log for a bucket, and should be omitted when disabling the access log.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AccessLogConfig_Enabled <Boolean>
A Boolean value that indicates whether bucket access logging is enabled for the bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AccessLogConfig_Prefix <String>
The optional object prefix for the bucket access log.The prefix is an optional addition to the object key that organizes your access log files in the destination bucket. For example, if you specify a logs/ prefix, then each log object will begin with the logs/ prefix in its key (for example, logs/2021-11-01-21-32-16-E568B2907131C0C0).This parameter can be optionally specified when enabling the access log for a bucket, and should be omitted when disabling the access log.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AccessRules_AllowPublicOverride <Boolean>
A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified.When this is true, you can use the PutObjectAcl Amazon S3 API action to set individual objects to public (read-only) using the public-read ACL, or to private using the private ACL.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAccessRules_AllowPublicOverrides
-AccessRules_GetObject <AccessType>
Specifies the anonymous access to all objects in a bucket.The following options can be specified:
  • public - Sets all objects in the bucket to public (read-only), making them readable by anyone in the world.If the getObject value is set to public, then all objects in the bucket default to public regardless of the allowPublicOverrides value.
  • private - Sets all objects in the bucket to private, making them readable only by you or anyone you give access to.If the getObject value is set to private, and the allowPublicOverrides value is set to true, then all objects in the bucket default to private unless they are configured with a public-read ACL. Individual objects with a public-read ACL are readable by anyone in the world.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-BucketName <String>
The name of the bucket to update.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the BucketName parameter. The -PassThru parameter is deprecated, use -Select '^BucketName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReadonlyAccessAccount <String[]>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesReadonlyAccessAccounts
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Lightsail.Model.UpdateBucketResponse). Specifying the name of a property of type Amazon.Lightsail.Model.UpdateBucketResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Versioning <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns an Amazon.Lightsail.Model.UpdateBucketResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z