Reference documentation and code samples for the Compute V1 Client class AWSV4Signature.
Messages
Contains the configurations necessary to generate a signature for access to private storage buckets that support Signature Version 4 for authentication. The service name for generating the authentication header will always default to 's3'.
Generated from protobuf message google.cloud.compute.v1.AWSV4Signature
Namespace
Google \ Cloud \ Compute \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ access_key
string
The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly
↳ access_key_id
string
The identifier of an access key used for s3 bucket authentication.
↳ access_key_version
string
The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.
↳ origin_region
string
The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, "us-east-1" for AWS or "us-ashburn-1" for OCI.
getAccessKey
The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly
Returns
Type
Description
string
hasAccessKey
clearAccessKey
setAccessKey
The access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAccessKeyId
The identifier of an access key used for s3 bucket authentication.
Returns
Type
Description
string
hasAccessKeyId
clearAccessKeyId
setAccessKeyId
The identifier of an access key used for s3 bucket authentication.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAccessKeyVersion
The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.
Returns
Type
Description
string
hasAccessKeyVersion
clearAccessKeyVersion
setAccessKeyVersion
The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getOriginRegion
The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, "us-east-1" for AWS or "us-ashburn-1" for OCI.
Returns
Type
Description
string
hasOriginRegion
clearOriginRegion
setOriginRegion
The name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, "us-east-1" for AWS or "us-ashburn-1" for OCI.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Compute V1 Client - Class AWSV4Signature (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.AWSV4Signature)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.AWSV4Signature)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.AWSV4Signature)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.AWSV4Signature)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.AWSV4Signature)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.AWSV4Signature)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.AWSV4Signature)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.AWSV4Signature)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.AWSV4Signature)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.AWSV4Signature)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.AWSV4Signature)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.AWSV4Signature)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.AWSV4Signature)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.AWSV4Signature)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.AWSV4Signature)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.AWSV4Signature)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.AWSV4Signature)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.AWSV4Signature)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.AWSV4Signature)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.AWSV4Signature)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.AWSV4Signature)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.AWSV4Signature)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.AWSV4Signature)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.AWSV4Signature)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.AWSV4Signature)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.AWSV4Signature)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.AWSV4Signature)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.AWSV4Signature)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.AWSV4Signature)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.AWSV4Signature) \nReference documentation and code samples for the Compute V1 Client class AWSV4Signature.\n\nMessages\nContains the configurations necessary to generate a signature for access to private storage buckets that support Signature Version 4 for authentication. The service name for generating the authentication header will always default to 's3'.\n\nGenerated from protobuf message `google.cloud.compute.v1.AWSV4Signature`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getAccessKey\n\nThe access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly\n\n### hasAccessKey\n\n### clearAccessKey\n\n### setAccessKey\n\nThe access key used for s3 bucket authentication. Required for updating or creating a backend that uses AWS v4 signature authentication, but will not be returned as part of the configuration when queried with a REST API GET request. @InputOnly\n\n### getAccessKeyId\n\nThe identifier of an access key used for s3 bucket authentication.\n\n### hasAccessKeyId\n\n### clearAccessKeyId\n\n### setAccessKeyId\n\nThe identifier of an access key used for s3 bucket authentication.\n\n### getAccessKeyVersion\n\nThe optional version identifier for the access key. You can use this to keep track of different iterations of your access key.\n\n### hasAccessKeyVersion\n\n### clearAccessKeyVersion\n\n### setAccessKeyVersion\n\nThe optional version identifier for the access key. You can use this to keep track of different iterations of your access key.\n\n### getOriginRegion\n\nThe name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, \"us-east-1\" for AWS or \"us-ashburn-1\" for OCI.\n\n### hasOriginRegion\n\n### clearOriginRegion\n\n### setOriginRegion\n\nThe name of the cloud region of your origin. This is a free-form field with the name of the region your cloud uses to host your origin. For example, \"us-east-1\" for AWS or \"us-ashburn-1\" for OCI."]]