aws-sdk 1.11.2 → 1.11.3

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.
@@ -38,6 +38,7 @@ module AWS
38
38
  # @!method create_auto_scaling_group(options = {})
39
39
  # Calls the CreateAutoScalingGroup API operation.
40
40
  # @param [Hash] options
41
+ #
41
42
  # * `:auto_scaling_group_name` - *required* - (String)
42
43
  # * `:launch_configuration_name` - *required* - (String)
43
44
  # * `:min_size` - *required* - (Integer)
@@ -62,6 +63,7 @@ module AWS
62
63
  # @!method create_launch_configuration(options = {})
63
64
  # Calls the CreateLaunchConfiguration API operation.
64
65
  # @param [Hash] options
66
+ #
65
67
  # * `:launch_configuration_name` - *required* - (String)
66
68
  # * `:image_id` - *required* - (String)
67
69
  # * `:key_name` - (String)
@@ -86,6 +88,7 @@ module AWS
86
88
  # @!method create_or_update_tags(options = {})
87
89
  # Calls the CreateOrUpdateTags API operation.
88
90
  # @param [Hash] options
91
+ #
89
92
  # * `:tags` - *required* - (Array<Hash>)
90
93
  # * `:resource_id` - (String)
91
94
  # * `:resource_type` - (String)
@@ -97,6 +100,7 @@ module AWS
97
100
  # @!method delete_auto_scaling_group(options = {})
98
101
  # Calls the DeleteAutoScalingGroup API operation.
99
102
  # @param [Hash] options
103
+ #
100
104
  # * `:auto_scaling_group_name` - *required* - (String)
101
105
  # * `:force_delete` - (Boolean)
102
106
  # @return [Core::Response]
@@ -104,12 +108,14 @@ module AWS
104
108
  # @!method delete_launch_configuration(options = {})
105
109
  # Calls the DeleteLaunchConfiguration API operation.
106
110
  # @param [Hash] options
111
+ #
107
112
  # * `:launch_configuration_name` - *required* - (String)
108
113
  # @return [Core::Response]
109
114
 
110
115
  # @!method delete_notification_configuration(options = {})
111
116
  # Calls the DeleteNotificationConfiguration API operation.
112
117
  # @param [Hash] options
118
+ #
113
119
  # * `:auto_scaling_group_name` - *required* - (String)
114
120
  # * `:topic_arn` - *required* - (String)
115
121
  # @return [Core::Response]
@@ -117,6 +123,7 @@ module AWS
117
123
  # @!method delete_policy(options = {})
118
124
  # Calls the DeletePolicy API operation.
119
125
  # @param [Hash] options
126
+ #
120
127
  # * `:auto_scaling_group_name` - (String)
121
128
  # * `:policy_name` - *required* - (String)
122
129
  # @return [Core::Response]
@@ -124,6 +131,7 @@ module AWS
124
131
  # @!method delete_scheduled_action(options = {})
125
132
  # Calls the DeleteScheduledAction API operation.
126
133
  # @param [Hash] options
134
+ #
127
135
  # * `:auto_scaling_group_name` - (String)
128
136
  # * `:scheduled_action_name` - *required* - (String)
129
137
  # @return [Core::Response]
@@ -131,6 +139,7 @@ module AWS
131
139
  # @!method delete_tags(options = {})
132
140
  # Calls the DeleteTags API operation.
133
141
  # @param [Hash] options
142
+ #
134
143
  # * `:tags` - *required* - (Array<Hash>)
135
144
  # * `:resource_id` - (String)
136
145
  # * `:resource_type` - (String)
@@ -142,6 +151,7 @@ module AWS
142
151
  # @!method describe_adjustment_types(options = {})
143
152
  # Calls the DescribeAdjustmentTypes API operation.
144
153
  # @param [Hash] options
154
+ #
145
155
  # @return [Core::Response]
146
156
  # The #data method of the response object returns
147
157
  # a hash with the following structure:
@@ -152,6 +162,7 @@ module AWS
152
162
  # @!method describe_auto_scaling_groups(options = {})
153
163
  # Calls the DescribeAutoScalingGroups API operation.
154
164
  # @param [Hash] options
165
+ #
155
166
  # * `:auto_scaling_group_names` - (Array<String>)
156
167
  # * `:next_token` - (String)
157
168
  # * `:max_records` - (Integer)
@@ -199,6 +210,7 @@ module AWS
199
210
  # @!method describe_auto_scaling_instances(options = {})
200
211
  # Calls the DescribeAutoScalingInstances API operation.
201
212
  # @param [Hash] options
213
+ #
202
214
  # * `:instance_ids` - (Array<String>)
203
215
  # * `:max_records` - (Integer)
204
216
  # * `:next_token` - (String)
@@ -218,6 +230,7 @@ module AWS
218
230
  # @!method describe_auto_scaling_notification_types(options = {})
219
231
  # Calls the DescribeAutoScalingNotificationTypes API operation.
220
232
  # @param [Hash] options
233
+ #
221
234
  # @return [Core::Response]
222
235
  # The #data method of the response object returns
223
236
  # a hash with the following structure:
@@ -227,6 +240,7 @@ module AWS
227
240
  # @!method describe_launch_configurations(options = {})
228
241
  # Calls the DescribeLaunchConfigurations API operation.
229
242
  # @param [Hash] options
243
+ #
230
244
  # * `:launch_configuration_names` - (Array<String>)
231
245
  # * `:next_token` - (String)
232
246
  # * `:max_records` - (Integer)
@@ -261,6 +275,7 @@ module AWS
261
275
  # @!method describe_metric_collection_types(options = {})
262
276
  # Calls the DescribeMetricCollectionTypes API operation.
263
277
  # @param [Hash] options
278
+ #
264
279
  # @return [Core::Response]
265
280
  # The #data method of the response object returns
266
281
  # a hash with the following structure:
@@ -273,6 +288,7 @@ module AWS
273
288
  # @!method describe_notification_configurations(options = {})
274
289
  # Calls the DescribeNotificationConfigurations API operation.
275
290
  # @param [Hash] options
291
+ #
276
292
  # * `:auto_scaling_group_names` - (Array<String>)
277
293
  # * `:next_token` - (String)
278
294
  # * `:max_records` - (Integer)
@@ -289,6 +305,7 @@ module AWS
289
305
  # @!method describe_policies(options = {})
290
306
  # Calls the DescribePolicies API operation.
291
307
  # @param [Hash] options
308
+ #
292
309
  # * `:auto_scaling_group_name` - (String)
293
310
  # * `:policy_names` - (Array<String>)
294
311
  # * `:next_token` - (String)
@@ -313,6 +330,7 @@ module AWS
313
330
  # @!method describe_scaling_activities(options = {})
314
331
  # Calls the DescribeScalingActivities API operation.
315
332
  # @param [Hash] options
333
+ #
316
334
  # * `:activity_ids` - (Array<String>)
317
335
  # * `:auto_scaling_group_name` - (String)
318
336
  # * `:max_records` - (Integer)
@@ -337,6 +355,7 @@ module AWS
337
355
  # @!method describe_scaling_process_types(options = {})
338
356
  # Calls the DescribeScalingProcessTypes API operation.
339
357
  # @param [Hash] options
358
+ #
340
359
  # @return [Core::Response]
341
360
  # The #data method of the response object returns
342
361
  # a hash with the following structure:
@@ -347,6 +366,7 @@ module AWS
347
366
  # @!method describe_scheduled_actions(options = {})
348
367
  # Calls the DescribeScheduledActions API operation.
349
368
  # @param [Hash] options
369
+ #
350
370
  # * `:auto_scaling_group_name` - (String)
351
371
  # * `:scheduled_action_names` - (Array<String>)
352
372
  # * `:start_time` - (String<ISO8601 datetime>)
@@ -373,6 +393,7 @@ module AWS
373
393
  # @!method describe_tags(options = {})
374
394
  # Calls the DescribeTags API operation.
375
395
  # @param [Hash] options
396
+ #
376
397
  # * `:filters` - (Array<Hash>)
377
398
  # * `:name` - (String)
378
399
  # * `:values` - (Array<String>)
@@ -393,6 +414,7 @@ module AWS
393
414
  # @!method describe_termination_policy_types(options = {})
394
415
  # Calls the DescribeTerminationPolicyTypes API operation.
395
416
  # @param [Hash] options
417
+ #
396
418
  # @return [Core::Response]
397
419
  # The #data method of the response object returns
398
420
  # a hash with the following structure:
@@ -402,6 +424,7 @@ module AWS
402
424
  # @!method disable_metrics_collection(options = {})
403
425
  # Calls the DisableMetricsCollection API operation.
404
426
  # @param [Hash] options
427
+ #
405
428
  # * `:auto_scaling_group_name` - *required* - (String)
406
429
  # * `:metrics` - (Array<String>)
407
430
  # @return [Core::Response]
@@ -409,6 +432,7 @@ module AWS
409
432
  # @!method enable_metrics_collection(options = {})
410
433
  # Calls the EnableMetricsCollection API operation.
411
434
  # @param [Hash] options
435
+ #
412
436
  # * `:auto_scaling_group_name` - *required* - (String)
413
437
  # * `:metrics` - (Array<String>)
414
438
  # * `:granularity` - *required* - (String)
@@ -417,6 +441,7 @@ module AWS
417
441
  # @!method execute_policy(options = {})
418
442
  # Calls the ExecutePolicy API operation.
419
443
  # @param [Hash] options
444
+ #
420
445
  # * `:auto_scaling_group_name` - (String)
421
446
  # * `:policy_name` - *required* - (String)
422
447
  # * `:honor_cooldown` - (Boolean)
@@ -425,6 +450,7 @@ module AWS
425
450
  # @!method put_notification_configuration(options = {})
426
451
  # Calls the PutNotificationConfiguration API operation.
427
452
  # @param [Hash] options
453
+ #
428
454
  # * `:auto_scaling_group_name` - *required* - (String)
429
455
  # * `:topic_arn` - *required* - (String)
430
456
  # * `:notification_types` - *required* - (Array<String>)
@@ -433,6 +459,7 @@ module AWS
433
459
  # @!method put_scaling_policy(options = {})
434
460
  # Calls the PutScalingPolicy API operation.
435
461
  # @param [Hash] options
462
+ #
436
463
  # * `:auto_scaling_group_name` - *required* - (String)
437
464
  # * `:policy_name` - *required* - (String)
438
465
  # * `:scaling_adjustment` - *required* - (Integer)
@@ -448,6 +475,7 @@ module AWS
448
475
  # @!method put_scheduled_update_group_action(options = {})
449
476
  # Calls the PutScheduledUpdateGroupAction API operation.
450
477
  # @param [Hash] options
478
+ #
451
479
  # * `:auto_scaling_group_name` - *required* - (String)
452
480
  # * `:scheduled_action_name` - *required* - (String)
453
481
  # * `:time` - (String<ISO8601 datetime>)
@@ -462,6 +490,7 @@ module AWS
462
490
  # @!method resume_processes(options = {})
463
491
  # Calls the ResumeProcesses API operation.
464
492
  # @param [Hash] options
493
+ #
465
494
  # * `:auto_scaling_group_name` - *required* - (String)
466
495
  # * `:scaling_processes` - (Array<String>)
467
496
  # @return [Core::Response]
@@ -469,6 +498,7 @@ module AWS
469
498
  # @!method set_desired_capacity(options = {})
470
499
  # Calls the SetDesiredCapacity API operation.
471
500
  # @param [Hash] options
501
+ #
472
502
  # * `:auto_scaling_group_name` - *required* - (String)
473
503
  # * `:desired_capacity` - *required* - (Integer)
474
504
  # * `:honor_cooldown` - (Boolean)
@@ -477,6 +507,7 @@ module AWS
477
507
  # @!method set_instance_health(options = {})
478
508
  # Calls the SetInstanceHealth API operation.
479
509
  # @param [Hash] options
510
+ #
480
511
  # * `:instance_id` - *required* - (String)
481
512
  # * `:health_status` - *required* - (String)
482
513
  # * `:should_respect_grace_period` - (Boolean)
@@ -485,6 +516,7 @@ module AWS
485
516
  # @!method suspend_processes(options = {})
486
517
  # Calls the SuspendProcesses API operation.
487
518
  # @param [Hash] options
519
+ #
488
520
  # * `:auto_scaling_group_name` - *required* - (String)
489
521
  # * `:scaling_processes` - (Array<String>)
490
522
  # @return [Core::Response]
@@ -492,6 +524,7 @@ module AWS
492
524
  # @!method terminate_instance_in_auto_scaling_group(options = {})
493
525
  # Calls the TerminateInstanceInAutoScalingGroup API operation.
494
526
  # @param [Hash] options
527
+ #
495
528
  # * `:instance_id` - *required* - (String)
496
529
  # * `:should_decrement_desired_capacity` - *required* - (Boolean)
497
530
  # @return [Core::Response]
@@ -513,6 +546,7 @@ module AWS
513
546
  # @!method update_auto_scaling_group(options = {})
514
547
  # Calls the UpdateAutoScalingGroup API operation.
515
548
  # @param [Hash] options
549
+ #
516
550
  # * `:auto_scaling_group_name` - *required* - (String)
517
551
  # * `:launch_configuration_name` - (String)
