aws-sdk-cloudfront 1.26.0 → 1.30.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/lib/aws-sdk-cloudfront.rb +1 -1
- data/lib/aws-sdk-cloudfront/client.rb +74 -26
- data/lib/aws-sdk-cloudfront/client_api.rb +2 -0
- data/lib/aws-sdk-cloudfront/resource.rb +1 -7
- data/lib/aws-sdk-cloudfront/signer.rb +1 -1
- data/lib/aws-sdk-cloudfront/types.rb +194 -159
- data/lib/aws-sdk-cloudfront/waiters.rb +63 -0
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 4da20bd39cfdef3e8522ad862a6de7811700405e36563bef35375e816b9a305a
|
4
|
+
data.tar.gz: 6caf441ec097daba2942fb16bb3ccc47c19bde12f4528c4122d211a47504cb17
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ffcec7d560adab8c3423040c4d784956a1ebdb5e760ed33ca05fe855ba372e4662c866ba00c84ee667382b24b9815eea28112a355ad00410d260f3d6be8f3a04
|
7
|
+
data.tar.gz: e3030e725059c9e5e5375410c901635bc86d71ec81481ea57019ed71f1fb9dff5ea25aa3fd251bd5e96ca13f39fcfcb9a372c366806f9ec039d1564ef02a7c14
|
data/lib/aws-sdk-cloudfront.rb
CHANGED
@@ -24,6 +24,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
24
24
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
25
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
26
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
27
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
27
28
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
29
|
require 'aws-sdk-core/plugins/protocols/rest_xml.rb'
|
29
30
|
|
@@ -32,11 +33,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:cloudfront)
|
|
32
33
|
module Aws::CloudFront
|
33
34
|
# An API client for CloudFront. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
35
|
#
|
35
|
-
#
|
36
|
-
#
|
37
|
-
#
|
38
|
-
#
|
39
|
-
#
|
36
|
+
# client = Aws::CloudFront::Client.new(
|
37
|
+
# region: region_name,
|
38
|
+
# credentials: credentials,
|
39
|
+
# # ...
|
40
|
+
# )
|
40
41
|
#
|
41
42
|
# For details on configuring region and credentials see
|
42
43
|
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
@@ -69,6 +70,7 @@ module Aws::CloudFront
|
|
69
70
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
70
71
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
71
72
|
add_plugin(Aws::Plugins::TransferEncoding)
|
73
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
72
74
|
add_plugin(Aws::Plugins::SignatureV4)
|
73
75
|
add_plugin(Aws::Plugins::Protocols::RestXml)
|
74
76
|
|
@@ -105,7 +107,7 @@ module Aws::CloudFront
|
|
105
107
|
# @option options [required, String] :region
|
106
108
|
# The AWS region to connect to. The configured `:region` is
|
107
109
|
# used to determine the service `:endpoint`. When not passed,
|
108
|
-
# a default `:region` is
|
110
|
+
# a default `:region` is searched for in the following locations:
|
109
111
|
#
|
110
112
|
# * `Aws.config[:region]`
|
111
113
|
# * `ENV['AWS_REGION']`
|
@@ -161,7 +163,7 @@ module Aws::CloudFront
|
|
161
163
|
# @option options [String] :endpoint
|
162
164
|
# The client endpoint is normally constructed from the `:region`
|
163
165
|
# option. You should only configure an `:endpoint` when connecting
|
164
|
-
# to test endpoints. This should be
|
166
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
165
167
|
#
|
166
168
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
167
169
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -176,7 +178,7 @@ module Aws::CloudFront
|
|
176
178
|
# requests fetching endpoints information. Defaults to 60 sec.
|
177
179
|
#
|
178
180
|
# @option options [Boolean] :endpoint_discovery (false)
|
179
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
181
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
180
182
|
#
|
181
183
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
182
184
|
# The log formatter.
|
@@ -229,15 +231,19 @@ module Aws::CloudFront
|
|
229
231
|
#
|
230
232
|
# @option options [String] :retry_mode ("legacy")
|
231
233
|
# Specifies which retry algorithm to use. Values are:
|
232
|
-
#
|
233
|
-
#
|
234
|
-
#
|
235
|
-
#
|
236
|
-
#
|
237
|
-
#
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
234
|
+
#
|
235
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
236
|
+
# no retry mode is provided.
|
237
|
+
#
|
238
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
239
|
+
# This includes support for retry quotas, which limit the number of
|
240
|
+
# unsuccessful retries a client can make.
|
241
|
+
#
|
242
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
243
|
+
# functionality of `standard` mode along with automatic client side
|
244
|
+
# throttling. This is a provisional mode that may change behavior
|
245
|
+
# in the future.
|
246
|
+
#
|
241
247
|
#
|
242
248
|
# @option options [String] :secret_access_key
|
243
249
|
#
|
@@ -265,8 +271,7 @@ module Aws::CloudFront
|
|
265
271
|
#
|
266
272
|
# @option options [Integer] :http_read_timeout (60) The default
|
267
273
|
# number of seconds to wait for response data. This value can
|
268
|
-
# safely be set
|
269
|
-
# per-request on the session yielded by {#session_for}.
|
274
|
+
# safely be set per-request on the session.
|
270
275
|
#
|
271
276
|
# @option options [Float] :http_idle_timeout (5) The number of
|
272
277
|
# seconds a connection is allowed to sit idle before it is
|
@@ -278,7 +283,7 @@ module Aws::CloudFront
|
|
278
283
|
# request body. This option has no effect unless the request has
|
279
284
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
280
285
|
# disables this behaviour. This value can safely be set per
|
281
|
-
# request on the session
|
286
|
+
# request on the session.
|
282
287
|
#
|
283
288
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
284
289
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -421,6 +426,8 @@ module Aws::CloudFront
|
|
421
426
|
# origin_read_timeout: 1,
|
422
427
|
# origin_keepalive_timeout: 1,
|
423
428
|
# },
|
429
|
+
# connection_attempts: 1,
|
430
|
+
# connection_timeout: 1,
|
424
431
|
# },
|
425
432
|
# ],
|
426
433
|
# },
|
@@ -634,6 +641,8 @@ module Aws::CloudFront
|
|
634
641
|
# resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.items[0] #=> String, one of "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2"
|
635
642
|
# resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_read_timeout #=> Integer
|
636
643
|
# resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_keepalive_timeout #=> Integer
|
644
|
+
# resp.distribution.distribution_config.origins.items[0].connection_attempts #=> Integer
|
645
|
+
# resp.distribution.distribution_config.origins.items[0].connection_timeout #=> Integer
|
637
646
|
# resp.distribution.distribution_config.origin_groups.quantity #=> Integer
|
638
647
|
# resp.distribution.distribution_config.origin_groups.items #=> Array
|
639
648
|
# resp.distribution.distribution_config.origin_groups.items[0].id #=> String
|
@@ -808,6 +817,8 @@ module Aws::CloudFront
|
|
808
817
|
# origin_read_timeout: 1,
|
809
818
|
# origin_keepalive_timeout: 1,
|
810
819
|
# },
|
820
|
+
# connection_attempts: 1,
|
821
|
+
# connection_timeout: 1,
|
811
822
|
# },
|
812
823
|
# ],
|
813
824
|
# },
|
@@ -1030,6 +1041,8 @@ module Aws::CloudFront
|
|
1030
1041
|
# resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.items[0] #=> String, one of "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2"
|
1031
1042
|
# resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_read_timeout #=> Integer
|
1032
1043
|
# resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_keepalive_timeout #=> Integer
|
1044
|
+
# resp.distribution.distribution_config.origins.items[0].connection_attempts #=> Integer
|
1045
|
+
# resp.distribution.distribution_config.origins.items[0].connection_timeout #=> Integer
|
1033
1046
|
# resp.distribution.distribution_config.origin_groups.quantity #=> Integer
|
1034
1047
|
# resp.distribution.distribution_config.origin_groups.items #=> Array
|
1035
1048
|
# resp.distribution.distribution_config.origin_groups.items[0].id #=> String
|
@@ -1907,6 +1920,8 @@ module Aws::CloudFront
|
|
1907
1920
|
# resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.items[0] #=> String, one of "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2"
|
1908
1921
|
# resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_read_timeout #=> Integer
|
1909
1922
|
# resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_keepalive_timeout #=> Integer
|
1923
|
+
# resp.distribution.distribution_config.origins.items[0].connection_attempts #=> Integer
|
1924
|
+
# resp.distribution.distribution_config.origins.items[0].connection_timeout #=> Integer
|
1910
1925
|
# resp.distribution.distribution_config.origin_groups.quantity #=> Integer
|
1911
1926
|
# resp.distribution.distribution_config.origin_groups.items #=> Array
|
1912
1927
|
# resp.distribution.distribution_config.origin_groups.items[0].id #=> String
|
@@ -2019,6 +2034,11 @@ module Aws::CloudFront
|
|
2019
2034
|
# resp.distribution.alias_icp_recordals[0].icp_recordal_status #=> String, one of "APPROVED", "SUSPENDED", "PENDING"
|
2020
2035
|
# resp.etag #=> String
|
2021
2036
|
#
|
2037
|
+
#
|
2038
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
2039
|
+
#
|
2040
|
+
# * distribution_deployed
|
2041
|
+
#
|
2022
2042
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudfront-2019-03-26/GetDistribution2019_03_26 AWS API Documentation
|
2023
2043
|
#
|
2024
2044
|
# @overload get_distribution(params = {})
|
@@ -2070,6 +2090,8 @@ module Aws::CloudFront
|
|
2070
2090
|
# resp.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.items[0] #=> String, one of "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2"
|
2071
2091
|
# resp.distribution_config.origins.items[0].custom_origin_config.origin_read_timeout #=> Integer
|
2072
2092
|
# resp.distribution_config.origins.items[0].custom_origin_config.origin_keepalive_timeout #=> Integer
|
2093
|
+
# resp.distribution_config.origins.items[0].connection_attempts #=> Integer
|
2094
|
+
# resp.distribution_config.origins.items[0].connection_timeout #=> Integer
|
2073
2095
|
# resp.distribution_config.origin_groups.quantity #=> Integer
|
2074
2096
|
# resp.distribution_config.origin_groups.items #=> Array
|
2075
2097
|
# resp.distribution_config.origin_groups.items[0].id #=> String
|
@@ -2387,6 +2409,11 @@ module Aws::CloudFront
|
|
2387
2409
|
# resp.invalidation.invalidation_batch.paths.items[0] #=> String
|
2388
2410
|
# resp.invalidation.invalidation_batch.caller_reference #=> String
|
2389
2411
|
#
|
2412
|
+
#
|
2413
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
2414
|
+
#
|
2415
|
+
# * invalidation_completed
|
2416
|
+
#
|
2390
2417
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudfront-2019-03-26/GetInvalidation2019_03_26 AWS API Documentation
|
2391
2418
|
#
|
2392
2419
|
# @overload get_invalidation(params = {})
|
@@ -2513,6 +2540,11 @@ module Aws::CloudFront
|
|
2513
2540
|
# resp.streaming_distribution.streaming_distribution_config.enabled #=> Boolean
|
2514
2541
|
# resp.etag #=> String
|
2515
2542
|
#
|
2543
|
+
#
|
2544
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
2545
|
+
#
|
2546
|
+
# * streaming_distribution_deployed
|
2547
|
+
#
|
2516
2548
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudfront-2019-03-26/GetStreamingDistribution2019_03_26 AWS API Documentation
|
2517
2549
|
#
|
2518
2550
|
# @overload get_streaming_distribution(params = {})
|
@@ -2585,6 +2617,8 @@ module Aws::CloudFront
|
|
2585
2617
|
#
|
2586
2618
|
# * {Types::ListCloudFrontOriginAccessIdentitiesResult#cloud_front_origin_access_identity_list #cloud_front_origin_access_identity_list} => Types::CloudFrontOriginAccessIdentityList
|
2587
2619
|
#
|
2620
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2621
|
+
#
|
2588
2622
|
# @example Request syntax with placeholder values
|
2589
2623
|
#
|
2590
2624
|
# resp = client.list_cloud_front_origin_access_identities({
|
@@ -2629,6 +2663,8 @@ module Aws::CloudFront
|
|
2629
2663
|
#
|
2630
2664
|
# * {Types::ListDistributionsResult#distribution_list #distribution_list} => Types::DistributionList
|
2631
2665
|
#
|
2666
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2667
|
+
#
|
2632
2668
|
# @example Request syntax with placeholder values
|
2633
2669
|
#
|
2634
2670
|
# resp = client.list_distributions({
|
@@ -2670,6 +2706,8 @@ module Aws::CloudFront
|
|
2670
2706
|
# resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_ssl_protocols.items[0] #=> String, one of "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2"
|
2671
2707
|
# resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_read_timeout #=> Integer
|
2672
2708
|
# resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_keepalive_timeout #=> Integer
|
2709
|
+
# resp.distribution_list.items[0].origins.items[0].connection_attempts #=> Integer
|
2710
|
+
# resp.distribution_list.items[0].origins.items[0].connection_timeout #=> Integer
|
2673
2711
|
# resp.distribution_list.items[0].origin_groups.quantity #=> Integer
|
2674
2712
|
# resp.distribution_list.items[0].origin_groups.items #=> Array
|
2675
2713
|
# resp.distribution_list.items[0].origin_groups.items[0].id #=> String
|
@@ -2852,6 +2890,8 @@ module Aws::CloudFront
|
|
2852
2890
|
# resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_ssl_protocols.items[0] #=> String, one of "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2"
|
2853
2891
|
# resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_read_timeout #=> Integer
|
2854
2892
|
# resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_keepalive_timeout #=> Integer
|
2893
|
+
# resp.distribution_list.items[0].origins.items[0].connection_attempts #=> Integer
|
2894
|
+
# resp.distribution_list.items[0].origins.items[0].connection_timeout #=> Integer
|
2855
2895
|
# resp.distribution_list.items[0].origin_groups.quantity #=> Integer
|
2856
2896
|
# resp.distribution_list.items[0].origin_groups.items #=> Array
|
2857
2897
|
# resp.distribution_list.items[0].origin_groups.items[0].id #=> String
|
@@ -3099,6 +3139,8 @@ module Aws::CloudFront
|
|
3099
3139
|
#
|
3100
3140
|
# * {Types::ListInvalidationsResult#invalidation_list #invalidation_list} => Types::InvalidationList
|
3101
3141
|
#
|
3142
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3143
|
+
#
|
3102
3144
|
# @example Request syntax with placeholder values
|
3103
3145
|
#
|
3104
3146
|
# resp = client.list_invalidations({
|
@@ -3185,6 +3227,8 @@ module Aws::CloudFront
|
|
3185
3227
|
#
|
3186
3228
|
# * {Types::ListStreamingDistributionsResult#streaming_distribution_list #streaming_distribution_list} => Types::StreamingDistributionList
|
3187
3229
|
#
|
3230
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3231
|
+
#
|
3188
3232
|
# @example Request syntax with placeholder values
|
3189
3233
|
#
|
3190
3234
|
# resp = client.list_streaming_distributions({
|
@@ -3495,6 +3539,8 @@ module Aws::CloudFront
|
|
3495
3539
|
# origin_read_timeout: 1,
|
3496
3540
|
# origin_keepalive_timeout: 1,
|
3497
3541
|
# },
|
3542
|
+
# connection_attempts: 1,
|
3543
|
+
# connection_timeout: 1,
|
3498
3544
|
# },
|
3499
3545
|
# ],
|
3500
3546
|
# },
|
@@ -3710,6 +3756,8 @@ module Aws::CloudFront
|
|
3710
3756
|
# resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.items[0] #=> String, one of "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2"
|
3711
3757
|
# resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_read_timeout #=> Integer
|
3712
3758
|
# resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_keepalive_timeout #=> Integer
|
3759
|
+
# resp.distribution.distribution_config.origins.items[0].connection_attempts #=> Integer
|
3760
|
+
# resp.distribution.distribution_config.origins.items[0].connection_timeout #=> Integer
|
3713
3761
|
# resp.distribution.distribution_config.origin_groups.quantity #=> Integer
|
3714
3762
|
# resp.distribution.distribution_config.origin_groups.items #=> Array
|
3715
3763
|
# resp.distribution.distribution_config.origin_groups.items[0].id #=> String
|
@@ -4132,7 +4180,7 @@ module Aws::CloudFront
|
|
4132
4180
|
params: params,
|
4133
4181
|
config: config)
|
4134
4182
|
context[:gem_name] = 'aws-sdk-cloudfront'
|
4135
|
-
context[:gem_version] = '1.
|
4183
|
+
context[:gem_version] = '1.30.1'
|
4136
4184
|
Seahorse::Client::Request.new(handlers, context)
|
4137
4185
|
end
|
4138
4186
|
|
@@ -4198,11 +4246,11 @@ module Aws::CloudFront
|
|
4198
4246
|
# The following table lists the valid waiter names, the operations they call,
|
4199
4247
|
# and the default `:delay` and `:max_attempts` values.
|
4200
4248
|
#
|
4201
|
-
# | waiter_name | params
|
4202
|
-
# | ------------------------------- |
|
4203
|
-
# | distribution_deployed | {#get_distribution} | 60 | 35 |
|
4204
|
-
# | invalidation_completed | {#get_invalidation} | 20 | 30 |
|
4205
|
-
# | streaming_distribution_deployed | {#get_streaming_distribution} | 60 | 25 |
|
4249
|
+
# | waiter_name | params | :delay | :max_attempts |
|
4250
|
+
# | ------------------------------- | ----------------------------------- | -------- | ------------- |
|
4251
|
+
# | distribution_deployed | {Client#get_distribution} | 60 | 35 |
|
4252
|
+
# | invalidation_completed | {Client#get_invalidation} | 20 | 30 |
|
4253
|
+
# | streaming_distribution_deployed | {Client#get_streaming_distribution} | 60 | 25 |
|
4206
4254
|
#
|
4207
4255
|
# @raise [Errors::FailureStateError] Raised when the waiter terminates
|
4208
4256
|
# because the waiter has entered a state that it will not transition
|
@@ -1138,6 +1138,8 @@ module Aws::CloudFront
|
|
1138
1138
|
Origin.add_member(:custom_headers, Shapes::ShapeRef.new(shape: CustomHeaders, location_name: "CustomHeaders"))
|
1139
1139
|
Origin.add_member(:s3_origin_config, Shapes::ShapeRef.new(shape: S3OriginConfig, location_name: "S3OriginConfig"))
|
1140
1140
|
Origin.add_member(:custom_origin_config, Shapes::ShapeRef.new(shape: CustomOriginConfig, location_name: "CustomOriginConfig"))
|
1141
|
+
Origin.add_member(:connection_attempts, Shapes::ShapeRef.new(shape: integer, location_name: "ConnectionAttempts"))
|
1142
|
+
Origin.add_member(:connection_timeout, Shapes::ShapeRef.new(shape: integer, location_name: "ConnectionTimeout"))
|
1141
1143
|
Origin.struct_class = Types::Origin
|
1142
1144
|
|
1143
1145
|
OriginCustomHeader.add_member(:header_name, Shapes::ShapeRef.new(shape: string, required: true, location_name: "HeaderName"))
|
@@ -6,13 +6,7 @@
|
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
8
|
module Aws::CloudFront
|
9
|
-
|
10
|
-
# To create a resource object:
|
11
|
-
# resource = Aws::CloudFront::Resource.new(region: 'us-west-2')
|
12
|
-
# You can supply a client object with custom configuration that will be used for all resource operations.
|
13
|
-
# If you do not pass +:client+, a default client will be constructed.
|
14
|
-
# client = Aws::CloudFront::Client.new(region: 'us-west-2')
|
15
|
-
# resource = Aws::CloudFront::Resource.new(client: client)
|
9
|
+
|
16
10
|
class Resource
|
17
11
|
|
18
12
|
# @param options ({})
|
@@ -236,19 +236,19 @@ module Aws::CloudFront
|
|
236
236
|
#
|
237
237
|
# You must create at least as many cache behaviors (including the
|
238
238
|
# default cache behavior) as you have origins if you want CloudFront to
|
239
|
-
#
|
240
|
-
#
|
241
|
-
#
|
242
|
-
#
|
243
|
-
#
|
244
|
-
#
|
245
|
-
# For the current limit on the number of cache
|
246
|
-
# add to a distribution, see [
|
247
|
-
#
|
239
|
+
# serve objects from all of the origins. Each cache behavior specifies
|
240
|
+
# the one origin from which you want CloudFront to get objects. If you
|
241
|
+
# have two origins and only the default cache behavior, the default
|
242
|
+
# cache behavior will cause CloudFront to get objects from one of the
|
243
|
+
# origins, but the other origin is never used.
|
244
|
+
#
|
245
|
+
# For the current quota (formerly known as limit) on the number of cache
|
246
|
+
# behaviors that you can add to a distribution, see [Quotas][1] in the
|
247
|
+
# *Amazon CloudFront Developer Guide*.
|
248
248
|
#
|
249
|
-
# If you don
|
250
|
-
# empty `CacheBehaviors` element. Don
|
251
|
-
#
|
249
|
+
# If you don’t want to specify any cache behaviors, include only an
|
250
|
+
# empty `CacheBehaviors` element. Don’t include an empty `CacheBehavior`
|
251
|
+
# element because this is invalid.
|
252
252
|
#
|
253
253
|
# To delete all cache behaviors in an existing distribution, update the
|
254
254
|
# distribution configuration and include only an empty `CacheBehaviors`
|
@@ -258,12 +258,12 @@ module Aws::CloudFront
|
|
258
258
|
# distribution configuration and specify all of the cache behaviors that
|
259
259
|
# you want to include in the updated distribution.
|
260
260
|
#
|
261
|
-
# For more information about cache behaviors, see [Cache
|
262
|
-
# in the *Amazon CloudFront Developer Guide*.
|
261
|
+
# For more information about cache behaviors, see [Cache Behavior
|
262
|
+
# Settings][2] in the *Amazon CloudFront Developer Guide*.
|
263
263
|
#
|
264
264
|
#
|
265
265
|
#
|
266
|
-
# [1]: https://docs.aws.amazon.com/
|
266
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html
|
267
267
|
# [2]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior
|
268
268
|
#
|
269
269
|
# @note When making an API call, you may pass CacheBehavior
|
@@ -349,9 +349,7 @@ module Aws::CloudFront
|
|
349
349
|
#
|
350
350
|
# @!attribute [rw] target_origin_id
|
351
351
|
# The value of `ID` for the origin that you want CloudFront to route
|
352
|
-
# requests to when
|
353
|
-
# cache behavior or for the default cache behavior in your
|
354
|
-
# distribution.
|
352
|
+
# requests to when they match this cache behavior.
|
355
353
|
# @return [String]
|
356
354
|
#
|
357
355
|
# @!attribute [rw] forwarded_values
|
@@ -367,15 +365,15 @@ module Aws::CloudFront
|
|
367
365
|
# target origin that match the `PathPattern` for this cache behavior,
|
368
366
|
# specify `true` for `Enabled`, and specify the applicable values for
|
369
367
|
# `Quantity` and `Items`. For more information, see [Serving Private
|
370
|
-
# Content
|
371
|
-
# Guide*.
|
368
|
+
# Content with Signed URLs and Signed Cookies][1] in the *Amazon
|
369
|
+
# CloudFront Developer Guide*.
|
372
370
|
#
|
373
|
-
# If you don
|
371
|
+
# If you don’t want to require signed URLs in requests for objects
|
374
372
|
# that match `PathPattern`, specify `false` for `Enabled` and `0` for
|
375
373
|
# `Quantity`. Omit `Items`.
|
376
374
|
#
|
377
375
|
# To add, change, or remove one or more trusted signers, change
|
378
|
-
# `Enabled` to `true` (if it
|
376
|
+
# `Enabled` to `true` (if it’s currently `false`), change `Quantity`
|
379
377
|
# as applicable, and specify all of the trusted signers that you want
|
380
378
|
# to include in the updated distribution.
|
381
379
|
#
|
@@ -399,26 +397,25 @@ module Aws::CloudFront
|
|
399
397
|
# * `https-only`\: If a viewer sends an HTTP request, CloudFront
|
400
398
|
# returns an HTTP status code of 403 (Forbidden).
|
401
399
|
#
|
402
|
-
# For more information about requiring the HTTPS protocol, see
|
403
|
-
#
|
400
|
+
# For more information about requiring the HTTPS protocol, see
|
401
|
+
# [Requiring HTTPS Between Viewers and CloudFront][1] in the *Amazon
|
404
402
|
# CloudFront Developer Guide*.
|
405
403
|
#
|
406
404
|
# <note markdown="1"> The only way to guarantee that viewers retrieve an object that was
|
407
405
|
# fetched from the origin using HTTPS is never to use any other
|
408
406
|
# protocol to fetch the object. If you have recently changed from HTTP
|
409
|
-
# to HTTPS, we recommend that you clear your objects
|
407
|
+
# to HTTPS, we recommend that you clear your objects’ cache because
|
410
408
|
# cached objects are protocol agnostic. That means that an edge
|
411
409
|
# location will return an object from the cache regardless of whether
|
412
410
|
# the current request protocol matches the protocol used previously.
|
413
|
-
# For more information, see [Managing
|
414
|
-
#
|
415
|
-
# Guide*.
|
411
|
+
# For more information, see [Managing Cache Expiration][2] in the
|
412
|
+
# *Amazon CloudFront Developer Guide*.
|
416
413
|
#
|
417
414
|
# </note>
|
418
415
|
#
|
419
416
|
#
|
420
417
|
#
|
421
|
-
# [1]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/
|
418
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html
|
422
419
|
# [2]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html
|
423
420
|
# @return [String]
|
424
421
|
#
|
@@ -515,8 +512,7 @@ module Aws::CloudFront
|
|
515
512
|
# @!attribute [rw] field_level_encryption_id
|
516
513
|
# The value of `ID` for the field-level encryption configuration that
|
517
514
|
# you want CloudFront to use for encrypting specific fields of data
|
518
|
-
# for
|
519
|
-
# distribution.
|
515
|
+
# for this cache behavior.
|
520
516
|
# @return [String]
|
521
517
|
#
|
522
518
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudfront-2019-03-26/CacheBehavior AWS API Documentation
|
@@ -1164,6 +1160,8 @@ module Aws::CloudFront
|
|
1164
1160
|
# origin_read_timeout: 1,
|
1165
1161
|
# origin_keepalive_timeout: 1,
|
1166
1162
|
# },
|
1163
|
+
# connection_attempts: 1,
|
1164
|
+
# connection_timeout: 1,
|
1167
1165
|
# },
|
1168
1166
|
# ],
|
1169
1167
|
# },
|
@@ -1419,6 +1417,8 @@ module Aws::CloudFront
|
|
1419
1417
|
# origin_read_timeout: 1,
|
1420
1418
|
# origin_keepalive_timeout: 1,
|
1421
1419
|
# },
|
1420
|
+
# connection_attempts: 1,
|
1421
|
+
# connection_timeout: 1,
|
1422
1422
|
# },
|
1423
1423
|
# ],
|
1424
1424
|
# },
|
@@ -2204,8 +2204,13 @@ module Aws::CloudFront
|
|
2204
2204
|
include Aws::Structure
|
2205
2205
|
end
|
2206
2206
|
|
2207
|
-
# A custom origin
|
2208
|
-
#
|
2207
|
+
# A custom origin. A custom origin is any origin that is *not* an Amazon
|
2208
|
+
# S3 bucket, with one exception. An Amazon S3 bucket that is [configured
|
2209
|
+
# with static website hosting][1] *is* a custom origin.
|
2210
|
+
#
|
2211
|
+
#
|
2212
|
+
#
|
2213
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html
|
2209
2214
|
#
|
2210
2215
|
# @note When making an API call, you may pass CustomOriginConfig
|
2211
2216
|
# data as a hash:
|
@@ -2223,48 +2228,68 @@ module Aws::CloudFront
|
|
2223
2228
|
# }
|
2224
2229
|
#
|
2225
2230
|
# @!attribute [rw] http_port
|
2226
|
-
# The HTTP port
|
2231
|
+
# The HTTP port that CloudFront uses to connect to the origin. Specify
|
2232
|
+
# the HTTP port that the origin listens on.
|
2227
2233
|
# @return [Integer]
|
2228
2234
|
#
|
2229
2235
|
# @!attribute [rw] https_port
|
2230
|
-
# The HTTPS port
|
2236
|
+
# The HTTPS port that CloudFront uses to connect to the origin.
|
2237
|
+
# Specify the HTTPS port that the origin listens on.
|
2231
2238
|
# @return [Integer]
|
2232
2239
|
#
|
2233
2240
|
# @!attribute [rw] origin_protocol_policy
|
2234
|
-
#
|
2241
|
+
# Specifies the protocol (HTTP or HTTPS) that CloudFront uses to
|
2242
|
+
# connect to the origin. Valid values are:
|
2243
|
+
#
|
2244
|
+
# * `http-only` – CloudFront always uses HTTP to connect to the
|
2245
|
+
# origin.
|
2246
|
+
#
|
2247
|
+
# * `match-viewer` – CloudFront connects to the origin using the same
|
2248
|
+
# protocol that the viewer used to connect to CloudFront.
|
2249
|
+
#
|
2250
|
+
# * `https-only` – CloudFront always uses HTTPS to connect to the
|
2251
|
+
# origin.
|
2235
2252
|
# @return [String]
|
2236
2253
|
#
|
2237
2254
|
# @!attribute [rw] origin_ssl_protocols
|
2238
|
-
#
|
2239
|
-
#
|
2255
|
+
# Specifies the minimum SSL/TLS protocol that CloudFront uses when
|
2256
|
+
# connecting to your origin over HTTPS. Valid values include `SSLv3`,
|
2257
|
+
# `TLSv1`, `TLSv1.1`, and `TLSv1.2`.
|
2258
|
+
#
|
2259
|
+
# For more information, see [Minimum Origin SSL Protocol][1] in the
|
2260
|
+
# *Amazon CloudFront Developer Guide*.
|
2261
|
+
#
|
2262
|
+
#
|
2263
|
+
#
|
2264
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols
|
2240
2265
|
# @return [Types::OriginSslProtocols]
|
2241
2266
|
#
|
2242
2267
|
# @!attribute [rw] origin_read_timeout
|
2243
|
-
#
|
2244
|
-
#
|
2245
|
-
#
|
2246
|
-
#
|
2268
|
+
# Specifies how long, in seconds, CloudFront waits for a response from
|
2269
|
+
# the origin. This is also known as the *origin response timeout*. The
|
2270
|
+
# minimum timeout is 1 second, the maximum is 60 seconds, and the
|
2271
|
+
# default (if you don’t specify otherwise) is 30 seconds.
|
2247
2272
|
#
|
2248
|
-
#
|
2249
|
-
#
|
2273
|
+
# For more information, see [Origin Response Timeout][1] in the
|
2274
|
+
# *Amazon CloudFront Developer Guide*.
|
2250
2275
|
#
|
2251
2276
|
#
|
2252
2277
|
#
|
2253
|
-
# [1]: https://
|
2278
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout
|
2254
2279
|
# @return [Integer]
|
2255
2280
|
#
|
2256
2281
|
# @!attribute [rw] origin_keepalive_timeout
|
2257
|
-
#
|
2258
|
-
#
|
2259
|
-
#
|
2260
|
-
#
|
2282
|
+
# Specifies how long, in seconds, CloudFront persists its connection
|
2283
|
+
# to the origin. The minimum timeout is 1 second, the maximum is 60
|
2284
|
+
# seconds, and the default (if you don’t specify otherwise) is 5
|
2285
|
+
# seconds.
|
2261
2286
|
#
|
2262
|
-
#
|
2263
|
-
#
|
2287
|
+
# For more information, see [Origin Keep-alive Timeout][1] in the
|
2288
|
+
# *Amazon CloudFront Developer Guide*.
|
2264
2289
|
#
|
2265
2290
|
#
|
2266
2291
|
#
|
2267
|
-
# [1]: https://
|
2292
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout
|
2268
2293
|
# @return [Integer]
|
2269
2294
|
#
|
2270
2295
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudfront-2019-03-26/CustomOriginConfig AWS API Documentation
|
@@ -2279,10 +2304,10 @@ module Aws::CloudFront
|
|
2279
2304
|
include Aws::Structure
|
2280
2305
|
end
|
2281
2306
|
|
2282
|
-
# A complex type that describes the default cache behavior if you don
|
2283
|
-
# specify a `CacheBehavior` element or if
|
2284
|
-
# values of `PathPattern` in `CacheBehavior` elements. You must
|
2285
|
-
# exactly one default cache behavior.
|
2307
|
+
# A complex type that describes the default cache behavior if you don’t
|
2308
|
+
# specify a `CacheBehavior` element or if request URLs don’t match any
|
2309
|
+
# of the values of `PathPattern` in `CacheBehavior` elements. You must
|
2310
|
+
# create exactly one default cache behavior.
|
2286
2311
|
#
|
2287
2312
|
# @note When making an API call, you may pass DefaultCacheBehavior
|
2288
2313
|
# data as a hash:
|
@@ -2341,9 +2366,7 @@ module Aws::CloudFront
|
|
2341
2366
|
#
|
2342
2367
|
# @!attribute [rw] target_origin_id
|
2343
2368
|
# The value of `ID` for the origin that you want CloudFront to route
|
2344
|
-
# requests to when
|
2345
|
-
# cache behavior or for the default cache behavior in your
|
2346
|
-
# distribution.
|
2369
|
+
# requests to when they use the default cache behavior.
|
2347
2370
|
# @return [String]
|
2348
2371
|
#
|
2349
2372
|
# @!attribute [rw] forwarded_values
|
@@ -2359,15 +2382,15 @@ module Aws::CloudFront
|
|
2359
2382
|
# target origin that match the `PathPattern` for this cache behavior,
|
2360
2383
|
# specify `true` for `Enabled`, and specify the applicable values for
|
2361
2384
|
# `Quantity` and `Items`. For more information, see [Serving Private
|
2362
|
-
# Content
|
2363
|
-
# Developer Guide
|
2385
|
+
# Content with Signed URLs and Signed Cookies][1] in the *Amazon
|
2386
|
+
# CloudFront Developer Guide*.
|
2364
2387
|
#
|
2365
|
-
# If you don
|
2388
|
+
# If you don’t want to require signed URLs in requests for objects
|
2366
2389
|
# that match `PathPattern`, specify `false` for `Enabled` and `0` for
|
2367
2390
|
# `Quantity`. Omit `Items`.
|
2368
2391
|
#
|
2369
2392
|
# To add, change, or remove one or more trusted signers, change
|
2370
|
-
# `Enabled` to `true` (if it
|
2393
|
+
# `Enabled` to `true` (if it’s currently `false`), change `Quantity`
|
2371
2394
|
# as applicable, and specify all of the trusted signers that you want
|
2372
2395
|
# to include in the updated distribution.
|
2373
2396
|
#
|
@@ -2391,26 +2414,25 @@ module Aws::CloudFront
|
|
2391
2414
|
# * `https-only`\: If a viewer sends an HTTP request, CloudFront
|
2392
2415
|
# returns an HTTP status code of 403 (Forbidden).
|
2393
2416
|
#
|
2394
|
-
# For more information about requiring the HTTPS protocol, see
|
2395
|
-
#
|
2417
|
+
# For more information about requiring the HTTPS protocol, see
|
2418
|
+
# [Requiring HTTPS Between Viewers and CloudFront][1] in the *Amazon
|
2396
2419
|
# CloudFront Developer Guide*.
|
2397
2420
|
#
|
2398
2421
|
# <note markdown="1"> The only way to guarantee that viewers retrieve an object that was
|
2399
2422
|
# fetched from the origin using HTTPS is never to use any other
|
2400
2423
|
# protocol to fetch the object. If you have recently changed from HTTP
|
2401
|
-
# to HTTPS, we recommend that you clear your objects
|
2424
|
+
# to HTTPS, we recommend that you clear your objects’ cache because
|
2402
2425
|
# cached objects are protocol agnostic. That means that an edge
|
2403
2426
|
# location will return an object from the cache regardless of whether
|
2404
2427
|
# the current request protocol matches the protocol used previously.
|
2405
|
-
# For more information, see [Managing
|
2406
|
-
#
|
2407
|
-
# Guide*.
|
2428
|
+
# For more information, see [Managing Cache Expiration][2] in the
|
2429
|
+
# *Amazon CloudFront Developer Guide*.
|
2408
2430
|
#
|
2409
2431
|
# </note>
|
2410
2432
|
#
|
2411
2433
|
#
|
2412
2434
|
#
|
2413
|
-
# [1]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/
|
2435
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html
|
2414
2436
|
# [2]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html
|
2415
2437
|
# @return [String]
|
2416
2438
|
#
|
@@ -2507,8 +2529,7 @@ module Aws::CloudFront
|
|
2507
2529
|
# @!attribute [rw] field_level_encryption_id
|
2508
2530
|
# The value of `ID` for the field-level encryption configuration that
|
2509
2531
|
# you want CloudFront to use for encrypting specific fields of data
|
2510
|
-
# for
|
2511
|
-
# distribution.
|
2532
|
+
# for the default cache behavior.
|
2512
2533
|
# @return [String]
|
2513
2534
|
#
|
2514
2535
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudfront-2019-03-26/DefaultCacheBehavior AWS API Documentation
|
@@ -2862,6 +2883,8 @@ module Aws::CloudFront
|
|
2862
2883
|
# origin_read_timeout: 1,
|
2863
2884
|
# origin_keepalive_timeout: 1,
|
2864
2885
|
# },
|
2886
|
+
# connection_attempts: 1,
|
2887
|
+
# connection_timeout: 1,
|
2865
2888
|
# },
|
2866
2889
|
# ],
|
2867
2890
|
# },
|
@@ -3336,6 +3359,8 @@ module Aws::CloudFront
|
|
3336
3359
|
# origin_read_timeout: 1,
|
3337
3360
|
# origin_keepalive_timeout: 1,
|
3338
3361
|
# },
|
3362
|
+
# connection_attempts: 1,
|
3363
|
+
# connection_timeout: 1,
|
3339
3364
|
# },
|
3340
3365
|
# ],
|
3341
3366
|
# },
|
@@ -4976,7 +5001,7 @@ module Aws::CloudFront
|
|
4976
5001
|
include Aws::Structure
|
4977
5002
|
end
|
4978
5003
|
|
4979
|
-
#
|
5004
|
+
# An argument is invalid.
|
4980
5005
|
#
|
4981
5006
|
# @!attribute [rw] message
|
4982
5007
|
# @return [String]
|
@@ -6140,19 +6165,36 @@ module Aws::CloudFront
|
|
6140
6165
|
include Aws::Structure
|
6141
6166
|
end
|
6142
6167
|
|
6143
|
-
#
|
6144
|
-
#
|
6145
|
-
#
|
6146
|
-
#
|
6147
|
-
#
|
6168
|
+
# An origin.
|
6169
|
+
#
|
6170
|
+
# An origin is the location where content is stored, and from which
|
6171
|
+
# CloudFront gets content to serve to viewers. To specify an origin:
|
6172
|
+
#
|
6173
|
+
# * Use the `S3OriginConfig` type to specify an Amazon S3 bucket that is
|
6174
|
+
# <i> <b>not</b> </i> configured with static website hosting.
|
6175
|
+
#
|
6176
|
+
# * Use the `CustomOriginConfig` type to specify various other kinds of
|
6177
|
+
# content containers or HTTP servers, including:
|
6178
|
+
#
|
6179
|
+
# * An Amazon S3 bucket that is configured with static website hosting
|
6180
|
+
#
|
6181
|
+
# * An Elastic Load Balancing load balancer
|
6182
|
+
#
|
6183
|
+
# * An AWS Elemental MediaPackage origin
|
6184
|
+
#
|
6185
|
+
# * An AWS Elemental MediaStore container
|
6186
|
+
#
|
6187
|
+
# * Any other HTTP server, running on an Amazon EC2 instance or any
|
6188
|
+
# other kind of host
|
6148
6189
|
#
|
6149
|
-
# For the current
|
6150
|
-
#
|
6151
|
-
#
|
6190
|
+
# For the current maximum number of origins that you can specify per
|
6191
|
+
# distribution, see [General Quotas on Web Distributions][1] in the
|
6192
|
+
# *Amazon CloudFront Developer Guide* (quotas were formerly referred to
|
6193
|
+
# as limits).
|
6152
6194
|
#
|
6153
6195
|
#
|
6154
6196
|
#
|
6155
|
-
# [1]: https://docs.aws.amazon.com/
|
6197
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html#limits-web-distributions
|
6156
6198
|
#
|
6157
6199
|
# @note When making an API call, you may pass Origin
|
6158
6200
|
# data as a hash:
|
@@ -6184,60 +6226,23 @@ module Aws::CloudFront
|
|
6184
6226
|
# origin_read_timeout: 1,
|
6185
6227
|
# origin_keepalive_timeout: 1,
|
6186
6228
|
# },
|
6229
|
+
# connection_attempts: 1,
|
6230
|
+
# connection_timeout: 1,
|
6187
6231
|
# }
|
6188
6232
|
#
|
6189
6233
|
# @!attribute [rw] id
|
6190
|
-
# A unique identifier for the origin
|
6191
|
-
#
|
6192
|
-
#
|
6193
|
-
# When you specify the value of `TargetOriginId` for the default cache
|
6194
|
-
# behavior or for another cache behavior, you indicate the origin to
|
6195
|
-
# which you want the cache behavior to route requests by specifying
|
6196
|
-
# the value of the `Id` element for that origin. When a request
|
6197
|
-
# matches the path pattern for that cache behavior, CloudFront routes
|
6198
|
-
# the request to the specified origin. For more information, see
|
6199
|
-
# [Cache Behavior Settings][1] in the *Amazon CloudFront Developer
|
6200
|
-
# Guide*.
|
6201
|
-
#
|
6202
|
-
#
|
6234
|
+
# A unique identifier for the origin. This value must be unique within
|
6235
|
+
# the distribution.
|
6203
6236
|
#
|
6204
|
-
#
|
6237
|
+
# Use this value to specify the `TargetOriginId` in a CacheBehavior or
|
6238
|
+
# DefaultCacheBehavior.
|
6205
6239
|
# @return [String]
|
6206
6240
|
#
|
6207
6241
|
# @!attribute [rw] domain_name
|
6208
|
-
#
|
6209
|
-
# which you want CloudFront to get objects for this origin, for
|
6210
|
-
# example, `myawsbucket.s3.amazonaws.com`. If you set up your bucket
|
6211
|
-
# to be configured as a website endpoint, enter the Amazon S3 static
|
6212
|
-
# website hosting endpoint for the bucket.
|
6213
|
-
#
|
6214
|
-
# For more information about specifying this value for different types
|
6215
|
-
# of origins, see [Origin Domain Name][1] in the *Amazon CloudFront
|
6216
|
-
# Developer Guide*.
|
6217
|
-
#
|
6218
|
-
# Constraints for Amazon S3 origins:
|
6219
|
-
#
|
6220
|
-
# * If you configured Amazon S3 Transfer Acceleration for your bucket,
|
6221
|
-
# don't specify the `s3-accelerate` endpoint for `DomainName`.
|
6222
|
-
#
|
6223
|
-
# * The bucket name must be between 3 and 63 characters long
|
6224
|
-
# (inclusive).
|
6225
|
-
#
|
6226
|
-
# * The bucket name must contain only lowercase characters, numbers,
|
6227
|
-
# periods, underscores, and dashes.
|
6228
|
-
#
|
6229
|
-
# * The bucket name must not contain adjacent periods.
|
6242
|
+
# The domain name for the origin.
|
6230
6243
|
#
|
6231
|
-
#
|
6232
|
-
#
|
6233
|
-
# example, `www.example.com`.
|
6234
|
-
#
|
6235
|
-
# Constraints for custom origins:
|
6236
|
-
#
|
6237
|
-
# * `DomainName` must be a valid DNS name that contains only a-z, A-Z,
|
6238
|
-
# 0-9, dot (.), hyphen (-), or underscore (\_) characters.
|
6239
|
-
#
|
6240
|
-
# * The name cannot exceed 128 characters.
|
6244
|
+
# For more information, see [Origin Domain Name][1] in the *Amazon
|
6245
|
+
# CloudFront Developer Guide*.
|
6241
6246
|
#
|
6242
6247
|
#
|
6243
6248
|
#
|
@@ -6245,48 +6250,72 @@ module Aws::CloudFront
|
|
6245
6250
|
# @return [String]
|
6246
6251
|
#
|
6247
6252
|
# @!attribute [rw] origin_path
|
6248
|
-
# An optional
|
6249
|
-
#
|
6250
|
-
# When you include the `OriginPath` element, specify the directory
|
6251
|
-
# name, beginning with a `/`. CloudFront appends the directory name to
|
6252
|
-
# the value of `DomainName`, for example, `example.com/production`. Do
|
6253
|
-
# not include a `/` at the end of the directory name.
|
6253
|
+
# An optional path that CloudFront appends to the origin domain name
|
6254
|
+
# when CloudFront requests content from the origin.
|
6254
6255
|
#
|
6255
|
-
# For
|
6256
|
-
#
|
6257
|
-
#
|
6258
|
-
# * `DomainName`\: An Amazon S3 bucket named `myawsbucket`.
|
6259
|
-
#
|
6260
|
-
# * `OriginPath`\: `/production`
|
6256
|
+
# For more information, see [Origin Path][1] in the *Amazon CloudFront
|
6257
|
+
# Developer Guide*.
|
6261
6258
|
#
|
6262
|
-
# * `CNAME`\: `example.com`
|
6263
6259
|
#
|
6264
|
-
# When a user enters `example.com/index.html` in a browser, CloudFront
|
6265
|
-
# sends a request to Amazon S3 for
|
6266
|
-
# `myawsbucket/production/index.html`.
|
6267
6260
|
#
|
6268
|
-
#
|
6269
|
-
# CloudFront sends a request to Amazon S3 for
|
6270
|
-
# `myawsbucket/production/acme/index.html`.
|
6261
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginPath
|
6271
6262
|
# @return [String]
|
6272
6263
|
#
|
6273
6264
|
# @!attribute [rw] custom_headers
|
6274
|
-
# A
|
6275
|
-
#
|
6265
|
+
# A list of HTTP header names and values that CloudFront adds to
|
6266
|
+
# requests it sends to the origin.
|
6267
|
+
#
|
6268
|
+
# For more information, see [Adding Custom Headers to Origin
|
6269
|
+
# Requests][1] in the *Amazon CloudFront Developer Guide*.
|
6270
|
+
#
|
6271
|
+
#
|
6272
|
+
#
|
6273
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/add-origin-custom-headers.html
|
6276
6274
|
# @return [Types::CustomHeaders]
|
6277
6275
|
#
|
6278
6276
|
# @!attribute [rw] s3_origin_config
|
6279
|
-
#
|
6280
|
-
#
|
6281
|
-
#
|
6277
|
+
# Use this type to specify an origin that is an Amazon S3 bucket that
|
6278
|
+
# is <i> <b>not</b> </i> configured with static website hosting. To
|
6279
|
+
# specify any other type of origin, including an Amazon S3 bucket that
|
6280
|
+
# is configured with static website hosting, use the
|
6281
|
+
# `CustomOriginConfig` type instead.
|
6282
6282
|
# @return [Types::S3OriginConfig]
|
6283
6283
|
#
|
6284
6284
|
# @!attribute [rw] custom_origin_config
|
6285
|
-
#
|
6286
|
-
#
|
6287
|
-
#
|
6285
|
+
# Use this type to specify an origin that is a content container or
|
6286
|
+
# HTTP server, including an Amazon S3 bucket that is configured with
|
6287
|
+
# static website hosting. To specify an Amazon S3 bucket that is <i>
|
6288
|
+
# <b>not</b> </i> configured with static website hosting, use the
|
6289
|
+
# `S3OriginConfig` type instead.
|
6288
6290
|
# @return [Types::CustomOriginConfig]
|
6289
6291
|
#
|
6292
|
+
# @!attribute [rw] connection_attempts
|
6293
|
+
# The number of times that CloudFront attempts to connect to the
|
6294
|
+
# origin. The minimum number is 1, the maximum is 3, and the default
|
6295
|
+
# (if you don’t specify otherwise) is 3.
|
6296
|
+
#
|
6297
|
+
# For more information, see [Origin Connection Attempts][1] in the
|
6298
|
+
# *Amazon CloudFront Developer Guide*.
|
6299
|
+
#
|
6300
|
+
#
|
6301
|
+
#
|
6302
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts
|
6303
|
+
# @return [Integer]
|
6304
|
+
#
|
6305
|
+
# @!attribute [rw] connection_timeout
|
6306
|
+
# The number of seconds that CloudFront waits when trying to establish
|
6307
|
+
# a connection to the origin. The minimum timeout is 1 second, the
|
6308
|
+
# maximum is 10 seconds, and the default (if you don’t specify
|
6309
|
+
# otherwise) is 10 seconds.
|
6310
|
+
#
|
6311
|
+
# For more information, see [Origin Connection Timeout][1] in the
|
6312
|
+
# *Amazon CloudFront Developer Guide*.
|
6313
|
+
#
|
6314
|
+
#
|
6315
|
+
#
|
6316
|
+
# [1]: https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout
|
6317
|
+
# @return [Integer]
|
6318
|
+
#
|
6290
6319
|
# @see http://docs.aws.amazon.com/goto/WebAPI/cloudfront-2019-03-26/Origin AWS API Documentation
|
6291
6320
|
#
|
6292
6321
|
class Origin < Struct.new(
|
@@ -6295,7 +6324,9 @@ module Aws::CloudFront
|
|
6295
6324
|
:origin_path,
|
6296
6325
|
:custom_headers,
|
6297
6326
|
:s3_origin_config,
|
6298
|
-
:custom_origin_config
|
6327
|
+
:custom_origin_config,
|
6328
|
+
:connection_attempts,
|
6329
|
+
:connection_timeout)
|
6299
6330
|
include Aws::Structure
|
6300
6331
|
end
|
6301
6332
|
|
@@ -6573,6 +6604,8 @@ module Aws::CloudFront
|
|
6573
6604
|
# origin_read_timeout: 1,
|
6574
6605
|
# origin_keepalive_timeout: 1,
|
6575
6606
|
# },
|
6607
|
+
# connection_attempts: 1,
|
6608
|
+
# connection_timeout: 1,
|
6576
6609
|
# },
|
6577
6610
|
# ],
|
6578
6611
|
# }
|
@@ -6628,7 +6661,7 @@ module Aws::CloudFront
|
|
6628
6661
|
include Aws::Structure
|
6629
6662
|
end
|
6630
6663
|
|
6631
|
-
# The precondition given in one or more of the request
|
6664
|
+
# The precondition given in one or more of the request header fields
|
6632
6665
|
# evaluated to `false`.
|
6633
6666
|
#
|
6634
6667
|
# @!attribute [rw] message
|
@@ -7017,8 +7050,8 @@ module Aws::CloudFront
|
|
7017
7050
|
end
|
7018
7051
|
|
7019
7052
|
# A complex type that contains information about the Amazon S3 origin.
|
7020
|
-
# If the origin is a custom origin
|
7021
|
-
# instead.
|
7053
|
+
# If the origin is a custom origin or an S3 bucket that is configured as
|
7054
|
+
# a website endpoint, use the `CustomOriginConfig` element instead.
|
7022
7055
|
#
|
7023
7056
|
# @note When making an API call, you may pass S3OriginConfig
|
7024
7057
|
# data as a hash:
|
@@ -8180,6 +8213,8 @@ module Aws::CloudFront
|
|
8180
8213
|
# origin_read_timeout: 1,
|
8181
8214
|
# origin_keepalive_timeout: 1,
|
8182
8215
|
# },
|
8216
|
+
# connection_attempts: 1,
|
8217
|
+
# connection_timeout: 1,
|
8183
8218
|
# },
|
8184
8219
|
# ],
|
8185
8220
|
# },
|
@@ -8,6 +8,69 @@
|
|
8
8
|
require 'aws-sdk-core/waiters'
|
9
9
|
|
10
10
|
module Aws::CloudFront
|
11
|
+
# Waiters are utility methods that poll for a particular state to occur
|
12
|
+
# on a client. Waiters can fail after a number of attempts at a polling
|
13
|
+
# interval defined for the service client.
|
14
|
+
#
|
15
|
+
# For a list of operations that can be waited for and the
|
16
|
+
# client methods called for each operation, see the table below or the
|
17
|
+
# {Client#wait_until} field documentation for the {Client}.
|
18
|
+
#
|
19
|
+
# # Invoking a Waiter
|
20
|
+
# To invoke a waiter, call #wait_until on a {Client}. The first parameter
|
21
|
+
# is the waiter name, which is specific to the service client and indicates
|
22
|
+
# which operation is being waited for. The second parameter is a hash of
|
23
|
+
# parameters that are passed to the client method called by the waiter,
|
24
|
+
# which varies according to the waiter name.
|
25
|
+
#
|
26
|
+
# # Wait Failures
|
27
|
+
# To catch errors in a waiter, use WaiterFailed,
|
28
|
+
# as shown in the following example.
|
29
|
+
#
|
30
|
+
# rescue rescue Aws::Waiters::Errors::WaiterFailed => error
|
31
|
+
# puts "failed waiting for instance running: #{error.message}
|
32
|
+
# end
|
33
|
+
#
|
34
|
+
# # Configuring a Waiter
|
35
|
+
# Each waiter has a default polling interval and a maximum number of
|
36
|
+
# attempts it will make before returning control to your program.
|
37
|
+
# To set these values, use the `max_attempts` and `delay` parameters
|
38
|
+
# in your `#wait_until` call.
|
39
|
+
# The following example waits for up to 25 seconds, polling every five seconds.
|
40
|
+
#
|
41
|
+
# client.wait_until(...) do |w|
|
42
|
+
# w.max_attempts = 5
|
43
|
+
# w.delay = 5
|
44
|
+
# end
|
45
|
+
#
|
46
|
+
# To disable wait failures, set the value of either of these parameters
|
47
|
+
# to `nil`.
|
48
|
+
#
|
49
|
+
# # Extending a Waiter
|
50
|
+
# To modify the behavior of waiters, you can register callbacks that are
|
51
|
+
# triggered before each polling attempt and before waiting.
|
52
|
+
#
|
53
|
+
# The following example implements an exponential backoff in a waiter
|
54
|
+
# by doubling the amount of time to wait on every attempt.
|
55
|
+
#
|
56
|
+
# client.wait_until(...) do |w|
|
57
|
+
# w.interval = 0 # disable normal sleep
|
58
|
+
# w.before_wait do |n, resp|
|
59
|
+
# sleep(n ** 2)
|
60
|
+
# end
|
61
|
+
# end
|
62
|
+
#
|
63
|
+
# # Available Waiters
|
64
|
+
#
|
65
|
+
# The following table lists the valid waiter names, the operations they call,
|
66
|
+
# and the default `:delay` and `:max_attempts` values.
|
67
|
+
#
|
68
|
+
# | waiter_name | params | :delay | :max_attempts |
|
69
|
+
# | ------------------------------- | ----------------------------------- | -------- | ------------- |
|
70
|
+
# | distribution_deployed | {Client#get_distribution} | 60 | 35 |
|
71
|
+
# | invalidation_completed | {Client#get_invalidation} | 20 | 30 |
|
72
|
+
# | streaming_distribution_deployed | {Client#get_streaming_distribution} | 60 | 25 |
|
73
|
+
#
|
11
74
|
module Waiters
|
12
75
|
|
13
76
|
# Wait until a distribution is deployed.
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-cloudfront
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.30.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-
|
11
|
+
date: 2020-06-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.99.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.99.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|
@@ -85,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
85
85
|
version: '0'
|
86
86
|
requirements: []
|
87
87
|
rubyforge_project:
|
88
|
-
rubygems_version: 2.
|
88
|
+
rubygems_version: 2.7.6.2
|
89
89
|
signing_key:
|
90
90
|
specification_version: 4
|
91
91
|
summary: AWS SDK for Ruby - CloudFront
|