Configuring BPA for a Bucket (SDK for Go)

Function

This API creates or modifies the public access block configuration of an OBS bucket by enabling or disabling the feature.

Restrictions

• To configure BPA for a bucket, you must be the bucket owner or have the required permission (obs:bucket:PutBucketPublicAccessBlock in IAM or PutBucketPublicAccessBlock in a bucket policy). For details, see Introduction to OBS Access Control, IAM Custom Policies, and Creating a Custom Bucket Policy.
• The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.
• If public access block is enabled, existing public access permissions are ignored and new public access permissions cannot be configured. If public access block is disabled, existing public access permissions continue to apply and new public access permissions can be configured.
• By default, BPA is disabled for new POSIX buckets but is enabled for new object buckets.

Method

func (obsClient ObsClient) PutBucketPublicAccessBlock(input *PutBucketPublicAccessBlockInput) (output *BaseModel, err error)

Request Parameters

Responses

Code Examples

This example configures PublicAccessBlock for bucket examplebucket.

package main

import (
    "fmt"
    "os"
    obs "github.com/huaweicloud/huaweicloud-sdk-go-obs/obs"
)
func main() {
    //Obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways. Using hard coding may result in leakage.
    //Obtain an AK/SK pair on the management console. For details, see https://support.huaweicloud.com/intl/en-us/usermanual-ca/ca_01_0003.html.
    ak := os.Getenv("AccessKeyID")
    sk := os.Getenv("SecretAccessKey")
    // (Optional) If you use a temporary AK/SK pair and a security token to access OBS, you are advised not to use hard coding, which may result in information leakage. You can obtain an AK/SK pair using environment variables or import an AK/SK pair in other ways.
    securityToken := os.Getenv("SecurityToken")
    // Enter the endpoint corresponding to the region where the bucket is located. CN-Hong Kong is used here as an example. Replace it with the one currently in use.
    endPoint := "https://obs.ap-southeast-1.myhuaweicloud.com"
    // Create an obsClient instance.
    // If you use a temporary AK/SK pair and a security token to access OBS, use the obs.WithSecurityToken method to specify a security token when creating an instance.
    // obsClient, err := obs.New(ak, sk, endPoint, obs.WithSecurityToken(securityToken))
    obsClient, err := "https://your-endpoint"
    if err != nil {
	fmt.Printf("Create obsClient error, errMsg: %s", err.Error())
    }
    input := &obs.PutBucketPublicAccessBlockInput{}
    // Specify the bucket name.
    input.Bucket = "examplebucket"
    // Specify the PublicAccessBlock configuration items of the bucket.
    input.BlockPublicAcls = true
    input.BlockPublicPolicy = true
    input.IgnorePublicAcls = true
    input.RestrictPublicBuckets = true
    // Set PublicAccessBlock for the bucket.
    output, err := obsClient.PutBucketPublicAccessBlock(input)
    if err == nil {
	fmt.Printf("Set bucket(%s)'s PublicAccessBlock successful!\n", input.Bucket)
	fmt.Printf("RequestId:%s\n", output.RequestId)
	return
    }
    fmt.Printf("Set bucket(%s)'s PublicAccessBlock fail!\n", input.Bucket)
    if obsError, ok := err.(obs.ObsError); ok {
	fmt.Println("An ObsError was found, which means your request sent to OBS was rejected with an error response.")
	fmt.Println(obsError.Error())
    } else {
	fmt.Println("An Exception was found, which means the client encountered an internal problem when attempting to communicate with OBS, for example, the client was unable to access the network.")
	fmt.Println(err)
    }
}