518
552
  # * `:min_size` - (Integer)
@@ -38,6 +38,7 @@ module AWS
38
38
  # @!method cancel_update_stack(options = {})
39
39
  # Calls the CancelUpdateStack API operation.
40
40
  # @param [Hash] options
41
+ #
41
42
  # * `:stack_name` - *required* - (String) The name or the unique
42
43
  # identifier associated with the stack.
43
44
  # @return [Core::Response]
@@ -45,6 +46,7 @@ module AWS
45
46
  # @!method create_stack(options = {})
46
47
  # Calls the CreateStack API operation.
47
48
  # @param [Hash] options
49
+ #
48
50
  # * `:stack_name` - *required* - (String) The name associated with the
49
51
  # stack. The name must be unique within your AWS account. Must
50
52
  # contain only alphanumeric characters (case sensitive) and start
@@ -110,6 +112,7 @@ module AWS
110
112
  # @!method delete_stack(options = {})
111
113
  # Calls the DeleteStack API operation.
112
114
  # @param [Hash] options
115
+ #
113
116
  # * `:stack_name` - *required* - (String) The name or the unique
114
117
  # identifier associated with the stack.
115
118
  # @return [Core::Response]
@@ -117,6 +120,7 @@ module AWS
117
120
  # @!method describe_stack_events(options = {})
118
121
  # Calls the DescribeStackEvents API operation.
119
122
  # @param [Hash] options
123
+ #
120
124
  # * `:stack_name` - (String) The name or the unique identifier
121
125
  # associated with the stack. Default: There is no default value.
122
126
  # * `:next_token` - (String) String that identifies the start of the
@@ -142,6 +146,7 @@ module AWS
142
146
  # @!method describe_stack_resource(options = {})
143
147
  # Calls the DescribeStackResource API operation.
144
148
  # @param [Hash] options
149
+ #
145
150
  # * `:stack_name` - *required* - (String) The name or the unique
146
151
  # identifier associated with the stack. Default: There is no default
147
152
  # value.
@@ -167,6 +172,7 @@ module AWS
167
172
  # @!method describe_stack_resources(options = {})
168
173
  # Calls the DescribeStackResources API operation.
169
174
  # @param [Hash] options
175
+ #
170
176
  # * `:stack_name` - (String) The name or the unique identifier
171
177
  # associated with the stack. Required: Conditional. If you do not
172
178
  # specify StackName, you must specify PhysicalResourceId. Default:
@@ -200,6 +206,7 @@ module AWS
200
206
  # @!method describe_stacks(options = {})
201
207
  # Calls the DescribeStacks API operation.
202
208
  # @param [Hash] options
209
+ #
203
210
  # * `:stack_name` - (String) The name or the unique identifier
204
211
  # associated with the stack. Default: There is no default value.
205
212
  # * `:next_token` - (String)
@@ -234,6 +241,7 @@ module AWS
234
241
  # @!method estimate_template_cost(options = {})
235
242
  # Calls the EstimateTemplateCost API operation.
236
243
  # @param [Hash] options
244
+ #
237
245
  # * `:template_body` - (String) Structure containing the template body.
238
246
  # (For more information, go to the AWS CloudFormation User Guide.)
239
247
  # Conditional: You must pass TemplateBody or TemplateURL. If both are
@@ -258,6 +266,7 @@ module AWS
258
266
  # @!method get_template(options = {})
259
267
  # Calls the GetTemplate API operation.
260
268
  # @param [Hash] options
269
+ #
261
270
  # * `:stack_name` - *required* - (String) The name or the unique
262
271
  # identifier associated with the stack.
263
272
  # @return [Core::Response]
@@ -269,6 +278,7 @@ module AWS
269
278
  # @!method list_stack_resources(options = {})
270
279
  # Calls the ListStackResources API operation.
271
280
  # @param [Hash] options
281
+ #
272
282
  # * `:stack_name` - *required* - (String) The name or the unique
273
283
  # identifier associated with the stack. Default: There is no default
274
284
  # value.
@@ -291,6 +301,7 @@ module AWS
291
301
  # @!method list_stacks(options = {})
292
302
  # Calls the ListStacks API operation.
293
303
  # @param [Hash] options
304
+ #
294
305
  # * `:next_token` - (String) String that identifies the start of the
295
306
  # next list of stacks, if there is one. Default: There is no default
296
307
  # value.
@@ -316,6 +327,7 @@ module AWS
316
327
  # @!method update_stack(options = {})
317
328
  # Calls the UpdateStack API operation.
318
329
  # @param [Hash] options
330
+ #
319
331
  # * `:stack_name` - *required* - (String) The name or stack ID of the
320
332
  # stack to update. Must contain only alphanumeric characters (case
321
333
  # sensitive) and start with an alpha character. Maximum length of the
@@ -351,6 +363,7 @@ module AWS
351
363
  # @!method validate_template(options = {})
352
364
  # Calls the ValidateTemplate API operation.
353
365
  # @param [Hash] options
366
+ #
354
367
  # * `:template_body` - (String) String containing the template body.
355
368
  # (For more information, go to the AWS CloudFormation User Guide.)
356
369
  # Conditional: You must pass TemplateURL or TemplateBody. If both are
@@ -23,24 +23,25 @@ module AWS
23
23
  # @!method create_cloud_front_origin_access_identity(options = {})
24
24
  # Calls the POST CreateCloudFrontOriginAccessIdentity API operation.
25
25
  # @param [Hash] options
26
- # * `:cloud_front_origin_access_identity_config` - *required* - (Hash)
27
- # The origin access identity's configuration information.
28
- # * `:caller_reference` - *required* - (String) A unique number that
29
- # ensures the request can't be replayed. If the CallerReference is
30
- # new (no matter the content of the
31
- # CloudFrontOriginAccessIdentityConfig object), a new origin access
32
- # identity is created. If the CallerReference is a value you already
33
- # sent in a previous request to create an identity, and the content
34
- # of the CloudFrontOriginAccessIdentityConfig is identical to the
35
- # original request (ignoring white space), the response includes the
36
- # same information returned to the original request. If the
37
- # CallerReference is a value you already sent in a previous request
38
- # to create an identity but the content of the
39
- # CloudFrontOriginAccessIdentityConfig is different from the original
40
- # request, CloudFront returns a
41
- # CloudFrontOriginAccessIdentityAlreadyExists error.
42
- # * `:comment` - *required* - (String) Any comments you want to include
43
- # about the origin access identity.
26
+ #
27
+ # * `:cloud_front_origin_access_identity_config` - *required* - (Hash)
28
+ # The origin access identity's configuration information.
29
+ # * `:caller_reference` - *required* - (String) A unique number that
30
+ # ensures the request can't be replayed. If the CallerReference is
31
+ # new (no matter the content of the
32
+ # CloudFrontOriginAccessIdentityConfig object), a new origin access
33
+ # identity is created. If the CallerReference is a value you
34
+ # already sent in a previous request to create an identity, and the
35
+ # content of the CloudFrontOriginAccessIdentityConfig is identical
36
+ # to the original request (ignoring white space), the response
37
+ # includes the same information returned to the original request.
38
+ # If the CallerReference is a value you already sent in a previous
39
+ # request to create an identity but the content of the
40
+ # CloudFrontOriginAccessIdentityConfig is different from the
41
+ # original request, CloudFront returns a
42
+ # CloudFrontOriginAccessIdentityAlreadyExists error.
43
+ # * `:comment` - *required* - (String) Any comments you want to
44
+ # include about the origin access identity.
44
45
  # @return [Core::Response]
45
46
  # The #data method of the response object returns
46
47
  # a hash with the following structure:
@@ -54,173 +55,93 @@ module AWS
54
55
  # @!method create_distribution(options = {})
55
56
  # Calls the POST CreateDistribution API operation.
56
57
  # @param [Hash] options
57
- # * `:distribution_config` - *required* - (Hash) The distribution's
58
- # configuration information.
59
- # * `:caller_reference` - *required* - (String) A unique number that
60
- # ensures the request can't be replayed. If the CallerReference is
61
- # new (no matter the content of the DistributionConfig object), a new
62
- # distribution is created. If the CallerReference is a value you
63
- # already sent in a previous request to create a distribution, and
64
- # the content of the DistributionConfig is identical to the original
65
- # request (ignoring white space), the response includes the same
66
- # information returned to the original request. If the
67
- # CallerReference is a value you already sent in a previous request
68
- # to create a distribution but the content of the DistributionConfig
69
- # is different from the original request, CloudFront returns a
70
- # DistributionAlreadyExists error.
71
- # * `:aliases` - *required* - (Hash) A complex type that contains
72
- # information about CNAMEs (alternate domain names), if any, for this
73
- # distribution.
74
- # * `:quantity` - *required* - (Integer) The number of CNAMEs, if
75
- # any, for this distribution.
76
- # * `:items` - (Array<String>) Optional: A complex type that contains
77
- # CNAME elements, if any, for this distribution. If Quantity is 0,
78
- # you can omit Items.
79
- # * `:default_root_object` - *required* - (String) The object that you
80
- # want CloudFront to return (for example, index.html) when an end
81
- # user requests the root URL for your distribution
82
- # (http://www.example.com) instead of an object in your distribution
83
- # (http://www.example.com/index.html). Specifying a default root
84
- # object avoids exposing the contents of your distribution. If you
85
- # don't want to specify a default root object when you create a
86
- # distribution, include an empty DefaultRootObject element. To delete
87
- # the default root object from an existing distribution, update the
88
- # distribution configuration and include an empty DefaultRootObject
89
- # element. To replace the default root object, update the
90
- # distribution configuration and specify the new object.
91
- # * `:origins` - *required* - (Hash) A complex type that contains
92
- # information about origins for this distribution.
93
- # * `:quantity` - *required* - (Integer) The number of origins for
94
- # this distribution.
95
- # * `:items` - (Array<Hash>) A complex type that contains origins for
58
+ #
59
+ # * `:distribution_config` - *required* - (Hash) The distribution's
60
+ # configuration information.
61
+ # * `:caller_reference` - *required* - (String) A unique number that
62
+ # ensures the request can't be replayed. If the CallerReference is
63
+ # new (no matter the content of the DistributionConfig object), a
64
+ # new distribution is created. If the CallerReference is a value
65
+ # you already sent in a previous request to create a distribution,
66
+ # and the content of the DistributionConfig is identical to the
67
+ # original request (ignoring white space), the response includes
68
+ # the same information returned to the original request. If the
69
+ # CallerReference is a value you already sent in a previous request
70
+ # to create a distribution but the content of the
71
+ # DistributionConfig is different from the original request,
72
+ # CloudFront returns a DistributionAlreadyExists error.
73
+ # * `:aliases` - *required* - (Hash) A complex type that contains
74
+ # information about CNAMEs (alternate domain names), if any, for
96
75
  # this distribution.
