Class: Fastly::LoggingS3Api

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/api/logging_s3_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LoggingS3Api

Returns a new instance of LoggingS3Api.



17
18
19
 
# File 'lib/fastly/api/logging_s3_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/fastly/api/logging_s3_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#create_log_aws_s3(opts = {}) ⇒ LoggingS3Response

Create an AWS S3 log endpoint Create a S3 for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :name (String) —

    The name for the real-time logging configuration.

  • :placement (String) —

    Where in the generated VCL the logging call should be placed. If not set, endpoints with `format_version` of 2 are placed in `vcl_log` and those with `format_version` of 1 are placed in `vcl_deliver`.

  • :response_condition (String) —

    The name of an existing condition in the configured endpoint, or leave blank to always execute.

  • :format (String) —

    A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats). (default to ‘%h %l %u %t "%r" %>s %b’)

  • :format_version (Integer) —

    The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. (default to FORMAT_VERSION::v2)

  • :message_type (String) —

    How the message should be formatted. (default to ‘classic’)

  • :timestamp_format (String) —

    A timestamp format

  • :compression_codec (String) —

    The codec used for compressing your logs. Valid values are `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error.

  • :period (Integer) —

    How frequently log files are finalized so they can be available for reading (in seconds). (default to 3600)

  • :gzip_level (Integer) —

    The level of gzip encoding when sending logs (default `0`, no compression). Specifying both `compression_codec` and `gzip_level` in the same API request will result in an error. (default to 0)

  • :access_key (String) —

    The access key for your S3 account. Not required if `iam_role` is provided.

  • :acl (String) —

    The access control list (ACL) specific request header. See the AWS documentation for [Access Control List (ACL) Specific Request Headers](docs.aws.amazon.com/AmazonS3/latest/API/mpUploadInitiate.html#initiate-mpu-acl-specific-request-headers) for more information.

  • :bucket_name (String) —

    The bucket name for S3 account.

  • :domain (String) —

    The domain of the Amazon S3 endpoint.

  • :iam_role (String) —

    The Amazon Resource Name (ARN) for the IAM role granting Fastly access to S3. Not required if `access_key` and `secret_key` are provided.

  • :path (String) —

    The path to upload logs to. (default to ‘null’)

  • :public_key (String) —

    A PGP public key that Fastly will use to encrypt your log files before writing them to disk. (default to ‘null’)

  • :redundancy (String) —

    The S3 redundancy level. (default to ‘null’)

  • :secret_key (String) —

    The secret key for your S3 account. Not required if `iam_role` is provided.

  • :server_side_encryption_kms_key_id (String) —

    Optional server-side KMS Key Id. Must be set if `server_side_encryption` is set to `aws:kms` or `AES256`. (default to ‘null’)

  • :server_side_encryption (String) —

    Set this to `AES256` or `aws:kms` to enable S3 Server Side Encryption. (default to ‘null’)

  • :file_max_bytes (Integer) —

    The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB.)

Returns:



47
48
49
50
 
# File 'lib/fastly/api/logging_s3_api.rb', line 47

def create_log_aws_s3(opts = {})
  data, _status_code, _headers = create_log_aws_s3_with_http_info(opts)
  data
end

#create_log_aws_s3_with_http_info(opts = {}) ⇒ Array<(LoggingS3Response, Integer, Hash)>

Create an AWS S3 log endpoint Create a S3 for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :name (String) —

    The name for the real-time logging configuration.

  • :placement (String) —

    Where in the generated VCL the logging call should be placed. If not set, endpoints with &#x60;format_version&#x60; of 2 are placed in &#x60;vcl_log&#x60; and those with &#x60;format_version&#x60; of 1 are placed in &#x60;vcl_deliver&#x60;.

  • :response_condition (String) —

    The name of an existing condition in the configured endpoint, or leave blank to always execute.

  • :format (String) —

    A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats). (default to ‘%h %l %u %t "%r" %&gt;s %b’)

  • :format_version (Integer) —

    The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in &#x60;vcl_log&#x60; if &#x60;format_version&#x60; is set to &#x60;2&#x60; and in &#x60;vcl_deliver&#x60; if &#x60;format_version&#x60; is set to &#x60;1&#x60;. (default to FORMAT_VERSION::v2)

  • :message_type (String) —

    How the message should be formatted. (default to ‘classic’)

  • :timestamp_format (String) —

    A timestamp format

  • :compression_codec (String) —

    The codec used for compressing your logs. Valid values are &#x60;zstd&#x60;, &#x60;snappy&#x60;, and &#x60;gzip&#x60;. Specifying both &#x60;compression_codec&#x60; and &#x60;gzip_level&#x60; in the same API request will result in an error.

  • :period (Integer) —

    How frequently log files are finalized so they can be available for reading (in seconds). (default to 3600)

  • :gzip_level (Integer) —

    The level of gzip encoding when sending logs (default &#x60;0&#x60;, no compression). Specifying both &#x60;compression_codec&#x60; and &#x60;gzip_level&#x60; in the same API request will result in an error. (default to 0)

  • :access_key (String) —

    The access key for your S3 account. Not required if &#x60;iam_role&#x60; is provided.

  • :acl (String) —

    The access control list (ACL) specific request header. See the AWS documentation for [Access Control List (ACL) Specific Request Headers](docs.aws.amazon.com/AmazonS3/latest/API/mpUploadInitiate.html#initiate-mpu-acl-specific-request-headers) for more information.

  • :bucket_name (String) —

    The bucket name for S3 account.

  • :domain (String) —

    The domain of the Amazon S3 endpoint.

  • :iam_role (String) —

    The Amazon Resource Name (ARN) for the IAM role granting Fastly access to S3. Not required if &#x60;access_key&#x60; and &#x60;secret_key&#x60; are provided.

  • :path (String) —

    The path to upload logs to. (default to ‘null’)

  • :public_key (String) —

    A PGP public key that Fastly will use to encrypt your log files before writing them to disk. (default to ‘null’)

  • :redundancy (String) —

    The S3 redundancy level. (default to ‘null’)

  • :secret_key (String) —

    The secret key for your S3 account. Not required if &#x60;iam_role&#x60; is provided.

  • :server_side_encryption_kms_key_id (String) —

    Optional server-side KMS Key Id. Must be set if &#x60;server_side_encryption&#x60; is set to &#x60;aws:kms&#x60; or &#x60;AES256&#x60;. (default to ‘null’)

  • :server_side_encryption (String) —

    Set this to &#x60;AES256&#x60; or &#x60;aws:kms&#x60; to enable S3 Server Side Encryption. (default to ‘null’)

  • :file_max_bytes (Integer) —

    The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB.)

Returns:

  • (Array<(LoggingS3Response, Integer, Hash)>) —

    LoggingS3Response data, response status code and response headers



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/fastly/api/logging_s3_api.rb', line 79

def create_log_aws_s3_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingS3Api.create_log_aws_s3 ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingS3Api.create_log_aws_s3"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingS3Api.create_log_aws_s3"
  end
  allowable_values = ["none", "waf_debug", "null"]
  if @api_client.config.client_side_validation && opts[:'placement'] && !allowable_values.include?(opts[:'placement'])
    fail ArgumentError, "invalid value for \"placement\", must be one of #{allowable_values}"
  end
  allowable_values = [1, 2]
  if @api_client.config.client_side_validation && opts[:'format_version'] && !allowable_values.include?(opts[:'format_version'])
    fail ArgumentError, "invalid value for \"format_version\", must be one of #{allowable_values}"
  end
  allowable_values = ["classic", "loggly", "logplex", "blank"]
  if @api_client.config.client_side_validation && opts[:'message_type'] && !allowable_values.include?(opts[:'message_type'])
    fail ArgumentError, "invalid value for \"message_type\", must be one of #{allowable_values}"
  end
  allowable_values = ["zstd", "snappy", "gzip"]
  if @api_client.config.client_side_validation && opts[:'compression_codec'] && !allowable_values.include?(opts[:'compression_codec'])
    fail ArgumentError, "invalid value for \"compression_codec\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'file_max_bytes'].nil? && opts[:'file_max_bytes'] < 1048576
    fail ArgumentError, 'invalid value for "opts[:"file_max_bytes"]" when calling LoggingS3Api.create_log_aws_s3, must be greater than or equal to 1048576.'
  end

  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/s3'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['placement'] = opts[:'placement'] if !opts[:'placement'].nil?
  form_params['response_condition'] = opts[:'response_condition'] if !opts[:'response_condition'].nil?
  form_params['format'] = opts[:'format'] if !opts[:'format'].nil?
  form_params['format_version'] = opts[:'format_version'] if !opts[:'format_version'].nil?
  form_params['message_type'] = opts[:'message_type'] if !opts[:'message_type'].nil?
  form_params['timestamp_format'] = opts[:'timestamp_format'] if !opts[:'timestamp_format'].nil?
  form_params['compression_codec'] = opts[:'compression_codec'] if !opts[:'compression_codec'].nil?
  form_params['period'] = opts[:'period'] if !opts[:'period'].nil?
  form_params['gzip_level'] = opts[:'gzip_level'] if !opts[:'gzip_level'].nil?
  form_params['access_key'] = opts[:'access_key'] if !opts[:'access_key'].nil?
  form_params['acl'] = opts[:'acl'] if !opts[:'acl'].nil?
  form_params['bucket_name'] = opts[:'bucket_name'] if !opts[:'bucket_name'].nil?
  form_params['domain'] = opts[:'domain'] if !opts[:'domain'].nil?
  form_params['iam_role'] = opts[:'iam_role'] if !opts[:'iam_role'].nil?
  form_params['path'] = opts[:'path'] if !opts[:'path'].nil?
  form_params['public_key'] = opts[:'public_key'] if !opts[:'public_key'].nil?
  form_params['redundancy'] = opts[:'redundancy'] if !opts[:'redundancy'].nil?
  form_params['secret_key'] = opts[:'secret_key'] if !opts[:'secret_key'].nil?
  form_params['server_side_encryption_kms_key_id'] = opts[:'server_side_encryption_kms_key_id'] if !opts[:'server_side_encryption_kms_key_id'].nil?
  form_params['server_side_encryption'] = opts[:'server_side_encryption'] if !opts[:'server_side_encryption'].nil?
  form_params['file_max_bytes'] = opts[:'file_max_bytes'] if !opts[:'file_max_bytes'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LoggingS3Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingS3Api.create_log_aws_s3",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingS3Api#create_log_aws_s3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_log_aws_s3(opts = {}) ⇒ InlineResponse200

Delete an AWS S3 log endpoint Delete the S3 for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_s3_name (String) —

    The name for the real-time logging configuration. (required)

Returns:



187
188
189
190
 
# File 'lib/fastly/api/logging_s3_api.rb', line 187

def delete_log_aws_s3(opts = {})
  data, _status_code, _headers = delete_log_aws_s3_with_http_info(opts)
  data
end

#delete_log_aws_s3_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>

Delete an AWS S3 log endpoint Delete the S3 for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_s3_name (String) —

    The name for the real-time logging configuration. (required)

Returns:

  • (Array<(InlineResponse200, Integer, Hash)>) —

    InlineResponse200 data, response status code and response headers



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/fastly/api/logging_s3_api.rb', line 198

def delete_log_aws_s3_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingS3Api.delete_log_aws_s3 ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  logging_s3_name = opts[:'logging_s3_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingS3Api.delete_log_aws_s3"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingS3Api.delete_log_aws_s3"
  end
  # verify the required parameter 'logging_s3_name' is set
  if @api_client.config.client_side_validation && logging_s3_name.nil?
    fail ArgumentError, "Missing the required parameter 'logging_s3_name' when calling LoggingS3Api.delete_log_aws_s3"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/s3/{logging_s3_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_s3_name' + '}', CGI.escape(logging_s3_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InlineResponse200'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingS3Api.delete_log_aws_s3",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingS3Api#delete_log_aws_s3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_log_aws_s3(opts = {}) ⇒ LoggingS3Response

Get an AWS S3 log endpoint Get the S3 for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_s3_name (String) —

    The name for the real-time logging configuration. (required)

Returns:



264
265
266
267
 
# File 'lib/fastly/api/logging_s3_api.rb', line 264

def get_log_aws_s3(opts = {})
  data, _status_code, _headers = get_log_aws_s3_with_http_info(opts)
  data
end

#get_log_aws_s3_with_http_info(opts = {}) ⇒ Array<(LoggingS3Response, Integer, Hash)>

Get an AWS S3 log endpoint Get the S3 for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_s3_name (String) —

    The name for the real-time logging configuration. (required)

Returns:

  • (Array<(LoggingS3Response, Integer, Hash)>) —

    LoggingS3Response data, response status code and response headers



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/fastly/api/logging_s3_api.rb', line 275

def get_log_aws_s3_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingS3Api.get_log_aws_s3 ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  logging_s3_name = opts[:'logging_s3_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingS3Api.get_log_aws_s3"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingS3Api.get_log_aws_s3"
  end
  # verify the required parameter 'logging_s3_name' is set
  if @api_client.config.client_side_validation && logging_s3_name.nil?
    fail ArgumentError, "Missing the required parameter 'logging_s3_name' when calling LoggingS3Api.get_log_aws_s3"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/s3/{logging_s3_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_s3_name' + '}', CGI.escape(logging_s3_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LoggingS3Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingS3Api.get_log_aws_s3",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingS3Api#get_log_aws_s3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_log_aws_s3(opts = {}) ⇒ Array<LoggingS3Response>

List AWS S3 log endpoints List all of the S3s for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

Returns:



340
341
342
343
 
# File 'lib/fastly/api/logging_s3_api.rb', line 340

def list_log_aws_s3(opts = {})
  data, _status_code, _headers = list_log_aws_s3_with_http_info(opts)
  data
end

#list_log_aws_s3_with_http_info(opts = {}) ⇒ Array<(Array<LoggingS3Response>, Integer, Hash)>

List AWS S3 log endpoints List all of the S3s for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

Returns:

  • (Array<(Array<LoggingS3Response>, Integer, Hash)>) —

    Array<LoggingS3Response> data, response status code and response headers



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/fastly/api/logging_s3_api.rb', line 350

def list_log_aws_s3_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingS3Api.list_log_aws_s3 ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingS3Api.list_log_aws_s3"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingS3Api.list_log_aws_s3"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/s3'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<LoggingS3Response>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingS3Api.list_log_aws_s3",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingS3Api#list_log_aws_s3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_log_aws_s3(opts = {}) ⇒ LoggingS3Response

Update an AWS S3 log endpoint Update the S3 for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_s3_name (String) —

    The name for the real-time logging configuration. (required)

  • :name (String) —

    The name for the real-time logging configuration.

  • :placement (String) —

    Where in the generated VCL the logging call should be placed. If not set, endpoints with &#x60;format_version&#x60; of 2 are placed in &#x60;vcl_log&#x60; and those with &#x60;format_version&#x60; of 1 are placed in &#x60;vcl_deliver&#x60;.

  • :response_condition (String) —

    The name of an existing condition in the configured endpoint, or leave blank to always execute.

  • :format (String) —

    A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats). (default to ‘%h %l %u %t "%r" %&gt;s %b’)

  • :format_version (Integer) —

    The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in &#x60;vcl_log&#x60; if &#x60;format_version&#x60; is set to &#x60;2&#x60; and in &#x60;vcl_deliver&#x60; if &#x60;format_version&#x60; is set to &#x60;1&#x60;. (default to FORMAT_VERSION::v2)

  • :message_type (String) —

    How the message should be formatted. (default to ‘classic’)

  • :timestamp_format (String) —

    A timestamp format

  • :compression_codec (String) —

    The codec used for compressing your logs. Valid values are &#x60;zstd&#x60;, &#x60;snappy&#x60;, and &#x60;gzip&#x60;. Specifying both &#x60;compression_codec&#x60; and &#x60;gzip_level&#x60; in the same API request will result in an error.

  • :period (Integer) —

    How frequently log files are finalized so they can be available for reading (in seconds). (default to 3600)

  • :gzip_level (Integer) —

    The level of gzip encoding when sending logs (default &#x60;0&#x60;, no compression). Specifying both &#x60;compression_codec&#x60; and &#x60;gzip_level&#x60; in the same API request will result in an error. (default to 0)

  • :access_key (String) —

    The access key for your S3 account. Not required if &#x60;iam_role&#x60; is provided.

  • :acl (String) —

    The access control list (ACL) specific request header. See the AWS documentation for [Access Control List (ACL) Specific Request Headers](docs.aws.amazon.com/AmazonS3/latest/API/mpUploadInitiate.html#initiate-mpu-acl-specific-request-headers) for more information.

  • :bucket_name (String) —

    The bucket name for S3 account.

  • :domain (String) —

    The domain of the Amazon S3 endpoint.

  • :iam_role (String) —

    The Amazon Resource Name (ARN) for the IAM role granting Fastly access to S3. Not required if &#x60;access_key&#x60; and &#x60;secret_key&#x60; are provided.

  • :path (String) —

    The path to upload logs to. (default to ‘null’)

  • :public_key (String) —

    A PGP public key that Fastly will use to encrypt your log files before writing them to disk. (default to ‘null’)

  • :redundancy (String) —

    The S3 redundancy level. (default to ‘null’)

  • :secret_key (String) —

    The secret key for your S3 account. Not required if &#x60;iam_role&#x60; is provided.

  • :server_side_encryption_kms_key_id (String) —

    Optional server-side KMS Key Id. Must be set if &#x60;server_side_encryption&#x60; is set to &#x60;aws:kms&#x60; or &#x60;AES256&#x60;. (default to ‘null’)

  • :server_side_encryption (String) —

    Set this to &#x60;AES256&#x60; or &#x60;aws:kms&#x60; to enable S3 Server Side Encryption. (default to ‘null’)

  • :file_max_bytes (Integer) —

    The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB.)

Returns:



433
434
435
436
 
# File 'lib/fastly/api/logging_s3_api.rb', line 433

def update_log_aws_s3(opts = {})
  data, _status_code, _headers = update_log_aws_s3_with_http_info(opts)
  data
end

#update_log_aws_s3_with_http_info(opts = {}) ⇒ Array<(LoggingS3Response, Integer, Hash)>

Update an AWS S3 log endpoint Update the S3 for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_s3_name (String) —

    The name for the real-time logging configuration. (required)

  • :name (String) —

    The name for the real-time logging configuration.

  • :placement (String) —

    Where in the generated VCL the logging call should be placed. If not set, endpoints with &#x60;format_version&#x60; of 2 are placed in &#x60;vcl_log&#x60; and those with &#x60;format_version&#x60; of 1 are placed in &#x60;vcl_deliver&#x60;.

  • :response_condition (String) —

    The name of an existing condition in the configured endpoint, or leave blank to always execute.

  • :format (String) —

    A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats). (default to ‘%h %l %u %t "%r" %&gt;s %b’)

  • :format_version (Integer) —

    The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in &#x60;vcl_log&#x60; if &#x60;format_version&#x60; is set to &#x60;2&#x60; and in &#x60;vcl_deliver&#x60; if &#x60;format_version&#x60; is set to &#x60;1&#x60;. (default to FORMAT_VERSION::v2)

  • :message_type (String) —

    How the message should be formatted. (default to ‘classic’)

  • :timestamp_format (String) —

    A timestamp format

  • :compression_codec (String) —

    The codec used for compressing your logs. Valid values are &#x60;zstd&#x60;, &#x60;snappy&#x60;, and &#x60;gzip&#x60;. Specifying both &#x60;compression_codec&#x60; and &#x60;gzip_level&#x60; in the same API request will result in an error.

  • :period (Integer) —

    How frequently log files are finalized so they can be available for reading (in seconds). (default to 3600)

  • :gzip_level (Integer) —

    The level of gzip encoding when sending logs (default &#x60;0&#x60;, no compression). Specifying both &#x60;compression_codec&#x60; and &#x60;gzip_level&#x60; in the same API request will result in an error. (default to 0)

  • :access_key (String) —

    The access key for your S3 account. Not required if &#x60;iam_role&#x60; is provided.

  • :acl (String) —

    The access control list (ACL) specific request header. See the AWS documentation for [Access Control List (ACL) Specific Request Headers](docs.aws.amazon.com/AmazonS3/latest/API/mpUploadInitiate.html#initiate-mpu-acl-specific-request-headers) for more information.

  • :bucket_name (String) —

    The bucket name for S3 account.

  • :domain (String) —

    The domain of the Amazon S3 endpoint.

  • :iam_role (String) —

    The Amazon Resource Name (ARN) for the IAM role granting Fastly access to S3. Not required if &#x60;access_key&#x60; and &#x60;secret_key&#x60; are provided.

  • :path (String) —

    The path to upload logs to. (default to ‘null’)

  • :public_key (String) —

    A PGP public key that Fastly will use to encrypt your log files before writing them to disk. (default to ‘null’)

  • :redundancy (String) —

    The S3 redundancy level. (default to ‘null’)

  • :secret_key (String) —

    The secret key for your S3 account. Not required if &#x60;iam_role&#x60; is provided.

  • :server_side_encryption_kms_key_id (String) —

    Optional server-side KMS Key Id. Must be set if &#x60;server_side_encryption&#x60; is set to &#x60;aws:kms&#x60; or &#x60;AES256&#x60;. (default to ‘null’)

  • :server_side_encryption (String) —

    Set this to &#x60;AES256&#x60; or &#x60;aws:kms&#x60; to enable S3 Server Side Encryption. (default to ‘null’)

  • :file_max_bytes (Integer) —

    The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB.)

Returns:

  • (Array<(LoggingS3Response, Integer, Hash)>) —

    LoggingS3Response data, response status code and response headers



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'lib/fastly/api/logging_s3_api.rb', line 466

def update_log_aws_s3_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingS3Api.update_log_aws_s3 ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  logging_s3_name = opts[:'logging_s3_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingS3Api.update_log_aws_s3"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingS3Api.update_log_aws_s3"
  end
  # verify the required parameter 'logging_s3_name' is set
  if @api_client.config.client_side_validation && logging_s3_name.nil?
    fail ArgumentError, "Missing the required parameter 'logging_s3_name' when calling LoggingS3Api.update_log_aws_s3"
  end
  allowable_values = ["none", "waf_debug", "null"]
  if @api_client.config.client_side_validation && opts[:'placement'] && !allowable_values.include?(opts[:'placement'])
    fail ArgumentError, "invalid value for \"placement\", must be one of #{allowable_values}"
  end
  allowable_values = [1, 2]
  if @api_client.config.client_side_validation && opts[:'format_version'] && !allowable_values.include?(opts[:'format_version'])
    fail ArgumentError, "invalid value for \"format_version\", must be one of #{allowable_values}"
  end
  allowable_values = ["classic", "loggly", "logplex", "blank"]
  if @api_client.config.client_side_validation && opts[:'message_type'] && !allowable_values.include?(opts[:'message_type'])
    fail ArgumentError, "invalid value for \"message_type\", must be one of #{allowable_values}"
  end
  allowable_values = ["zstd", "snappy", "gzip"]
  if @api_client.config.client_side_validation && opts[:'compression_codec'] && !allowable_values.include?(opts[:'compression_codec'])
    fail ArgumentError, "invalid value for \"compression_codec\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'file_max_bytes'].nil? && opts[:'file_max_bytes'] < 1048576
    fail ArgumentError, 'invalid value for "opts[:"file_max_bytes"]" when calling LoggingS3Api.update_log_aws_s3, must be greater than or equal to 1048576.'
  end

  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/s3/{logging_s3_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_s3_name' + '}', CGI.escape(logging_s3_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['placement'] = opts[:'placement'] if !opts[:'placement'].nil?
  form_params['response_condition'] = opts[:'response_condition'] if !opts[:'response_condition'].nil?
  form_params['format'] = opts[:'format'] if !opts[:'format'].nil?
  form_params['format_version'] = opts[:'format_version'] if !opts[:'format_version'].nil?
  form_params['message_type'] = opts[:'message_type'] if !opts[:'message_type'].nil?
  form_params['timestamp_format'] = opts[:'timestamp_format'] if !opts[:'timestamp_format'].nil?
  form_params['compression_codec'] = opts[:'compression_codec'] if !opts[:'compression_codec'].nil?
  form_params['period'] = opts[:'period'] if !opts[:'period'].nil?
  form_params['gzip_level'] = opts[:'gzip_level'] if !opts[:'gzip_level'].nil?
  form_params['access_key'] = opts[:'access_key'] if !opts[:'access_key'].nil?
  form_params['acl'] = opts[:'acl'] if !opts[:'acl'].nil?
  form_params['bucket_name'] = opts[:'bucket_name'] if !opts[:'bucket_name'].nil?
  form_params['domain'] = opts[:'domain'] if !opts[:'domain'].nil?
  form_params['iam_role'] = opts[:'iam_role'] if !opts[:'iam_role'].nil?
  form_params['path'] = opts[:'path'] if !opts[:'path'].nil?
  form_params['public_key'] = opts[:'public_key'] if !opts[:'public_key'].nil?
  form_params['redundancy'] = opts[:'redundancy'] if !opts[:'redundancy'].nil?
  form_params['secret_key'] = opts[:'secret_key'] if !opts[:'secret_key'].nil?
  form_params['server_side_encryption_kms_key_id'] = opts[:'server_side_encryption_kms_key_id'] if !opts[:'server_side_encryption_kms_key_id'].nil?
  form_params['server_side_encryption'] = opts[:'server_side_encryption'] if !opts[:'server_side_encryption'].nil?
  form_params['file_max_bytes'] = opts[:'file_max_bytes'] if !opts[:'file_max_bytes'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LoggingS3Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingS3Api.update_log_aws_s3",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingS3Api#update_log_aws_s3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end