Class: Google::Apis::ComputeV1::Awsv4Signature

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/representations.rb

Overview

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'.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Awsv4Signature

Returns a new instance of Awsv4Signature.



58
59
60
 
# File 'lib/google/apis/compute_v1/classes.rb', line 58

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#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. Corresponds to the JSON property accessKey

Returns:

  • (String) 


38
39
40
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38

def access_key
  @access_key
end

#access_key_id ⇒ String

The identifier of an access key used for s3 bucket authentication. Corresponds to the JSON property accessKeyId

Returns:

  • (String) 


43
44
45
 
# File 'lib/google/apis/compute_v1/classes.rb', line 43

def access_key_id
  @access_key_id
end

#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. Corresponds to the JSON property accessKeyVersion

Returns:

  • (String) 


49
50
51
 
# File 'lib/google/apis/compute_v1/classes.rb', line 49

def access_key_version
  @access_key_version
end

#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. Corresponds to the JSON property originRegion

Returns:

  • (String) 


56
57
58
 
# File 'lib/google/apis/compute_v1/classes.rb', line 56

def origin_region
  @origin_region
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



63
64
65
66
67
68
 
# File 'lib/google/apis/compute_v1/classes.rb', line 63

def update!(**args)
  @access_key = args[:access_key] if args.key?(:access_key)
  @access_key_id = args[:access_key_id] if args.key?(:access_key_id)
  @access_key_version = args[:access_key_version] if args.key?(:access_key_version)
  @origin_region = args[:origin_region] if args.key?(:origin_region)
end