97
- # * `:id` - *required* - (String) A unique identifier for the
98
- # origin. The value of Id must be unique within the distribution.
99
- # You use the value of Id when you create a cache behavior. The
100
- # Id identifies the origin that CloudFront routes a request to
101
- # when the request matches the path pattern for that cache
102
- # behavior.
103
- # * `:domain_name` - *required* - (String) Amazon S3 origins: The
104
- # DNS name of the Amazon S3 bucket from which you want CloudFront
105
- # to get objects for this origin, for example,
106
- # myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain
107
- # name for the HTTP server from which you want CloudFront to get
108
- # objects for this origin, for example, www.example.com.
109
- # * `:s3_origin_config` - (Hash) A complex type that contains
110
- # information about the Amazon S3 origin. If the origin is a
111
- # custom origin, use the CustomOriginConfig element instead.
112
- # * `:origin_access_identity` - *required* - (String) The
113
- # CloudFront origin access identity to associate with the
114
- # origin. Use an origin access identity to configure the origin
115
- # so that end users can only access objects in an Amazon S3
116
- # bucket through CloudFront. If you want end users to be able
117
- # to access objects using either the CloudFront URL or the
118
- # Amazon S3 URL, specify an empty OriginAccessIdentity element.
119
- # To delete the origin access identity from an existing
120
- # distribution, update the distribution configuration and
121
- # include an empty OriginAccessIdentity element. To replace the
122
- # origin access identity, update the distribution configuration
123
- # and specify the new origin access identity.
124
- # * `:custom_origin_config` - (Hash) A complex type that contains
125
- # information about a custom origin. If the origin is an Amazon
126
- # S3 bucket, use the S3OriginConfig element instead.
127
- # * `:http_port` - *required* - (Integer) The HTTP port the
128
- # custom origin listens on.
129
- # * `:https_port` - *required* - (Integer) The HTTPS port the
130
- # custom origin listens on.
131
- # * `:origin_protocol_policy` - *required* - (String) The origin
132
- # protocol policy to apply to your origin. Valid values
133
- # include:
134
- # * `http-only`
135
- # * `match-viewer`
136
- # * `:default_cache_behavior` - *required* - (Hash) A complex type that
137
- # describes the default cache behavior if you do not specify a
138
- # CacheBehavior element or if files don't match any of the values of
139
- # PathPattern in CacheBehavior elements.You must create exactly one
140
- # default cache behavior.
141
- # * `:target_origin_id` - *required* - (String) The value of ID for
142
- # the origin that you want CloudFront to route requests to when a
143
- # request matches the path pattern either for a cache behavior or
144
- # for the default cache behavior.
145
- # * `:forwarded_values` - *required* - (Hash) A complex type that
146
- # specifies how CloudFront handles query strings and cookies.
147
- # * `:query_string` - *required* - (Boolean) Indicates whether you
148
- # want CloudFront to forward query strings to the origin that is
149
- # associated with this cache behavior. If so, specify `true` ; if
150
- # not, specify `false` .
151
- # * `:cookies` - *required* - (Hash) A complex type that specifies
152
- # how CloudFront handles cookies.
153
- # * `:forward` - *required* - (String) Use this element to
154
- # specify whether you want CloudFront to forward cookies to the
155
- # origin that is associated with this cache behavior. You can
156
- # specify all, none or whitelist. If you choose All, CloudFront
157
- # forwards all cookies regardless of how many your application
158
- # uses. Valid values include:
159
- # * `none`
160
- # * `whitelist`
161
- # * `all`
162
- # * `:whitelisted_names` - (Hash) A complex type that specifies
163
- # the whitelisted cookies, if any, that you want CloudFront to
164
- # forward to your origin that is associated with this cache
165
- # behavior.
166
- # * `:quantity` - *required* - (Integer) The number of
167
- # whitelisted cookies for this cache behavior.
168
- # * `:items` - (Array<String>) Optional: A complex type that
169
- # contains whitelisted cookies for this cache behavior. If
170
- # Quantity is 0, you can omit Items.
171
- # * `:trusted_signers` - *required* - (Hash) A complex type that
172
- # specifies the AWS accounts, if any, that you want to allow to
173
- # create signed URLs for private content. If you want to require
174
- # signed URLs in requests for objects in the target origin that
175
- # match the PathPattern for this cache behavior, specify `true` for
176
- # Enabled, and specify the applicable values for Quantity and
177
- # Items. For more information, go to Using a Signed URL to Serve
178
- # Private Content in the Amazon CloudFront Developer Guide. If you
179
- # don't want to require signed URLs in requests for objects that
180
- # match PathPattern, specify `false` for Enabled and 0 for
181
- # Quantity. Omit Items. To add, change, or remove one or more
182
- # trusted signers, change Enabled to `true` (if it's currently
183
- # `false` ), change Quantity as applicable, and specify all of the
184
- # trusted signers that you want to include in the updated
185
- # distribution.
186
- # * `:enabled` - *required* - (Boolean) Specifies whether you want
187
- # to require end users to use signed URLs to access the files
188
- # specified by PathPattern and TargetOriginId.
189
- # * `:quantity` - *required* - (Integer) The number of trusted
190
- # signers for this cache behavior.
76
+ # * `:quantity` - *required* - (Integer) The number of CNAMEs, if
77
+ # any, for this distribution.
191
78
  # * `:items` - (Array<String>) Optional: A complex type that
192
- # contains trusted signers for this cache behavior. If Quantity
193
- # is 0, you can omit Items.
194
- # * `:viewer_protocol_policy` - *required* - (String) Use this
195
- # element to specify the protocol that users can use to access the
196
- # files in the origin specified by TargetOriginId when a request
197
- # matches the path pattern in PathPattern. If you want CloudFront
198
- # to allow end users to use any available protocol, specify
199
- # allow-all. If you want CloudFront to require HTTPS, specify
200
- # https. Valid values include:
201
- # * `allow-all`
202
- # * `https-only`
203
- # * `:min_ttl` - *required* - (Integer) The minimum amount of time
204
- # that you want objects to stay in CloudFront caches before
205
- # CloudFront queries your origin to see whether the object has been
206
- # updated.You can specify a value from 0 to 3,153,600,000 seconds
207
- # (100 years).
208
- # * `:cache_behaviors` - *required* - (Hash) A complex type that
209
- # contains zero or more CacheBehavior elements.
210
- # * `:quantity` - *required* - (Integer) The number of cache
211
- # behaviors for this distribution.
212
- # * `:items` - (Array<Hash>) Optional: A complex type that contains
213
- # cache behaviors for this distribution. If Quantity is 0, you can
214
- # omit Items.
215
- # * `:path_pattern` - *required* - (String) The pattern (for
216
- # example, images/*.jpg) that specifies which requests you want
217
- # this cache behavior to apply to. When CloudFront receives an
218
- # end-user request, the requested path is compared with path
219
- # patterns in the order in which cache behaviors are listed in
220
- # the distribution. The path pattern for the default cache
221
- # behavior is * and cannot be changed. If the request for an
222
- # object does not match the path pattern for any cache behaviors,
223
- # CloudFront applies the behavior in the default cache behavior.
79
+ # contains CNAME elements, if any, for this distribution. If
80
+ # Quantity is 0, you can omit Items.
81
+ # * `:default_root_object` - *required* - (String) The object that
82
+ # you want CloudFront to return (for example, index.html) when an
83
+ # end user requests the root URL for your distribution
84
+ # (http://www.example.com) instead of an object in your
85
+ # distribution (http://www.example.com/index.html). Specifying a
86
+ # default root object avoids exposing the contents of your
87
+ # distribution. If you don't want to specify a default root object
88
+ # when you create a distribution, include an empty
89
+ # DefaultRootObject element. To delete the default root object from
90
+ # an existing distribution, update the distribution configuration
91
+ # and include an empty DefaultRootObject element. To replace the
92
+ # default root object, update the distribution configuration and
93
+ # specify the new object.
94
+ # * `:origins` - *required* - (Hash) A complex type that contains
95
+ # information about origins for this distribution.
96
+ # * `:quantity` - *required* - (Integer) The number of origins for
97
+ # this distribution.
98
+ # * `:items` - (Array<Hash>) A complex type that contains origins
99
+ # for this distribution.
100
+ # * `:id` - *required* - (String) A unique identifier for the
101
+ # origin. The value of Id must be unique within the
102
+ # distribution. You use the value of Id when you create a cache
103
+ # behavior. The Id identifies the origin that CloudFront routes
104
+ # a request to when the request matches the path pattern for
105
+ # that cache behavior.
106
+ # * `:domain_name` - *required* - (String) Amazon S3 origins: The
107
+ # DNS name of the Amazon S3 bucket from which you want
108
+ # CloudFront to get objects for this origin, for example,
109
+ # myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain
110
+ # name for the HTTP server from which you want CloudFront to
111
+ # get objects for this origin, for example, www.example.com.
112
+ # * `:s3_origin_config` - (Hash) A complex type that contains
113
+ # information about the Amazon S3 origin. If the origin is a
114
+ # custom origin, use the CustomOriginConfig element instead.
115
+ # * `:origin_access_identity` - *required* - (String) The
116
+ # CloudFront origin access identity to associate with the
117
+ # origin. Use an origin access identity to configure the
118
+ # origin so that end users can only access objects in an
119
+ # Amazon S3 bucket through CloudFront. If you want end users
120
+ # to be able to access objects using either the CloudFront
121
+ # URL or the Amazon S3 URL, specify an empty
122
+ # OriginAccessIdentity element. To delete the origin access
123
+ # identity from an existing distribution, update the
124
+ # distribution configuration and include an empty
125
+ # OriginAccessIdentity element. To replace the origin access
126
+ # identity, update the distribution configuration and specify
127
+ # the new origin access identity.
128
+ # * `:custom_origin_config` - (Hash) A complex type that contains
129
+ # information about a custom origin. If the origin is an Amazon
130
+ # S3 bucket, use the S3OriginConfig element instead.
131
+ # * `:http_port` - *required* - (Integer) The HTTP port the
132
+ # custom origin listens on.
133
+ # * `:https_port` - *required* - (Integer) The HTTPS port the
134
+ # custom origin listens on.
135
+ # * `:origin_protocol_policy` - *required* - (String) The
136
+ # origin protocol policy to apply to your origin. Valid
137
+ # values include:
138
+ # * `http-only`
139
+ # * `match-viewer`
140
+ # * `:default_cache_behavior` - *required* - (Hash) A complex type
141
+ # that describes the default cache behavior if you do not specify a
142
+ # CacheBehavior element or if files don't match any of the values
143
+ # of PathPattern in CacheBehavior elements.You must create exactly
144
+ # one default cache behavior.
224
145
  # * `:target_origin_id` - *required* - (String) The value of ID for
225
146
  # the origin that you want CloudFront to route requests to when a
226
147
  # request matches the path pattern either for a cache behavior or
@@ -288,41 +209,126 @@ module AWS
288
209
  # CloudFront queries your origin to see whether the object has
289
210
  # been updated.You can specify a value from 0 to 3,153,600,000
290
211
  # seconds (100 years).
291
- # * `:comment` - *required* - (String) Any comments you want to include
292
- # about the distribution.
293
- # * `:logging` - *required* - (Hash) A complex type that controls
294
- # whether access logs are written for the distribution.
295
- # * `:enabled` - *required* - (Boolean) Specifies whether you want
296
- # CloudFront to save access logs to an Amazon S3 bucket. If you do
297
- # not want to enable logging when you create a distribution or if
298
- # you want to disable logging for an existing distribution, specify
299
- # `false` for Enabled, and specify empty Bucket and Prefix
300
- # elements. If you specify `false` for Enabled but you specify
301
- # values for Bucket, prefix and IncludeCookies, the values are
302
- # automatically deleted.
303
- # * `:include_cookies` - *required* - (Boolean) Specifies whether you
304
- # want CloudFront to include cookies in access logs, specify `true`
305
- # for IncludeCookies. If you choose to include cookies in logs,
306
- # CloudFront logs all cookies regardless of how you configure the
307
- # cache behaviors for this distribution. If you do not want to
308
- # include cookies when you create a distribution or if you want to
309
- # disable include cookies for an existing distribution, specify
310
- # `false` for IncludeCookies.
311
- # * `:bucket` - *required* - (String) The Amazon S3 bucket to store
312
- # the access logs in, for example, myawslogbucket.s3.amazonaws.com.
313
- # * `:prefix` - *required* - (String) An optional string that you
314
- # want CloudFront to prefix to the access log filenames for this
315
- # distribution, for example, myprefix/. If you want to enable
316
- # logging, but you do not want to specify a prefix, you still must
317
- # include an empty Prefix element in the Logging element.
318
- # * `:price_class` - *required* - (String) A complex type that contains
319
- # information about price class for this distribution. Valid values
320
- # include:
321
- # * `PriceClass_100`
322
- # * `PriceClass_200`
323
- # * `PriceClass_All`
324
- # * `:enabled` - *required* - (Boolean) Whether the distribution is
325
- # enabled to accept end user requests for content.
212
+ # * `:cache_behaviors` - *required* - (Hash) A complex type that
213
+ # contains zero or more CacheBehavior elements.
214
+ # * `:quantity` - *required* - (Integer) The number of cache
215
+ # behaviors for this distribution.
216
+ # * `:items` - (Array<Hash>) Optional: A complex type that contains
217
+ # cache behaviors for this distribution. If Quantity is 0, you
218
+ # can omit Items.
219
+ # * `:path_pattern` - *required* - (String) The pattern (for
220
+ # example, images/*.jpg) that specifies which requests you want
221
+ # this cache behavior to apply to. When CloudFront receives an
222
+ # end-user request, the requested path is compared with path
223
+ # patterns in the order in which cache behaviors are listed in
224
+ # the distribution. The path pattern for the default cache
225
+ # behavior is * and cannot be changed. If the request for an
226
+ # object does not match the path pattern for any cache
227
+ # behaviors, CloudFront applies the behavior in the default
228
+ # cache behavior.
229
+ # * `:target_origin_id` - *required* - (String) The value of ID
230
+ # for the origin that you want CloudFront to route requests to
231
+ # when a request matches the path pattern either for a cache
232
+ # behavior or for the default cache behavior.
233
+ # * `:forwarded_values` - *required* - (Hash) A complex type that
234
+ # specifies how CloudFront handles query strings and cookies.
235
+ # * `:query_string` - *required* - (Boolean) Indicates whether
236
+ # you want CloudFront to forward query strings to the origin
237
+ # that is associated with this cache behavior. If so, specify
238
+ # `true` ; if not, specify `false` .
239
+ # * `:cookies` - *required* - (Hash) A complex type that
240
+ # specifies how CloudFront handles cookies.
241
+ # * `:forward` - *required* - (String) Use this element to
242
+ # specify whether you want CloudFront to forward cookies to
243
+ # the origin that is associated with this cache behavior.
244
+ # You can specify all, none or whitelist. If you choose
245
+ # All, CloudFront forwards all cookies regardless of how
246
+ # many your application uses. Valid values include:
247
+ # * `none`
248
+ # * `whitelist`
249
+ # * `all`
250
+ # * `:whitelisted_names` - (Hash) A complex type that
251
+ # specifies the whitelisted cookies, if any, that you want
252
+ # CloudFront to forward to your origin that is associated
253
+ # with this cache behavior.
254
+ # * `:quantity` - *required* - (Integer) The number of
255
+ # whitelisted cookies for this cache behavior.
256
+ # * `:items` - (Array<String>) Optional: A complex type
257
+ # that contains whitelisted cookies for this cache
258
+ # behavior. If Quantity is 0, you can omit Items.
259
+ # * `:trusted_signers` - *required* - (Hash) A complex type that
260
+ # specifies the AWS accounts, if any, that you want to allow to
261
+ # create signed URLs for private content. If you want to
262
+ # require signed URLs in requests for objects in the target
263
+ # origin that match the PathPattern for this cache behavior,
264
+ # specify `true` for Enabled, and specify the applicable values
265
+ # for Quantity and Items. For more information, go to Using a
266
+ # Signed URL to Serve Private Content in the Amazon CloudFront
267
+ # Developer Guide. If you don't want to require signed URLs in
268
+ # requests for objects that match PathPattern, specify `false`
269
+ # for Enabled and 0 for Quantity. Omit Items. To add, change,
270
+ # or remove one or more trusted signers, change Enabled to
271
+ # `true` (if it's currently `false` ), change Quantity as
272
+ # applicable, and specify all of the trusted signers that you
273
+ # want to include in the updated distribution.
274
+ # * `:enabled` - *required* - (Boolean) Specifies whether you
275
+ # want to require end users to use signed URLs to access the
276
+ # files specified by PathPattern and TargetOriginId.
277
+ # * `:quantity` - *required* - (Integer) The number of trusted
278
+ # signers for this cache behavior.
279
+ # * `:items` - (Array<String>) Optional: A complex type that
280
+ # contains trusted signers for this cache behavior. If
281
+ # Quantity is 0, you can omit Items.
282
+ # * `:viewer_protocol_policy` - *required* - (String) Use this
283
+ # element to specify the protocol that users can use to access
284
+ # the files in the origin specified by TargetOriginId when a
285
+ # request matches the path pattern in PathPattern. If you want
286
+ # CloudFront to allow end users to use any available protocol,
287
+ # specify allow-all. If you want CloudFront to require HTTPS,
288
+ # specify https. Valid values include:
289
+ # * `allow-all`
290
+ # * `https-only`
291
+ # * `:min_ttl` - *required* - (Integer) The minimum amount of
292
+ # time that you want objects to stay in CloudFront caches
293
+ # before CloudFront queries your origin to see whether the
294
+ # object has been updated.You can specify a value from 0 to
295
+ # 3,153,600,000 seconds (100 years).
296
+ # * `:comment` - *required* - (String) Any comments you want to
297
+ # include about the distribution.
298
+ # * `:logging` - *required* - (Hash) A complex type that controls
299
+ # whether access logs are written for the distribution.
300
+ # * `:enabled` - *required* - (Boolean) Specifies whether you want
301
+ # CloudFront to save access logs to an Amazon S3 bucket. If you
302
+ # do not want to enable logging when you create a distribution or
303
+ # if you want to disable logging for an existing distribution,
304
+ # specify `false` for Enabled, and specify empty Bucket and
305
+ # Prefix elements. If you specify `false` for Enabled but you
306
+ # specify values for Bucket, prefix and IncludeCookies, the
307
+ # values are automatically deleted.
308
+ # * `:include_cookies` - *required* - (Boolean) Specifies whether
309
+ # you want CloudFront to include cookies in access logs, specify
310
+ # `true` for IncludeCookies. If you choose to include cookies in
311
+ # logs, CloudFront logs all cookies regardless of how you
312
+ # configure the cache behaviors for this distribution. If you do
313
+ # not want to include cookies when you create a distribution or
314
+ # if you want to disable include cookies for an existing
315
+ # distribution, specify `false` for IncludeCookies.
316
+ # * `:bucket` - *required* - (String) The Amazon S3 bucket to store
317
+ # the access logs in, for example,
318
+ # myawslogbucket.s3.amazonaws.com.
319
+ # * `:prefix` - *required* - (String) An optional string that you
320
+ # want CloudFront to prefix to the access log filenames for this
321
+ # distribution, for example, myprefix/. If you want to enable
322
+ # logging, but you do not want to specify a prefix, you still
323
+ # must include an empty Prefix element in the Logging element.
324
+ # * `:price_class` - *required* - (String) A complex type that
325
+ # contains information about price class for this distribution.
326
+ # Valid values include:
327
+ # * `PriceClass_100`
328
+ # * `PriceClass_200`
329
+ # * `PriceClass_All`
330
+ # * `:enabled` - *required* - (Boolean) Whether the distribution is
331
+ # enabled to accept end user requests for content.
326
332
  # @return [Core::Response]
