Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::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'.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#access_key
defaccess_key()->::String
Returns
(::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=
defaccess_key=(value)->::String
Parameter
value (::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
Returns
(::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
defaccess_key_id()->::String
Returns
(::String) — The identifier of an access key used for s3 bucket authentication.
#access_key_id=
defaccess_key_id=(value)->::String
Parameter
value (::String) — The identifier of an access key used for s3 bucket authentication.
Returns
(::String) — The identifier of an access key used for s3 bucket authentication.
#access_key_version
defaccess_key_version()->::String
Returns
(::String) — The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.
#access_key_version=
defaccess_key_version=(value)->::String
Parameter
value (::String) — The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.
Returns
(::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
deforigin_region()->::String
Returns
(::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.
#origin_region=
deforigin_region=(value)->::String
Parameter
value (::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.
Returns
(::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.
[[["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-29 UTC."],[],[],null,["# Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::AWSV4Signature (v3.0.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.0.0 (latest)](/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-AWSV4Signature)\n- [2.22.0](/ruby/docs/reference/google-cloud-compute-v1/2.22.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [2.21.1](/ruby/docs/reference/google-cloud-compute-v1/2.21.1/Google-Cloud-Compute-V1-AWSV4Signature)\n- [2.20.0](/ruby/docs/reference/google-cloud-compute-v1/2.20.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [2.19.1](/ruby/docs/reference/google-cloud-compute-v1/2.19.1/Google-Cloud-Compute-V1-AWSV4Signature)\n- [2.18.0](/ruby/docs/reference/google-cloud-compute-v1/2.18.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [2.17.0](/ruby/docs/reference/google-cloud-compute-v1/2.17.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [2.16.0](/ruby/docs/reference/google-cloud-compute-v1/2.16.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [2.15.0](/ruby/docs/reference/google-cloud-compute-v1/2.15.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [2.14.0](/ruby/docs/reference/google-cloud-compute-v1/2.14.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [2.13.0](/ruby/docs/reference/google-cloud-compute-v1/2.13.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [2.12.0](/ruby/docs/reference/google-cloud-compute-v1/2.12.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [2.11.0](/ruby/docs/reference/google-cloud-compute-v1/2.11.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [2.10.0](/ruby/docs/reference/google-cloud-compute-v1/2.10.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [2.9.0](/ruby/docs/reference/google-cloud-compute-v1/2.9.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [2.8.0](/ruby/docs/reference/google-cloud-compute-v1/2.8.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [2.7.2](/ruby/docs/reference/google-cloud-compute-v1/2.7.2/Google-Cloud-Compute-V1-AWSV4Signature)\n- [2.6.0](/ruby/docs/reference/google-cloud-compute-v1/2.6.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [2.5.0](/ruby/docs/reference/google-cloud-compute-v1/2.5.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [2.4.0](/ruby/docs/reference/google-cloud-compute-v1/2.4.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [2.3.0](/ruby/docs/reference/google-cloud-compute-v1/2.3.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [2.2.0](/ruby/docs/reference/google-cloud-compute-v1/2.2.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [2.1.0](/ruby/docs/reference/google-cloud-compute-v1/2.1.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [2.0.0](/ruby/docs/reference/google-cloud-compute-v1/2.0.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [1.10.0](/ruby/docs/reference/google-cloud-compute-v1/1.10.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [1.9.0](/ruby/docs/reference/google-cloud-compute-v1/1.9.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [1.8.0](/ruby/docs/reference/google-cloud-compute-v1/1.8.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [1.7.1](/ruby/docs/reference/google-cloud-compute-v1/1.7.1/Google-Cloud-Compute-V1-AWSV4Signature)\n- [1.6.0](/ruby/docs/reference/google-cloud-compute-v1/1.6.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [1.5.0](/ruby/docs/reference/google-cloud-compute-v1/1.5.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [1.4.0](/ruby/docs/reference/google-cloud-compute-v1/1.4.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [1.3.0](/ruby/docs/reference/google-cloud-compute-v1/1.3.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [1.2.0](/ruby/docs/reference/google-cloud-compute-v1/1.2.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [1.1.0](/ruby/docs/reference/google-cloud-compute-v1/1.1.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [1.0.0](/ruby/docs/reference/google-cloud-compute-v1/1.0.0/Google-Cloud-Compute-V1-AWSV4Signature)\n- [0.5.0](/ruby/docs/reference/google-cloud-compute-v1/0.5.0/Google-Cloud-Compute-V1-AWSV4Signature) \nReference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::AWSV4Signature.\n\nMessages\n\n\n\u003cbr /\u003e\n\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\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #access_key\n\n def access_key() -\u003e ::String\n\n**Returns**\n\n- (::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\n\n### #access_key=\n\n def access_key=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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 \n**Returns**\n\n- (::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\n\n### #access_key_id\n\n def access_key_id() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The identifier of an access key used for s3 bucket authentication.\n\n### #access_key_id=\n\n def access_key_id=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The identifier of an access key used for s3 bucket authentication. \n**Returns**\n\n- (::String) --- The identifier of an access key used for s3 bucket authentication.\n\n### #access_key_version\n\n def access_key_version() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.\n\n### #access_key_version=\n\n def access_key_version=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The optional version identifier for the access key. You can use this to keep track of different iterations of your access key. \n**Returns**\n\n- (::String) --- The optional version identifier for the access key. You can use this to keep track of different iterations of your access key.\n\n### #origin_region\n\n def origin_region() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #origin_region=\n\n def origin_region=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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. \n**Returns**\n\n- (::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."]]
