lib/aws-sdk-cloudfront/client.rb in aws-sdk-cloudfront-1.0.0.rc6 vs lib/aws-sdk-cloudfront/client.rb in aws-sdk-cloudfront-1.0.0.rc7
- old
+ new
@@ -2388,12 +2388,74 @@
def update_cloud_front_origin_access_identity(params = {}, options = {})
req = build_request(:update_cloud_front_origin_access_identity, params)
req.send_request(options)
end
- # Update a distribution.
+ # Updates the configuration for a web distribution. Perform the
+ # following steps.
#
+ # For information about updating a distribution using the CloudFront
+ # console, see [Creating or Updating a Web Distribution Using the
+ # CloudFront Console ][1] in the *Amazon CloudFront Developer Guide*.
+ #
+ # **To update a web distribution using the CloudFront API**
+ #
+ # 1. Submit a GetDistributionConfig request to get the current
+ # configuration and an `Etag` header for the distribution.
+ #
+ # <note markdown="1"> If you update the distribution again, you need to get a new `Etag`
+ # header.
+ #
+ # </note>
+ #
+ # 2. Update the XML document that was returned in the response to your
+ # `GetDistributionConfig` request to include the desired changes.
+ # You can't change the value of `CallerReference`. If you try to
+ # change this value, CloudFront returns an `IllegalUpdate` error.
+ #
+ # The new configuration replaces the existing configuration; the
+ # values that you specify in an `UpdateDistribution` request are not
+ # merged into the existing configuration. When you add, delete, or
+ # replace values in an element that allows multiple values (for
+ # example, `CNAME`), you must specify all of the values that you
+ # want to appear in the updated distribution. In addition, you must
+ # update the corresponding `Quantity` element.
+ #
+ # 3. Submit an `UpdateDistribution` request to update the configuration
+ # for your distribution:
+ #
+ # * In the request body, include the XML document that you updated
+ # in Step 2. The request body must include an XML document with a
+ # `DistributionConfig` element.
+ #
+ # * Set the value of the HTTP `If-Match` header to the value of the
+ # `ETag` header that CloudFront returned when you submitted the
+ # `GetDistributionConfig` request in Step 1.
+ #
+ # 4. Review the response to the `UpdateDistribution` request to confirm
+ # that the configuration was successfully updated.
+ #
+ # 5. Optional: Submit a GetDistribution request to confirm that your
+ # changes have propagated. When propagation is complete, the value
+ # of `Status` is `Deployed`.
+ #
+ # Beginning with the 2012-05-05 version of the CloudFront API, we
+ # made substantial changes to the format of the XML document that
+ # you include in the request body when you create or update a
+ # distribution. With previous versions of the API, we discovered
+ # that it was too easy to accidentally delete one or more values for
+ # an element that accepts multiple values, for example, CNAMEs and
+ # trusted signers. Our changes for the 2012-05-05 release are
+ # intended to prevent these accidental deletions and to notify you
+ # when there's a mismatch between the number of values you say
+ # you're specifying in the `Quantity` element and the number of
+ # values you're actually specifying.
+ #
+ #
+ #
+ # [1]: http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-creating-console.html
+ #
# @option params [required, Types::DistributionConfig] :distribution_config
# The distribution's configuration information.
#
# @option params [required, String] :id
# The distribution's id.
@@ -2842,10 +2904,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-cloudfront'
- context[:gem_version] = '1.0.0.rc6'
+ context[:gem_version] = '1.0.0.rc7'
Seahorse::Client::Request.new(handlers, context)
end
# Polls an API operation until a resource enters a desired state.
#