327
333
  # The #data method of the response object returns
328
334
  # a hash with the following structure:
@@ -402,32 +408,35 @@ module AWS
402
408
  # @!method create_invalidation(options = {})
403
409
  # Calls the POST CreateInvalidation API operation.
404
410
  # @param [Hash] options
405
- # * `:distribution_id` - *required* - (String) The distribution's id.
406
- # * `:invalidation_batch` - *required* - (Hash) The batch information for
407
- # the invalidation.
408
- # * `:paths` - *required* - (Hash) The path of the object to
409
- # invalidate. The path is relative to the distribution and must begin
410
- # with a slash (/). You must enclose each invalidation object with
411
- # the Path element tags. If the path includes non-ASCII characters or
412
- # unsafe characters as defined in RFC 1783
413
- # (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters.
414
- # Do not URL encode any other characters in the path, or CloudFront
415
- # will not invalidate the old version of the updated object.
416
- # * `:quantity` - *required* - (Integer) The number of objects that
417
- # you want to invalidate.
418
- # * `:items` - (Array<String>) A complex type that contains a list of
419
- # the objects that you want to invalidate.
420
- # * `:caller_reference` - *required* - (String) A unique name that
421
- # ensures the request can't be replayed. If the CallerReference is
422
- # new (no matter the content of the Path object), a new distribution
423
- # is created. If the CallerReference is a value you already sent in a
424
- # previous request to create an invalidation batch, and the content
425
- # of each Path element is identical to the original request, the
426
- # response includes the same information returned to the original
427
- # request. If the CallerReference is a value you already sent in a
428
- # previous request to create a distribution but the content of any
429
- # Path is different from the original request, CloudFront returns an
430
- # InvalidationBatchAlreadyExists error.
411
+ #
412
+ # * `:distribution_id` - *required* - (String) The distribution's id.
413
+ # * `:invalidation_batch` - *required* - (Hash) The batch information
414
+ # for the invalidation.
415
+ # * `:paths` - *required* - (Hash) The path of the object to
416
+ # invalidate. The path is relative to the distribution and must
417
+ # begin with a slash (/). You must enclose each invalidation object
418
+ # with the Path element tags. If the path includes non-ASCII
419
+ # characters or unsafe characters as defined in RFC 1783
420
+ # (http://www.ietf.org/rfc/rfc1738.txt), URL encode those
421
+ # characters. Do not URL encode any other characters in the path,
422
+ # or CloudFront will not invalidate the old version of the updated
423
+ # object.
424
+ # * `:quantity` - *required* - (Integer) The number of objects that
425
+ # you want to invalidate.
426
+ # * `:items` - (Array<String>) A complex type that contains a list
427
+ # of the objects that you want to invalidate.
428
+ # * `:caller_reference` - *required* - (String) A unique name that
429
+ # ensures the request can't be replayed. If the CallerReference is
430
+ # new (no matter the content of the Path object), a new
431
+ # distribution is created. If the CallerReference is a value you
432
+ # already sent in a previous request to create an invalidation
433
+ # batch, and the content of each Path element is identical to the
434
+ # original request, the response includes the same information
435
+ # returned to the original request. If the CallerReference is a
436
+ # value you already sent in a previous request to create a
437
+ # distribution but the content of any Path is different from the
438
+ # original request, CloudFront returns an
439
+ # InvalidationBatchAlreadyExists error.
431
440
  # @return [Core::Response]
432
441
  # The #data method of the response object returns
433
442
  # a hash with the following structure:
@@ -444,86 +453,89 @@ module AWS
444
453
  # @!method create_streaming_distribution(options = {})
445
454
  # Calls the POST CreateStreamingDistribution API operation.
446
455
  # @param [Hash] options
447
- # * `:streaming_distribution_config` - *required* - (Hash) The streaming
448
- # distribution's configuration information.
449
- # * `:caller_reference` - *required* - (String) A unique number that
450
- # ensures the request can't be replayed. If the CallerReference is
451
- # new (no matter the content of the StreamingDistributionConfig
452
- # object), a new streaming distribution is created. If the
453
- # CallerReference is a value you already sent in a previous request
454
- # to create a streaming distribution, and the content of the
455
- # StreamingDistributionConfig is identical to the original request
456
- # (ignoring white space), the response includes the same information
457
- # returned to the original request. If the CallerReference is a value
458
- # you already sent in a previous request to create a streaming
459
- # distribution but the content of the StreamingDistributionConfig is
460
- # different from the original request, CloudFront returns a
461
- # DistributionAlreadyExists error.
462
- # * `:s3_origin` - *required* - (Hash) A complex type that contains
463
- # information about the Amazon S3 bucket from which you want
464
- # CloudFront to get your media files for distribution.
465
- # * `:domain_name` - *required* - (String) The DNS name of the S3
466
- # origin.
467
- # * `:origin_access_identity` - *required* - (String) Your S3
468
- # origin's origin access identity.
469
- # * `:aliases` - *required* - (Hash) A complex type that contains
470
- # information about CNAMEs (alternate domain names), if any, for this
471
- # streaming distribution.
472
- # * `:quantity` - *required* - (Integer) The number of CNAMEs, if
473
- # any, for this distribution.
474
- # * `:items` - (Array<String>) Optional: A complex type that contains
475
- # CNAME elements, if any, for this distribution. If Quantity is 0,
476
- # you can omit Items.
477
- # * `:comment` - *required* - (String) Any comments you want to include
478
- # about the streaming distribution.
479
- # * `:logging` - *required* - (Hash) A complex type that controls
480
- # whether access logs are written for the streaming distribution.
481
- # * `:enabled` - *required* - (Boolean) Specifies whether you want
482
- # CloudFront to save access logs to an Amazon S3 bucket. If you do
483
- # not want to enable logging when you create a streaming
484
- # distribution or if you want to disable logging for an existing
485
- # streaming distribution, specify `false` for Enabled, and specify
486
- # empty Bucket and Prefix elements. If you specify `false` for
487
- # Enabled but you specify values for Bucket and Prefix, the values
488
- # are automatically deleted.
489
- # * `:bucket` - *required* - (String) The Amazon S3 bucket to store
490
- # the access logs in, for example, myawslogbucket.s3.amazonaws.com.
491
- # * `:prefix` - *required* - (String) An optional string that you
492
- # want CloudFront to prefix to the access log filenames for this
493
- # streaming distribution, for example, myprefix/. If you want to
494
- # enable logging, but you do not want to specify a prefix, you
495
- # still must include an empty Prefix element in the Logging
496
- # element.
497
- # * `:trusted_signers` - *required* - (Hash) A complex type that
498
- # specifies the AWS accounts, if any, that you want to allow to
499
- # create signed URLs for private content. If you want to require
500
- # signed URLs in requests for objects in the target origin that match
501
- # the PathPattern for this cache behavior, specify `true` for
502
- # Enabled, and specify the applicable values for Quantity and Items.
503
- # For more information, go to Using a Signed URL to Serve Private
504
- # Content in the Amazon CloudFront Developer Guide. If you don't want
505
- # to require signed URLs in requests for objects that match
506
- # PathPattern, specify `false` for Enabled and 0 for Quantity. Omit
507
- # Items. To add, change, or remove one or more trusted signers,
508
- # change Enabled to `true` (if it's currently `false` ), change
509
- # Quantity as applicable, and specify all of the trusted signers that
510
- # you want to include in the updated distribution.
511
- # * `:enabled` - *required* - (Boolean) Specifies whether you want to
512
- # require end users to use signed URLs to access the files
513
- # specified by PathPattern and TargetOriginId.
514
- # * `:quantity` - *required* - (Integer) The number of trusted
515
- # signers for this cache behavior.
516
- # * `:items` - (Array<String>) Optional: A complex type that contains
517
- # trusted signers for this cache behavior. If Quantity is 0, you
518
- # can omit Items.
519
- # * `:price_class` - *required* - (String) A complex type that contains
520
- # information about price class for this streaming distribution.
521
- # Valid values include:
522
- # * `PriceClass_100`
523
- # * `PriceClass_200`
524
- # * `PriceClass_All`
525
- # * `:enabled` - *required* - (Boolean) Whether the streaming
526
- # distribution is enabled to accept end user requests for content.
456
+ #
457
+ # * `:streaming_distribution_config` - *required* - (Hash) The
458
+ # streaming distribution's configuration information.
459
+ # * `:caller_reference` - *required* - (String) A unique number that
460
+ # ensures the request can't be replayed. If the CallerReference is
461
+ # new (no matter the content of the StreamingDistributionConfig
462
+ # object), a new streaming distribution is created. If the
463
+ # CallerReference is a value you already sent in a previous request
464
+ # to create a streaming distribution, and the content of the
465
+ # StreamingDistributionConfig is identical to the original request
466
+ # (ignoring white space), the response includes the same
467
+ # information returned to the original request. If the
468
+ # CallerReference is a value you already sent in a previous request
469
+ # to create a streaming distribution but the content of the
470
+ # StreamingDistributionConfig is different from the original
471
+ # request, CloudFront returns a DistributionAlreadyExists error.
472
+ # * `:s3_origin` - *required* - (Hash) A complex type that contains
473
+ # information about the Amazon S3 bucket from which you want
474
+ # CloudFront to get your media files for distribution.
475
+ # * `:domain_name` - *required* - (String) The DNS name of the S3
476
+ # origin.
477
+ # * `:origin_access_identity` - *required* - (String) Your S3
478
+ # origin's origin access identity.
479
+ # * `:aliases` - *required* - (Hash) A complex type that contains
480
+ # information about CNAMEs (alternate domain names), if any, for
481
+ # this streaming distribution.
482
+ # * `:quantity` - *required* - (Integer) The number of CNAMEs, if
483
+ # any, for this distribution.
484
+ # * `:items` - (Array<String>) Optional: A complex type that
485
+ # contains CNAME elements, if any, for this distribution. If
486
+ # Quantity is 0, you can omit Items.
487
+ # * `:comment` - *required* - (String) Any comments you want to
488
+ # include about the streaming distribution.
489
+ # * `:logging` - *required* - (Hash) A complex type that controls
490
+ # whether access logs are written for the streaming distribution.
491
+ # * `:enabled` - *required* - (Boolean) Specifies whether you want
492
+ # CloudFront to save access logs to an Amazon S3 bucket. If you
493
+ # do not want to enable logging when you create a streaming
494
+ # distribution or if you want to disable logging for an existing
495
+ # streaming distribution, specify `false` for Enabled, and
496
+ # specify empty Bucket and Prefix elements. If you specify
497
+ # `false` for Enabled but you specify values for Bucket and
498
+ # Prefix, the values are automatically deleted.
499
+ # * `:bucket` - *required* - (String) The Amazon S3 bucket to store
500
+ # the access logs in, for example,
501
+ # myawslogbucket.s3.amazonaws.com.
502
+ # * `:prefix` - *required* - (String) An optional string that you
503
+ # want CloudFront to prefix to the access log filenames for this
504
+ # streaming distribution, for example, myprefix/. If you want to
505
+ # enable logging, but you do not want to specify a prefix, you
506
+ # still must include an empty Prefix element in the Logging
507
+ # element.
508
+ # * `:trusted_signers` - *required* - (Hash) A complex type that
509
+ # specifies the AWS accounts, if any, that you want to allow to
510
+ # create signed URLs for private content. If you want to require
511
+ # signed URLs in requests for objects in the target origin that
512
+ # match the PathPattern for this cache behavior, specify `true` for
513
+ # Enabled, and specify the applicable values for Quantity and
514
+ # Items. For more information, go to Using a Signed URL to Serve
515
+ # Private Content in the Amazon CloudFront Developer Guide. If you
516
+ # don't want to require signed URLs in requests for objects that
517
+ # match PathPattern, specify `false` for Enabled and 0 for
518
+ # Quantity. Omit Items. To add, change, or remove one or more
519
+ # trusted signers, change Enabled to `true` (if it's currently
520
+ # `false` ), change Quantity as applicable, and specify all of the
521
+ # trusted signers that you want to include in the updated
522
+ # distribution.
523
+ # * `:enabled` - *required* - (Boolean) Specifies whether you want
524
+ # to require end users to use signed URLs to access the files
525
+ # specified by PathPattern and TargetOriginId.
526
+ # * `:quantity` - *required* - (Integer) The number of trusted
527
+ # signers for this cache behavior.
528
+ # * `:items` - (Array<String>) Optional: A complex type that
529
+ # contains trusted signers for this cache behavior. If Quantity
530
+ # is 0, you can omit Items.
531
+ # * `:price_class` - *required* - (String) A complex type that
532
+ # contains information about price class for this streaming
533
+ # distribution. Valid values include:
534
+ # * `PriceClass_100`
535
+ # * `PriceClass_200`
536
+ # * `PriceClass_All`
537
+ # * `:enabled` - *required* - (Boolean) Whether the streaming
538
+ # distribution is enabled to accept end user requests for content.
527
539
  # @return [Core::Response]
