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 \ V1Methods
__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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|