aws-sdk 1.13.0 → 1.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.yardopts +3 -3
- data/lib/aws/api_config/OpsWorks-2013-02-18.yml +55 -0
- data/lib/aws/api_config/SNS-2010-03-31.yml +0 -3
- data/lib/aws/api_config/SimpleWorkflow-2012-01-25.yml +30 -0
- data/lib/aws/auto_scaling/client.rb +0 -530
- data/lib/aws/cloud_formation/client.rb +0 -356
- data/lib/aws/cloud_front/client.rb +0 -1567
- data/lib/aws/cloud_search/client.rb +0 -578
- data/lib/aws/cloud_watch/client.rb +0 -445
- data/lib/aws/data_pipeline/client.rb +0 -396
- data/lib/aws/direct_connect/client.rb +0 -248
- data/lib/aws/dynamo_db.rb +0 -1
- data/lib/aws/dynamo_db/client.rb +70 -1
- data/lib/aws/dynamo_db/client_v2.rb +1 -1
- data/lib/aws/ec2/client.rb +0 -3942
- data/lib/aws/ec2/reserved_instances_offering_collection.rb +9 -3
- data/lib/aws/ec2/tag_collection.rb +1 -1
- data/lib/aws/elastic_beanstalk/client.rb +0 -898
- data/lib/aws/elastic_transcoder/client.rb +0 -1755
- data/lib/aws/elasticache/client.rb +0 -947
- data/lib/aws/elb/client.rb +0 -509
- data/lib/aws/emr/client.rb +0 -314
- data/lib/aws/glacier/client.rb +0 -278
- data/lib/aws/iam/client.rb +0 -1155
- data/lib/aws/import_export/client.rb +0 -96
- data/lib/aws/ops_works/client.rb +0 -1255
- data/lib/aws/rds/client.rb +0 -2367
- data/lib/aws/redshift/client.rb +0 -1458
- data/lib/aws/route_53/client.rb +0 -420
- data/lib/aws/simple_db/client.rb +2 -250
- data/lib/aws/simple_email_service/client.rb +0 -282
- data/lib/aws/simple_workflow/client.rb +0 -1248
- data/lib/aws/sns/client.rb +0 -283
- data/lib/aws/sns/message.rb +1 -1
- data/lib/aws/sqs/client.rb +0 -255
- data/lib/aws/storage_gateway/client.rb +0 -582
- data/lib/aws/sts/client.rb +0 -183
- data/lib/aws/support/client.rb +0 -232
- data/lib/aws/version.rb +1 -1
- metadata +2 -3
- data/lib/aws/dynamo_db/client_base.rb +0 -92
@@ -39,362 +39,6 @@ module AWS
|
|
39
39
|
|
40
40
|
class Client::V20100515 < Client
|
41
41
|
|
42
|
-
# client methods #
|
43
|
-
|
44
|
-
# @!method cancel_update_stack(options = {})
|
45
|
-
# Calls the CancelUpdateStack API operation.
|
46
|
-
# @param [Hash] options
|
47
|
-
#
|
48
|
-
# * `:stack_name` - *required* - (String) The name or the unique
|
49
|
-
# identifier associated with the stack.
|
50
|
-
# @return [Core::Response]
|
51
|
-
|
52
|
-
# @!method create_stack(options = {})
|
53
|
-
# Calls the CreateStack API operation.
|
54
|
-
# @param [Hash] options
|
55
|
-
#
|
56
|
-
# * `:stack_name` - *required* - (String) The name associated with the
|
57
|
-
# stack. The name must be unique within your AWS account. Must
|
58
|
-
# contain only alphanumeric characters (case sensitive) and start
|
59
|
-
# with an alpha character. Maximum length of the name is 255
|
60
|
-
# characters.
|
61
|
-
# * `:template_body` - (String) Structure containing the template body.
|
62
|
-
# (For more information, go to the AWS CloudFormation User Guide.)
|
63
|
-
# Conditional: You must pass TemplateBody or TemplateURL. If both are
|
64
|
-
# passed, only TemplateBody is used.
|
65
|
-
# * `:template_url` - (String) Location of file containing the template
|
66
|
-
# body. The URL must point to a template (max size: 307,200 bytes)
|
67
|
-
# located in an S3 bucket in the same region as the stack. For more
|
68
|
-
# information, go to the AWS CloudFormation User Guide. Conditional:
|
69
|
-
# You must pass TemplateURL or TemplateBody. If both are passed, only
|
70
|
-
# TemplateBody is used.
|
71
|
-
# * `:parameters` - (Array<Hash>) A list of Parameter structures that
|
72
|
-
# specify input parameters for the stack.
|
73
|
-
# * `:parameter_key` - (String) The key associated with the
|
74
|
-
# parameter.
|
75
|
-
# * `:parameter_value` - (String) The value associated with the
|
76
|
-
# parameter.
|
77
|
-
# * `:disable_rollback` - (Boolean) Set to `true` to disable rollback
|
78
|
-
# of the stack if stack creation failed. You can specify either
|
79
|
-
# DisableRollback or OnFailure, but not both. Default: `false`
|
80
|
-
# * `:timeout_in_minutes` - (Integer) The amount of time that can pass
|
81
|
-
# before the stack status becomes CREATE_FAILED; if DisableRollback
|
82
|
-
# is not set or is set to `false` , the stack will be rolled back.
|
83
|
-
# * `:notification_arns` - (Array<String>) The Simple Notification
|
84
|
-
# Service (SNS) topic ARNs to publish stack related events. You can
|
85
|
-
# find your SNS topic ARNs using the SNS console or your Command Line
|
86
|
-
# Interface (CLI).
|
87
|
-
# * `:capabilities` - (Array<String>) The list of capabilities that you
|
88
|
-
# want to allow in the stack. If your template contains IAM
|
89
|
-
# resources, you must specify the CAPABILITY_IAM value for this
|
90
|
-
# parameter; otherwise, this action returns an
|
91
|
-
# InsufficientCapabilities error. IAM resources are the following:
|
92
|
-
# AWS::IAM::AccessKey, AWS::IAM::Group, AWS::IAM::Policy,
|
93
|
-
# AWS::IAM::User, and AWS::IAM::UserToGroupAddition.
|
94
|
-
# * `:on_failure` - (String) Determines what action will be taken if
|
95
|
-
# stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or
|
96
|
-
# DELETE. You can specify either OnFailure or DisableRollback, but
|
97
|
-
# not both. Default: ROLLBACK Valid values include:
|
98
|
-
# * `DO_NOTHING`
|
99
|
-
# * `ROLLBACK`
|
100
|
-
# * `DELETE`
|
101
|
-
# * `:tags` - (Array<Hash>) A set of user-defined Tags to associate
|
102
|
-
# with this stack, represented by key/value pairs. Tags defined for
|
103
|
-
# the stack are propogated to EC2 resources that are created as part
|
104
|
-
# of the stack. A maximum number of 10 tags can be specified.
|
105
|
-
# * `:key` - (String) Required. A string used to identify this tag.
|
106
|
-
# You can specify a maximum of 128 characters for a tag key. Tags
|
107
|
-
# owned by Amazon Web Services (AWS) have the reserved prefix:
|
108
|
-
# aws:.
|
109
|
-
# * `:value` - (String) Required. A string containing the value for
|
110
|
-
# this tag. You can specify a maximum of 256 characters for a tag
|
111
|
-
# value.
|
112
|
-
# @return [Core::Response]
|
113
|
-
# The #data method of the response object returns
|
114
|
-
# a hash with the following structure:
|
115
|
-
#
|
116
|
-
# * `:stack_id` - (String)
|
117
|
-
|
118
|
-
# @!method delete_stack(options = {})
|
119
|
-
# Calls the DeleteStack API operation.
|
120
|
-
# @param [Hash] options
|
121
|
-
#
|
122
|
-
# * `:stack_name` - *required* - (String) The name or the unique
|
123
|
-
# identifier associated with the stack.
|
124
|
-
# @return [Core::Response]
|
125
|
-
|
126
|
-
# @!method describe_stack_events(options = {})
|
127
|
-
# Calls the DescribeStackEvents API operation.
|
128
|
-
# @param [Hash] options
|
129
|
-
#
|
130
|
-
# * `:stack_name` - (String) The name or the unique identifier
|
131
|
-
# associated with the stack. Default: There is no default value.
|
132
|
-
# * `:next_token` - (String) String that identifies the start of the
|
133
|
-
# next list of events, if there is one. Default: There is no default
|
134
|
-
# value.
|
135
|
-
# @return [Core::Response]
|
136
|
-
# The #data method of the response object returns
|
137
|
-
# a hash with the following structure:
|
138
|
-
#
|
139
|
-
# * `:stack_events` - (Array<Hash>)
|
140
|
-
# * `:stack_id` - (String)
|
141
|
-
# * `:event_id` - (String)
|
142
|
-
# * `:stack_name` - (String)
|
143
|
-
# * `:logical_resource_id` - (String)
|
144
|
-
# * `:physical_resource_id` - (String)
|
145
|
-
# * `:resource_type` - (String)
|
146
|
-
# * `:timestamp` - (Time)
|
147
|
-
# * `:resource_status` - (String)
|
148
|
-
# * `:resource_status_reason` - (String)
|
149
|
-
# * `:resource_properties` - (String)
|
150
|
-
# * `:next_token` - (String)
|
151
|
-
|
152
|
-
# @!method describe_stack_resource(options = {})
|
153
|
-
# Calls the DescribeStackResource API operation.
|
154
|
-
# @param [Hash] options
|
155
|
-
#
|
156
|
-
# * `:stack_name` - *required* - (String) The name or the unique
|
157
|
-
# identifier associated with the stack. Default: There is no default
|
158
|
-
# value.
|
159
|
-
# * `:logical_resource_id` - *required* - (String) The logical name of
|
160
|
-
# the resource as specified in the template. Default: There is no
|
161
|
-
# default value.
|
162
|
-
# @return [Core::Response]
|
163
|
-
# The #data method of the response object returns
|
164
|
-
# a hash with the following structure:
|
165
|
-
#
|
166
|
-
# * `:stack_resource_detail` - (Hash)
|
167
|
-
# * `:stack_name` - (String)
|
168
|
-
# * `:stack_id` - (String)
|
169
|
-
# * `:logical_resource_id` - (String)
|
170
|
-
# * `:physical_resource_id` - (String)
|
171
|
-
# * `:resource_type` - (String)
|
172
|
-
# * `:last_updated_timestamp` - (Time)
|
173
|
-
# * `:resource_status` - (String)
|
174
|
-
# * `:resource_status_reason` - (String)
|
175
|
-
# * `:description` - (String)
|
176
|
-
# * `:metadata` - (String)
|
177
|
-
|
178
|
-
# @!method describe_stack_resources(options = {})
|
179
|
-
# Calls the DescribeStackResources API operation.
|
180
|
-
# @param [Hash] options
|
181
|
-
#
|
182
|
-
# * `:stack_name` - (String) The name or the unique identifier
|
183
|
-
# associated with the stack. Required: Conditional. If you do not
|
184
|
-
# specify StackName, you must specify PhysicalResourceId. Default:
|
185
|
-
# There is no default value.
|
186
|
-
# * `:logical_resource_id` - (String) The logical name of the resource
|
187
|
-
# as specified in the template. Default: There is no default value.
|
188
|
-
# * `:physical_resource_id` - (String) The name or unique identifier
|
189
|
-
# that corresponds to a physical instance ID of a resource supported
|
190
|
-
# by AWS CloudFormation. For example, for an Amazon Elastic Compute
|
191
|
-
# Cloud (EC2) instance, PhysicalResourceId corresponds to the
|
192
|
-
# InstanceId. You can pass the EC2 InstanceId to
|
193
|
-
# DescribeStackResources to find which stack the instance belongs to
|
194
|
-
# and what other resources are part of the stack. Required:
|
195
|
-
# Conditional. If you do not specify PhysicalResourceId, you must
|
196
|
-
# specify StackName. Default: There is no default value.
|
197
|
-
# @return [Core::Response]
|
198
|
-
# The #data method of the response object returns
|
199
|
-
# a hash with the following structure:
|
200
|
-
#
|
201
|
-
# * `:stack_resources` - (Array<Hash>)
|
202
|
-
# * `:stack_name` - (String)
|
203
|
-
# * `:stack_id` - (String)
|
204
|
-
# * `:logical_resource_id` - (String)
|
205
|
-
# * `:physical_resource_id` - (String)
|
206
|
-
# * `:resource_type` - (String)
|
207
|
-
# * `:timestamp` - (Time)
|
208
|
-
# * `:resource_status` - (String)
|
209
|
-
# * `:resource_status_reason` - (String)
|
210
|
-
# * `:description` - (String)
|
211
|
-
|
212
|
-
# @!method describe_stacks(options = {})
|
213
|
-
# Calls the DescribeStacks API operation.
|
214
|
-
# @param [Hash] options
|
215
|
-
#
|
216
|
-
# * `:stack_name` - (String) The name or the unique identifier
|
217
|
-
# associated with the stack. Default: There is no default value.
|
218
|
-
# * `:next_token` - (String)
|
219
|
-
# @return [Core::Response]
|
220
|
-
# The #data method of the response object returns
|
221
|
-
# a hash with the following structure:
|
222
|
-
#
|
223
|
-
# * `:stacks` - (Array<Hash>)
|
224
|
-
# * `:stack_id` - (String)
|
225
|
-
# * `:stack_name` - (String)
|
226
|
-
# * `:description` - (String)
|
227
|
-
# * `:parameters` - (Array<Hash>)
|
228
|
-
# * `:parameter_key` - (String)
|
229
|
-
# * `:parameter_value` - (String)
|
230
|
-
# * `:creation_time` - (Time)
|
231
|
-
# * `:last_updated_time` - (Time)
|
232
|
-
# * `:stack_status` - (String)
|
233
|
-
# * `:stack_status_reason` - (String)
|
234
|
-
# * `:disable_rollback` - (Boolean)
|
235
|
-
# * `:notification_arns` - (Array<String>)
|
236
|
-
# * `:timeout_in_minutes` - (Integer)
|
237
|
-
# * `:capabilities` - (Array<String>)
|
238
|
-
# * `:outputs` - (Array<Hash>)
|
239
|
-
# * `:output_key` - (String)
|
240
|
-
# * `:output_value` - (String)
|
241
|
-
# * `:description` - (String)
|
242
|
-
# * `:tags` - (Array<Hash>)
|
243
|
-
# * `:key` - (String)
|
244
|
-
# * `:value` - (String)
|
245
|
-
# * `:next_token` - (String)
|
246
|
-
|
247
|
-
# @!method estimate_template_cost(options = {})
|
248
|
-
# Calls the EstimateTemplateCost API operation.
|
249
|
-
# @param [Hash] options
|
250
|
-
#
|
251
|
-
# * `:template_body` - (String) Structure containing the template body.
|
252
|
-
# (For more information, go to the AWS CloudFormation User Guide.)
|
253
|
-
# Conditional: You must pass TemplateBody or TemplateURL. If both are
|
254
|
-
# passed, only TemplateBody is used.
|
255
|
-
# * `:template_url` - (String) Location of file containing the template
|
256
|
-
# body. The URL must point to a template located in an S3 bucket in
|
257
|
-
# the same region as the stack. For more information, go to the AWS
|
258
|
-
# CloudFormation User Guide. Conditional: You must pass TemplateURL
|
259
|
-
# or TemplateBody. If both are passed, only TemplateBody is used.
|
260
|
-
# * `:parameters` - (Array<Hash>) A list of Parameter structures that
|
261
|
-
# specify input parameters.
|
262
|
-
# * `:parameter_key` - (String) The key associated with the
|
263
|
-
# parameter.
|
264
|
-
# * `:parameter_value` - (String) The value associated with the
|
265
|
-
# parameter.
|
266
|
-
# @return [Core::Response]
|
267
|
-
# The #data method of the response object returns
|
268
|
-
# a hash with the following structure:
|
269
|
-
#
|
270
|
-
# * `:url` - (String)
|
271
|
-
|
272
|
-
# @!method get_template(options = {})
|
273
|
-
# Calls the GetTemplate API operation.
|
274
|
-
# @param [Hash] options
|
275
|
-
#
|
276
|
-
# * `:stack_name` - *required* - (String) The name or the unique
|
277
|
-
# identifier associated with the stack.
|
278
|
-
# @return [Core::Response]
|
279
|
-
# The #data method of the response object returns
|
280
|
-
# a hash with the following structure:
|
281
|
-
#
|
282
|
-
# * `:template_body` - (String)
|
283
|
-
|
284
|
-
# @!method list_stack_resources(options = {})
|
285
|
-
# Calls the ListStackResources API operation.
|
286
|
-
# @param [Hash] options
|
287
|
-
#
|
288
|
-
# * `:stack_name` - *required* - (String) The name or the unique
|
289
|
-
# identifier associated with the stack. Default: There is no default
|
290
|
-
# value.
|
291
|
-
# * `:next_token` - (String) String that identifies the start of the
|
292
|
-
# next list of stack resource summaries, if there is one. Default:
|
293
|
-
# There is no default value.
|
294
|
-
# @return [Core::Response]
|
295
|
-
# The #data method of the response object returns
|
296
|
-
# a hash with the following structure:
|
297
|
-
#
|
298
|
-
# * `:stack_resource_summaries` - (Array<Hash>)
|
299
|
-
# * `:logical_resource_id` - (String)
|
300
|
-
# * `:physical_resource_id` - (String)
|
301
|
-
# * `:resource_type` - (String)
|
302
|
-
# * `:last_updated_timestamp` - (Time)
|
303
|
-
# * `:resource_status` - (String)
|
304
|
-
# * `:resource_status_reason` - (String)
|
305
|
-
# * `:next_token` - (String)
|
306
|
-
|
307
|
-
# @!method list_stacks(options = {})
|
308
|
-
# Calls the ListStacks API operation.
|
309
|
-
# @param [Hash] options
|
310
|
-
#
|
311
|
-
# * `:next_token` - (String) String that identifies the start of the
|
312
|
-
# next list of stacks, if there is one. Default: There is no default
|
313
|
-
# value.
|
314
|
-
# * `:stack_status_filter` - (Array<String>) Stack status to use as a
|
315
|
-
# filter. Specify one or more stack status codes to list only stacks
|
316
|
-
# with the specified status codes. For a complete list of stack
|
317
|
-
# status codes, see the StackStatus parameter of the Stack data type.
|
318
|
-
# @return [Core::Response]
|
319
|
-
# The #data method of the response object returns
|
320
|
-
# a hash with the following structure:
|
321
|
-
#
|
322
|
-
# * `:stack_summaries` - (Array<Hash>)
|
323
|
-
# * `:stack_id` - (String)
|
324
|
-
# * `:stack_name` - (String)
|
325
|
-
# * `:template_description` - (String)
|
326
|
-
# * `:creation_time` - (Time)
|
327
|
-
# * `:last_updated_time` - (Time)
|
328
|
-
# * `:deletion_time` - (Time)
|
329
|
-
# * `:stack_status` - (String)
|
330
|
-
# * `:stack_status_reason` - (String)
|
331
|
-
# * `:next_token` - (String)
|
332
|
-
|
333
|
-
# @!method update_stack(options = {})
|
334
|
-
# Calls the UpdateStack API operation.
|
335
|
-
# @param [Hash] options
|
336
|
-
#
|
337
|
-
# * `:stack_name` - *required* - (String) The name or stack ID of the
|
338
|
-
# stack to update. Must contain only alphanumeric characters (case
|
339
|
-
# sensitive) and start with an alpha character. Maximum length of the
|
340
|
-
# name is 255 characters.
|
341
|
-
# * `:template_body` - (String) Structure containing the template body.
|
342
|
-
# (For more information, go to the AWS CloudFormation User Guide.)
|
343
|
-
# Conditional: You must pass TemplateBody or TemplateURL. If both are
|
344
|
-
# passed, only TemplateBody is used.
|
345
|
-
# * `:template_url` - (String) Location of file containing the template
|
346
|
-
# body. The URL must point to a template located in an S3 bucket in
|
347
|
-
# the same region as the stack. For more information, go to the AWS
|
348
|
-
# CloudFormation User Guide. Conditional: You must pass TemplateURL
|
349
|
-
# or TemplateBody. If both are passed, only TemplateBody is used.
|
350
|
-
# * `:parameters` - (Array<Hash>) A list of Parameter structures that
|
351
|
-
# specify input parameters for the stack.
|
352
|
-
# * `:parameter_key` - (String) The key associated with the
|
353
|
-
# parameter.
|
354
|
-
# * `:parameter_value` - (String) The value associated with the
|
355
|
-
# parameter.
|
356
|
-
# * `:capabilities` - (Array<String>) The list of capabilities that you
|
357
|
-
# want to allow in the stack. If your stack contains IAM resources,
|
358
|
-
# you must specify the CAPABILITY_IAM value for this parameter;
|
359
|
-
# otherwise, this action returns an InsufficientCapabilities error.
|
360
|
-
# IAM resources are the following: AWS::IAM::AccessKey,
|
361
|
-
# AWS::IAM::Group, AWS::IAM::Policy, AWS::IAM::User, and
|
362
|
-
# AWS::IAM::UserToGroupAddition.
|
363
|
-
# @return [Core::Response]
|
364
|
-
# The #data method of the response object returns
|
365
|
-
# a hash with the following structure:
|
366
|
-
#
|
367
|
-
# * `:stack_id` - (String)
|
368
|
-
|
369
|
-
# @!method validate_template(options = {})
|
370
|
-
# Calls the ValidateTemplate API operation.
|
371
|
-
# @param [Hash] options
|
372
|
-
#
|
373
|
-
# * `:template_body` - (String) String containing the template body.
|
374
|
-
# (For more information, go to the AWS CloudFormation User Guide.)
|
375
|
-
# Conditional: You must pass TemplateURL or TemplateBody. If both are
|
376
|
-
# passed, only TemplateBody is used.
|
377
|
-
# * `:template_url` - (String) Location of file containing the template
|
378
|
-
# body. The URL must point to a template (max size: 307,200 bytes)
|
379
|
-
# located in an S3 bucket in the same region as the stack. For more
|
380
|
-
# information, go to the AWS CloudFormation User Guide. Conditional:
|
381
|
-
# You must pass TemplateURL or TemplateBody. If both are passed, only
|
382
|
-
# TemplateBody is used.
|
383
|
-
# @return [Core::Response]
|
384
|
-
# The #data method of the response object returns
|
385
|
-
# a hash with the following structure:
|
386
|
-
#
|
387
|
-
# * `:parameters` - (Array<Hash>)
|
388
|
-
# * `:parameter_key` - (String)
|
389
|
-
# * `:default_value` - (String)
|
390
|
-
# * `:no_echo` - (Boolean)
|
391
|
-
# * `:description` - (String)
|
392
|
-
# * `:description` - (String)
|
393
|
-
# * `:capabilities` - (Array<String>)
|
394
|
-
# * `:capabilities_reason` - (String)
|
395
|
-
|
396
|
-
# end client methods #
|
397
|
-
|
398
42
|
define_client_methods('2010-05-15')
|
399
43
|
|
400
44
|
end
|
@@ -25,1573 +25,6 @@ module AWS
|
|
25
25
|
|
26
26
|
class Client::V20130512 < Client
|
27
27
|
|
28
|
-
# client methods #
|
29
|
-
|
30
|
-
# @!method create_cloud_front_origin_access_identity(options = {})
|
31
|
-
# Calls the POST CreateCloudFrontOriginAccessIdentity API operation.
|
32
|
-
# @param [Hash] options
|
33
|
-
#
|
34
|
-
# * `:cloud_front_origin_access_identity_config` - *required* - (Hash)
|
35
|
-
# The origin access identity's configuration information.
|
36
|
-
# * `:caller_reference` - *required* - (String) A unique number that
|
37
|
-
# ensures the request can't be replayed. If the CallerReference is
|
38
|
-
# new (no matter the content of the
|
39
|
-
# CloudFrontOriginAccessIdentityConfig object), a new origin access
|
40
|
-
# identity is created. If the CallerReference is a value you
|
41
|
-
# already sent in a previous request to create an identity, and the
|
42
|
-
# content of the CloudFrontOriginAccessIdentityConfig is identical
|
43
|
-
# to the original request (ignoring white space), the response
|
44
|
-
# includes the same information returned to the original request.
|
45
|
-
# If the CallerReference is a value you already sent in a previous
|
46
|
-
# request to create an identity but the content of the
|
47
|
-
# CloudFrontOriginAccessIdentityConfig is different from the
|
48
|
-
# original request, CloudFront returns a
|
49
|
-
# CloudFrontOriginAccessIdentityAlreadyExists error.
|
50
|
-
# * `:comment` - *required* - (String) Any comments you want to
|
51
|
-
# include about the origin access identity.
|
52
|
-
# @return [Core::Response]
|
53
|
-
# The #data method of the response object returns
|
54
|
-
# a hash with the following structure:
|
55
|
-
#
|
56
|
-
# * `:id` - (String)
|
57
|
-
# * `:s3_canonical_user_id` - (String)
|
58
|
-
# * `:cloud_front_origin_access_identity_config` - (Hash)
|
59
|
-
# * `:caller_reference` - (String)
|
60
|
-
# * `:comment` - (String)
|
61
|
-
|
62
|
-
# @!method create_distribution(options = {})
|
63
|
-
# Calls the POST CreateDistribution API operation.
|
64
|
-
# @param [Hash] options
|
65
|
-
#
|
66
|
-
# * `:distribution_config` - *required* - (Hash) The distribution's
|
67
|
-
# configuration information.
|
68
|
-
# * `:caller_reference` - *required* - (String) A unique number that
|
69
|
-
# ensures the request can't be replayed. If the CallerReference is
|
70
|
-
# new (no matter the content of the DistributionConfig object), a
|
71
|
-
# new distribution is created. If the CallerReference is a value
|
72
|
-
# you already sent in a previous request to create a distribution,
|
73
|
-
# and the content of the DistributionConfig is identical to the
|
74
|
-
# original request (ignoring white space), the response includes
|
75
|
-
# the same information returned to the original request. If the
|
76
|
-
# CallerReference is a value you already sent in a previous request
|
77
|
-
# to create a distribution but the content of the
|
78
|
-
# DistributionConfig is different from the original request,
|
79
|
-
# CloudFront returns a DistributionAlreadyExists error.
|
80
|
-
# * `:aliases` - *required* - (Hash) A complex type that contains
|
81
|
-
# information about CNAMEs (alternate domain names), if any, for
|
82
|
-
# this distribution.
|
83
|
-
# * `:quantity` - *required* - (Integer) The number of CNAMEs, if
|
84
|
-
# any, for this distribution.
|
85
|
-
# * `:items` - (Array<String>) Optional: A complex type that
|
86
|
-
# contains CNAME elements, if any, for this distribution. If
|
87
|
-
# Quantity is 0, you can omit Items.
|
88
|
-
# * `:default_root_object` - *required* - (String) The object that
|
89
|
-
# you want CloudFront to return (for example, index.html) when an
|
90
|
-
# end user requests the root URL for your distribution
|
91
|
-
# (http://www.example.com) instead of an object in your
|
92
|
-
# distribution (http://www.example.com/index.html). Specifying a
|
93
|
-
# default root object avoids exposing the contents of your
|
94
|
-
# distribution. If you don't want to specify a default root object
|
95
|
-
# when you create a distribution, include an empty
|
96
|
-
# DefaultRootObject element. To delete the default root object from
|
97
|
-
# an existing distribution, update the distribution configuration
|
98
|
-
# and include an empty DefaultRootObject element. To replace the
|
99
|
-
# default root object, update the distribution configuration and
|
100
|
-
# specify the new object.
|
101
|
-
# * `:origins` - *required* - (Hash) A complex type that contains
|
102
|
-
# information about origins for this distribution.
|
103
|
-
# * `:quantity` - *required* - (Integer) The number of origins for
|
104
|
-
# this distribution.
|
105
|
-
# * `:items` - (Array<Hash>) A complex type that contains origins
|
106
|
-
# for this distribution.
|
107
|
-
# * `:id` - *required* - (String) A unique identifier for the
|
108
|
-
# origin. The value of Id must be unique within the
|
109
|
-
# distribution. You use the value of Id when you create a cache
|
110
|
-
# behavior. The Id identifies the origin that CloudFront routes
|
111
|
-
# a request to when the request matches the path pattern for
|
112
|
-
# that cache behavior.
|
113
|
-
# * `:domain_name` - *required* - (String) Amazon S3 origins: The
|
114
|
-
# DNS name of the Amazon S3 bucket from which you want
|
115
|
-
# CloudFront to get objects for this origin, for example,
|
116
|
-
# myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain
|
117
|
-
# name for the HTTP server from which you want CloudFront to
|
118
|
-
# get objects for this origin, for example, www.example.com.
|
119
|
-
# * `:s3_origin_config` - (Hash) A complex type that contains
|
120
|
-
# information about the Amazon S3 origin. If the origin is a
|
121
|
-
# custom origin, use the CustomOriginConfig element instead.
|
122
|
-
# * `:origin_access_identity` - *required* - (String) The
|
123
|
-
# CloudFront origin access identity to associate with the
|
124
|
-
# origin. Use an origin access identity to configure the
|
125
|
-
# origin so that end users can only access objects in an
|
126
|
-
# Amazon S3 bucket through CloudFront. If you want end users
|
127
|
-
# to be able to access objects using either the CloudFront
|
128
|
-
# URL or the Amazon S3 URL, specify an empty
|
129
|
-
# OriginAccessIdentity element. To delete the origin access
|
130
|
-
# identity from an existing distribution, update the
|
131
|
-
# distribution configuration and include an empty
|
132
|
-
# OriginAccessIdentity element. To replace the origin access
|
133
|
-
# identity, update the distribution configuration and specify
|
134
|
-
# the new origin access identity.
|
135
|
-
# * `:custom_origin_config` - (Hash) A complex type that contains
|
136
|
-
# information about a custom origin. If the origin is an Amazon
|
137
|
-
# S3 bucket, use the S3OriginConfig element instead.
|
138
|
-
# * `:http_port` - *required* - (Integer) The HTTP port the
|
139
|
-
# custom origin listens on.
|
140
|
-
# * `:https_port` - *required* - (Integer) The HTTPS port the
|
141
|
-
# custom origin listens on.
|
142
|
-
# * `:origin_protocol_policy` - *required* - (String) The
|
143
|
-
# origin protocol policy to apply to your origin. Valid
|
144
|
-
# values include:
|
145
|
-
# * `http-only`
|
146
|
-
# * `match-viewer`
|
147
|
-
# * `:default_cache_behavior` - *required* - (Hash) A complex type
|
148
|
-
# that describes the default cache behavior if you do not specify a
|
149
|
-
# CacheBehavior element or if files don't match any of the values
|
150
|
-
# of PathPattern in CacheBehavior elements.You must create exactly
|
151
|
-
# one default cache behavior.
|
152
|
-
# * `:target_origin_id` - *required* - (String) The value of ID for
|
153
|
-
# the origin that you want CloudFront to route requests to when a
|
154
|
-
# request matches the path pattern either for a cache behavior or
|
155
|
-
# for the default cache behavior.
|
156
|
-
# * `:forwarded_values` - *required* - (Hash) A complex type that
|
157
|
-
# specifies how CloudFront handles query strings and cookies.
|
158
|
-
# * `:query_string` - *required* - (Boolean) Indicates whether
|
159
|
-
# you want CloudFront to forward query strings to the origin
|
160
|
-
# that is associated with this cache behavior. If so, specify
|
161
|
-
# `true` ; if not, specify `false` .
|
162
|
-
# * `:cookies` - *required* - (Hash) A complex type that
|
163
|
-
# specifies how CloudFront handles cookies.
|
164
|
-
# * `:forward` - *required* - (String) Use this element to
|
165
|
-
# specify whether you want CloudFront to forward cookies to
|
166
|
-
# the origin that is associated with this cache behavior. You
|
167
|
-
# can specify all, none or whitelist. If you choose All,
|
168
|
-
# CloudFront forwards all cookies regardless of how many your
|
169
|
-
# application uses. Valid values include:
|
170
|
-
# * `none`
|
171
|
-
# * `whitelist`
|
172
|
-
# * `all`
|
173
|
-
# * `:whitelisted_names` - (Hash) A complex type that specifies
|
174
|
-
# the whitelisted cookies, if any, that you want CloudFront
|
175
|
-
# to forward to your origin that is associated with this
|
176
|
-
# cache behavior.
|
177
|
-
# * `:quantity` - *required* - (Integer) The number of
|
178
|
-
# whitelisted cookies for this cache behavior.
|
179
|
-
# * `:items` - (Array<String>) Optional: A complex type that
|
180
|
-
# contains whitelisted cookies for this cache behavior. If
|
181
|
-
# Quantity is 0, you can omit Items.
|
182
|
-
# * `:trusted_signers` - *required* - (Hash) A complex type that
|
183
|
-
# specifies the AWS accounts, if any, that you want to allow to
|
184
|
-
# create signed URLs for private content. If you want to require
|
185
|
-
# signed URLs in requests for objects in the target origin that
|
186
|
-
# match the PathPattern for this cache behavior, specify `true`
|
187
|
-
# for Enabled, and specify the applicable values for Quantity and
|
188
|
-
# Items. For more information, go to Using a Signed URL to Serve
|
189
|
-
# Private Content in the Amazon CloudFront Developer Guide. If
|
190
|
-
# you don't want to require signed URLs in requests for objects
|
191
|
-
# that match PathPattern, specify `false` for Enabled and 0 for
|
192
|
-
# Quantity. Omit Items. To add, change, or remove one or more
|
193
|
-
# trusted signers, change Enabled to `true` (if it's currently
|
194
|
-
# `false` ), change Quantity as applicable, and specify all of
|
195
|
-
# the trusted signers that you want to include in the updated
|
196
|
-
# distribution.
|
197
|
-
# * `:enabled` - *required* - (Boolean) Specifies whether you
|
198
|
-
# want to require end users to use signed URLs to access the
|
199
|
-
# files specified by PathPattern and TargetOriginId.
|
200
|
-
# * `:quantity` - *required* - (Integer) The number of trusted
|
201
|
-
# signers for this cache behavior.
|
202
|
-
# * `:items` - (Array<String>) Optional: A complex type that
|
203
|
-
# contains trusted signers for this cache behavior. If Quantity
|
204
|
-
# is 0, you can omit Items.
|
205
|
-
# * `:viewer_protocol_policy` - *required* - (String) Use this
|
206
|
-
# element to specify the protocol that users can use to access
|
207
|
-
# the files in the origin specified by TargetOriginId when a
|
208
|
-
# request matches the path pattern in PathPattern. If you want
|
209
|
-
# CloudFront to allow end users to use any available protocol,
|
210
|
-
# specify allow-all. If you want CloudFront to require HTTPS,
|
211
|
-
# specify https. Valid values include:
|
212
|
-
# * `allow-all`
|
213
|
-
# * `https-only`
|
214
|
-
# * `:min_ttl` - *required* - (Integer) The minimum amount of time
|
215
|
-
# that you want objects to stay in CloudFront caches before
|
216
|
-
# CloudFront queries your origin to see whether the object has
|
217
|
-
# been updated.You can specify a value from 0 to 3,153,600,000
|
218
|
-
# seconds (100 years).
|
219
|
-
# * `:cache_behaviors` - *required* - (Hash) A complex type that
|
220
|
-
# contains zero or more CacheBehavior elements.
|
221
|
-
# * `:quantity` - *required* - (Integer) The number of cache
|
222
|
-
# behaviors for this distribution.
|
223
|
-
# * `:items` - (Array<Hash>) Optional: A complex type that contains
|
224
|
-
# cache behaviors for this distribution. If Quantity is 0, you
|
225
|
-
# can omit Items.
|
226
|
-
# * `:path_pattern` - *required* - (String) The pattern (for
|
227
|
-
# example, images/*.jpg) that specifies which requests you want
|
228
|
-
# this cache behavior to apply to. When CloudFront receives an
|
229
|
-
# end-user request, the requested path is compared with path
|
230
|
-
# patterns in the order in which cache behaviors are listed in
|
231
|
-
# the distribution. The path pattern for the default cache
|
232
|
-
# behavior is * and cannot be changed. If the request for an
|
233
|
-
# object does not match the path pattern for any cache
|
234
|
-
# behaviors, CloudFront applies the behavior in the default
|
235
|
-
# cache behavior.
|
236
|
-
# * `:target_origin_id` - *required* - (String) The value of ID
|
237
|
-
# for the origin that you want CloudFront to route requests to
|
238
|
-
# when a request matches the path pattern either for a cache
|
239
|
-
# behavior or for the default cache behavior.
|
240
|
-
# * `:forwarded_values` - *required* - (Hash) A complex type that
|
241
|
-
# specifies how CloudFront handles query strings and cookies.
|
242
|
-
# * `:query_string` - *required* - (Boolean) Indicates whether
|
243
|
-
# you want CloudFront to forward query strings to the origin
|
244
|
-
# that is associated with this cache behavior. If so, specify
|
245
|
-
# `true` ; if not, specify `false` .
|
246
|
-
# * `:cookies` - *required* - (Hash) A complex type that
|
247
|
-
# specifies how CloudFront handles cookies.
|
248
|
-
# * `:forward` - *required* - (String) Use this element to
|
249
|
-
# specify whether you want CloudFront to forward cookies to
|
250
|
-
# the origin that is associated with this cache behavior.
|
251
|
-
# You can specify all, none or whitelist. If you choose
|
252
|
-
# All, CloudFront forwards all cookies regardless of how
|
253
|
-
# many your application uses. Valid values include:
|
254
|
-
# * `none`
|
255
|
-
# * `whitelist`
|
256
|
-
# * `all`
|
257
|
-
# * `:whitelisted_names` - (Hash) A complex type that
|
258
|
-
# specifies the whitelisted cookies, if any, that you want
|
259
|
-
# CloudFront to forward to your origin that is associated
|
260
|
-
# with this cache behavior.
|
261
|
-
# * `:quantity` - *required* - (Integer) The number of
|
262
|
-
# whitelisted cookies for this cache behavior.
|
263
|
-
# * `:items` - (Array<String>) Optional: A complex type
|
264
|
-
# that contains whitelisted cookies for this cache
|
265
|
-
# behavior. If Quantity is 0, you can omit Items.
|
266
|
-
# * `:trusted_signers` - *required* - (Hash) A complex type that
|
267
|
-
# specifies the AWS accounts, if any, that you want to allow to
|
268
|
-
# create signed URLs for private content. If you want to
|
269
|
-
# require signed URLs in requests for objects in the target
|
270
|
-
# origin that match the PathPattern for this cache behavior,
|
271
|
-
# specify `true` for Enabled, and specify the applicable values
|
272
|
-
# for Quantity and Items. For more information, go to Using a
|
273
|
-
# Signed URL to Serve Private Content in the Amazon CloudFront
|
274
|
-
# Developer Guide. If you don't want to require signed URLs in
|
275
|
-
# requests for objects that match PathPattern, specify `false`
|
276
|
-
# for Enabled and 0 for Quantity. Omit Items. To add, change,
|
277
|
-
# or remove one or more trusted signers, change Enabled to
|
278
|
-
# `true` (if it's currently `false` ), change Quantity as
|
279
|
-
# applicable, and specify all of the trusted signers that you
|
280
|
-
# want to include in the updated distribution.
|
281
|
-
# * `:enabled` - *required* - (Boolean) Specifies whether you
|
282
|
-
# want to require end users to use signed URLs to access the
|
283
|
-
# files specified by PathPattern and TargetOriginId.
|
284
|
-
# * `:quantity` - *required* - (Integer) The number of trusted
|
285
|
-
# signers for this cache behavior.
|
286
|
-
# * `:items` - (Array<String>) Optional: A complex type that
|
287
|
-
# contains trusted signers for this cache behavior. If
|
288
|
-
# Quantity is 0, you can omit Items.
|
289
|
-
# * `:viewer_protocol_policy` - *required* - (String) Use this
|
290
|
-
# element to specify the protocol that users can use to access
|
291
|
-
# the files in the origin specified by TargetOriginId when a
|
292
|
-
# request matches the path pattern in PathPattern. If you want
|
293
|
-
# CloudFront to allow end users to use any available protocol,
|
294
|
-
# specify allow-all. If you want CloudFront to require HTTPS,
|
295
|
-
# specify https. Valid values include:
|
296
|
-
# * `allow-all`
|
297
|
-
# * `https-only`
|
298
|
-
# * `:min_ttl` - *required* - (Integer) The minimum amount of
|
299
|
-
# time that you want objects to stay in CloudFront caches
|
300
|
-
# before CloudFront queries your origin to see whether the
|
301
|
-
# object has been updated.You can specify a value from 0 to
|
302
|
-
# 3,153,600,000 seconds (100 years).
|
303
|
-
# * `:comment` - *required* - (String) Any comments you want to
|
304
|
-
# include about the distribution.
|
305
|
-
# * `:logging` - *required* - (Hash) A complex type that controls
|
306
|
-
# whether access logs are written for the distribution.
|
307
|
-
# * `:enabled` - *required* - (Boolean) Specifies whether you want
|
308
|
-
# CloudFront to save access logs to an Amazon S3 bucket. If you
|
309
|
-
# do not want to enable logging when you create a distribution or
|
310
|
-
# if you want to disable logging for an existing distribution,
|
311
|
-
# specify `false` for Enabled, and specify empty Bucket and
|
312
|
-
# Prefix elements. If you specify `false` for Enabled but you
|
313
|
-
# specify values for Bucket, prefix and IncludeCookies, the
|
314
|
-
# values are automatically deleted.
|
315
|
-
# * `:include_cookies` - *required* - (Boolean) Specifies whether
|
316
|
-
# you want CloudFront to include cookies in access logs, specify
|
317
|
-
# `true` for IncludeCookies. If you choose to include cookies in
|
318
|
-
# logs, CloudFront logs all cookies regardless of how you
|
319
|
-
# configure the cache behaviors for this distribution. If you do
|
320
|
-
# not want to include cookies when you create a distribution or
|
321
|
-
# if you want to disable include cookies for an existing
|
322
|
-
# distribution, specify `false` for IncludeCookies.
|
323
|
-
# * `:bucket` - *required* - (String) The Amazon S3 bucket to store
|
324
|
-
# the access logs in, for example,
|
325
|
-
# myawslogbucket.s3.amazonaws.com.
|
326
|
-
# * `:prefix` - *required* - (String) An optional string that you
|
327
|
-
# want CloudFront to prefix to the access log filenames for this
|
328
|
-
# distribution, for example, myprefix/. If you want to enable
|
329
|
-
# logging, but you do not want to specify a prefix, you still
|
330
|
-
# must include an empty Prefix element in the Logging element.
|
331
|
-
# * `:price_class` - *required* - (String) A complex type that
|
332
|
-
# contains information about price class for this distribution.
|
333
|
-
# Valid values include:
|
334
|
-
# * `PriceClass_100`
|
335
|
-
# * `PriceClass_200`
|
336
|
-
# * `PriceClass_All`
|
337
|
-
# * `:enabled` - *required* - (Boolean) Whether the distribution is
|
338
|
-
# enabled to accept end user requests for content.
|
339
|
-
# * `:viewer_certificate` - (Hash)
|
340
|
-
# * `:iam_certificate_id` - (String) The IAM certificate identifier
|
341
|
-
# of the custom viewer certificate for this distribution.
|
342
|
-
# * `:cloud_front_default_certificate` - (Boolean) Set to `true` if
|
343
|
-
# you want to use the default *.cloudfront.net viewer certificate
|
344
|
-
# for this distribution. Omit this value if you are setting an
|
345
|
-
# IAMCertificateId.
|
346
|
-
# @return [Core::Response]
|
347
|
-
# The #data method of the response object returns
|
348
|
-
# a hash with the following structure:
|
349
|
-
#
|
350
|
-
# * `:id` - (String)
|
351
|
-
# * `:status` - (String)
|
352
|
-
# * `:last_modified_time` - (Time)
|
353
|
-
# * `:in_progress_invalidation_batches` - (Integer)
|
354
|
-
# * `:domain_name` - (String)
|
355
|
-
# * `:active_trusted_signers` - (Hash)
|
356
|
-
# * `:enabled` - (Boolean)
|
357
|
-
# * `:quantity` - (Integer)
|
358
|
-
# * `:items` - (Array<Hash>)
|
359
|
-
# * `:aws_account_number` - (String)
|
360
|
-
# * `:key_pair_ids` - (Hash)
|
361
|
-
# * `:quantity` - (Integer)
|
362
|
-
# * `:items` - (Array<String>)
|
363
|
-
# * `:distribution_config` - (Hash)
|
364
|
-
# * `:caller_reference` - (String)
|
365
|
-
# * `:aliases` - (Hash)
|
366
|
-
# * `:quantity` - (Integer)
|
367
|
-
# * `:items` - (Array<String>)
|
368
|
-
# * `:default_root_object` - (String)
|
369
|
-
# * `:origins` - (Hash)
|
370
|
-
# * `:quantity` - (Integer)
|
371
|
-
# * `:items` - (Array<Hash>)
|
372
|
-
# * `:id` - (String)
|
373
|
-
# * `:domain_name` - (String)
|
374
|
-
# * `:s3_origin_config` - (Hash)
|
375
|
-
# * `:origin_access_identity` - (String)
|
376
|
-
# * `:custom_origin_config` - (Hash)
|
377
|
-
# * `:http_port` - (Integer)
|
378
|
-
# * `:https_port` - (Integer)
|
379
|
-
# * `:origin_protocol_policy` - (String)
|
380
|
-
# * `:default_cache_behavior` - (Hash)
|
381
|
-
# * `:target_origin_id` - (String)
|
382
|
-
# * `:forwarded_values` - (Hash)
|
383
|
-
# * `:query_string` - (Boolean)
|
384
|
-
# * `:cookies` - (Hash)
|
385
|
-
# * `:forward` - (String)
|
386
|
-
# * `:whitelisted_names` - (Hash)
|
387
|
-
# * `:quantity` - (Integer)
|
388
|
-
# * `:items` - (Array<String>)
|
389
|
-
# * `:trusted_signers` - (Hash)
|
390
|
-
# * `:enabled` - (Boolean)
|
391
|
-
# * `:quantity` - (Integer)
|
392
|
-
# * `:items` - (Array<String>)
|
393
|
-
# * `:viewer_protocol_policy` - (String)
|
394
|
-
# * `:min_ttl` - (Integer)
|
395
|
-
# * `:cache_behaviors` - (Hash)
|
396
|
-
# * `:quantity` - (Integer)
|
397
|
-
# * `:items` - (Array<Hash>)
|
398
|
-
# * `:path_pattern` - (String)
|
399
|
-
# * `:target_origin_id` - (String)
|
400
|
-
# * `:forwarded_values` - (Hash)
|
401
|
-
# * `:query_string` - (Boolean)
|
402
|
-
# * `:cookies` - (Hash)
|
403
|
-
# * `:forward` - (String)
|
404
|
-
# * `:whitelisted_names` - (Hash)
|
405
|
-
# * `:quantity` - (Integer)
|
406
|
-
# * `:items` - (Array<String>)
|
407
|
-
# * `:trusted_signers` - (Hash)
|
408
|
-
# * `:enabled` - (Boolean)
|
409
|
-
# * `:quantity` - (Integer)
|
410
|
-
# * `:items` - (Array<String>)
|
411
|
-
# * `:viewer_protocol_policy` - (String)
|
412
|
-
# * `:min_ttl` - (Integer)
|
413
|
-
# * `:comment` - (String)
|
414
|
-
# * `:logging` - (Hash)
|
415
|
-
# * `:enabled` - (Boolean)
|
416
|
-
# * `:include_cookies` - (Boolean)
|
417
|
-
# * `:bucket` - (String)
|
418
|
-
# * `:prefix` - (String)
|
419
|
-
# * `:price_class` - (String)
|
420
|
-
# * `:enabled` - (Boolean)
|
421
|
-
# * `:viewer_certificate` - (Hash)
|
422
|
-
# * `:iam_certificate_id` - (String)
|
423
|
-
# * `:cloud_front_default_certificate` - (Boolean)
|
424
|
-
|
425
|
-
# @!method create_invalidation(options = {})
|
426
|
-
# Calls the POST CreateInvalidation API operation.
|
427
|
-
# @param [Hash] options
|
428
|
-
#
|
429
|
-
# * `:distribution_id` - *required* - (String) The distribution's id.
|
430
|
-
# * `:invalidation_batch` - *required* - (Hash) The batch information
|
431
|
-
# for the invalidation.
|
432
|
-
# * `:paths` - *required* - (Hash) The path of the object to
|
433
|
-
# invalidate. The path is relative to the distribution and must
|
434
|
-
# begin with a slash (/). You must enclose each invalidation object
|
435
|
-
# with the Path element tags. If the path includes non-ASCII
|
436
|
-
# characters or unsafe characters as defined in RFC 1783
|
437
|
-
# (http://www.ietf.org/rfc/rfc1738.txt), URL encode those
|
438
|
-
# characters. Do not URL encode any other characters in the path,
|
439
|
-
# or CloudFront will not invalidate the old version of the updated
|
440
|
-
# object.
|
441
|
-
# * `:quantity` - *required* - (Integer) The number of objects that
|
442
|
-
# you want to invalidate.
|
443
|
-
# * `:items` - (Array<String>) A complex type that contains a list
|
444
|
-
# of the objects that you want to invalidate.
|
445
|
-
# * `:caller_reference` - *required* - (String) A unique name that
|
446
|
-
# ensures the request can't be replayed. If the CallerReference is
|
447
|
-
# new (no matter the content of the Path object), a new
|
448
|
-
# distribution is created. If the CallerReference is a value you
|
449
|
-
# already sent in a previous request to create an invalidation
|
450
|
-
# batch, and the content of each Path element is identical to the
|
451
|
-
# original request, the response includes the same information
|
452
|
-
# returned to the original request. If the CallerReference is a
|
453
|
-
# value you already sent in a previous request to create a
|
454
|
-
# distribution but the content of any Path is different from the
|
455
|
-
# original request, CloudFront returns an
|
456
|
-
# InvalidationBatchAlreadyExists error.
|
457
|
-
# @return [Core::Response]
|
458
|
-
# The #data method of the response object returns
|
459
|
-
# a hash with the following structure:
|
460
|
-
#
|
461
|
-
# * `:id` - (String)
|
462
|
-
# * `:status` - (String)
|
463
|
-
# * `:create_time` - (Time)
|
464
|
-
# * `:invalidation_batch` - (Hash)
|
465
|
-
# * `:paths` - (Hash)
|
466
|
-
# * `:quantity` - (Integer)
|
467
|
-
# * `:items` - (Array<String>)
|
468
|
-
# * `:caller_reference` - (String)
|
469
|
-
|
470
|
-
# @!method create_streaming_distribution(options = {})
|
471
|
-
# Calls the POST CreateStreamingDistribution API operation.
|
472
|
-
# @param [Hash] options
|
473
|
-
#
|
474
|
-
# * `:streaming_distribution_config` - *required* - (Hash) The
|
475
|
-
# streaming distribution's configuration information.
|
476
|
-
# * `:caller_reference` - *required* - (String) A unique number that
|
477
|
-
# ensures the request can't be replayed. If the CallerReference is
|
478
|
-
# new (no matter the content of the StreamingDistributionConfig
|
479
|
-
# object), a new streaming distribution is created. If the
|
480
|
-
# CallerReference is a value you already sent in a previous request
|
481
|
-
# to create a streaming distribution, and the content of the
|
482
|
-
# StreamingDistributionConfig is identical to the original request
|
483
|
-
# (ignoring white space), the response includes the same
|
484
|
-
# information returned to the original request. If the
|
485
|
-
# CallerReference is a value you already sent in a previous request
|
486
|
-
# to create a streaming distribution but the content of the
|
487
|
-
# StreamingDistributionConfig is different from the original
|
488
|
-
# request, CloudFront returns a DistributionAlreadyExists error.
|
489
|
-
# * `:s3_origin` - *required* - (Hash) A complex type that contains
|
490
|
-
# information about the Amazon S3 bucket from which you want
|
491
|
-
# CloudFront to get your media files for distribution.
|
492
|
-
# * `:domain_name` - *required* - (String) The DNS name of the S3
|
493
|
-
# origin.
|
494
|
-
# * `:origin_access_identity` - *required* - (String) Your S3
|
495
|
-
# origin's origin access identity.
|
496
|
-
# * `:aliases` - *required* - (Hash) A complex type that contains
|
497
|
-
# information about CNAMEs (alternate domain names), if any, for
|
498
|
-
# this streaming distribution.
|
499
|
-
# * `:quantity` - *required* - (Integer) The number of CNAMEs, if
|
500
|
-
# any, for this distribution.
|
501
|
-
# * `:items` - (Array<String>) Optional: A complex type that
|
502
|
-
# contains CNAME elements, if any, for this distribution. If
|
503
|
-
# Quantity is 0, you can omit Items.
|
504
|
-
# * `:comment` - *required* - (String) Any comments you want to
|
505
|
-
# include about the streaming distribution.
|
506
|
-
# * `:logging` - *required* - (Hash) A complex type that controls
|
507
|
-
# whether access logs are written for the streaming distribution.
|
508
|
-
# * `:enabled` - *required* - (Boolean) Specifies whether you want
|
509
|
-
# CloudFront to save access logs to an Amazon S3 bucket. If you
|
510
|
-
# do not want to enable logging when you create a streaming
|
511
|
-
# distribution or if you want to disable logging for an existing
|
512
|
-
# streaming distribution, specify `false` for Enabled, and
|
513
|
-
# specify empty Bucket and Prefix elements. If you specify
|
514
|
-
# `false` for Enabled but you specify values for Bucket and
|
515
|
-
# Prefix, the values are automatically deleted.
|
516
|
-
# * `:bucket` - *required* - (String) The Amazon S3 bucket to store
|
517
|
-
# the access logs in, for example,
|
518
|
-
# myawslogbucket.s3.amazonaws.com.
|
519
|
-
# * `:prefix` - *required* - (String) An optional string that you
|
520
|
-
# want CloudFront to prefix to the access log filenames for this
|
521
|
-
# streaming distribution, for example, myprefix/. If you want to
|
522
|
-
# enable logging, but you do not want to specify a prefix, you
|
523
|
-
# still must include an empty Prefix element in the Logging
|
524
|
-
# element.
|
525
|
-
# * `:trusted_signers` - *required* - (Hash) A complex type that
|
526
|
-
# specifies the AWS accounts, if any, that you want to allow to
|
527
|
-
# create signed URLs for private content. If you want to require
|
528
|
-
# signed URLs in requests for objects in the target origin that
|
529
|
-
# match the PathPattern for this cache behavior, specify `true` for
|
530
|
-
# Enabled, and specify the applicable values for Quantity and
|
531
|
-
# Items. For more information, go to Using a Signed URL to Serve
|
532
|
-
# Private Content in the Amazon CloudFront Developer Guide. If you
|
533
|
-
# don't want to require signed URLs in requests for objects that
|
534
|
-
# match PathPattern, specify `false` for Enabled and 0 for
|
535
|
-
# Quantity. Omit Items. To add, change, or remove one or more
|
536
|
-
# trusted signers, change Enabled to `true` (if it's currently
|
537
|
-
# `false` ), change Quantity as applicable, and specify all of the
|
538
|
-
# trusted signers that you want to include in the updated
|
539
|
-
# distribution.
|
540
|
-
# * `:enabled` - *required* - (Boolean) Specifies whether you want
|
541
|
-
# to require end users to use signed URLs to access the files
|
542
|
-
# specified by PathPattern and TargetOriginId.
|
543
|
-
# * `:quantity` - *required* - (Integer) The number of trusted
|
544
|
-
# signers for this cache behavior.
|
545
|
-
# * `:items` - (Array<String>) Optional: A complex type that
|
546
|
-
# contains trusted signers for this cache behavior. If Quantity
|
547
|
-
# is 0, you can omit Items.
|
548
|
-
# * `:price_class` - *required* - (String) A complex type that
|
549
|
-
# contains information about price class for this streaming
|
550
|
-
# distribution. Valid values include:
|
551
|
-
# * `PriceClass_100`
|
552
|
-
# * `PriceClass_200`
|
553
|
-
# * `PriceClass_All`
|
554
|
-
# * `:enabled` - *required* - (Boolean) Whether the streaming
|
555
|
-
# distribution is enabled to accept end user requests for content.
|
556
|
-
# @return [Core::Response]
|
557
|
-
# The #data method of the response object returns
|
558
|
-
# a hash with the following structure:
|
559
|
-
#
|
560
|
-
# * `:id` - (String)
|
561
|
-
# * `:status` - (String)
|
562
|
-
# * `:last_modified_time` - (Time)
|
563
|
-
# * `:domain_name` - (String)
|
564
|
-
# * `:active_trusted_signers` - (Hash)
|
565
|
-
# * `:enabled` - (Boolean)
|
566
|
-
# * `:quantity` - (Integer)
|
567
|
-
# * `:items` - (Array<Hash>)
|
568
|
-
# * `:aws_account_number` - (String)
|
569
|
-
# * `:key_pair_ids` - (Hash)
|
570
|
-
# * `:quantity` - (Integer)
|
571
|
-
# * `:items` - (Array<String>)
|
572
|
-
# * `:streaming_distribution_config` - (Hash)
|
573
|
-
# * `:caller_reference` - (String)
|
574
|
-
# * `:s3_origin` - (Hash)
|
575
|
-
# * `:domain_name` - (String)
|
576
|
-
# * `:origin_access_identity` - (String)
|
577
|
-
# * `:aliases` - (Hash)
|
578
|
-
# * `:quantity` - (Integer)
|
579
|
-
# * `:items` - (Array<String>)
|
580
|
-
# * `:comment` - (String)
|
581
|
-
# * `:logging` - (Hash)
|
582
|
-
# * `:enabled` - (Boolean)
|
583
|
-
# * `:bucket` - (String)
|
584
|
-
# * `:prefix` - (String)
|
585
|
-
# * `:trusted_signers` - (Hash)
|
586
|
-
# * `:enabled` - (Boolean)
|
587
|
-
# * `:quantity` - (Integer)
|
588
|
-
# * `:items` - (Array<String>)
|
589
|
-
# * `:price_class` - (String)
|
590
|
-
# * `:enabled` - (Boolean)
|
591
|
-
|
592
|
-
# @!method delete_cloud_front_origin_access_identity(options = {})
|
593
|
-
# Calls the DELETE DeleteCloudFrontOriginAccessIdentity API operation.
|
594
|
-
# @param [Hash] options
|
595
|
-
#
|
596
|
-
# * `:id` - *required* - (String) The origin access identity's id.
|
597
|
-
# * `:if_match` - (String) The value of the ETag header you received
|
598
|
-
# from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.
|
599
|
-
# @return [Core::Response]
|
600
|
-
|
601
|
-
# @!method delete_distribution(options = {})
|
602
|
-
# Calls the DELETE DeleteDistribution API operation.
|
603
|
-
# @param [Hash] options
|
604
|
-
#
|
605
|
-
# * `:id` - *required* - (String) The distribution id.
|
606
|
-
# * `:if_match` - (String) The value of the ETag header you received
|
607
|
-
# when you disabled the distribution. For example: E2QWRUHAPOMQZL.
|
608
|
-
# @return [Core::Response]
|
609
|
-
|
610
|
-
# @!method delete_streaming_distribution(options = {})
|
611
|
-
# Calls the DELETE DeleteStreamingDistribution API operation.
|
612
|
-
# @param [Hash] options
|
613
|
-
#
|
614
|
-
# * `:id` - *required* - (String) The distribution id.
|
615
|
-
# * `:if_match` - (String) The value of the ETag header you received
|
616
|
-
# when you disabled the streaming distribution. For example:
|
617
|
-
# E2QWRUHAPOMQZL.
|
618
|
-
# @return [Core::Response]
|
619
|
-
|
620
|
-
# @!method get_cloud_front_origin_access_identity(options = {})
|
621
|
-
# Calls the GET GetCloudFrontOriginAccessIdentity API operation.
|
622
|
-
# @param [Hash] options
|
623
|
-
#
|
624
|
-
# * `:id` - *required* - (String) The identity's id.
|
625
|
-
# @return [Core::Response]
|
626
|
-
# The #data method of the response object returns
|
627
|
-
# a hash with the following structure:
|
628
|
-
#
|
629
|
-
# * `:id` - (String)
|
630
|
-
# * `:s3_canonical_user_id` - (String)
|
631
|
-
# * `:cloud_front_origin_access_identity_config` - (Hash)
|
632
|
-
# * `:caller_reference` - (String)
|
633
|
-
# * `:comment` - (String)
|
634
|
-
|
635
|
-
# @!method get_cloud_front_origin_access_identity_config(options = {})
|
636
|
-
# Calls the GET GetCloudFrontOriginAccessIdentityConfig API operation.
|
637
|
-
# @param [Hash] options
|
638
|
-
#
|
639
|
-
# * `:id` - *required* - (String) The identity's id.
|
640
|
-
# @return [Core::Response]
|
641
|
-
# The #data method of the response object returns
|
642
|
-
# a hash with the following structure:
|
643
|
-
#
|
644
|
-
# * `:caller_reference` - (String)
|
645
|
-
# * `:comment` - (String)
|
646
|
-
|
647
|
-
# @!method get_distribution(options = {})
|
648
|
-
# Calls the GET GetDistribution API operation.
|
649
|
-
# @param [Hash] options
|
650
|
-
#
|
651
|
-
# * `:id` - *required* - (String) The distribution's id.
|
652
|
-
# @return [Core::Response]
|
653
|
-
# The #data method of the response object returns
|
654
|
-
# a hash with the following structure:
|
655
|
-
#
|
656
|
-
# * `:id` - (String)
|
657
|
-
# * `:status` - (String)
|
658
|
-
# * `:last_modified_time` - (Time)
|
659
|
-
# * `:in_progress_invalidation_batches` - (Integer)
|
660
|
-
# * `:domain_name` - (String)
|
661
|
-
# * `:active_trusted_signers` - (Hash)
|
662
|
-
# * `:enabled` - (Boolean)
|
663
|
-
# * `:quantity` - (Integer)
|
664
|
-
# * `:items` - (Array<Hash>)
|
665
|
-
# * `:aws_account_number` - (String)
|
666
|
-
# * `:key_pair_ids` - (Hash)
|
667
|
-
# * `:quantity` - (Integer)
|
668
|
-
# * `:items` - (Array<String>)
|
669
|
-
# * `:distribution_config` - (Hash)
|
670
|
-
# * `:caller_reference` - (String)
|
671
|
-
# * `:aliases` - (Hash)
|
672
|
-
# * `:quantity` - (Integer)
|
673
|
-
# * `:items` - (Array<String>)
|
674
|
-
# * `:default_root_object` - (String)
|
675
|
-
# * `:origins` - (Hash)
|
676
|
-
# * `:quantity` - (Integer)
|
677
|
-
# * `:items` - (Array<Hash>)
|
678
|
-
# * `:id` - (String)
|
679
|
-
# * `:domain_name` - (String)
|
680
|
-
# * `:s3_origin_config` - (Hash)
|
681
|
-
# * `:origin_access_identity` - (String)
|
682
|
-
# * `:custom_origin_config` - (Hash)
|
683
|
-
# * `:http_port` - (Integer)
|
684
|
-
# * `:https_port` - (Integer)
|
685
|
-
# * `:origin_protocol_policy` - (String)
|
686
|
-
# * `:default_cache_behavior` - (Hash)
|
687
|
-
# * `:target_origin_id` - (String)
|
688
|
-
# * `:forwarded_values` - (Hash)
|
689
|
-
# * `:query_string` - (Boolean)
|
690
|
-
# * `:cookies` - (Hash)
|
691
|
-
# * `:forward` - (String)
|
692
|
-
# * `:whitelisted_names` - (Hash)
|
693
|
-
# * `:quantity` - (Integer)
|
694
|
-
# * `:items` - (Array<String>)
|
695
|
-
# * `:trusted_signers` - (Hash)
|
696
|
-
# * `:enabled` - (Boolean)
|
697
|
-
# * `:quantity` - (Integer)
|
698
|
-
# * `:items` - (Array<String>)
|
699
|
-
# * `:viewer_protocol_policy` - (String)
|
700
|
-
# * `:min_ttl` - (Integer)
|
701
|
-
# * `:cache_behaviors` - (Hash)
|
702
|
-
# * `:quantity` - (Integer)
|
703
|
-
# * `:items` - (Array<Hash>)
|
704
|
-
# * `:path_pattern` - (String)
|
705
|
-
# * `:target_origin_id` - (String)
|
706
|
-
# * `:forwarded_values` - (Hash)
|
707
|
-
# * `:query_string` - (Boolean)
|
708
|
-
# * `:cookies` - (Hash)
|
709
|
-
# * `:forward` - (String)
|
710
|
-
# * `:whitelisted_names` - (Hash)
|
711
|
-
# * `:quantity` - (Integer)
|
712
|
-
# * `:items` - (Array<String>)
|
713
|
-
# * `:trusted_signers` - (Hash)
|
714
|
-
# * `:enabled` - (Boolean)
|
715
|
-
# * `:quantity` - (Integer)
|
716
|
-
# * `:items` - (Array<String>)
|
717
|
-
# * `:viewer_protocol_policy` - (String)
|
718
|
-
# * `:min_ttl` - (Integer)
|
719
|
-
# * `:comment` - (String)
|
720
|
-
# * `:logging` - (Hash)
|
721
|
-
# * `:enabled` - (Boolean)
|
722
|
-
# * `:include_cookies` - (Boolean)
|
723
|
-
# * `:bucket` - (String)
|
724
|
-
# * `:prefix` - (String)
|
725
|
-
# * `:price_class` - (String)
|
726
|
-
# * `:enabled` - (Boolean)
|
727
|
-
# * `:viewer_certificate` - (Hash)
|
728
|
-
# * `:iam_certificate_id` - (String)
|
729
|
-
# * `:cloud_front_default_certificate` - (Boolean)
|
730
|
-
|
731
|
-
# @!method get_distribution_config(options = {})
|
732
|
-
# Calls the GET GetDistributionConfig API operation.
|
733
|
-
# @param [Hash] options
|
734
|
-
#
|
735
|
-
# * `:id` - *required* - (String) The distribution's id.
|
736
|
-
# @return [Core::Response]
|
737
|
-
# The #data method of the response object returns
|
738
|
-
# a hash with the following structure:
|
739
|
-
#
|
740
|
-
# * `:caller_reference` - (String)
|
741
|
-
# * `:aliases` - (Hash)
|
742
|
-
# * `:quantity` - (Integer)
|
743
|
-
# * `:items` - (Array<String>)
|
744
|
-
# * `:default_root_object` - (String)
|
745
|
-
# * `:origins` - (Hash)
|
746
|
-
# * `:quantity` - (Integer)
|
747
|
-
# * `:items` - (Array<Hash>)
|
748
|
-
# * `:id` - (String)
|
749
|
-
# * `:domain_name` - (String)
|
750
|
-
# * `:s3_origin_config` - (Hash)
|
751
|
-
# * `:origin_access_identity` - (String)
|
752
|
-
# * `:custom_origin_config` - (Hash)
|
753
|
-
# * `:http_port` - (Integer)
|
754
|
-
# * `:https_port` - (Integer)
|
755
|
-
# * `:origin_protocol_policy` - (String)
|
756
|
-
# * `:default_cache_behavior` - (Hash)
|
757
|
-
# * `:target_origin_id` - (String)
|
758
|
-
# * `:forwarded_values` - (Hash)
|
759
|
-
# * `:query_string` - (Boolean)
|
760
|
-
# * `:cookies` - (Hash)
|
761
|
-
# * `:forward` - (String)
|
762
|
-
# * `:whitelisted_names` - (Hash)
|
763
|
-
# * `:quantity` - (Integer)
|
764
|
-
# * `:items` - (Array<String>)
|
765
|
-
# * `:trusted_signers` - (Hash)
|
766
|
-
# * `:enabled` - (Boolean)
|
767
|
-
# * `:quantity` - (Integer)
|
768
|
-
# * `:items` - (Array<String>)
|
769
|
-
# * `:viewer_protocol_policy` - (String)
|
770
|
-
# * `:min_ttl` - (Integer)
|
771
|
-
# * `:cache_behaviors` - (Hash)
|
772
|
-
# * `:quantity` - (Integer)
|
773
|
-
# * `:items` - (Array<Hash>)
|
774
|
-
# * `:path_pattern` - (String)
|
775
|
-
# * `:target_origin_id` - (String)
|
776
|
-
# * `:forwarded_values` - (Hash)
|
777
|
-
# * `:query_string` - (Boolean)
|
778
|
-
# * `:cookies` - (Hash)
|
779
|
-
# * `:forward` - (String)
|
780
|
-
# * `:whitelisted_names` - (Hash)
|
781
|
-
# * `:quantity` - (Integer)
|
782
|
-
# * `:items` - (Array<String>)
|
783
|
-
# * `:trusted_signers` - (Hash)
|
784
|
-
# * `:enabled` - (Boolean)
|
785
|
-
# * `:quantity` - (Integer)
|
786
|
-
# * `:items` - (Array<String>)
|
787
|
-
# * `:viewer_protocol_policy` - (String)
|
788
|
-
# * `:min_ttl` - (Integer)
|
789
|
-
# * `:comment` - (String)
|
790
|
-
# * `:logging` - (Hash)
|
791
|
-
# * `:enabled` - (Boolean)
|
792
|
-
# * `:include_cookies` - (Boolean)
|
793
|
-
# * `:bucket` - (String)
|
794
|
-
# * `:prefix` - (String)
|
795
|
-
# * `:price_class` - (String)
|
796
|
-
# * `:enabled` - (Boolean)
|
797
|
-
# * `:viewer_certificate` - (Hash)
|
798
|
-
# * `:iam_certificate_id` - (String)
|
799
|
-
# * `:cloud_front_default_certificate` - (Boolean)
|
800
|
-
|
801
|
-
# @!method get_invalidation(options = {})
|
802
|
-
# Calls the GET GetInvalidation API operation.
|
803
|
-
# @param [Hash] options
|
804
|
-
#
|
805
|
-
# * `:distribution_id` - *required* - (String) The distribution's id.
|
806
|
-
# * `:id` - *required* - (String) The invalidation's id.
|
807
|
-
# @return [Core::Response]
|
808
|
-
# The #data method of the response object returns
|
809
|
-
# a hash with the following structure:
|
810
|
-
#
|
811
|
-
# * `:id` - (String)
|
812
|
-
# * `:status` - (String)
|
813
|
-
# * `:create_time` - (Time)
|
814
|
-
# * `:invalidation_batch` - (Hash)
|
815
|
-
# * `:paths` - (Hash)
|
816
|
-
# * `:quantity` - (Integer)
|
817
|
-
# * `:items` - (Array<String>)
|
818
|
-
# * `:caller_reference` - (String)
|
819
|
-
|
820
|
-
# @!method get_streaming_distribution(options = {})
|
821
|
-
# Calls the GET GetStreamingDistribution API operation.
|
822
|
-
# @param [Hash] options
|
823
|
-
#
|
824
|
-
# * `:id` - *required* - (String) The streaming distribution's id.
|
825
|
-
# @return [Core::Response]
|
826
|
-
# The #data method of the response object returns
|
827
|
-
# a hash with the following structure:
|
828
|
-
#
|
829
|
-
# * `:id` - (String)
|
830
|
-
# * `:status` - (String)
|
831
|
-
# * `:last_modified_time` - (Time)
|
832
|
-
# * `:domain_name` - (String)
|
833
|
-
# * `:active_trusted_signers` - (Hash)
|
834
|
-
# * `:enabled` - (Boolean)
|
835
|
-
# * `:quantity` - (Integer)
|
836
|
-
# * `:items` - (Array<Hash>)
|
837
|
-
# * `:aws_account_number` - (String)
|
838
|
-
# * `:key_pair_ids` - (Hash)
|
839
|
-
# * `:quantity` - (Integer)
|
840
|
-
# * `:items` - (Array<String>)
|
841
|
-
# * `:streaming_distribution_config` - (Hash)
|
842
|
-
# * `:caller_reference` - (String)
|
843
|
-
# * `:s3_origin` - (Hash)
|
844
|
-
# * `:domain_name` - (String)
|
845
|
-
# * `:origin_access_identity` - (String)
|
846
|
-
# * `:aliases` - (Hash)
|
847
|
-
# * `:quantity` - (Integer)
|
848
|
-
# * `:items` - (Array<String>)
|
849
|
-
# * `:comment` - (String)
|
850
|
-
# * `:logging` - (Hash)
|
851
|
-
# * `:enabled` - (Boolean)
|
852
|
-
# * `:bucket` - (String)
|
853
|
-
# * `:prefix` - (String)
|
854
|
-
# * `:trusted_signers` - (Hash)
|
855
|
-
# * `:enabled` - (Boolean)
|
856
|
-
# * `:quantity` - (Integer)
|
857
|
-
# * `:items` - (Array<String>)
|
858
|
-
# * `:price_class` - (String)
|
859
|
-
# * `:enabled` - (Boolean)
|
860
|
-
|
861
|
-
# @!method get_streaming_distribution_config(options = {})
|
862
|
-
# Calls the GET GetStreamingDistributionConfig API operation.
|
863
|
-
# @param [Hash] options
|
864
|
-
#
|
865
|
-
# * `:id` - *required* - (String) The streaming distribution's id.
|
866
|
-
# @return [Core::Response]
|
867
|
-
# The #data method of the response object returns
|
868
|
-
# a hash with the following structure:
|
869
|
-
#
|
870
|
-
# * `:caller_reference` - (String)
|
871
|
-
# * `:s3_origin` - (Hash)
|
872
|
-
# * `:domain_name` - (String)
|
873
|
-
# * `:origin_access_identity` - (String)
|
874
|
-
# * `:aliases` - (Hash)
|
875
|
-
# * `:quantity` - (Integer)
|
876
|
-
# * `:items` - (Array<String>)
|
877
|
-
# * `:comment` - (String)
|
878
|
-
# * `:logging` - (Hash)
|
879
|
-
# * `:enabled` - (Boolean)
|
880
|
-
# * `:bucket` - (String)
|
881
|
-
# * `:prefix` - (String)
|
882
|
-
# * `:trusted_signers` - (Hash)
|
883
|
-
# * `:enabled` - (Boolean)
|
884
|
-
# * `:quantity` - (Integer)
|
885
|
-
# * `:items` - (Array<String>)
|
886
|
-
# * `:price_class` - (String)
|
887
|
-
# * `:enabled` - (Boolean)
|
888
|
-
|
889
|
-
# @!method list_cloud_front_origin_access_identities(options = {})
|
890
|
-
# Calls the GET ListCloudFrontOriginAccessIdentities API operation.
|
891
|
-
# @param [Hash] options
|
892
|
-
#
|
893
|
-
# * `:marker` - (String) Use this when paginating results to indicate
|
894
|
-
# where to begin in your list of origin access identities. The
|
895
|
-
# results include identities in the list that occur after the marker.
|
896
|
-
# To get the next page of results, set the Marker to the value of the
|
897
|
-
# NextMarker from the current page's response (which is also the ID
|
898
|
-
# of the last identity on that page).
|
899
|
-
# * `:max_items` - (Integer) The maximum number of origin access
|
900
|
-
# identities you want in the response body.
|
901
|
-
# @return [Core::Response]
|
902
|
-
# The #data method of the response object returns
|
903
|
-
# a hash with the following structure:
|
904
|
-
#
|
905
|
-
# * `:marker` - (String)
|
906
|
-
# * `:next_marker` - (String)
|
907
|
-
# * `:max_items` - (Integer)
|
908
|
-
# * `:is_truncated` - (Boolean)
|
909
|
-
# * `:quantity` - (Integer)
|
910
|
-
# * `:items` - (Array<Hash>)
|
911
|
-
# * `:id` - (String)
|
912
|
-
# * `:s3_canonical_user_id` - (String)
|
913
|
-
# * `:comment` - (String)
|
914
|
-
|
915
|
-
# @!method list_distributions(options = {})
|
916
|
-
# Calls the GET ListDistributions API operation.
|
917
|
-
# @param [Hash] options
|
918
|
-
#
|
919
|
-
# * `:marker` - (String) Use this when paginating results to indicate
|
920
|
-
# where to begin in your list of distributions. The results include
|
921
|
-
# distributions in the list that occur after the marker. To get the
|
922
|
-
# next page of results, set the Marker to the value of the NextMarker
|
923
|
-
# from the current page's response (which is also the ID of the last
|
924
|
-
# distribution on that page).
|
925
|
-
# * `:max_items` - (Integer) The maximum number of distributions you
|
926
|
-
# want in the response body.
|
927
|
-
# @return [Core::Response]
|
928
|
-
# The #data method of the response object returns
|
929
|
-
# a hash with the following structure:
|
930
|
-
#
|
931
|
-
# * `:marker` - (String)
|
932
|
-
# * `:next_marker` - (String)
|
933
|
-
# * `:max_items` - (Integer)
|
934
|
-
# * `:is_truncated` - (Boolean)
|
935
|
-
# * `:quantity` - (Integer)
|
936
|
-
# * `:items` - (Array<Hash>)
|
937
|
-
# * `:id` - (String)
|
938
|
-
# * `:status` - (String)
|
939
|
-
# * `:last_modified_time` - (Time)
|
940
|
-
# * `:domain_name` - (String)
|
941
|
-
# * `:aliases` - (Hash)
|
942
|
-
# * `:quantity` - (Integer)
|
943
|
-
# * `:items` - (Array<String>)
|
944
|
-
# * `:origins` - (Hash)
|
945
|
-
# * `:quantity` - (Integer)
|
946
|
-
# * `:items` - (Array<Hash>)
|
947
|
-
# * `:id` - (String)
|
948
|
-
# * `:domain_name` - (String)
|
949
|
-
# * `:s3_origin_config` - (Hash)
|
950
|
-
# * `:origin_access_identity` - (String)
|
951
|
-
# * `:custom_origin_config` - (Hash)
|
952
|
-
# * `:http_port` - (Integer)
|
953
|
-
# * `:https_port` - (Integer)
|
954
|
-
# * `:origin_protocol_policy` - (String)
|
955
|
-
# * `:default_cache_behavior` - (Hash)
|
956
|
-
# * `:target_origin_id` - (String)
|
957
|
-
# * `:forwarded_values` - (Hash)
|
958
|
-
# * `:query_string` - (Boolean)
|
959
|
-
# * `:cookies` - (Hash)
|
960
|
-
# * `:forward` - (String)
|
961
|
-
# * `:whitelisted_names` - (Hash)
|
962
|
-
# * `:quantity` - (Integer)
|
963
|
-
# * `:items` - (Array<String>)
|
964
|
-
# * `:trusted_signers` - (Hash)
|
965
|
-
# * `:enabled` - (Boolean)
|
966
|
-
# * `:quantity` - (Integer)
|
967
|
-
# * `:items` - (Array<String>)
|
968
|
-
# * `:viewer_protocol_policy` - (String)
|
969
|
-
# * `:min_ttl` - (Integer)
|
970
|
-
# * `:cache_behaviors` - (Hash)
|
971
|
-
# * `:quantity` - (Integer)
|
972
|
-
# * `:items` - (Array<Hash>)
|
973
|
-
# * `:path_pattern` - (String)
|
974
|
-
# * `:target_origin_id` - (String)
|
975
|
-
# * `:forwarded_values` - (Hash)
|
976
|
-
# * `:query_string` - (Boolean)
|
977
|
-
# * `:cookies` - (Hash)
|
978
|
-
# * `:forward` - (String)
|
979
|
-
# * `:whitelisted_names` - (Hash)
|
980
|
-
# * `:quantity` - (Integer)
|
981
|
-
# * `:items` - (Array<String>)
|
982
|
-
# * `:trusted_signers` - (Hash)
|
983
|
-
# * `:enabled` - (Boolean)
|
984
|
-
# * `:quantity` - (Integer)
|
985
|
-
# * `:items` - (Array<String>)
|
986
|
-
# * `:viewer_protocol_policy` - (String)
|
987
|
-
# * `:min_ttl` - (Integer)
|
988
|
-
# * `:comment` - (String)
|
989
|
-
# * `:price_class` - (String)
|
990
|
-
# * `:enabled` - (Boolean)
|
991
|
-
# * `:viewer_certificate` - (Hash)
|
992
|
-
# * `:iam_certificate_id` - (String)
|
993
|
-
# * `:cloud_front_default_certificate` - (Boolean)
|
994
|
-
|
995
|
-
# @!method list_invalidations(options = {})
|
996
|
-
# Calls the GET ListInvalidations API operation.
|
997
|
-
# @param [Hash] options
|
998
|
-
#
|
999
|
-
# * `:distribution_id` - *required* - (String) The distribution's id.
|
1000
|
-
# * `:marker` - (String) Use this parameter when paginating results to
|
1001
|
-
# indicate where to begin in your list of invalidation batches.
|
1002
|
-
# Because the results are returned in decreasing order from most
|
1003
|
-
# recent to oldest, the most recent results are on the first page,
|
1004
|
-
# the second page will contain earlier results, and so on. To get the
|
1005
|
-
# next page of results, set the Marker to the value of the NextMarker
|
1006
|
-
# from the current page's response. This value is the same as the ID
|
1007
|
-
# of the last invalidation batch on that page.
|
1008
|
-
# * `:max_items` - (Integer) The maximum number of invalidation batches
|
1009
|
-
# you want in the response body.
|
1010
|
-
# @return [Core::Response]
|
1011
|
-
# The #data method of the response object returns
|
1012
|
-
# a hash with the following structure:
|
1013
|
-
#
|
1014
|
-
# * `:marker` - (String)
|
1015
|
-
# * `:next_marker` - (String)
|
1016
|
-
# * `:max_items` - (Integer)
|
1017
|
-
# * `:is_truncated` - (Boolean)
|
1018
|
-
# * `:quantity` - (Integer)
|
1019
|
-
# * `:items` - (Array<Hash>)
|
1020
|
-
# * `:id` - (String)
|
1021
|
-
# * `:create_time` - (Time)
|
1022
|
-
# * `:status` - (String)
|
1023
|
-
|
1024
|
-
# @!method list_streaming_distributions(options = {})
|
1025
|
-
# Calls the GET ListStreamingDistributions API operation.
|
1026
|
-
# @param [Hash] options
|
1027
|
-
#
|
1028
|
-
# * `:marker` - (String) Use this when paginating results to indicate
|
1029
|
-
# where to begin in your list of streaming distributions. The results
|
1030
|
-
# include distributions in the list that occur after the marker. To
|
1031
|
-
# get the next page of results, set the Marker to the value of the
|
1032
|
-
# NextMarker from the current page's response (which is also the ID
|
1033
|
-
# of the last distribution on that page).
|
1034
|
-
# * `:max_items` - (Integer) The maximum number of streaming
|
1035
|
-
# distributions you want in the response body.
|
1036
|
-
# @return [Core::Response]
|
1037
|
-
# The #data method of the response object returns
|
1038
|
-
# a hash with the following structure:
|
1039
|
-
#
|
1040
|
-
# * `:marker` - (String)
|
1041
|
-
# * `:next_marker` - (String)
|
1042
|
-
# * `:max_items` - (Integer)
|
1043
|
-
# * `:is_truncated` - (Boolean)
|
1044
|
-
# * `:quantity` - (Integer)
|
1045
|
-
# * `:items` - (Array<Hash>)
|
1046
|
-
# * `:id` - (String)
|
1047
|
-
# * `:status` - (String)
|
1048
|
-
# * `:last_modified_time` - (Time)
|
1049
|
-
# * `:domain_name` - (String)
|
1050
|
-
# * `:s3_origin` - (Hash)
|
1051
|
-
# * `:domain_name` - (String)
|
1052
|
-
# * `:origin_access_identity` - (String)
|
1053
|
-
# * `:aliases` - (Hash)
|
1054
|
-
# * `:quantity` - (Integer)
|
1055
|
-
# * `:items` - (Array<String>)
|
1056
|
-
# * `:trusted_signers` - (Hash)
|
1057
|
-
# * `:enabled` - (Boolean)
|
1058
|
-
# * `:quantity` - (Integer)
|
1059
|
-
# * `:items` - (Array<String>)
|
1060
|
-
# * `:comment` - (String)
|
1061
|
-
# * `:price_class` - (String)
|
1062
|
-
# * `:enabled` - (Boolean)
|
1063
|
-
|
1064
|
-
# @!method update_cloud_front_origin_access_identity(options = {})
|
1065
|
-
# Calls the PUT UpdateCloudFrontOriginAccessIdentity API operation.
|
1066
|
-
# @param [Hash] options
|
1067
|
-
#
|
1068
|
-
# * `:cloud_front_origin_access_identity_config` - *required* - (Hash)
|
1069
|
-
# The identity's configuration information.
|
1070
|
-
# * `:caller_reference` - *required* - (String) A unique number that
|
1071
|
-
# ensures the request can't be replayed. If the CallerReference is
|
1072
|
-
# new (no matter the content of the
|
1073
|
-
# CloudFrontOriginAccessIdentityConfig object), a new origin access
|
1074
|
-
# identity is created. If the CallerReference is a value you
|
1075
|
-
# already sent in a previous request to create an identity, and the
|
1076
|
-
# content of the CloudFrontOriginAccessIdentityConfig is identical
|
1077
|
-
# to the original request (ignoring white space), the response
|
1078
|
-
# includes the same information returned to the original request.
|
1079
|
-
# If the CallerReference is a value you already sent in a previous
|
1080
|
-
# request to create an identity but the content of the
|
1081
|
-
# CloudFrontOriginAccessIdentityConfig is different from the
|
1082
|
-
# original request, CloudFront returns a
|
1083
|
-
# CloudFrontOriginAccessIdentityAlreadyExists error.
|
1084
|
-
# * `:comment` - *required* - (String) Any comments you want to
|
1085
|
-
# include about the origin access identity.
|
1086
|
-
# * `:id` - *required* - (String) The identity's id.
|
1087
|
-
# * `:if_match` - (String) The value of the ETag header you received
|
1088
|
-
# when retrieving the identity's configuration. For example:
|
1089
|
-
# E2QWRUHAPOMQZL.
|
1090
|
-
# @return [Core::Response]
|
1091
|
-
# The #data method of the response object returns
|
1092
|
-
# a hash with the following structure:
|
1093
|
-
#
|
1094
|
-
# * `:id` - (String)
|
1095
|
-
# * `:s3_canonical_user_id` - (String)
|
1096
|
-
# * `:cloud_front_origin_access_identity_config` - (Hash)
|
1097
|
-
# * `:caller_reference` - (String)
|
1098
|
-
# * `:comment` - (String)
|
1099
|
-
|
1100
|
-
# @!method update_distribution(options = {})
|
1101
|
-
# Calls the PUT UpdateDistribution API operation.
|
1102
|
-
# @param [Hash] options
|
1103
|
-
#
|
1104
|
-
# * `:distribution_config` - *required* - (Hash) The distribution's
|
1105
|
-
# configuration information.
|
1106
|
-
# * `:caller_reference` - *required* - (String) A unique number that
|
1107
|
-
# ensures the request can't be replayed. If the CallerReference is
|
1108
|
-
# new (no matter the content of the DistributionConfig object), a
|
1109
|
-
# new distribution is created. If the CallerReference is a value
|
1110
|
-
# you already sent in a previous request to create a distribution,
|
1111
|
-
# and the content of the DistributionConfig is identical to the
|
1112
|
-
# original request (ignoring white space), the response includes
|
1113
|
-
# the same information returned to the original request. If the
|
1114
|
-
# CallerReference is a value you already sent in a previous request
|
1115
|
-
# to create a distribution but the content of the
|
1116
|
-
# DistributionConfig is different from the original request,
|
1117
|
-
# CloudFront returns a DistributionAlreadyExists error.
|
1118
|
-
# * `:aliases` - *required* - (Hash) A complex type that contains
|
1119
|
-
# information about CNAMEs (alternate domain names), if any, for
|
1120
|
-
# this distribution.
|
1121
|
-
# * `:quantity` - *required* - (Integer) The number of CNAMEs, if
|
1122
|
-
# any, for this distribution.
|
1123
|
-
# * `:items` - (Array<String>) Optional: A complex type that
|
1124
|
-
# contains CNAME elements, if any, for this distribution. If
|
1125
|
-
# Quantity is 0, you can omit Items.
|
1126
|
-
# * `:default_root_object` - *required* - (String) The object that
|
1127
|
-
# you want CloudFront to return (for example, index.html) when an
|
1128
|
-
# end user requests the root URL for your distribution
|
1129
|
-
# (http://www.example.com) instead of an object in your
|
1130
|
-
# distribution (http://www.example.com/index.html). Specifying a
|
1131
|
-
# default root object avoids exposing the contents of your
|
1132
|
-
# distribution. If you don't want to specify a default root object
|
1133
|
-
# when you create a distribution, include an empty
|
1134
|
-
# DefaultRootObject element. To delete the default root object from
|
1135
|
-
# an existing distribution, update the distribution configuration
|
1136
|
-
# and include an empty DefaultRootObject element. To replace the
|
1137
|
-
# default root object, update the distribution configuration and
|
1138
|
-
# specify the new object.
|
1139
|
-
# * `:origins` - *required* - (Hash) A complex type that contains
|
1140
|
-
# information about origins for this distribution.
|
1141
|
-
# * `:quantity` - *required* - (Integer) The number of origins for
|
1142
|
-
# this distribution.
|
1143
|
-
# * `:items` - (Array<Hash>) A complex type that contains origins
|
1144
|
-
# for this distribution.
|
1145
|
-
# * `:id` - *required* - (String) A unique identifier for the
|
1146
|
-
# origin. The value of Id must be unique within the
|
1147
|
-
# distribution. You use the value of Id when you create a cache
|
1148
|
-
# behavior. The Id identifies the origin that CloudFront routes
|
1149
|
-
# a request to when the request matches the path pattern for
|
1150
|
-
# that cache behavior.
|
1151
|
-
# * `:domain_name` - *required* - (String) Amazon S3 origins: The
|
1152
|
-
# DNS name of the Amazon S3 bucket from which you want
|
1153
|
-
# CloudFront to get objects for this origin, for example,
|
1154
|
-
# myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain
|
1155
|
-
# name for the HTTP server from which you want CloudFront to
|
1156
|
-
# get objects for this origin, for example, www.example.com.
|
1157
|
-
# * `:s3_origin_config` - (Hash) A complex type that contains
|
1158
|
-
# information about the Amazon S3 origin. If the origin is a
|
1159
|
-
# custom origin, use the CustomOriginConfig element instead.
|
1160
|
-
# * `:origin_access_identity` - *required* - (String) The
|
1161
|
-
# CloudFront origin access identity to associate with the
|
1162
|
-
# origin. Use an origin access identity to configure the
|
1163
|
-
# origin so that end users can only access objects in an
|
1164
|
-
# Amazon S3 bucket through CloudFront. If you want end users
|
1165
|
-
# to be able to access objects using either the CloudFront
|
1166
|
-
# URL or the Amazon S3 URL, specify an empty
|
1167
|
-
# OriginAccessIdentity element. To delete the origin access
|
1168
|
-
# identity from an existing distribution, update the
|
1169
|
-
# distribution configuration and include an empty
|
1170
|
-
# OriginAccessIdentity element. To replace the origin access
|
1171
|
-
# identity, update the distribution configuration and specify
|
1172
|
-
# the new origin access identity.
|
1173
|
-
# * `:custom_origin_config` - (Hash) A complex type that contains
|
1174
|
-
# information about a custom origin. If the origin is an Amazon
|
1175
|
-
# S3 bucket, use the S3OriginConfig element instead.
|
1176
|
-
# * `:http_port` - *required* - (Integer) The HTTP port the
|
1177
|
-
# custom origin listens on.
|
1178
|
-
# * `:https_port` - *required* - (Integer) The HTTPS port the
|
1179
|
-
# custom origin listens on.
|
1180
|
-
# * `:origin_protocol_policy` - *required* - (String) The
|
1181
|
-
# origin protocol policy to apply to your origin. Valid
|
1182
|
-
# values include:
|
1183
|
-
# * `http-only`
|
1184
|
-
# * `match-viewer`
|
1185
|
-
# * `:default_cache_behavior` - *required* - (Hash) A complex type
|
1186
|
-
# that describes the default cache behavior if you do not specify a
|
1187
|
-
# CacheBehavior element or if files don't match any of the values
|
1188
|
-
# of PathPattern in CacheBehavior elements.You must create exactly
|
1189
|
-
# one default cache behavior.
|
1190
|
-
# * `:target_origin_id` - *required* - (String) The value of ID for
|
1191
|
-
# the origin that you want CloudFront to route requests to when a
|
1192
|
-
# request matches the path pattern either for a cache behavior or
|
1193
|
-
# for the default cache behavior.
|
1194
|
-
# * `:forwarded_values` - *required* - (Hash) A complex type that
|
1195
|
-
# specifies how CloudFront handles query strings and cookies.
|
1196
|
-
# * `:query_string` - *required* - (Boolean) Indicates whether
|
1197
|
-
# you want CloudFront to forward query strings to the origin
|
1198
|
-
# that is associated with this cache behavior. If so, specify
|
1199
|
-
# `true` ; if not, specify `false` .
|
1200
|
-
# * `:cookies` - *required* - (Hash) A complex type that
|
1201
|
-
# specifies how CloudFront handles cookies.
|
1202
|
-
# * `:forward` - *required* - (String) Use this element to
|
1203
|
-
# specify whether you want CloudFront to forward cookies to
|
1204
|
-
# the origin that is associated with this cache behavior. You
|
1205
|
-
# can specify all, none or whitelist. If you choose All,
|
1206
|
-
# CloudFront forwards all cookies regardless of how many your
|
1207
|
-
# application uses. Valid values include:
|
1208
|
-
# * `none`
|
1209
|
-
# * `whitelist`
|
1210
|
-
# * `all`
|
1211
|
-
# * `:whitelisted_names` - (Hash) A complex type that specifies
|
1212
|
-
# the whitelisted cookies, if any, that you want CloudFront
|
1213
|
-
# to forward to your origin that is associated with this
|
1214
|
-
# cache behavior.
|
1215
|
-
# * `:quantity` - *required* - (Integer) The number of
|
1216
|
-
# whitelisted cookies for this cache behavior.
|
1217
|
-
# * `:items` - (Array<String>) Optional: A complex type that
|
1218
|
-
# contains whitelisted cookies for this cache behavior. If
|
1219
|
-
# Quantity is 0, you can omit Items.
|
1220
|
-
# * `:trusted_signers` - *required* - (Hash) A complex type that
|
1221
|
-
# specifies the AWS accounts, if any, that you want to allow to
|
1222
|
-
# create signed URLs for private content. If you want to require
|
1223
|
-
# signed URLs in requests for objects in the target origin that
|
1224
|
-
# match the PathPattern for this cache behavior, specify `true`
|
1225
|
-
# for Enabled, and specify the applicable values for Quantity and
|
1226
|
-
# Items. For more information, go to Using a Signed URL to Serve
|
1227
|
-
# Private Content in the Amazon CloudFront Developer Guide. If
|
1228
|
-
# you don't want to require signed URLs in requests for objects
|
1229
|
-
# that match PathPattern, specify `false` for Enabled and 0 for
|
1230
|
-
# Quantity. Omit Items. To add, change, or remove one or more
|
1231
|
-
# trusted signers, change Enabled to `true` (if it's currently
|
1232
|
-
# `false` ), change Quantity as applicable, and specify all of
|
1233
|
-
# the trusted signers that you want to include in the updated
|
1234
|
-
# distribution.
|
1235
|
-
# * `:enabled` - *required* - (Boolean) Specifies whether you
|
1236
|
-
# want to require end users to use signed URLs to access the
|
1237
|
-
# files specified by PathPattern and TargetOriginId.
|
1238
|
-
# * `:quantity` - *required* - (Integer) The number of trusted
|
1239
|
-
# signers for this cache behavior.
|
1240
|
-
# * `:items` - (Array<String>) Optional: A complex type that
|
1241
|
-
# contains trusted signers for this cache behavior. If Quantity
|
1242
|
-
# is 0, you can omit Items.
|
1243
|
-
# * `:viewer_protocol_policy` - *required* - (String) Use this
|
1244
|
-
# element to specify the protocol that users can use to access
|
1245
|
-
# the files in the origin specified by TargetOriginId when a
|
1246
|
-
# request matches the path pattern in PathPattern. If you want
|
1247
|
-
# CloudFront to allow end users to use any available protocol,
|
1248
|
-
# specify allow-all. If you want CloudFront to require HTTPS,
|
1249
|
-
# specify https. Valid values include:
|
1250
|
-
# * `allow-all`
|
1251
|
-
# * `https-only`
|
1252
|
-
# * `:min_ttl` - *required* - (Integer) The minimum amount of time
|
1253
|
-
# that you want objects to stay in CloudFront caches before
|
1254
|
-
# CloudFront queries your origin to see whether the object has
|
1255
|
-
# been updated.You can specify a value from 0 to 3,153,600,000
|
1256
|
-
# seconds (100 years).
|
1257
|
-
# * `:cache_behaviors` - *required* - (Hash) A complex type that
|
1258
|
-
# contains zero or more CacheBehavior elements.
|
1259
|
-
# * `:quantity` - *required* - (Integer) The number of cache
|
1260
|
-
# behaviors for this distribution.
|
1261
|
-
# * `:items` - (Array<Hash>) Optional: A complex type that contains
|
1262
|
-
# cache behaviors for this distribution. If Quantity is 0, you
|
1263
|
-
# can omit Items.
|
1264
|
-
# * `:path_pattern` - *required* - (String) The pattern (for
|
1265
|
-
# example, images/*.jpg) that specifies which requests you want
|
1266
|
-
# this cache behavior to apply to. When CloudFront receives an
|
1267
|
-
# end-user request, the requested path is compared with path
|
1268
|
-
# patterns in the order in which cache behaviors are listed in
|
1269
|
-
# the distribution. The path pattern for the default cache
|
1270
|
-
# behavior is * and cannot be changed. If the request for an
|
1271
|
-
# object does not match the path pattern for any cache
|
1272
|
-
# behaviors, CloudFront applies the behavior in the default
|
1273
|
-
# cache behavior.
|
1274
|
-
# * `:target_origin_id` - *required* - (String) The value of ID
|
1275
|
-
# for the origin that you want CloudFront to route requests to
|
1276
|
-
# when a request matches the path pattern either for a cache
|
1277
|
-
# behavior or for the default cache behavior.
|
1278
|
-
# * `:forwarded_values` - *required* - (Hash) A complex type that
|
1279
|
-
# specifies how CloudFront handles query strings and cookies.
|
1280
|
-
# * `:query_string` - *required* - (Boolean) Indicates whether
|
1281
|
-
# you want CloudFront to forward query strings to the origin
|
1282
|
-
# that is associated with this cache behavior. If so, specify
|
1283
|
-
# `true` ; if not, specify `false` .
|
1284
|
-
# * `:cookies` - *required* - (Hash) A complex type that
|
1285
|
-
# specifies how CloudFront handles cookies.
|
1286
|
-
# * `:forward` - *required* - (String) Use this element to
|
1287
|
-
# specify whether you want CloudFront to forward cookies to
|
1288
|
-
# the origin that is associated with this cache behavior.
|
1289
|
-
# You can specify all, none or whitelist. If you choose
|
1290
|
-
# All, CloudFront forwards all cookies regardless of how
|
1291
|
-
# many your application uses. Valid values include:
|
1292
|
-
# * `none`
|
1293
|
-
# * `whitelist`
|
1294
|
-
# * `all`
|
1295
|
-
# * `:whitelisted_names` - (Hash) A complex type that
|
1296
|
-
# specifies the whitelisted cookies, if any, that you want
|
1297
|
-
# CloudFront to forward to your origin that is associated
|
1298
|
-
# with this cache behavior.
|
1299
|
-
# * `:quantity` - *required* - (Integer) The number of
|
1300
|
-
# whitelisted cookies for this cache behavior.
|
1301
|
-
# * `:items` - (Array<String>) Optional: A complex type
|
1302
|
-
# that contains whitelisted cookies for this cache
|
1303
|
-
# behavior. If Quantity is 0, you can omit Items.
|
1304
|
-
# * `:trusted_signers` - *required* - (Hash) A complex type that
|
1305
|
-
# specifies the AWS accounts, if any, that you want to allow to
|
1306
|
-
# create signed URLs for private content. If you want to
|
1307
|
-
# require signed URLs in requests for objects in the target
|
1308
|
-
# origin that match the PathPattern for this cache behavior,
|
1309
|
-
# specify `true` for Enabled, and specify the applicable values
|
1310
|
-
# for Quantity and Items. For more information, go to Using a
|
1311
|
-
# Signed URL to Serve Private Content in the Amazon CloudFront
|
1312
|
-
# Developer Guide. If you don't want to require signed URLs in
|
1313
|
-
# requests for objects that match PathPattern, specify `false`
|
1314
|
-
# for Enabled and 0 for Quantity. Omit Items. To add, change,
|
1315
|
-
# or remove one or more trusted signers, change Enabled to
|
1316
|
-
# `true` (if it's currently `false` ), change Quantity as
|
1317
|
-
# applicable, and specify all of the trusted signers that you
|
1318
|
-
# want to include in the updated distribution.
|
1319
|
-
# * `:enabled` - *required* - (Boolean) Specifies whether you
|
1320
|
-
# want to require end users to use signed URLs to access the
|
1321
|
-
# files specified by PathPattern and TargetOriginId.
|
1322
|
-
# * `:quantity` - *required* - (Integer) The number of trusted
|
1323
|
-
# signers for this cache behavior.
|
1324
|
-
# * `:items` - (Array<String>) Optional: A complex type that
|
1325
|
-
# contains trusted signers for this cache behavior. If
|
1326
|
-
# Quantity is 0, you can omit Items.
|
1327
|
-
# * `:viewer_protocol_policy` - *required* - (String) Use this
|
1328
|
-
# element to specify the protocol that users can use to access
|
1329
|
-
# the files in the origin specified by TargetOriginId when a
|
1330
|
-
# request matches the path pattern in PathPattern. If you want
|
1331
|
-
# CloudFront to allow end users to use any available protocol,
|
1332
|
-
# specify allow-all. If you want CloudFront to require HTTPS,
|
1333
|
-
# specify https. Valid values include:
|
1334
|
-
# * `allow-all`
|
1335
|
-
# * `https-only`
|
1336
|
-
# * `:min_ttl` - *required* - (Integer) The minimum amount of
|
1337
|
-
# time that you want objects to stay in CloudFront caches
|
1338
|
-
# before CloudFront queries your origin to see whether the
|
1339
|
-
# object has been updated.You can specify a value from 0 to
|
1340
|
-
# 3,153,600,000 seconds (100 years).
|
1341
|
-
# * `:comment` - *required* - (String) Any comments you want to
|
1342
|
-
# include about the distribution.
|
1343
|
-
# * `:logging` - *required* - (Hash) A complex type that controls
|
1344
|
-
# whether access logs are written for the distribution.
|
1345
|
-
# * `:enabled` - *required* - (Boolean) Specifies whether you want
|
1346
|
-
# CloudFront to save access logs to an Amazon S3 bucket. If you
|
1347
|
-
# do not want to enable logging when you create a distribution or
|
1348
|
-
# if you want to disable logging for an existing distribution,
|
1349
|
-
# specify `false` for Enabled, and specify empty Bucket and
|
1350
|
-
# Prefix elements. If you specify `false` for Enabled but you
|
1351
|
-
# specify values for Bucket, prefix and IncludeCookies, the
|
1352
|
-
# values are automatically deleted.
|
1353
|
-
# * `:include_cookies` - *required* - (Boolean) Specifies whether
|
1354
|
-
# you want CloudFront to include cookies in access logs, specify
|
1355
|
-
# `true` for IncludeCookies. If you choose to include cookies in
|
1356
|
-
# logs, CloudFront logs all cookies regardless of how you
|
1357
|
-
# configure the cache behaviors for this distribution. If you do
|
1358
|
-
# not want to include cookies when you create a distribution or
|
1359
|
-
# if you want to disable include cookies for an existing
|
1360
|
-
# distribution, specify `false` for IncludeCookies.
|
1361
|
-
# * `:bucket` - *required* - (String) The Amazon S3 bucket to store
|
1362
|
-
# the access logs in, for example,
|
1363
|
-
# myawslogbucket.s3.amazonaws.com.
|
1364
|
-
# * `:prefix` - *required* - (String) An optional string that you
|
1365
|
-
# want CloudFront to prefix to the access log filenames for this
|
1366
|
-
# distribution, for example, myprefix/. If you want to enable
|
1367
|
-
# logging, but you do not want to specify a prefix, you still
|
1368
|
-
# must include an empty Prefix element in the Logging element.
|
1369
|
-
# * `:price_class` - *required* - (String) A complex type that
|
1370
|
-
# contains information about price class for this distribution.
|
1371
|
-
# Valid values include:
|
1372
|
-
# * `PriceClass_100`
|
1373
|
-
# * `PriceClass_200`
|
1374
|
-
# * `PriceClass_All`
|
1375
|
-
# * `:enabled` - *required* - (Boolean) Whether the distribution is
|
1376
|
-
# enabled to accept end user requests for content.
|
1377
|
-
# * `:viewer_certificate` - (Hash)
|
1378
|
-
# * `:iam_certificate_id` - (String) The IAM certificate identifier
|
1379
|
-
# of the custom viewer certificate for this distribution.
|
1380
|
-
# * `:cloud_front_default_certificate` - (Boolean) Set to `true` if
|
1381
|
-
# you want to use the default *.cloudfront.net viewer certificate
|
1382
|
-
# for this distribution. Omit this value if you are setting an
|
1383
|
-
# IAMCertificateId.
|
1384
|
-
# * `:id` - *required* - (String) The distribution's id.
|
1385
|
-
# * `:if_match` - (String) The value of the ETag header you received
|
1386
|
-
# when retrieving the distribution's configuration. For example:
|
1387
|
-
# E2QWRUHAPOMQZL.
|
1388
|
-
# @return [Core::Response]
|
1389
|
-
# The #data method of the response object returns
|
1390
|
-
# a hash with the following structure:
|
1391
|
-
#
|
1392
|
-
# * `:id` - (String)
|
1393
|
-
# * `:status` - (String)
|
1394
|
-
# * `:last_modified_time` - (Time)
|
1395
|
-
# * `:in_progress_invalidation_batches` - (Integer)
|
1396
|
-
# * `:domain_name` - (String)
|
1397
|
-
# * `:active_trusted_signers` - (Hash)
|
1398
|
-
# * `:enabled` - (Boolean)
|
1399
|
-
# * `:quantity` - (Integer)
|
1400
|
-
# * `:items` - (Array<Hash>)
|
1401
|
-
# * `:aws_account_number` - (String)
|
1402
|
-
# * `:key_pair_ids` - (Hash)
|
1403
|
-
# * `:quantity` - (Integer)
|
1404
|
-
# * `:items` - (Array<String>)
|
1405
|
-
# * `:distribution_config` - (Hash)
|
1406
|
-
# * `:caller_reference` - (String)
|
1407
|
-
# * `:aliases` - (Hash)
|
1408
|
-
# * `:quantity` - (Integer)
|
1409
|
-
# * `:items` - (Array<String>)
|
1410
|
-
# * `:default_root_object` - (String)
|
1411
|
-
# * `:origins` - (Hash)
|
1412
|
-
# * `:quantity` - (Integer)
|
1413
|
-
# * `:items` - (Array<Hash>)
|
1414
|
-
# * `:id` - (String)
|
1415
|
-
# * `:domain_name` - (String)
|
1416
|
-
# * `:s3_origin_config` - (Hash)
|
1417
|
-
# * `:origin_access_identity` - (String)
|
1418
|
-
# * `:custom_origin_config` - (Hash)
|
1419
|
-
# * `:http_port` - (Integer)
|
1420
|
-
# * `:https_port` - (Integer)
|
1421
|
-
# * `:origin_protocol_policy` - (String)
|
1422
|
-
# * `:default_cache_behavior` - (Hash)
|
1423
|
-
# * `:target_origin_id` - (String)
|
1424
|
-
# * `:forwarded_values` - (Hash)
|
1425
|
-
# * `:query_string` - (Boolean)
|
1426
|
-
# * `:cookies` - (Hash)
|
1427
|
-
# * `:forward` - (String)
|
1428
|
-
# * `:whitelisted_names` - (Hash)
|
1429
|
-
# * `:quantity` - (Integer)
|
1430
|
-
# * `:items` - (Array<String>)
|
1431
|
-
# * `:trusted_signers` - (Hash)
|
1432
|
-
# * `:enabled` - (Boolean)
|
1433
|
-
# * `:quantity` - (Integer)
|
1434
|
-
# * `:items` - (Array<String>)
|
1435
|
-
# * `:viewer_protocol_policy` - (String)
|
1436
|
-
# * `:min_ttl` - (Integer)
|
1437
|
-
# * `:cache_behaviors` - (Hash)
|
1438
|
-
# * `:quantity` - (Integer)
|
1439
|
-
# * `:items` - (Array<Hash>)
|
1440
|
-
# * `:path_pattern` - (String)
|
1441
|
-
# * `:target_origin_id` - (String)
|
1442
|
-
# * `:forwarded_values` - (Hash)
|
1443
|
-
# * `:query_string` - (Boolean)
|
1444
|
-
# * `:cookies` - (Hash)
|
1445
|
-
# * `:forward` - (String)
|
1446
|
-
# * `:whitelisted_names` - (Hash)
|
1447
|
-
# * `:quantity` - (Integer)
|
1448
|
-
# * `:items` - (Array<String>)
|
1449
|
-
# * `:trusted_signers` - (Hash)
|
1450
|
-
# * `:enabled` - (Boolean)
|
1451
|
-
# * `:quantity` - (Integer)
|
1452
|
-
# * `:items` - (Array<String>)
|
1453
|
-
# * `:viewer_protocol_policy` - (String)
|
1454
|
-
# * `:min_ttl` - (Integer)
|
1455
|
-
# * `:comment` - (String)
|
1456
|
-
# * `:logging` - (Hash)
|
1457
|
-
# * `:enabled` - (Boolean)
|
1458
|
-
# * `:include_cookies` - (Boolean)
|
1459
|
-
# * `:bucket` - (String)
|
1460
|
-
# * `:prefix` - (String)
|
1461
|
-
# * `:price_class` - (String)
|
1462
|
-
# * `:enabled` - (Boolean)
|
1463
|
-
# * `:viewer_certificate` - (Hash)
|
1464
|
-
# * `:iam_certificate_id` - (String)
|
1465
|
-
# * `:cloud_front_default_certificate` - (Boolean)
|
1466
|
-
|
1467
|
-
# @!method update_streaming_distribution(options = {})
|
1468
|
-
# Calls the PUT UpdateStreamingDistribution API operation.
|
1469
|
-
# @param [Hash] options
|
1470
|
-
#
|
1471
|
-
# * `:streaming_distribution_config` - *required* - (Hash) The
|
1472
|
-
# streaming distribution's configuration information.
|
1473
|
-
# * `:caller_reference` - *required* - (String) A unique number that
|
1474
|
-
# ensures the request can't be replayed. If the CallerReference is
|
1475
|
-
# new (no matter the content of the StreamingDistributionConfig
|
1476
|
-
# object), a new streaming distribution is created. If the
|
1477
|
-
# CallerReference is a value you already sent in a previous request
|
1478
|
-
# to create a streaming distribution, and the content of the
|
1479
|
-
# StreamingDistributionConfig is identical to the original request
|
1480
|
-
# (ignoring white space), the response includes the same
|
1481
|
-
# information returned to the original request. If the
|
1482
|
-
# CallerReference is a value you already sent in a previous request
|
1483
|
-
# to create a streaming distribution but the content of the
|
1484
|
-
# StreamingDistributionConfig is different from the original
|
1485
|
-
# request, CloudFront returns a DistributionAlreadyExists error.
|
1486
|
-
# * `:s3_origin` - *required* - (Hash) A complex type that contains
|
1487
|
-
# information about the Amazon S3 bucket from which you want
|
1488
|
-
# CloudFront to get your media files for distribution.
|
1489
|
-
# * `:domain_name` - *required* - (String) The DNS name of the S3
|
1490
|
-
# origin.
|
1491
|
-
# * `:origin_access_identity` - *required* - (String) Your S3
|
1492
|
-
# origin's origin access identity.
|
1493
|
-
# * `:aliases` - *required* - (Hash) A complex type that contains
|
1494
|
-
# information about CNAMEs (alternate domain names), if any, for
|
1495
|
-
# this streaming distribution.
|
1496
|
-
# * `:quantity` - *required* - (Integer) The number of CNAMEs, if
|
1497
|
-
# any, for this distribution.
|
1498
|
-
# * `:items` - (Array<String>) Optional: A complex type that
|
1499
|
-
# contains CNAME elements, if any, for this distribution. If
|
1500
|
-
# Quantity is 0, you can omit Items.
|
1501
|
-
# * `:comment` - *required* - (String) Any comments you want to
|
1502
|
-
# include about the streaming distribution.
|
1503
|
-
# * `:logging` - *required* - (Hash) A complex type that controls
|
1504
|
-
# whether access logs are written for the streaming distribution.
|
1505
|
-
# * `:enabled` - *required* - (Boolean) Specifies whether you want
|
1506
|
-
# CloudFront to save access logs to an Amazon S3 bucket. If you
|
1507
|
-
# do not want to enable logging when you create a streaming
|
1508
|
-
# distribution or if you want to disable logging for an existing
|
1509
|
-
# streaming distribution, specify `false` for Enabled, and
|
1510
|
-
# specify empty Bucket and Prefix elements. If you specify
|
1511
|
-
# `false` for Enabled but you specify values for Bucket and
|
1512
|
-
# Prefix, the values are automatically deleted.
|
1513
|
-
# * `:bucket` - *required* - (String) The Amazon S3 bucket to store
|
1514
|
-
# the access logs in, for example,
|
1515
|
-
# myawslogbucket.s3.amazonaws.com.
|
1516
|
-
# * `:prefix` - *required* - (String) An optional string that you
|
1517
|
-
# want CloudFront to prefix to the access log filenames for this
|
1518
|
-
# streaming distribution, for example, myprefix/. If you want to
|
1519
|
-
# enable logging, but you do not want to specify a prefix, you
|
1520
|
-
# still must include an empty Prefix element in the Logging
|
1521
|
-
# element.
|
1522
|
-
# * `:trusted_signers` - *required* - (Hash) A complex type that
|
1523
|
-
# specifies the AWS accounts, if any, that you want to allow to
|
1524
|
-
# create signed URLs for private content. If you want to require
|
1525
|
-
# signed URLs in requests for objects in the target origin that
|
1526
|
-
# match the PathPattern for this cache behavior, specify `true` for
|
1527
|
-
# Enabled, and specify the applicable values for Quantity and
|
1528
|
-
# Items. For more information, go to Using a Signed URL to Serve
|
1529
|
-
# Private Content in the Amazon CloudFront Developer Guide. If you
|
1530
|
-
# don't want to require signed URLs in requests for objects that
|
1531
|
-
# match PathPattern, specify `false` for Enabled and 0 for
|
1532
|
-
# Quantity. Omit Items. To add, change, or remove one or more
|
1533
|
-
# trusted signers, change Enabled to `true` (if it's currently
|
1534
|
-
# `false` ), change Quantity as applicable, and specify all of the
|
1535
|
-
# trusted signers that you want to include in the updated
|
1536
|
-
# distribution.
|
1537
|
-
# * `:enabled` - *required* - (Boolean) Specifies whether you want
|
1538
|
-
# to require end users to use signed URLs to access the files
|
1539
|
-
# specified by PathPattern and TargetOriginId.
|
1540
|
-
# * `:quantity` - *required* - (Integer) The number of trusted
|
1541
|
-
# signers for this cache behavior.
|
1542
|
-
# * `:items` - (Array<String>) Optional: A complex type that
|
1543
|
-
# contains trusted signers for this cache behavior. If Quantity
|
1544
|
-
# is 0, you can omit Items.
|
1545
|
-
# * `:price_class` - *required* - (String) A complex type that
|
1546
|
-
# contains information about price class for this streaming
|
1547
|
-
# distribution. Valid values include:
|
1548
|
-
# * `PriceClass_100`
|
1549
|
-
# * `PriceClass_200`
|
1550
|
-
# * `PriceClass_All`
|
1551
|
-
# * `:enabled` - *required* - (Boolean) Whether the streaming
|
1552
|
-
# distribution is enabled to accept end user requests for content.
|
1553
|
-
# * `:id` - *required* - (String) The streaming distribution's id.
|
1554
|
-
# * `:if_match` - (String) The value of the ETag header you received
|
1555
|
-
# when retrieving the streaming distribution's configuration. For
|
1556
|
-
# example: E2QWRUHAPOMQZL.
|
1557
|
-
# @return [Core::Response]
|
1558
|
-
# The #data method of the response object returns
|
1559
|
-
# a hash with the following structure:
|
1560
|
-
#
|
1561
|
-
# * `:id` - (String)
|
1562
|
-
# * `:status` - (String)
|
1563
|
-
# * `:last_modified_time` - (Time)
|
1564
|
-
# * `:domain_name` - (String)
|
1565
|
-
# * `:active_trusted_signers` - (Hash)
|
1566
|
-
# * `:enabled` - (Boolean)
|
1567
|
-
# * `:quantity` - (Integer)
|
1568
|
-
# * `:items` - (Array<Hash>)
|
1569
|
-
# * `:aws_account_number` - (String)
|
1570
|
-
# * `:key_pair_ids` - (Hash)
|
1571
|
-
# * `:quantity` - (Integer)
|
1572
|
-
# * `:items` - (Array<String>)
|
1573
|
-
# * `:streaming_distribution_config` - (Hash)
|
1574
|
-
# * `:caller_reference` - (String)
|
1575
|
-
# * `:s3_origin` - (Hash)
|
1576
|
-
# * `:domain_name` - (String)
|
1577
|
-
# * `:origin_access_identity` - (String)
|
1578
|
-
# * `:aliases` - (Hash)
|
1579
|
-
# * `:quantity` - (Integer)
|
1580
|
-
# * `:items` - (Array<String>)
|
1581
|
-
# * `:comment` - (String)
|
1582
|
-
# * `:logging` - (Hash)
|
1583
|
-
# * `:enabled` - (Boolean)
|
1584
|
-
# * `:bucket` - (String)
|
1585
|
-
# * `:prefix` - (String)
|
1586
|
-
# * `:trusted_signers` - (Hash)
|
1587
|
-
# * `:enabled` - (Boolean)
|
1588
|
-
# * `:quantity` - (Integer)
|
1589
|
-
# * `:items` - (Array<String>)
|
1590
|
-
# * `:price_class` - (String)
|
1591
|
-
# * `:enabled` - (Boolean)
|
1592
|
-
|
1593
|
-
# end client methods #
|
1594
|
-
|
1595
28
|
define_client_methods('2013-05-12')
|
1596
29
|
|
1597
30
|
end
|