528
540
  # The #data method of the response object returns
529
541
  # a hash with the following structure:
@@ -563,31 +575,36 @@ module AWS
563
575
  # @!method delete_cloud_front_origin_access_identity(options = {})
564
576
  # Calls the DELETE DeleteCloudFrontOriginAccessIdentity API operation.
565
577
  # @param [Hash] options
566
- # * `:id` - *required* - (String) The origin access identity's id.
567
- # * `:if_match` - (String) The value of the ETag header you received from
568
- # a previous GET or PUT request. For example: E2QWRUHAPOMQZL.
578
+ #
579
+ # * `:id` - *required* - (String) The origin access identity's id.
580
+ # * `:if_match` - (String) The value of the ETag header you received
581
+ # from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.
569
582
  # @return [Core::Response]
570
583
 
571
584
  # @!method delete_distribution(options = {})
572
585
  # Calls the DELETE DeleteDistribution API operation.
573
586
  # @param [Hash] options
574
- # * `:id` - *required* - (String) The distribution id.
575
- # * `:if_match` - (String) The value of the ETag header you received when
576
- # you disabled the distribution. For example: E2QWRUHAPOMQZL.
587
+ #
588
+ # * `:id` - *required* - (String) The distribution id.
589
+ # * `:if_match` - (String) The value of the ETag header you received
590
+ # when you disabled the distribution. For example: E2QWRUHAPOMQZL.
577
591
  # @return [Core::Response]
578
592
 
579
593
  # @!method delete_streaming_distribution(options = {})
580
594
  # Calls the DELETE DeleteStreamingDistribution API operation.
581
595
  # @param [Hash] options
582
- # * `:id` - *required* - (String) The distribution id.
583
- # * `:if_match` - (String) The value of the ETag header you received when
584
- # you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.
596
+ #
597
+ # * `:id` - *required* - (String) The distribution id.
598
+ # * `:if_match` - (String) The value of the ETag header you received
599
+ # when you disabled the streaming distribution. For example:
600
+ # E2QWRUHAPOMQZL.
585
601
  # @return [Core::Response]
586
602
 
587
603
  # @!method get_cloud_front_origin_access_identity(options = {})
588
604
  # Calls the GET GetCloudFrontOriginAccessIdentity API operation.
589
605
  # @param [Hash] options
590
- # * `:id` - *required* - (String) The identity's id.
606
+ #
607
+ # * `:id` - *required* - (String) The identity's id.
591
608
  # @return [Core::Response]
592
609
  # The #data method of the response object returns
593
610
  # a hash with the following structure:
@@ -601,7 +618,8 @@ module AWS
601
618
  # @!method get_cloud_front_origin_access_identity_config(options = {})
602
619
  # Calls the GET GetCloudFrontOriginAccessIdentityConfig API operation.
603
620
  # @param [Hash] options
604
- # * `:id` - *required* - (String) The identity's id.
621
+ #
622
+ # * `:id` - *required* - (String) The identity's id.
605
623
  # @return [Core::Response]
606
624
  # The #data method of the response object returns
607
625
  # a hash with the following structure:
@@ -612,7 +630,8 @@ module AWS
612
630
  # @!method get_distribution(options = {})
613
631
  # Calls the GET GetDistribution API operation.
614
632
  # @param [Hash] options
615
- # * `:id` - *required* - (String) The distribution's id.
633
+ #
634
+ # * `:id` - *required* - (String) The distribution's id.
616
635
  # @return [Core::Response]
617
636
  # The #data method of the response object returns
618
637
  # a hash with the following structure:
@@ -692,7 +711,8 @@ module AWS
692
711
  # @!method get_distribution_config(options = {})
693
712
  # Calls the GET GetDistributionConfig API operation.
694
713
  # @param [Hash] options
695
- # * `:id` - *required* - (String) The distribution's id.
714
+ #
715
+ # * `:id` - *required* - (String) The distribution's id.
696
716
  # @return [Core::Response]
697
717
  # The #data method of the response object returns
698
718
  # a hash with the following structure:
@@ -758,8 +778,9 @@ module AWS
758
778
  # @!method get_invalidation(options = {})
759
779
  # Calls the GET GetInvalidation API operation.
760
780
  # @param [Hash] options
761
- # * `:distribution_id` - *required* - (String) The distribution's id.
762
- # * `:id` - *required* - (String) The invalidation's id.
781
+ #
782
+ # * `:distribution_id` - *required* - (String) The distribution's id.
783
+ # * `:id` - *required* - (String) The invalidation's id.
763
784
  # @return [Core::Response]
764
785
  # The #data method of the response object returns
765
786
  # a hash with the following structure:
@@ -776,7 +797,8 @@ module AWS
776
797
  # @!method get_streaming_distribution(options = {})
777
798
  # Calls the GET GetStreamingDistribution API operation.
778
799
  # @param [Hash] options
779
- # * `:id` - *required* - (String) The streaming distribution's id.
800
+ #
801
+ # * `:id` - *required* - (String) The streaming distribution's id.
780
802
  # @return [Core::Response]
781
803
  # The #data method of the response object returns
782
804
  # a hash with the following structure:
@@ -816,7 +838,8 @@ module AWS
816
838
  # @!method get_streaming_distribution_config(options = {})
817
839
  # Calls the GET GetStreamingDistributionConfig API operation.
818
840
  # @param [Hash] options
819
- # * `:id` - *required* - (String) The streaming distribution's id.
841
+ #
842
+ # * `:id` - *required* - (String) The streaming distribution's id.
820
843
  # @return [Core::Response]
821
844
  # The #data method of the response object returns
822
845
  # a hash with the following structure:
@@ -843,14 +866,15 @@ module AWS
843
866
  # @!method list_cloud_front_origin_access_identities(options = {})
844
867
  # Calls the GET ListCloudFrontOriginAccessIdentities API operation.
845
868
  # @param [Hash] options
846
- # * `:marker` - (String) Use this when paginating results to indicate
847
- # where to begin in your list of origin access identities. The results
848
- # include identities in the list that occur after the marker. To get
849
- # the next page of results, set the Marker to the value of the
850
- # NextMarker from the current page's response (which is also the ID of
851
- # the last identity on that page).
852
- # * `:max_items` - (Integer) The maximum number of origin access
853
- # identities you want in the response body.
869
+ #
870
+ # * `:marker` - (String) Use this when paginating results to indicate
871
+ # where to begin in your list of origin access identities. The
872
+ # results include identities in the list that occur after the marker.
873
+ # To get the next page of results, set the Marker to the value of the
874
+ # NextMarker from the current page's response (which is also the ID
875
+ # of the last identity on that page).
876
+ # * `:max_items` - (Integer) The maximum number of origin access
877
+ # identities you want in the response body.
854
878
  # @return [Core::Response]
855
879
  # The #data method of the response object returns
856
880
  # a hash with the following structure:
@@ -868,14 +892,15 @@ module AWS
868
892
  # @!method list_distributions(options = {})
869
893
  # Calls the GET ListDistributions API operation.
870
894
  # @param [Hash] options
871
- # * `:marker` - (String) Use this when paginating results to indicate
872
- # where to begin in your list of distributions. The results include
873
- # distributions in the list that occur after the marker. To get the
874
- # next page of results, set the Marker to the value of the NextMarker
875
- # from the current page's response (which is also the ID of the last
876
- # distribution on that page).
877
- # * `:max_items` - (Integer) The maximum number of distributions you want
878
- # in the response body.
895
+ #
896
+ # * `:marker` - (String) Use this when paginating results to indicate
897
+ # where to begin in your list of distributions. The results include
898
+ # distributions in the list that occur after the marker. To get the
899
+ # next page of results, set the Marker to the value of the NextMarker
900
+ # from the current page's response (which is also the ID of the last
901
+ # distribution on that page).
902
+ # * `:max_items` - (Integer) The maximum number of distributions you
903
+ # want in the response body.
879
904
  # @return [Core::Response]
880
905
  # The #data method of the response object returns
881
906
  # a hash with the following structure:
@@ -944,17 +969,18 @@ module AWS
944
969
  # @!method list_invalidations(options = {})
945
970
  # Calls the GET ListInvalidations API operation.
946
971
  # @param [Hash] options
947
- # * `:distribution_id` - *required* - (String) The distribution's id.
948
- # * `:marker` - (String) Use this parameter when paginating results to
949
- # indicate where to begin in your list of invalidation batches. Because
950
- # the results are returned in decreasing order from most recent to
951
- # oldest, the most recent results are on the first page, the second
952
- # page will contain earlier results, and so on. To get the next page of
953
- # results, set the Marker to the value of the NextMarker from the
954
- # current page's response. This value is the same as the ID of the last
955
- # invalidation batch on that page.
956
- # * `:max_items` - (Integer) The maximum number of invalidation batches
957
- # you want in the response body.
972
+ #
973
+ # * `:distribution_id` - *required* - (String) The distribution's id.
974
+ # * `:marker` - (String) Use this parameter when paginating results to
975
+ # indicate where to begin in your list of invalidation batches.
976
+ # Because the results are returned in decreasing order from most
977
+ # recent to oldest, the most recent results are on the first page,
978
+ # the second page will contain earlier results, and so on. To get the
979
+ # next page of results, set the Marker to the value of the NextMarker
980
+ # from the current page's response. This value is the same as the ID
981
+ # of the last invalidation batch on that page.
982
+ # * `:max_items` - (Integer) The maximum number of invalidation batches
983
+ # you want in the response body.
958
984
  # @return [Core::Response]
959
985
  # The #data method of the response object returns
960
986
  # a hash with the following structure:
@@ -972,14 +998,15 @@ module AWS
972
998
  # @!method list_streaming_distributions(options = {})
973
999
  # Calls the GET ListStreamingDistributions API operation.
974
1000
  # @param [Hash] options
975
- # * `:marker` - (String) Use this when paginating results to indicate
976
- # where to begin in your list of streaming distributions. The results
977
- # include distributions in the list that occur after the marker. To get
978
- # the next page of results, set the Marker to the value of the
979
- # NextMarker from the current page's response (which is also the ID of
980
- # the last distribution on that page).
981
- # * `:max_items` - (Integer) The maximum number of streaming
982
- # distributions you want in the response body.
1001
+ #
1002
+ # * `:marker` - (String) Use this when paginating results to indicate
1003
+ # where to begin in your list of streaming distributions. The results
1004
+ # include distributions in the list that occur after the marker. To
1005
+ # get the next page of results, set the Marker to the value of the
1006
+ # NextMarker from the current page's response (which is also the ID
1007
+ # of the last distribution on that page).
1008
+ # * `:max_items` - (Integer) The maximum number of streaming
1009
+ # distributions you want in the response body.
983
1010
  # @return [Core::Response]
984
1011
  # The #data method of the response object returns
985
1012
  # a hash with the following structure:
@@ -1011,27 +1038,29 @@ module AWS
1011
1038
  # @!method update_cloud_front_origin_access_identity(options = {})
1012
1039
  # Calls the PUT UpdateCloudFrontOriginAccessIdentity API operation.
1013
1040
  # @param [Hash] options
1014
- # * `:cloud_front_origin_access_identity_config` - *required* - (Hash)
1015
- # The identity's configuration information.
1016
- # * `:caller_reference` - *required* - (String) A unique number that
1017
- # ensures the request can't be replayed. If the CallerReference is
1018
- # new (no matter the content of the
1019
- # CloudFrontOriginAccessIdentityConfig object), a new origin access
1020
- # identity is created. If the CallerReference is a value you already
1021
- # sent in a previous request to create an identity, and the content
1022
- # of the CloudFrontOriginAccessIdentityConfig is identical to the
1023
- # original request (ignoring white space), the response includes the
1024
- # same information returned to the original request. If the
1025
- # CallerReference is a value you already sent in a previous request
1026
- # to create an identity but the content of the
1027
- # CloudFrontOriginAccessIdentityConfig is different from the original
1028
- # request, CloudFront returns a
1029
- # CloudFrontOriginAccessIdentityAlreadyExists error.
1030
- # * `:comment` - *required* - (String) Any comments you want to include
1031
- # about the origin access identity.
1032
- # * `:id` - *required* - (String) The identity's id.
1033
- # * `:if_match` - (String) The value of the ETag header you received when
1034
- # retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.
1041
+ #
1042
+ # * `:cloud_front_origin_access_identity_config` - *required* - (Hash)
1043
+ # The identity's configuration information.
1044
+ # * `:caller_reference` - *required* - (String) A unique number that
1045
+ # ensures the request can't be replayed. If the CallerReference is
1046
+ # new (no matter the content of the
1047
+ # CloudFrontOriginAccessIdentityConfig object), a new origin access
1048
+ # identity is created. If the CallerReference is a value you
1049
+ # already sent in a previous request to create an identity, and the
1050
+ # content of the CloudFrontOriginAccessIdentityConfig is identical
1051
+ # to the original request (ignoring white space), the response
1052
+ # includes the same information returned to the original request.
1053
+ # If the CallerReference is a value you already sent in a previous
1054
+ # request to create an identity but the content of the
1055
+ # CloudFrontOriginAccessIdentityConfig is different from the
1056
+ # original request, CloudFront returns a
1057
+ # CloudFrontOriginAccessIdentityAlreadyExists error.
1058
+ # * `:comment` - *required* - (String) Any comments you want to
1059
+ # include about the origin access identity.
1060
+ # * `:id` - *required* - (String) The identity's id.
1061
+ # * `:if_match` - (String) The value of the ETag header you received
1062
+ # when retrieving the identity's configuration. For example:
1063
+ # E2QWRUHAPOMQZL.
1035
1064
  # @return [Core::Response]
1036
1065
  # The #data method of the response object returns
1037
1066
  # a hash with the following structure:
@@ -1045,173 +1074,93 @@ module AWS
1045
1074
  # @!method update_distribution(options = {})
1046
1075
  # Calls the PUT UpdateDistribution API operation.
1047
1076
  # @param [Hash] options
1048
- # * `:distribution_config` - *required* - (Hash) The distribution's
1049
- # configuration information.
1050
- # * `:caller_reference` - *required* - (String) A unique number that
1051
- # ensures the request can't be replayed. If the CallerReference is
1052
- # new (no matter the content of the DistributionConfig object), a new
1053
- # distribution is created. If the CallerReference is a value you
1054
- # already sent in a previous request to create a distribution, and
1055
- # the content of the DistributionConfig is identical to the original
1056
- # request (ignoring white space), the response includes the same
1057
- # information returned to the original request. If the
1058
- # CallerReference is a value you already sent in a previous request
1059
- # to create a distribution but the content of the DistributionConfig
1060
- # is different from the original request, CloudFront returns a
1061
- # DistributionAlreadyExists error.
1062
- # * `:aliases` - *required* - (Hash) A complex type that contains
1063
- # information about CNAMEs (alternate domain names), if any, for this
1064
- # distribution.
1065
- # * `:quantity` - *required* - (Integer) The number of CNAMEs, if
1066
- # any, for this distribution.
1067
- # * `:items` - (Array<String>) Optional: A complex type that contains
1068
- # CNAME elements, if any, for this distribution. If Quantity is 0,
1069
- # you can omit Items.
1070
- # * `:default_root_object` - *required* - (String) The object that you
1071
- # want CloudFront to return (for example, index.html) when an end
1072
- # user requests the root URL for your distribution
1073
- # (http://www.example.com) instead of an object in your distribution
1074
- # (http://www.example.com/index.html). Specifying a default root
1075
- # object avoids exposing the contents of your distribution. If you
1076
- # don't want to specify a default root object when you create a
1077
- # distribution, include an empty DefaultRootObject element. To delete
1078
- # the default root object from an existing distribution, update the
1079
- # distribution configuration and include an empty DefaultRootObject
1080
- # element. To replace the default root object, update the
1081
- # distribution configuration and specify the new object.
1082
- # * `:origins` - *required* - (Hash) A complex type that contains
1083
- # information about origins for this distribution.
1084
- # * `:quantity` - *required* - (Integer) The number of origins for
1085
- # this distribution.
1086
- # * `:items` - (Array<Hash>) A complex type that contains origins for
1077
+ #
1078
+ # * `:distribution_config` - *required* - (Hash) The distribution's
1079
+ # configuration information.
1080
+ # * `:caller_reference` - *required* - (String) A unique number that
1081
+ # ensures the request can't be replayed. If the CallerReference is
1082
+ # new (no matter the content of the DistributionConfig object), a
1083
+ # new distribution is created. If the CallerReference is a value
1084
+ # you already sent in a previous request to create a distribution,
1085
+ # and the content of the DistributionConfig is identical to the
1086
+ # original request (ignoring white space), the response includes
1087
+ # the same information returned to the original request. If the
1088
+ # CallerReference is a value you already sent in a previous request
1089
+ # to create a distribution but the content of the
1090
+ # DistributionConfig is different from the original request,
1091
+ # CloudFront returns a DistributionAlreadyExists error.
1092
+ # * `:aliases` - *required* - (Hash) A complex type that contains
1093
+ # information about CNAMEs (alternate domain names), if any, for
1087
1094
  # this distribution.
1088
- # * `:id` - *required* - (String) A unique identifier for the
1089
- # origin. The value of Id must be unique within the distribution.
1090
- # You use the value of Id when you create a cache behavior. The
1091
- # Id identifies the origin that CloudFront routes a request to
1092
- # when the request matches the path pattern for that cache
1093
- # behavior.
1094
- # * `:domain_name` - *required* - (String) Amazon S3 origins: The
1095
- # DNS name of the Amazon S3 bucket from which you want CloudFront
1096
- # to get objects for this origin, for example,
1097
- # myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain
1098
- # name for the HTTP server from which you want CloudFront to get
1099
- # objects for this origin, for example, www.example.com.
1100
- # * `:s3_origin_config` - (Hash) A complex type that contains
1101
- # information about the Amazon S3 origin. If the origin is a
1102
- # custom origin, use the CustomOriginConfig element instead.
1103
- # * `:origin_access_identity` - *required* - (String) The
1104
- # CloudFront origin access identity to associate with the
1105
- # origin. Use an origin access identity to configure the origin
1106
- # so that end users can only access objects in an Amazon S3
1107
- # bucket through CloudFront. If you want end users to be able
1108
- # to access objects using either the CloudFront URL or the
1109
- # Amazon S3 URL, specify an empty OriginAccessIdentity element.
1110
- # To delete the origin access identity from an existing
1111
- # distribution, update the distribution configuration and
1112
- # include an empty OriginAccessIdentity element. To replace the
1113
- # origin access identity, update the distribution configuration
1114
- # and specify the new origin access identity.
1115
- # * `:custom_origin_config` - (Hash) A complex type that contains
1116
- # information about a custom origin. If the origin is an Amazon
1117
- # S3 bucket, use the S3OriginConfig element instead.
1118
- # * `:http_port` - *required* - (Integer) The HTTP port the
1119
- # custom origin listens on.
1120
- # * `:https_port` - *required* - (Integer) The HTTPS port the
1121
- # custom origin listens on.
1122
- # * `:origin_protocol_policy` - *required* - (String) The origin
1123
- # protocol policy to apply to your origin. Valid values
1124
- # include:
1125
- # * `http-only`
1126
- # * `match-viewer`
1127
- # * `:default_cache_behavior` - *required* - (Hash) A complex type that
1128
- # describes the default cache behavior if you do not specify a
1129
- # CacheBehavior element or if files don't match any of the values of
1130
- # PathPattern in CacheBehavior elements.You must create exactly one
1131
- # default cache behavior.
1132
- # * `:target_origin_id` - *required* - (String) The value of ID for
1133
- # the origin that you want CloudFront to route requests to when a
1134
- # request matches the path pattern either for a cache behavior or
1135
- # for the default cache behavior.
1136
- # * `:forwarded_values` - *required* - (Hash) A complex type that
1137
- # specifies how CloudFront handles query strings and cookies.
1138
- # * `:query_string` - *required* - (Boolean) Indicates whether you
1139
- # want CloudFront to forward query strings to the origin that is
1140
- # associated with this cache behavior. If so, specify `true` ; if
1141
- # not, specify `false` .
1142
- # * `:cookies` - *required* - (Hash) A complex type that specifies
1143
- # how CloudFront handles cookies.
1144
- # * `:forward` - *required* - (String) Use this element to
1145
- # specify whether you want CloudFront to forward cookies to the
1146
- # origin that is associated with this cache behavior. You can
1147
- # specify all, none or whitelist. If you choose All, CloudFront
1148
- # forwards all cookies regardless of how many your application
1149
- # uses. Valid values include:
1150
- # * `none`
1151
- # * `whitelist`
1152
- # * `all`
1153
- # * `:whitelisted_names` - (Hash) A complex type that specifies
1154
- # the whitelisted cookies, if any, that you want CloudFront to
1155
- # forward to your origin that is associated with this cache
1156
- # behavior.
1157
- # * `:quantity` - *required* - (Integer) The number of
1158
- # whitelisted cookies for this cache behavior.
1159
- # * `:items` - (Array<String>) Optional: A complex type that
1160
- # contains whitelisted cookies for this cache behavior. If
1161
- # Quantity is 0, you can omit Items.
1162
- # * `:trusted_signers` - *required* - (Hash) A complex type that
1163
- # specifies the AWS accounts, if any, that you want to allow to
1164
- # create signed URLs for private content. If you want to require
1165
- # signed URLs in requests for objects in the target origin that
1166
- # match the PathPattern for this cache behavior, specify `true` for
1167
- # Enabled, and specify the applicable values for Quantity and
1168
- # Items. For more information, go to Using a Signed URL to Serve
1169
- # Private Content in the Amazon CloudFront Developer Guide. If you
1170
- # don't want to require signed URLs in requests for objects that
1171
- # match PathPattern, specify `false` for Enabled and 0 for
1172
- # Quantity. Omit Items. To add, change, or remove one or more
1173
- # trusted signers, change Enabled to `true` (if it's currently
1174
- # `false` ), change Quantity as applicable, and specify all of the
1175
- # trusted signers that you want to include in the updated
1176
- # distribution.
1177
- # * `:enabled` - *required* - (Boolean) Specifies whether you want
1178
- # to require end users to use signed URLs to access the files
1179
- # specified by PathPattern and TargetOriginId.
1180
- # * `:quantity` - *required* - (Integer) The number of trusted
1181
- # signers for this cache behavior.
1095
+ # * `:quantity` - *required* - (Integer) The number of CNAMEs, if
1096
+ # any, for this distribution.
1182
1097
  # * `:items` - (Array<String>) Optional: A complex type that
1183
- # contains trusted signers for this cache behavior. If Quantity
1184
- # is 0, you can omit Items.
1185
- # * `:viewer_protocol_policy` - *required* - (String) Use this
1186
- # element to specify the protocol that users can use to access the
1187
- # files in the origin specified by TargetOriginId when a request
1188
- # matches the path pattern in PathPattern. If you want CloudFront
1189
- # to allow end users to use any available protocol, specify
1190
- # allow-all. If you want CloudFront to require HTTPS, specify
1191
- # https. Valid values include:
1192
- # * `allow-all`
1193
- # * `https-only`
1194
- # * `:min_ttl` - *required* - (Integer) The minimum amount of time
1195
- # that you want objects to stay in CloudFront caches before
1196
- # CloudFront queries your origin to see whether the object has been
1197
- # updated.You can specify a value from 0 to 3,153,600,000 seconds
1198
- # (100 years).
1199
- # * `:cache_behaviors` - *required* - (Hash) A complex type that
1200
- # contains zero or more CacheBehavior elements.
1201
- # * `:quantity` - *required* - (Integer) The number of cache
1202
- # behaviors for this distribution.
1203
- # * `:items` - (Array<Hash>) Optional: A complex type that contains
1204
- # cache behaviors for this distribution. If Quantity is 0, you can
1205
- # omit Items.
1206
- # * `:path_pattern` - *required* - (String) The pattern (for
1207
- # example, images/*.jpg) that specifies which requests you want
1208
- # this cache behavior to apply to. When CloudFront receives an
1209
- # end-user request, the requested path is compared with path
1210
- # patterns in the order in which cache behaviors are listed in
1211
- # the distribution. The path pattern for the default cache
1212
- # behavior is * and cannot be changed. If the request for an
1213
- # object does not match the path pattern for any cache behaviors,
1214
- # CloudFront applies the behavior in the default cache behavior.
1098
+ # contains CNAME elements, if any, for this distribution. If
1099
+ # Quantity is 0, you can omit Items.
1100
+ # * `:default_root_object` - *required* - (String) The object that
1101
+ # you want CloudFront to return (for example, index.html) when an
1102
+ # end user requests the root URL for your distribution
1103
+ # (http://www.example.com) instead of an object in your
1104
+ # distribution (http://www.example.com/index.html). Specifying a
1105
+ # default root object avoids exposing the contents of your
1106
+ # distribution. If you don't want to specify a default root object
1107
+ # when you create a distribution, include an empty
1108
+ # DefaultRootObject element. To delete the default root object from
1109
+ # an existing distribution, update the distribution configuration
1110
+ # and include an empty DefaultRootObject element. To replace the
1111
+ # default root object, update the distribution configuration and
1112
+ # specify the new object.
1113
+ # * `:origins` - *required* - (Hash) A complex type that contains
1114
+ # information about origins for this distribution.
1115
+ # * `:quantity` - *required* - (Integer) The number of origins for
1116
+ # this distribution.
1117
+ # * `:items` - (Array<Hash>) A complex type that contains origins
1118
+ # for this distribution.
1119
+ # * `:id` - *required* - (String) A unique identifier for the
1120
+ # origin. The value of Id must be unique within the
1121
+ # distribution. You use the value of Id when you create a cache
1122
+ # behavior. The Id identifies the origin that CloudFront routes
1123
+ # a request to when the request matches the path pattern for
1124
+ # that cache behavior.
1125
+ # * `:domain_name` - *required* - (String) Amazon S3 origins: The
1126
+ # DNS name of the Amazon S3 bucket from which you want
1127
+ # CloudFront to get objects for this origin, for example,
1128
+ # myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain
1129
+ # name for the HTTP server from which you want CloudFront to
1130
+ # get objects for this origin, for example, www.example.com.
1131
+ # * `:s3_origin_config` - (Hash) A complex type that contains
1132
+ # information about the Amazon S3 origin. If the origin is a
1133
+ # custom origin, use the CustomOriginConfig element instead.
1134
+ # * `:origin_access_identity` - *required* - (String) The
1135
+ # CloudFront origin access identity to associate with the
1136
+ # origin. Use an origin access identity to configure the
1137
+ # origin so that end users can only access objects in an
1138
+ # Amazon S3 bucket through CloudFront. If you want end users
1139
+ # to be able to access objects using either the CloudFront
1140
+ # URL or the Amazon S3 URL, specify an empty
1141
+ # OriginAccessIdentity element. To delete the origin access
1142
+ # identity from an existing distribution, update the
1143
+ # distribution configuration and include an empty
1144
+ # OriginAccessIdentity element. To replace the origin access
1145
+ # identity, update the distribution configuration and specify
1146
+ # the new origin access identity.
1147
+ # * `:custom_origin_config` - (Hash) A complex type that contains
1148
+ # information about a custom origin. If the origin is an Amazon
1149
+ # S3 bucket, use the S3OriginConfig element instead.
1150
+ # * `:http_port` - *required* - (Integer) The HTTP port the
1151
+ # custom origin listens on.
1152
+ # * `:https_port` - *required* - (Integer) The HTTPS port the
1153
+ # custom origin listens on.
1154
+ # * `:origin_protocol_policy` - *required* - (String) The
1155
+ # origin protocol policy to apply to your origin. Valid
1156
+ # values include:
1157
+ # * `http-only`
1158
+ # * `match-viewer`
1159
+ # * `:default_cache_behavior` - *required* - (Hash) A complex type
1160
+ # that describes the default cache behavior if you do not specify a
1161
+ # CacheBehavior element or if files don't match any of the values
1162
+ # of PathPattern in CacheBehavior elements.You must create exactly
1163
+ # one default cache behavior.
1215
1164
  # * `:target_origin_id` - *required* - (String) The value of ID for
1216
1165
  # the origin that you want CloudFront to route requests to when a
1217
1166
  # request matches the path pattern either for a cache behavior or
@@ -1279,45 +1228,130 @@ module AWS
1279
1228
  # CloudFront queries your origin to see whether the object has
1280
1229
  # been updated.You can specify a value from 0 to 3,153,600,000
1281
1230
  # seconds (100 years).
1282
- # * `:comment` - *required* - (String) Any comments you want to include
1283
- # about the distribution.
1284
- # * `:logging` - *required* - (Hash) A complex type that controls
1285
- # whether access logs are written for the distribution.
1286
- # * `:enabled` - *required* - (Boolean) Specifies whether you want
1287
- # CloudFront to save access logs to an Amazon S3 bucket. If you do
1288
- # not want to enable logging when you create a distribution or if
1289
- # you want to disable logging for an existing distribution, specify
1290
- # `false` for Enabled, and specify empty Bucket and Prefix
1291
- # elements. If you specify `false` for Enabled but you specify
1292
- # values for Bucket, prefix and IncludeCookies, the values are
1293
- # automatically deleted.
1294
- # * `:include_cookies` - *required* - (Boolean) Specifies whether you
1295
- # want CloudFront to include cookies in access logs, specify `true`
1296
- # for IncludeCookies. If you choose to include cookies in logs,
1297
- # CloudFront logs all cookies regardless of how you configure the
1298
- # cache behaviors for this distribution. If you do not want to
1299
- # include cookies when you create a distribution or if you want to
1300
- # disable include cookies for an existing distribution, specify
1301
- # `false` for IncludeCookies.
1302
- # * `:bucket` - *required* - (String) The Amazon S3 bucket to store
1303
- # the access logs in, for example, myawslogbucket.s3.amazonaws.com.
1304
- # * `:prefix` - *required* - (String) An optional string that you
1305
- # want CloudFront to prefix to the access log filenames for this
1306
- # distribution, for example, myprefix/. If you want to enable
1307
- # logging, but you do not want to specify a prefix, you still must
1308
- # include an empty Prefix element in the Logging element.
1309
- # * `:price_class` - *required* - (String) A complex type that contains
1310
- # information about price class for this distribution. Valid values
1311
- # include:
1312
- # * `PriceClass_100`
1313
- # * `PriceClass_200`
1314
- # * `PriceClass_All`
1315
- # * `:enabled` - *required* - (Boolean) Whether the distribution is
1316
- # enabled to accept end user requests for content.
1317
- # * `:id` - *required* - (String) The distribution's id.
1318
- # * `:if_match` - (String) The value of the ETag header you received when
1319
- # retrieving the distribution's configuration. For example:
1320
- # E2QWRUHAPOMQZL.
1231
+ # * `:cache_behaviors` - *required* - (Hash) A complex type that
1232
+ # contains zero or more CacheBehavior elements.
1233
+ # * `:quantity` - *required* - (Integer) The number of cache
1234
+ # behaviors for this distribution.
1235
+ # * `:items` - (Array<Hash>) Optional: A complex type that contains
1236
+ # cache behaviors for this distribution. If Quantity is 0, you
1237
+ # can omit Items.
1238
+ # * `:path_pattern` - *required* - (String) The pattern (for
1239
+ # example, images/*.jpg) that specifies which requests you want
1240
+ # this cache behavior to apply to. When CloudFront receives an
1241
+ # end-user request, the requested path is compared with path
1242
+ # patterns in the order in which cache behaviors are listed in
1243
+ # the distribution. The path pattern for the default cache
1244
+ # behavior is * and cannot be changed. If the request for an
1245
+ # object does not match the path pattern for any cache
1246
+ # behaviors, CloudFront applies the behavior in the default
1247
+ # cache behavior.
1248
+ # * `:target_origin_id` - *required* - (String) The value of ID
1249
+ # for the origin that you want CloudFront to route requests to
1250
+ # when a request matches the path pattern either for a cache
1251
+ # behavior or for the default cache behavior.
1252
+ # * `:forwarded_values` - *required* - (Hash) A complex type that
1253
+ # specifies how CloudFront handles query strings and cookies.
1254
+ # * `:query_string` - *required* - (Boolean) Indicates whether
1255
+ # you want CloudFront to forward query strings to the origin
1256
+ # that is associated with this cache behavior. If so, specify
1257
+ # `true` ; if not, specify `false` .
1258
+ # * `:cookies` - *required* - (Hash) A complex type that
1259
+ # specifies how CloudFront handles cookies.
1260
+ # * `:forward` - *required* - (String) Use this element to
1261
+ # specify whether you want CloudFront to forward cookies to
1262
+ # the origin that is associated with this cache behavior.
1263
+ # You can specify all, none or whitelist. If you choose
1264
+ # All, CloudFront forwards all cookies regardless of how
1265
+ # many your application uses. Valid values include:
1266
+ # * `none`
1267
+ # * `whitelist`
1268
+ # * `all`
1269
+ # * `:whitelisted_names` - (Hash) A complex type that
1270
+ # specifies the whitelisted cookies, if any, that you want
1271
+ # CloudFront to forward to your origin that is associated
1272
+ # with this cache behavior.
1273
+ # * `:quantity` - *required* - (Integer) The number of
1274
+ # whitelisted cookies for this cache behavior.
1275
+ # * `:items` - (Array<String>) Optional: A complex type
1276
+ # that contains whitelisted cookies for this cache
1277
+ # behavior. If Quantity is 0, you can omit Items.
1278
+ # * `:trusted_signers` - *required* - (Hash) A complex type that
1279
+ # specifies the AWS accounts, if any, that you want to allow to
1280
+ # create signed URLs for private content. If you want to
1281
+ # require signed URLs in requests for objects in the target
1282
+ # origin that match the PathPattern for this cache behavior,
1283
+ # specify `true` for Enabled, and specify the applicable values
1284
+ # for Quantity and Items. For more information, go to Using a
1285
+ # Signed URL to Serve Private Content in the Amazon CloudFront
1286
+ # Developer Guide. If you don't want to require signed URLs in
1287
+ # requests for objects that match PathPattern, specify `false`
1288
+ # for Enabled and 0 for Quantity. Omit Items. To add, change,
1289
+ # or remove one or more trusted signers, change Enabled to
1290
+ # `true` (if it's currently `false` ), change Quantity as
1291
+ # applicable, and specify all of the trusted signers that you
1292
+ # want to include in the updated distribution.
1293
+ # * `:enabled` - *required* - (Boolean) Specifies whether you
1294
+ # want to require end users to use signed URLs to access the
1295
+ # files specified by PathPattern and TargetOriginId.
1296
+ # * `:quantity` - *required* - (Integer) The number of trusted
1297
+ # signers for this cache behavior.
1298
+ # * `:items` - (Array<String>) Optional: A complex type that
1299
+ # contains trusted signers for this cache behavior. If
1300
+ # Quantity is 0, you can omit Items.
1301
+ # * `:viewer_protocol_policy` - *required* - (String) Use this
1302
+ # element to specify the protocol that users can use to access
1303
+ # the files in the origin specified by TargetOriginId when a
1304
+ # request matches the path pattern in PathPattern. If you want
1305
+ # CloudFront to allow end users to use any available protocol,
1306
+ # specify allow-all. If you want CloudFront to require HTTPS,
1307
+ # specify https. Valid values include:
1308
+ # * `allow-all`
1309
+ # * `https-only`
1310
+ # * `:min_ttl` - *required* - (Integer) The minimum amount of
1311
+ # time that you want objects to stay in CloudFront caches
1312
+ # before CloudFront queries your origin to see whether the
1313
+ # object has been updated.You can specify a value from 0 to
1314
+ # 3,153,600,000 seconds (100 years).
1315
+ # * `:comment` - *required* - (String) Any comments you want to
1316
+ # include about the distribution.
1317
+ # * `:logging` - *required* - (Hash) A complex type that controls
1318
+ # whether access logs are written for the distribution.
1319
+ # * `:enabled` - *required* - (Boolean) Specifies whether you want
1320
+ # CloudFront to save access logs to an Amazon S3 bucket. If you
1321
+ # do not want to enable logging when you create a distribution or
1322
+ # if you want to disable logging for an existing distribution,
1323
+ # specify `false` for Enabled, and specify empty Bucket and
1324
+ # Prefix elements. If you specify `false` for Enabled but you
1325
+ # specify values for Bucket, prefix and IncludeCookies, the
1326
+ # values are automatically deleted.
1327
+ # * `:include_cookies` - *required* - (Boolean) Specifies whether
1328
+ # you want CloudFront to include cookies in access logs, specify
1329
+ # `true` for IncludeCookies. If you choose to include cookies in
1330
+ # logs, CloudFront logs all cookies regardless of how you
1331
+ # configure the cache behaviors for this distribution. If you do
1332
+ # not want to include cookies when you create a distribution or
1333
+ # if you want to disable include cookies for an existing
1334
+ # distribution, specify `false` for IncludeCookies.
1335
+ # * `:bucket` - *required* - (String) The Amazon S3 bucket to store
1336
+ # the access logs in, for example,
1337
+ # myawslogbucket.s3.amazonaws.com.
1338
+ # * `:prefix` - *required* - (String) An optional string that you
1339
+ # want CloudFront to prefix to the access log filenames for this
1340
+ # distribution, for example, myprefix/. If you want to enable
1341
+ # logging, but you do not want to specify a prefix, you still
1342
+ # must include an empty Prefix element in the Logging element.
1343
+ # * `:price_class` - *required* - (String) A complex type that
1344
+ # contains information about price class for this distribution.
1345
+ # Valid values include:
1346
+ # * `PriceClass_100`
1347
+ # * `PriceClass_200`
1348
+ # * `PriceClass_All`
1349
+ # * `:enabled` - *required* - (Boolean) Whether the distribution is
1350
+ # enabled to accept end user requests for content.
1351
+ # * `:id` - *required* - (String) The distribution's id.
1352
+ # * `:if_match` - (String) The value of the ETag header you received
1353
+ # when retrieving the distribution's configuration. For example:
1354
+ # E2QWRUHAPOMQZL.
1321
1355
  # @return [Core::Response]
1322
1356
  # The #data method of the response object returns
1323
1357
  # a hash with the following structure:
@@ -1397,90 +1431,93 @@ module AWS
1397
1431
  # @!method update_streaming_distribution(options = {})
1398
1432
  # Calls the PUT UpdateStreamingDistribution API operation.
1399
1433
  # @param [Hash] options
1400
- # * `:streaming_distribution_config` - *required* - (Hash) The streaming
1401
- # distribution's configuration information.
1402
- # * `:caller_reference` - *required* - (String) A unique number that
1403
- # ensures the request can't be replayed. If the CallerReference is
1404
- # new (no matter the content of the StreamingDistributionConfig
1405
- # object), a new streaming distribution is created. If the
1406
- # CallerReference is a value you already sent in a previous request
1407
- # to create a streaming distribution, and the content of the
1408
- # StreamingDistributionConfig is identical to the original request
1409
- # (ignoring white space), the response includes the same information
1410
- # returned to the original request. If the CallerReference is a value
1411
- # you already sent in a previous request to create a streaming
1412
- # distribution but the content of the StreamingDistributionConfig is
1413
- # different from the original request, CloudFront returns a
1414
- # DistributionAlreadyExists error.
1415
- # * `:s3_origin` - *required* - (Hash) A complex type that contains
1416
- # information about the Amazon S3 bucket from which you want
1417
- # CloudFront to get your media files for distribution.
1418
- # * `:domain_name` - *required* - (String) The DNS name of the S3
1419
- # origin.
1420
- # * `:origin_access_identity` - *required* - (String) Your S3
1421
- # origin's origin access identity.
1422
- # * `:aliases` - *required* - (Hash) A complex type that contains
1423
- # information about CNAMEs (alternate domain names), if any, for this
1424
- # streaming distribution.
1425
- # * `:quantity` - *required* - (Integer) The number of CNAMEs, if
1426
- # any, for this distribution.
1427
- # * `:items` - (Array<String>) Optional: A complex type that contains
1428
- # CNAME elements, if any, for this distribution. If Quantity is 0,
1429
- # you can omit Items.
1430
- # * `:comment` - *required* - (String) Any comments you want to include
1431
- # about the streaming distribution.
1432
- # * `:logging` - *required* - (Hash) A complex type that controls
1433
- # whether access logs are written for the streaming distribution.
1434
- # * `:enabled` - *required* - (Boolean) Specifies whether you want
1435
- # CloudFront to save access logs to an Amazon S3 bucket. If you do
1436
- # not want to enable logging when you create a streaming
1437
- # distribution or if you want to disable logging for an existing
1438
- # streaming distribution, specify `false` for Enabled, and specify
1439
- # empty Bucket and Prefix elements. If you specify `false` for
1440
- # Enabled but you specify values for Bucket and Prefix, the values
1441
- # are automatically deleted.
1442
- # * `:bucket` - *required* - (String) The Amazon S3 bucket to store
1443
- # the access logs in, for example, myawslogbucket.s3.amazonaws.com.
1444
- # * `:prefix` - *required* - (String) An optional string that you
1445
- # want CloudFront to prefix to the access log filenames for this
1446
- # streaming distribution, for example, myprefix/. If you want to
1447
- # enable logging, but you do not want to specify a prefix, you
1448
- # still must include an empty Prefix element in the Logging
1449
- # element.
1450
- # * `:trusted_signers` - *required* - (Hash) A complex type that
1451
- # specifies the AWS accounts, if any, that you want to allow to
1452
- # create signed URLs for private content. If you want to require
1453
- # signed URLs in requests for objects in the target origin that match
1454
- # the PathPattern for this cache behavior, specify `true` for
1455
- # Enabled, and specify the applicable values for Quantity and Items.
1456
- # For more information, go to Using a Signed URL to Serve Private
1457
- # Content in the Amazon CloudFront Developer Guide. If you don't want
1458
- # to require signed URLs in requests for objects that match
1459
- # PathPattern, specify `false` for Enabled and 0 for Quantity. Omit
1460
- # Items. To add, change, or remove one or more trusted signers,
1461
- # change Enabled to `true` (if it's currently `false` ), change
1462
- # Quantity as applicable, and specify all of the trusted signers that
1463
- # you want to include in the updated distribution.
1464
- # * `:enabled` - *required* - (Boolean) Specifies whether you want to
1465
- # require end users to use signed URLs to access the files
1466
- # specified by PathPattern and TargetOriginId.
1467
- # * `:quantity` - *required* - (Integer) The number of trusted
1468
- # signers for this cache behavior.
1469
- # * `:items` - (Array<String>) Optional: A complex type that contains
1470
- # trusted signers for this cache behavior. If Quantity is 0, you
1471
- # can omit Items.
1472
- # * `:price_class` - *required* - (String) A complex type that contains
1473
- # information about price class for this streaming distribution.
1474
- # Valid values include:
1475
- # * `PriceClass_100`
1476
- # * `PriceClass_200`
1477
- # * `PriceClass_All`
1478
- # * `:enabled` - *required* - (Boolean) Whether the streaming
1479
- # distribution is enabled to accept end user requests for content.
1480
- # * `:id` - *required* - (String) The streaming distribution's id.
1481
- # * `:if_match` - (String) The value of the ETag header you received when
1482
- # retrieving the streaming distribution's configuration. For example:
1483
- # E2QWRUHAPOMQZL.
1434
+ #
1435
+ # * `:streaming_distribution_config` - *required* - (Hash) The
1436
+ # streaming distribution's configuration information.
1437
+ # * `:caller_reference` - *required* - (String) A unique number that
1438
+ # ensures the request can't be replayed. If the CallerReference is
1439
+ # new (no matter the content of the StreamingDistributionConfig
1440
+ # object), a new streaming distribution is created. If the
1441
+ # CallerReference is a value you already sent in a previous request
1442
+ # to create a streaming distribution, and the content of the
1443
+ # StreamingDistributionConfig is identical to the original request
1444
+ # (ignoring white space), the response includes the same
1445
+ # information returned to the original request. If the
1446
+ # CallerReference is a value you already sent in a previous request
1447
+ # to create a streaming distribution but the content of the
1448
+ # StreamingDistributionConfig is different from the original
1449
+ # request, CloudFront returns a DistributionAlreadyExists error.
1450
+ # * `:s3_origin` - *required* - (Hash) A complex type that contains
1451
+ # information about the Amazon S3 bucket from which you want
1452
+ # CloudFront to get your media files for distribution.
1453
+ # * `:domain_name` - *required* - (String) The DNS name of the S3
1454
+ # origin.
1455
+ # * `:origin_access_identity` - *required* - (String) Your S3
1456
+ # origin's origin access identity.
1457
+ # * `:aliases` - *required* - (Hash) A complex type that contains
1458
+ # information about CNAMEs (alternate domain names), if any, for
1459
+ # this streaming distribution.
1460
+ # * `:quantity` - *required* - (Integer) The number of CNAMEs, if
1461
+ # any, for this distribution.
1462
+ # * `:items` - (Array<String>) Optional: A complex type that
1463
+ # contains CNAME elements, if any, for this distribution. If
1464
+ # Quantity is 0, you can omit Items.
1465
+ # * `:comment` - *required* - (String) Any comments you want to
1466
+ # include about the streaming distribution.
1467
+ # * `:logging` - *required* - (Hash) A complex type that controls
1468
+ # whether access logs are written for the streaming distribution.
1469
+ # * `:enabled` - *required* - (Boolean) Specifies whether you want
1470
+ # CloudFront to save access logs to an Amazon S3 bucket. If you
1471
+ # do not want to enable logging when you create a streaming
1472
+ # distribution or if you want to disable logging for an existing
1473
+ # streaming distribution, specify `false` for Enabled, and
1474
+ # specify empty Bucket and Prefix elements. If you specify
1475
+ # `false` for Enabled but you specify values for Bucket and
1476
+ # Prefix, the values are automatically deleted.
1477
+ # * `:bucket` - *required* - (String) The Amazon S3 bucket to store
1478
+ # the access logs in, for example,
1479
+ # myawslogbucket.s3.amazonaws.com.
1480
+ # * `:prefix` - *required* - (String) An optional string that you
1481
+ # want CloudFront to prefix to the access log filenames for this
1482
+ # streaming distribution, for example, myprefix/. If you want to
1483
+ # enable logging, but you do not want to specify a prefix, you
1484
+ # still must include an empty Prefix element in the Logging
1485
+ # element.
1486
+ # * `:trusted_signers` - *required* - (Hash) A complex type that
1487
+ # specifies the AWS accounts, if any, that you want to allow to
1488
+ # create signed URLs for private content. If you want to require
1489
+ # signed URLs in requests for objects in the target origin that
1490
+ # match the PathPattern for this cache behavior, specify `true` for
1491
+ # Enabled, and specify the applicable values for Quantity and
1492
+ # Items. For more information, go to Using a Signed URL to Serve
1493
+ # Private Content in the Amazon CloudFront Developer Guide. If you
1494
+ # don't want to require signed URLs in requests for objects that
1495
+ # match PathPattern, specify `false` for Enabled and 0 for
1496
+ # Quantity. Omit Items. To add, change, or remove one or more
1497
+ # trusted signers, change Enabled to `true` (if it's currently
1498
+ # `false` ), change Quantity as applicable, and specify all of the
1499
+ # trusted signers that you want to include in the updated
1500
+ # distribution.
1501
+ # * `:enabled` - *required* - (Boolean) Specifies whether you want
1502
+ # to require end users to use signed URLs to access the files
1503
+ # specified by PathPattern and TargetOriginId.
1504
+ # * `:quantity` - *required* - (Integer) The number of trusted
1505
+ # signers for this cache behavior.
1506
+ # * `:items` - (Array<String>) Optional: A complex type that
1507
+ # contains trusted signers for this cache behavior. If Quantity
1508
+ # is 0, you can omit Items.
1509
+ # * `:price_class` - *required* - (String) A complex type that
1510
+ # contains information about price class for this streaming
1511
+ # distribution. Valid values include:
1512
+ # * `PriceClass_100`
1513
+ # * `PriceClass_200`
1514
+ # * `PriceClass_All`
1515
+ # * `:enabled` - *required* - (Boolean) Whether the streaming
1516
+ # distribution is enabled to accept end user requests for content.
1517
+ # * `:id` - *required* - (String) The streaming distribution's id.
1518
+ # * `:if_match` - (String) The value of the ETag header you received
1519
+ # when retrieving the streaming distribution's configuration. For
1520
+ # example: E2QWRUHAPOMQZL.
1484
1521
  # @return [Core::Response]
1485
1522
  # The #data method of the response object returns
1486
1523
  # a hash with the following structure: