Class: Aws::CloudFront::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CloudFront::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb
Overview
An API client for CloudFront. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::CloudFront::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_alias(params = {}) ⇒ Struct
Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.
-
#copy_distribution(params = {}) ⇒ Types::CopyDistributionResult
Creates a staging distribution using the configuration of the provided primary distribution.
-
#create_cache_policy(params = {}) ⇒ Types::CreateCachePolicyResult
Creates a cache policy.
-
#create_cloud_front_origin_access_identity(params = {}) ⇒ Types::CreateCloudFrontOriginAccessIdentityResult
Creates a new origin access identity.
-
#create_continuous_deployment_policy(params = {}) ⇒ Types::CreateContinuousDeploymentPolicyResult
Creates a continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions.
-
#create_distribution(params = {}) ⇒ Types::CreateDistributionResult
Creates a CloudFront distribution.
-
#create_distribution_with_tags(params = {}) ⇒ Types::CreateDistributionWithTagsResult
Create a new distribution with tags.
-
#create_field_level_encryption_config(params = {}) ⇒ Types::CreateFieldLevelEncryptionConfigResult
Create a new field-level encryption configuration.
-
#create_field_level_encryption_profile(params = {}) ⇒ Types::CreateFieldLevelEncryptionProfileResult
Create a field-level encryption profile.
-
#create_function(params = {}) ⇒ Types::CreateFunctionResult
Creates a CloudFront function.
-
#create_invalidation(params = {}) ⇒ Types::CreateInvalidationResult
Create a new invalidation.
-
#create_key_group(params = {}) ⇒ Types::CreateKeyGroupResult
Creates a key group that you can use with [CloudFront signed URLs and signed cookies][1].
-
#create_key_value_store(params = {}) ⇒ Types::CreateKeyValueStoreResult
Specifies the key value store resource to add to your account.
-
#create_monitoring_subscription(params = {}) ⇒ Types::CreateMonitoringSubscriptionResult
Enables additional CloudWatch metrics for the specified CloudFront distribution.
-
#create_origin_access_control(params = {}) ⇒ Types::CreateOriginAccessControlResult
Creates a new origin access control in CloudFront.
-
#create_origin_request_policy(params = {}) ⇒ Types::CreateOriginRequestPolicyResult
Creates an origin request policy.
-
#create_public_key(params = {}) ⇒ Types::CreatePublicKeyResult
Uploads a public key to CloudFront that you can use with [signed URLs and signed cookies][1], or with [field-level encryption][2].
-
#create_realtime_log_config(params = {}) ⇒ Types::CreateRealtimeLogConfigResult
Creates a real-time log configuration.
-
#create_response_headers_policy(params = {}) ⇒ Types::CreateResponseHeadersPolicyResult
Creates a response headers policy.
-
#create_streaming_distribution(params = {}) ⇒ Types::CreateStreamingDistributionResult
This API is deprecated.
-
#create_streaming_distribution_with_tags(params = {}) ⇒ Types::CreateStreamingDistributionWithTagsResult
This API is deprecated.
-
#delete_cache_policy(params = {}) ⇒ Struct
Deletes a cache policy.
-
#delete_cloud_front_origin_access_identity(params = {}) ⇒ Struct
Delete an origin access identity.
-
#delete_continuous_deployment_policy(params = {}) ⇒ Struct
Deletes a continuous deployment policy.
-
#delete_distribution(params = {}) ⇒ Struct
Delete a distribution.
-
#delete_field_level_encryption_config(params = {}) ⇒ Struct
Remove a field-level encryption configuration.
-
#delete_field_level_encryption_profile(params = {}) ⇒ Struct
Remove a field-level encryption profile.
-
#delete_function(params = {}) ⇒ Struct
Deletes a CloudFront function.
-
#delete_key_group(params = {}) ⇒ Struct
Deletes a key group.
-
#delete_key_value_store(params = {}) ⇒ Struct
Specifies the key value store to delete.
-
#delete_monitoring_subscription(params = {}) ⇒ Struct
Disables additional CloudWatch metrics for the specified CloudFront distribution.
-
#delete_origin_access_control(params = {}) ⇒ Struct
Deletes a CloudFront origin access control.
-
#delete_origin_request_policy(params = {}) ⇒ Struct
Deletes an origin request policy.
-
#delete_public_key(params = {}) ⇒ Struct
Remove a public key you previously added to CloudFront.
-
#delete_realtime_log_config(params = {}) ⇒ Struct
Deletes a real-time log configuration.
-
#delete_response_headers_policy(params = {}) ⇒ Struct
Deletes a response headers policy.
-
#delete_streaming_distribution(params = {}) ⇒ Struct
Delete a streaming distribution.
-
#describe_function(params = {}) ⇒ Types::DescribeFunctionResult
Gets configuration information and metadata about a CloudFront function, but not the function's code.
-
#describe_key_value_store(params = {}) ⇒ Types::DescribeKeyValueStoreResult
Specifies the key value store and its configuration.
-
#get_cache_policy(params = {}) ⇒ Types::GetCachePolicyResult
Gets a cache policy, including the following metadata:.
-
#get_cache_policy_config(params = {}) ⇒ Types::GetCachePolicyConfigResult
Gets a cache policy configuration.
-
#get_cloud_front_origin_access_identity(params = {}) ⇒ Types::GetCloudFrontOriginAccessIdentityResult
Get the information about an origin access identity.
-
#get_cloud_front_origin_access_identity_config(params = {}) ⇒ Types::GetCloudFrontOriginAccessIdentityConfigResult
Get the configuration information about an origin access identity.
-
#get_continuous_deployment_policy(params = {}) ⇒ Types::GetContinuousDeploymentPolicyResult
Gets a continuous deployment policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
-
#get_continuous_deployment_policy_config(params = {}) ⇒ Types::GetContinuousDeploymentPolicyConfigResult
Gets configuration information about a continuous deployment policy.
-
#get_distribution(params = {}) ⇒ Types::GetDistributionResult
Get the information about a distribution.
-
#get_distribution_config(params = {}) ⇒ Types::GetDistributionConfigResult
Get the configuration information about a distribution.
-
#get_field_level_encryption(params = {}) ⇒ Types::GetFieldLevelEncryptionResult
Get the field-level encryption configuration information.
-
#get_field_level_encryption_config(params = {}) ⇒ Types::GetFieldLevelEncryptionConfigResult
Get the field-level encryption configuration information.
-
#get_field_level_encryption_profile(params = {}) ⇒ Types::GetFieldLevelEncryptionProfileResult
Get the field-level encryption profile information.
-
#get_field_level_encryption_profile_config(params = {}) ⇒ Types::GetFieldLevelEncryptionProfileConfigResult
Get the field-level encryption profile configuration information.
-
#get_function(params = {}) ⇒ Types::GetFunctionResult
Gets the code of a CloudFront function.
-
#get_invalidation(params = {}) ⇒ Types::GetInvalidationResult
Get the information about an invalidation.
-
#get_key_group(params = {}) ⇒ Types::GetKeyGroupResult
Gets a key group, including the date and time when the key group was last modified.
-
#get_key_group_config(params = {}) ⇒ Types::GetKeyGroupConfigResult
Gets a key group configuration.
-
#get_monitoring_subscription(params = {}) ⇒ Types::GetMonitoringSubscriptionResult
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
-
#get_origin_access_control(params = {}) ⇒ Types::GetOriginAccessControlResult
Gets a CloudFront origin access control, including its unique identifier.
-
#get_origin_access_control_config(params = {}) ⇒ Types::GetOriginAccessControlConfigResult
Gets a CloudFront origin access control configuration.
-
#get_origin_request_policy(params = {}) ⇒ Types::GetOriginRequestPolicyResult
Gets an origin request policy, including the following metadata:.
-
#get_origin_request_policy_config(params = {}) ⇒ Types::GetOriginRequestPolicyConfigResult
Gets an origin request policy configuration.
-
#get_public_key(params = {}) ⇒ Types::GetPublicKeyResult
Gets a public key.
-
#get_public_key_config(params = {}) ⇒ Types::GetPublicKeyConfigResult
Gets a public key configuration.
-
#get_realtime_log_config(params = {}) ⇒ Types::GetRealtimeLogConfigResult
Gets a real-time log configuration.
-
#get_response_headers_policy(params = {}) ⇒ Types::GetResponseHeadersPolicyResult
Gets a response headers policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
-
#get_response_headers_policy_config(params = {}) ⇒ Types::GetResponseHeadersPolicyConfigResult
Gets a response headers policy configuration.
-
#get_streaming_distribution(params = {}) ⇒ Types::GetStreamingDistributionResult
Gets information about a specified RTMP distribution, including the distribution configuration.
-
#get_streaming_distribution_config(params = {}) ⇒ Types::GetStreamingDistributionConfigResult
Get the configuration information about a streaming distribution.
-
#list_cache_policies(params = {}) ⇒ Types::ListCachePoliciesResult
Gets a list of cache policies.
-
#list_cloud_front_origin_access_identities(params = {}) ⇒ Types::ListCloudFrontOriginAccessIdentitiesResult
Lists origin access identities.
-
#list_conflicting_aliases(params = {}) ⇒ Types::ListConflictingAliasesResult
Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias.
-
#list_continuous_deployment_policies(params = {}) ⇒ Types::ListContinuousDeploymentPoliciesResult
Gets a list of the continuous deployment policies in your Amazon Web Services account.
-
#list_distributions(params = {}) ⇒ Types::ListDistributionsResult
List CloudFront distributions.
-
#list_distributions_by_cache_policy_id(params = {}) ⇒ Types::ListDistributionsByCachePolicyIdResult
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified cache policy.
-
#list_distributions_by_key_group(params = {}) ⇒ Types::ListDistributionsByKeyGroupResult
Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.
-
#list_distributions_by_origin_request_policy_id(params = {}) ⇒ Types::ListDistributionsByOriginRequestPolicyIdResult
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified origin request policy.
-
#list_distributions_by_realtime_log_config(params = {}) ⇒ Types::ListDistributionsByRealtimeLogConfigResult
Gets a list of distributions that have a cache behavior that's associated with the specified real-time log configuration.
-
#list_distributions_by_response_headers_policy_id(params = {}) ⇒ Types::ListDistributionsByResponseHeadersPolicyIdResult
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified response headers policy.
-
#list_distributions_by_web_acl_id(params = {}) ⇒ Types::ListDistributionsByWebACLIdResult
List the distributions that are associated with a specified WAF web ACL.
-
#list_field_level_encryption_configs(params = {}) ⇒ Types::ListFieldLevelEncryptionConfigsResult
List all field-level encryption configurations that have been created in CloudFront for this account.
-
#list_field_level_encryption_profiles(params = {}) ⇒ Types::ListFieldLevelEncryptionProfilesResult
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
-
#list_functions(params = {}) ⇒ Types::ListFunctionsResult
Gets a list of all CloudFront functions in your Amazon Web Services account.
-
#list_invalidations(params = {}) ⇒ Types::ListInvalidationsResult
Lists invalidation batches.
-
#list_key_groups(params = {}) ⇒ Types::ListKeyGroupsResult
Gets a list of key groups.
-
#list_key_value_stores(params = {}) ⇒ Types::ListKeyValueStoresResult
Specifies the key value stores to list.
-
#list_origin_access_controls(params = {}) ⇒ Types::ListOriginAccessControlsResult
Gets the list of CloudFront origin access controls in this Amazon Web Services account.
-
#list_origin_request_policies(params = {}) ⇒ Types::ListOriginRequestPoliciesResult
Gets a list of origin request policies.
-
#list_public_keys(params = {}) ⇒ Types::ListPublicKeysResult
List all public keys that have been added to CloudFront for this account.
-
#list_realtime_log_configs(params = {}) ⇒ Types::ListRealtimeLogConfigsResult
Gets a list of real-time log configurations.
-
#list_response_headers_policies(params = {}) ⇒ Types::ListResponseHeadersPoliciesResult
Gets a list of response headers policies.
-
#list_streaming_distributions(params = {}) ⇒ Types::ListStreamingDistributionsResult
List streaming distributions.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult
List tags for a CloudFront resource.
-
#publish_function(params = {}) ⇒ Types::PublishFunctionResult
Publishes a CloudFront function by copying the function code from the
DEVELOPMENT
stage toLIVE
. -
#tag_resource(params = {}) ⇒ Struct
Add tags to a CloudFront resource.
-
#test_function(params = {}) ⇒ Types::TestFunctionResult
Tests a CloudFront function.
-
#untag_resource(params = {}) ⇒ Struct
Remove tags from a CloudFront resource.
-
#update_cache_policy(params = {}) ⇒ Types::UpdateCachePolicyResult
Updates a cache policy configuration.
-
#update_cloud_front_origin_access_identity(params = {}) ⇒ Types::UpdateCloudFrontOriginAccessIdentityResult
Update an origin access identity.
-
#update_continuous_deployment_policy(params = {}) ⇒ Types::UpdateContinuousDeploymentPolicyResult
Updates a continuous deployment policy.
-
#update_distribution(params = {}) ⇒ Types::UpdateDistributionResult
Updates the configuration for a CloudFront distribution.
-
#update_distribution_with_staging_config(params = {}) ⇒ Types::UpdateDistributionWithStagingConfigResult
Copies the staging distribution's configuration to its corresponding primary distribution.
-
#update_field_level_encryption_config(params = {}) ⇒ Types::UpdateFieldLevelEncryptionConfigResult
Update a field-level encryption configuration.
-
#update_field_level_encryption_profile(params = {}) ⇒ Types::UpdateFieldLevelEncryptionProfileResult
Update a field-level encryption profile.
-
#update_function(params = {}) ⇒ Types::UpdateFunctionResult
Updates a CloudFront function.
-
#update_key_group(params = {}) ⇒ Types::UpdateKeyGroupResult
Updates a key group.
-
#update_key_value_store(params = {}) ⇒ Types::UpdateKeyValueStoreResult
Specifies the key value store to update.
-
#update_origin_access_control(params = {}) ⇒ Types::UpdateOriginAccessControlResult
Updates a CloudFront origin access control.
-
#update_origin_request_policy(params = {}) ⇒ Types::UpdateOriginRequestPolicyResult
Updates an origin request policy configuration.
-
#update_public_key(params = {}) ⇒ Types::UpdatePublicKeyResult
Update public key information.
-
#update_realtime_log_config(params = {}) ⇒ Types::UpdateRealtimeLogConfigResult
Updates a real-time log configuration.
-
#update_response_headers_policy(params = {}) ⇒ Types::UpdateResponseHeadersPolicyResult
Updates a response headers policy.
-
#update_streaming_distribution(params = {}) ⇒ Types::UpdateStreamingDistributionResult
Update a streaming distribution.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
446 447 448 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 446 def initialize(*args) super end |
Instance Method Details
#associate_alias(params = {}) ⇒ Struct
Associates an alias (also known as a CNAME or an alternate domain name) with a CloudFront distribution.
With this operation you can move an alias that's already in use on a CloudFront distribution to a different distribution in one step. This prevents the downtime that could occur if you first remove the alias from one distribution and then separately add the alias to another distribution.
To use this operation to associate an alias with a distribution, you provide the alias and the ID of the target distribution for the alias. For more information, including how to set up the target distribution, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
491 492 493 494 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 491 def associate_alias(params = {}, = {}) req = build_request(:associate_alias, params) req.send_request() end |
#copy_distribution(params = {}) ⇒ Types::CopyDistributionResult
Creates a staging distribution using the configuration of the provided primary distribution. A staging distribution is a copy of an existing distribution (called the primary distribution) that you can use in a continuous deployment workflow.
After you create a staging distribution, you can use
UpdateDistribution
to modify the staging distribution's
configuration. Then you can use CreateContinuousDeploymentPolicy
to
incrementally move traffic to the staging distribution.
This API operation requires the following IAM permissions:
756 757 758 759 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 756 def copy_distribution(params = {}, = {}) req = build_request(:copy_distribution, params) req.send_request() end |
#create_cache_policy(params = {}) ⇒ Types::CreateCachePolicyResult
Creates a cache policy.
After you create a cache policy, you can attach it to one or more cache behaviors. When it's attached to a cache behavior, the cache policy determines the following:
The values that CloudFront includes in the cache key. These values can include HTTP headers, cookies, and URL query strings. CloudFront uses the cache key to find an object in its cache that it can return to the viewer.
The default, minimum, and maximum time to live (TTL) values that you want objects to stay in the CloudFront cache.
The headers, cookies, and query strings that are included in the cache
key are also included in requests that CloudFront sends to the origin.
CloudFront sends a request when it can't find an object in its cache
that matches the request's cache key. If you want to send values to
the origin but not include them in the cache key, use
OriginRequestPolicy
.
For more information about cache policies, see Controlling the cache key in the Amazon CloudFront Developer Guide.
865 866 867 868 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 865 def create_cache_policy(params = {}, = {}) req = build_request(:create_cache_policy, params) req.send_request() end |
#create_cloud_front_origin_access_identity(params = {}) ⇒ Types::CreateCloudFrontOriginAccessIdentityResult
Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.
912 913 914 915 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 912 def create_cloud_front_origin_access_identity(params = {}, = {}) req = build_request(:create_cloud_front_origin_access_identity, params) req.send_request() end |
#create_continuous_deployment_policy(params = {}) ⇒ Types::CreateContinuousDeploymentPolicyResult
Creates a continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions.
To use a continuous deployment policy, first use CopyDistribution
to
create a staging distribution, then use UpdateDistribution
to modify
the staging distribution's configuration.
After you create and update a staging distribution, you can use a continuous deployment policy to incrementally move traffic to the staging distribution. This workflow enables you to test changes to a distribution's configuration before moving all of your domain's production traffic to the new configuration.
986 987 988 989 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 986 def create_continuous_deployment_policy(params = {}, = {}) req = build_request(:create_continuous_deployment_policy, params) req.send_request() end |
#create_distribution(params = {}) ⇒ Types::CreateDistributionResult
Creates a CloudFront distribution.
1455 1456 1457 1458 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 1455 def create_distribution(params = {}, = {}) req = build_request(:create_distribution, params) req.send_request() end |
#create_distribution_with_tags(params = {}) ⇒ Types::CreateDistributionWithTagsResult
Create a new distribution with tags. This API operation requires the following IAM permissions:
1944 1945 1946 1947 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 1944 def (params = {}, = {}) req = build_request(:create_distribution_with_tags, params) req.send_request() end |
#create_field_level_encryption_config(params = {}) ⇒ Types::CreateFieldLevelEncryptionConfigResult
Create a new field-level encryption configuration.
2018 2019 2020 2021 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 2018 def create_field_level_encryption_config(params = {}, = {}) req = build_request(:create_field_level_encryption_config, params) req.send_request() end |
#create_field_level_encryption_profile(params = {}) ⇒ Types::CreateFieldLevelEncryptionProfileResult
Create a field-level encryption profile.
2078 2079 2080 2081 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 2078 def create_field_level_encryption_profile(params = {}, = {}) req = build_request(:create_field_level_encryption_profile, params) req.send_request() end |
#create_function(params = {}) ⇒ Types::CreateFunctionResult
Creates a CloudFront function.
To create a function, you provide the function code and some configuration information about the function. The response contains an Amazon Resource Name (ARN) that uniquely identifies the function.
When you create a function, it's in the DEVELOPMENT
stage. In this
stage, you can test the function with TestFunction
, and update it
with UpdateFunction
.
When you're ready to use your function with a CloudFront
distribution, use PublishFunction
to copy the function from the
DEVELOPMENT
stage to LIVE
. When it's live, you can attach the
function to a distribution's cache behavior, using the function's
ARN.
2210 2211 2212 2213 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 2210 def create_function(params = {}, = {}) req = build_request(:create_function, params) req.send_request() end |
#create_invalidation(params = {}) ⇒ Types::CreateInvalidationResult
Create a new invalidation. For more information, see Invalidating files in the Amazon CloudFront Developer Guide.
2261 2262 2263 2264 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 2261 def create_invalidation(params = {}, = {}) req = build_request(:create_invalidation, params) req.send_request() end |
#create_key_group(params = {}) ⇒ Types::CreateKeyGroupResult
Creates a key group that you can use with CloudFront signed URLs and signed cookies.
To create a key group, you must specify at least one public key for the key group. After you create a key group, you can reference it from one or more cache behaviors. When you reference a key group in a cache behavior, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see Serving private content in the Amazon CloudFront Developer Guide.
2318 2319 2320 2321 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 2318 def create_key_group(params = {}, = {}) req = build_request(:create_key_group, params) req.send_request() end |
#create_key_value_store(params = {}) ⇒ Types::CreateKeyValueStoreResult
Specifies the key value store resource to add to your account. In your
account, the key value store names must be unique. You can also import
key value store data in JSON format from an S3 bucket by providing a
valid ImportSource
that you own.
2399 2400 2401 2402 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 2399 def create_key_value_store(params = {}, = {}) req = build_request(:create_key_value_store, params) req.send_request() end |
#create_monitoring_subscription(params = {}) ⇒ Types::CreateMonitoringSubscriptionResult
Enables additional CloudWatch metrics for the specified CloudFront distribution. The additional metrics incur an additional cost.
For more information, see Viewing additional CloudFront distribution metrics in the Amazon CloudFront Developer Guide.
2445 2446 2447 2448 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 2445 def create_monitoring_subscription(params = {}, = {}) req = build_request(:create_monitoring_subscription, params) req.send_request() end |
#create_origin_access_control(params = {}) ⇒ Types::CreateOriginAccessControlResult
Creates a new origin access control in CloudFront. After you create an origin access control, you can add it to an origin in a CloudFront distribution so that CloudFront sends authenticated (signed) requests to the origin.
This makes it possible to block public access to the origin, allowing viewers (users) to access the origin's content only through CloudFront.
For more information about using a CloudFront origin access control, see Restricting access to an Amazon Web Services origin in the Amazon CloudFront Developer Guide.
2503 2504 2505 2506 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 2503 def create_origin_access_control(params = {}, = {}) req = build_request(:create_origin_access_control, params) req.send_request() end |
#create_origin_request_policy(params = {}) ⇒ Types::CreateOriginRequestPolicyResult
Creates an origin request policy.
After you create an origin request policy, you can attach it to one or more cache behaviors. When it's attached to a cache behavior, the origin request policy determines the values that CloudFront includes in requests that it sends to the origin. Each request that CloudFront sends to the origin includes the following:
The request body and the URL path (without the domain name) from the viewer request.
The headers that CloudFront automatically includes in every origin request, including
Host
,User-Agent
, andX-Amz-Cf-Id
.All HTTP headers, cookies, and URL query strings that are specified in the cache policy or the origin request policy. These can include items from the viewer request and, in the case of headers, additional ones that are added by CloudFront.
CloudFront sends a request when it can't find a valid object in its
cache that matches the request. If you want to send values to the
origin and also include them in the cache key, use CachePolicy
.
For more information about origin request policies, see Controlling origin requests in the Amazon CloudFront Developer Guide.
2602 2603 2604 2605 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 2602 def create_origin_request_policy(params = {}, = {}) req = build_request(:create_origin_request_policy, params) req.send_request() end |
#create_public_key(params = {}) ⇒ Types::CreatePublicKeyResult
Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption.
2650 2651 2652 2653 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 2650 def create_public_key(params = {}, = {}) req = build_request(:create_public_key, params) req.send_request() end |
#create_realtime_log_config(params = {}) ⇒ Types::CreateRealtimeLogConfigResult
Creates a real-time log configuration.
After you create a real-time log configuration, you can attach it to one or more cache behaviors to send real-time log data to the specified Amazon Kinesis data stream.
For more information about real-time log configurations, see Real-time logs in the Amazon CloudFront Developer Guide.
2728 2729 2730 2731 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 2728 def create_realtime_log_config(params = {}, = {}) req = build_request(:create_realtime_log_config, params) req.send_request() end |
#create_response_headers_policy(params = {}) ⇒ Types::CreateResponseHeadersPolicyResult
Creates a response headers policy.
A response headers policy contains information about a set of HTTP headers. To create a response headers policy, you provide some metadata about the policy and a set of configurations that specify the headers.
After you create a response headers policy, you can use its ID to attach it to one or more cache behaviors in a CloudFront distribution. When it's attached to a cache behavior, the response headers policy affects the HTTP headers that CloudFront includes in HTTP responses to requests that match the cache behavior. CloudFront adds or removes response headers according to the configuration of the response headers policy.
For more information, see Adding or removing HTTP headers in CloudFront responses in the Amazon CloudFront Developer Guide.
2899 2900 2901 2902 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 2899 def create_response_headers_policy(params = {}, = {}) req = build_request(:create_response_headers_policy, params) req.send_request() end |
#create_streaming_distribution(params = {}) ⇒ Types::CreateStreamingDistributionResult
This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
2988 2989 2990 2991 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 2988 def create_streaming_distribution(params = {}, = {}) req = build_request(:create_streaming_distribution, params) req.send_request() end |
#create_streaming_distribution_with_tags(params = {}) ⇒ Types::CreateStreamingDistributionWithTagsResult
This API is deprecated. Amazon CloudFront is deprecating real-time messaging protocol (RTMP) distributions on December 31, 2020. For more information, read the announcement on the Amazon CloudFront discussion forum.
3087 3088 3089 3090 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3087 def (params = {}, = {}) req = build_request(:create_streaming_distribution_with_tags, params) req.send_request() end |
#delete_cache_policy(params = {}) ⇒ Struct
Deletes a cache policy.
You cannot delete a cache policy if it's attached to a cache behavior. First update your distributions to remove the cache policy from all cache behaviors, then delete the cache policy.
To delete a cache policy, you must provide the policy's identifier
and version. To get these values, you can use ListCachePolicies
or
GetCachePolicy
.
3124 3125 3126 3127 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3124 def delete_cache_policy(params = {}, = {}) req = build_request(:delete_cache_policy, params) req.send_request() end |
#delete_cloud_front_origin_access_identity(params = {}) ⇒ Struct
Delete an origin access identity.
3151 3152 3153 3154 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3151 def delete_cloud_front_origin_access_identity(params = {}, = {}) req = build_request(:delete_cloud_front_origin_access_identity, params) req.send_request() end |
#delete_continuous_deployment_policy(params = {}) ⇒ Struct
Deletes a continuous deployment policy.
You cannot delete a continuous deployment policy that's attached to a primary distribution. First update your distribution to remove the continuous deployment policy, then you can delete the policy.
3183 3184 3185 3186 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3183 def delete_continuous_deployment_policy(params = {}, = {}) req = build_request(:delete_continuous_deployment_policy, params) req.send_request() end |
#delete_distribution(params = {}) ⇒ Struct
Delete a distribution.
3210 3211 3212 3213 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3210 def delete_distribution(params = {}, = {}) req = build_request(:delete_distribution, params) req.send_request() end |
#delete_field_level_encryption_config(params = {}) ⇒ Struct
Remove a field-level encryption configuration.
3237 3238 3239 3240 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3237 def delete_field_level_encryption_config(params = {}, = {}) req = build_request(:delete_field_level_encryption_config, params) req.send_request() end |
#delete_field_level_encryption_profile(params = {}) ⇒ Struct
Remove a field-level encryption profile.
3264 3265 3266 3267 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3264 def delete_field_level_encryption_profile(params = {}, = {}) req = build_request(:delete_field_level_encryption_profile, params) req.send_request() end |
#delete_function(params = {}) ⇒ Struct
Deletes a CloudFront function.
You cannot delete a function if it's associated with a cache behavior. First, update your distributions to remove the function association from all cache behaviors, then delete the function.
To delete a function, you must provide the function's name and
version (ETag
value). To get these values, you can use
ListFunctions
and DescribeFunction
.
3299 3300 3301 3302 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3299 def delete_function(params = {}, = {}) req = build_request(:delete_function, params) req.send_request() end |
#delete_key_group(params = {}) ⇒ Struct
Deletes a key group.
You cannot delete a key group that is referenced in a cache behavior. First update your distributions to remove the key group from all cache behaviors, then delete the key group.
To delete a key group, you must provide the key group's identifier
and version. To get these values, use ListKeyGroups
followed by
GetKeyGroup
or GetKeyGroupConfig
.
3336 3337 3338 3339 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3336 def delete_key_group(params = {}, = {}) req = build_request(:delete_key_group, params) req.send_request() end |
#delete_key_value_store(params = {}) ⇒ Struct
Specifies the key value store to delete.
3372 3373 3374 3375 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3372 def delete_key_value_store(params = {}, = {}) req = build_request(:delete_key_value_store, params) req.send_request() end |
#delete_monitoring_subscription(params = {}) ⇒ Struct
Disables additional CloudWatch metrics for the specified CloudFront distribution.
3395 3396 3397 3398 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3395 def delete_monitoring_subscription(params = {}, = {}) req = build_request(:delete_monitoring_subscription, params) req.send_request() end |
#delete_origin_access_control(params = {}) ⇒ Struct
Deletes a CloudFront origin access control.
You cannot delete an origin access control if it's in use. First, update all distributions to remove the origin access control from all origins, then delete the origin access control.
3427 3428 3429 3430 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3427 def delete_origin_access_control(params = {}, = {}) req = build_request(:delete_origin_access_control, params) req.send_request() end |
#delete_origin_request_policy(params = {}) ⇒ Struct
Deletes an origin request policy.
You cannot delete an origin request policy if it's attached to any cache behaviors. First update your distributions to remove the origin request policy from all cache behaviors, then delete the origin request policy.
To delete an origin request policy, you must provide the policy's
identifier and version. To get the identifier, you can use
ListOriginRequestPolicies
or GetOriginRequestPolicy
.
3467 3468 3469 3470 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3467 def delete_origin_request_policy(params = {}, = {}) req = build_request(:delete_origin_request_policy, params) req.send_request() end |
#delete_public_key(params = {}) ⇒ Struct
Remove a public key you previously added to CloudFront.
3494 3495 3496 3497 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3494 def delete_public_key(params = {}, = {}) req = build_request(:delete_public_key, params) req.send_request() end |
#delete_realtime_log_config(params = {}) ⇒ Struct
Deletes a real-time log configuration.
You cannot delete a real-time log configuration if it's attached to a cache behavior. First update your distributions to remove the real-time log configuration from all cache behaviors, then delete the real-time log configuration.
To delete a real-time log configuration, you can provide the configuration's name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to delete.
3531 3532 3533 3534 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3531 def delete_realtime_log_config(params = {}, = {}) req = build_request(:delete_realtime_log_config, params) req.send_request() end |
#delete_response_headers_policy(params = {}) ⇒ Struct
Deletes a response headers policy.
You cannot delete a response headers policy if it's attached to a cache behavior. First update your distributions to remove the response headers policy from all cache behaviors, then delete the response headers policy.
To delete a response headers policy, you must provide the policy's
identifier and version. To get these values, you can use
ListResponseHeadersPolicies
or GetResponseHeadersPolicy
.
3572 3573 3574 3575 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3572 def delete_response_headers_policy(params = {}, = {}) req = build_request(:delete_response_headers_policy, params) req.send_request() end |
#delete_streaming_distribution(params = {}) ⇒ Struct
Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.
To delete an RTMP distribution using the CloudFront API:
Disable the RTMP distribution.
Submit a
GET Streaming Distribution Config
request to get the current configuration and theEtag
header for the distribution.Update the XML document that was returned in the response to your
GET Streaming Distribution Config
request to change the value ofEnabled
tofalse
.Submit a
PUT Streaming Distribution Config
request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTPIf-Match
header to the value of theETag
header that CloudFront returned when you submitted theGET Streaming Distribution Config
request in Step 2.Review the response to the
PUT Streaming Distribution Config
request to confirm that the distribution was successfully disabled.Submit a
GET Streaming Distribution Config
request to confirm that your changes have propagated. When propagation is complete, the value ofStatus
isDeployed
.Submit a
DELETE Streaming Distribution
request. Set the value of the HTTPIf-Match
header to the value of theETag
header that CloudFront returned when you submitted theGET Streaming Distribution Config
request in Step 2.Review the response to your
DELETE Streaming Distribution
request to confirm that the distribution was successfully deleted.
For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.
3642 3643 3644 3645 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3642 def delete_streaming_distribution(params = {}, = {}) req = build_request(:delete_streaming_distribution, params) req.send_request() end |
#describe_function(params = {}) ⇒ Types::DescribeFunctionResult
Gets configuration information and metadata about a CloudFront
function, but not the function's code. To get a function's code, use
GetFunction
.
To get configuration information and metadata about a function, you
must provide the function's name and stage. To get these values, you
can use ListFunctions
.
3692 3693 3694 3695 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3692 def describe_function(params = {}, = {}) req = build_request(:describe_function, params) req.send_request() end |
#describe_key_value_store(params = {}) ⇒ Types::DescribeKeyValueStoreResult
Specifies the key value store and its configuration.
3749 3750 3751 3752 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3749 def describe_key_value_store(params = {}, = {}) req = build_request(:describe_key_value_store, params) req.send_request() end |
#get_cache_policy(params = {}) ⇒ Types::GetCachePolicyResult
Gets a cache policy, including the following metadata:
The policy's identifier.
The date and time when the policy was last modified.
To get a cache policy, you must provide the policy's identifier. If
the cache policy is attached to a distribution's cache behavior, you
can get the policy's identifier using ListDistributions
or
GetDistribution
. If the cache policy is not attached to a cache
behavior, you can get the identifier using ListCachePolicies
.
3813 3814 3815 3816 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3813 def get_cache_policy(params = {}, = {}) req = build_request(:get_cache_policy, params) req.send_request() end |
#get_cache_policy_config(params = {}) ⇒ Types::GetCachePolicyConfigResult
Gets a cache policy configuration.
To get a cache policy configuration, you must provide the policy's
identifier. If the cache policy is attached to a distribution's cache
behavior, you can get the policy's identifier using
ListDistributions
or GetDistribution
. If the cache policy is not
attached to a cache behavior, you can get the identifier using
ListCachePolicies
.
3872 3873 3874 3875 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3872 def get_cache_policy_config(params = {}, = {}) req = build_request(:get_cache_policy_config, params) req.send_request() end |
#get_cloud_front_origin_access_identity(params = {}) ⇒ Types::GetCloudFrontOriginAccessIdentityResult
Get the information about an origin access identity.
3905 3906 3907 3908 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3905 def get_cloud_front_origin_access_identity(params = {}, = {}) req = build_request(:get_cloud_front_origin_access_identity, params) req.send_request() end |
#get_cloud_front_origin_access_identity_config(params = {}) ⇒ Types::GetCloudFrontOriginAccessIdentityConfigResult
Get the configuration information about an origin access identity.
3936 3937 3938 3939 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3936 def get_cloud_front_origin_access_identity_config(params = {}, = {}) req = build_request(:get_cloud_front_origin_access_identity_config, params) req.send_request() end |
#get_continuous_deployment_policy(params = {}) ⇒ Types::GetContinuousDeploymentPolicyResult
Gets a continuous deployment policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
3979 3980 3981 3982 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3979 def get_continuous_deployment_policy(params = {}, = {}) req = build_request(:get_continuous_deployment_policy, params) req.send_request() end |
#get_continuous_deployment_policy_config(params = {}) ⇒ Types::GetContinuousDeploymentPolicyConfigResult
Gets configuration information about a continuous deployment policy.
4019 4020 4021 4022 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4019 def get_continuous_deployment_policy_config(params = {}, = {}) req = build_request(:get_continuous_deployment_policy_config, params) req.send_request() end |
#get_distribution(params = {}) ⇒ Types::GetDistributionResult
Get the information about a distribution.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- distribution_deployed
4238 4239 4240 4241 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4238 def get_distribution(params = {}, = {}) req = build_request(:get_distribution, params) req.send_request() end |
#get_distribution_config(params = {}) ⇒ Types::GetDistributionConfigResult
Get the configuration information about a distribution.
4429 4430 4431 4432 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4429 def get_distribution_config(params = {}, = {}) req = build_request(:get_distribution_config, params) req.send_request() end |
#get_field_level_encryption(params = {}) ⇒ Types::GetFieldLevelEncryptionResult
Get the field-level encryption configuration information.
4474 4475 4476 4477 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4474 def get_field_level_encryption(params = {}, = {}) req = build_request(:get_field_level_encryption, params) req.send_request() end |
#get_field_level_encryption_config(params = {}) ⇒ Types::GetFieldLevelEncryptionConfigResult
Get the field-level encryption configuration information.
4517 4518 4519 4520 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4517 def get_field_level_encryption_config(params = {}, = {}) req = build_request(:get_field_level_encryption_config, params) req.send_request() end |
#get_field_level_encryption_profile(params = {}) ⇒ Types::GetFieldLevelEncryptionProfileResult
Get the field-level encryption profile information.
4558 4559 4560 4561 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4558 def get_field_level_encryption_profile(params = {}, = {}) req = build_request(:get_field_level_encryption_profile, params) req.send_request() end |
#get_field_level_encryption_profile_config(params = {}) ⇒ Types::GetFieldLevelEncryptionProfileConfigResult
Get the field-level encryption profile configuration information.
4598 4599 4600 4601 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4598 def get_field_level_encryption_profile_config(params = {}, = {}) req = build_request(:get_field_level_encryption_profile_config, params) req.send_request() end |
#get_function(params = {}) ⇒ Types::GetFunctionResult
Gets the code of a CloudFront function. To get configuration
information and metadata about a function, use DescribeFunction
.
To get a function's code, you must provide the function's name and
stage. To get these values, you can use ListFunctions
.
4638 4639 4640 4641 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4638 def get_function(params = {}, = {}) req = build_request(:get_function, params) req.send_request() end |
#get_invalidation(params = {}) ⇒ Types::GetInvalidationResult
Get the information about an invalidation.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- invalidation_completed
4682 4683 4684 4685 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4682 def get_invalidation(params = {}, = {}) req = build_request(:get_invalidation, params) req.send_request() end |
#get_key_group(params = {}) ⇒ Types::GetKeyGroupResult
Gets a key group, including the date and time when the key group was last modified.
To get a key group, you must provide the key group's identifier. If
the key group is referenced in a distribution's cache behavior, you
can get the key group's identifier using ListDistributions
or
GetDistribution
. If the key group is not referenced in a cache
behavior, you can get the identifier using ListKeyGroups
.
4725 4726 4727 4728 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4725 def get_key_group(params = {}, = {}) req = build_request(:get_key_group, params) req.send_request() end |
#get_key_group_config(params = {}) ⇒ Types::GetKeyGroupConfigResult
Gets a key group configuration.
To get a key group configuration, you must provide the key group's
identifier. If the key group is referenced in a distribution's cache
behavior, you can get the key group's identifier using
ListDistributions
or GetDistribution
. If the key group is not
referenced in a cache behavior, you can get the identifier using
ListKeyGroups
.
4766 4767 4768 4769 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4766 def get_key_group_config(params = {}, = {}) req = build_request(:get_key_group_config, params) req.send_request() end |
#get_monitoring_subscription(params = {}) ⇒ Types::GetMonitoringSubscriptionResult
Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.
4796 4797 4798 4799 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4796 def get_monitoring_subscription(params = {}, = {}) req = build_request(:get_monitoring_subscription, params) req.send_request() end |
#get_origin_access_control(params = {}) ⇒ Types::GetOriginAccessControlResult
Gets a CloudFront origin access control, including its unique identifier.
4832 4833 4834 4835 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4832 def get_origin_access_control(params = {}, = {}) req = build_request(:get_origin_access_control, params) req.send_request() end |
#get_origin_access_control_config(params = {}) ⇒ Types::GetOriginAccessControlConfigResult
Gets a CloudFront origin access control configuration.
4866 4867 4868 4869 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4866 def get_origin_access_control_config(params = {}, = {}) req = build_request(:get_origin_access_control_config, params) req.send_request() end |
#get_origin_request_policy(params = {}) ⇒ Types::GetOriginRequestPolicyResult
Gets an origin request policy, including the following metadata:
The policy's identifier.
The date and time when the policy was last modified.
To get an origin request policy, you must provide the policy's
identifier. If the origin request policy is attached to a
distribution's cache behavior, you can get the policy's identifier
using ListDistributions
or GetDistribution
. If the origin request
policy is not attached to a cache behavior, you can get the identifier
using ListOriginRequestPolicies
.
4927 4928 4929 4930 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4927 def get_origin_request_policy(params = {}, = {}) req = build_request(:get_origin_request_policy, params) req.send_request() end |
#get_origin_request_policy_config(params = {}) ⇒ Types::GetOriginRequestPolicyConfigResult
Gets an origin request policy configuration.
To get an origin request policy configuration, you must provide the
policy's identifier. If the origin request policy is attached to a
distribution's cache behavior, you can get the policy's identifier
using ListDistributions
or GetDistribution
. If the origin request
policy is not attached to a cache behavior, you can get the identifier
using ListOriginRequestPolicies
.
4982 4983 4984 4985 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4982 def get_origin_request_policy_config(params = {}, = {}) req = build_request(:get_origin_request_policy_config, params) req.send_request() end |
#get_public_key(params = {}) ⇒ Types::GetPublicKeyResult
Gets a public key.
5017 5018 5019 5020 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5017 def get_public_key(params = {}, = {}) req = build_request(:get_public_key, params) req.send_request() end |
#get_public_key_config(params = {}) ⇒ Types::GetPublicKeyConfigResult
Gets a public key configuration.
5050 5051 5052 5053 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5050 def get_public_key_config(params = {}, = {}) req = build_request(:get_public_key_config, params) req.send_request() end |
#get_realtime_log_config(params = {}) ⇒ Types::GetRealtimeLogConfigResult
Gets a real-time log configuration.
To get a real-time log configuration, you can provide the configuration's name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to get.
5096 5097 5098 5099 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5096 def get_realtime_log_config(params = {}, = {}) req = build_request(:get_realtime_log_config, params) req.send_request() end |
#get_response_headers_policy(params = {}) ⇒ Types::GetResponseHeadersPolicyResult
Gets a response headers policy, including metadata (the policy's identifier and the date and time when the policy was last modified).
To get a response headers policy, you must provide the policy's
identifier. If the response headers policy is attached to a
distribution's cache behavior, you can get the policy's identifier
using ListDistributions
or GetDistribution
. If the response
headers policy is not attached to a cache behavior, you can get the
identifier using ListResponseHeadersPolicies
.
5183 5184 5185 5186 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5183 def get_response_headers_policy(params = {}, = {}) req = build_request(:get_response_headers_policy, params) req.send_request() end |
#get_response_headers_policy_config(params = {}) ⇒ Types::GetResponseHeadersPolicyConfigResult
Gets a response headers policy configuration.
To get a response headers policy configuration, you must provide the
policy's identifier. If the response headers policy is attached to a
distribution's cache behavior, you can get the policy's identifier
using ListDistributions
or GetDistribution
. If the response
headers policy is not attached to a cache behavior, you can get the
identifier using ListResponseHeadersPolicies
.
5267 5268 5269 5270 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5267 def get_response_headers_policy_config(params = {}, = {}) req = build_request(:get_response_headers_policy_config, params) req.send_request() end |
#get_streaming_distribution(params = {}) ⇒ Types::GetStreamingDistributionResult
Gets information about a specified RTMP distribution, including the distribution configuration.
The following waiters are defined for this operation (see #wait_until for detailed usage):
- streaming_distribution_deployed
5330 5331 5332 5333 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5330 def get_streaming_distribution(params = {}, = {}) req = build_request(:get_streaming_distribution, params) req.send_request() end |
#get_streaming_distribution_config(params = {}) ⇒ Types::GetStreamingDistributionConfigResult
Get the configuration information about a streaming distribution.
5375 5376 5377 5378 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5375 def get_streaming_distribution_config(params = {}, = {}) req = build_request(:get_streaming_distribution_config, params) req.send_request() end |
#list_cache_policies(params = {}) ⇒ Types::ListCachePoliciesResult
Gets a list of cache policies.
You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in
the response. If the total number of items in the list exceeds the
maximum that you specify, or the default maximum, the response is
paginated. To get the next page of items, send a subsequent request
that specifies the NextMarker
value from the current response as the
Marker
value in the subsequent request.
5458 5459 5460 5461 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5458 def list_cache_policies(params = {}, = {}) req = build_request(:list_cache_policies, params) req.send_request() end |
#list_cloud_front_origin_access_identities(params = {}) ⇒ Types::ListCloudFrontOriginAccessIdentitiesResult
Lists origin access identities.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5506 5507 5508 5509 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5506 def list_cloud_front_origin_access_identities(params = {}, = {}) req = build_request(:list_cloud_front_origin_access_identities, params) req.send_request() end |
#list_conflicting_aliases(params = {}) ⇒ Types::ListConflictingAliasesResult
Gets a list of aliases (also called CNAMEs or alternate domain names) that conflict or overlap with the provided alias, and the associated CloudFront distributions and Amazon Web Services accounts for each conflicting alias. In the returned list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own.
Use this operation to find aliases that are in use in CloudFront that
conflict or overlap with the provided alias. For example, if you
provide www.example.com
as input, the returned list can include
www.example.com
and the overlapping wildcard alternate domain name
(*.example.com
), if they exist. If you provide *.example.com
as
input, the returned list can include *.example.com
and any alternate
domain names covered by that wildcard (for example, www.example.com
,
test.example.com
, dev.example.com
, and so on), if they exist.
To list conflicting aliases, you provide the alias to search and the ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias. For more information, including how to set up the distribution and certificate, see Moving an alternate domain name to a different distribution in the Amazon CloudFront Developer Guide.
You can optionally specify the maximum number of items to receive in
the response. If the total number of items in the list exceeds the
maximum that you specify, or the default maximum, the response is
paginated. To get the next page of items, send a subsequent request
that specifies the NextMarker
value from the current response as the
Marker
value in the subsequent request.
5591 5592 5593 5594 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5591 def list_conflicting_aliases(params = {}, = {}) req = build_request(:list_conflicting_aliases, params) req.send_request() end |
#list_continuous_deployment_policies(params = {}) ⇒ Types::ListContinuousDeploymentPoliciesResult
Gets a list of the continuous deployment policies in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in
the response. If the total number of items in the list exceeds the
maximum that you specify, or the default maximum, the response is
paginated. To get the next page of items, send a subsequent request
that specifies the NextMarker
value from the current response as the
Marker
value in the subsequent request.
5651 5652 5653 5654 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5651 def list_continuous_deployment_policies(params = {}, = {}) req = build_request(:list_continuous_deployment_policies, params) req.send_request() end |
#list_distributions(params = {}) ⇒ Types::ListDistributionsResult
List CloudFront distributions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5856 5857 5858 5859 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5856 def list_distributions(params = {}, = {}) req = build_request(:list_distributions, params) req.send_request() end |
#list_distributions_by_cache_policy_id(params = {}) ⇒ Types::ListDistributionsByCachePolicyIdResult
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified cache policy.
You can optionally specify the maximum number of items to receive in
the response. If the total number of items in the list exceeds the
maximum that you specify, or the default maximum, the response is
paginated. To get the next page of items, send a subsequent request
that specifies the NextMarker
value from the current response as the
Marker
value in the subsequent request.
5911 5912 5913 5914 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5911 def list_distributions_by_cache_policy_id(params = {}, = {}) req = build_request(:list_distributions_by_cache_policy_id, params) req.send_request() end |
#list_distributions_by_key_group(params = {}) ⇒ Types::ListDistributionsByKeyGroupResult
Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group.
You can optionally specify the maximum number of items to receive in
the response. If the total number of items in the list exceeds the
maximum that you specify, or the default maximum, the response is
paginated. To get the next page of items, send a subsequent request
that specifies the NextMarker
value from the current response as the
Marker
value in the subsequent request.
5966 5967 5968 5969 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5966 def list_distributions_by_key_group(params = {}, = {}) req = build_request(:list_distributions_by_key_group, params) req.send_request() end |
#list_distributions_by_origin_request_policy_id(params = {}) ⇒ Types::ListDistributionsByOriginRequestPolicyIdResult
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified origin request policy.
You can optionally specify the maximum number of items to receive in
the response. If the total number of items in the list exceeds the
maximum that you specify, or the default maximum, the response is
paginated. To get the next page of items, send a subsequent request
that specifies the NextMarker
value from the current response as the
Marker
value in the subsequent request.
6021 6022 6023 6024 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6021 def list_distributions_by_origin_request_policy_id(params = {}, = {}) req = build_request(:list_distributions_by_origin_request_policy_id, params) req.send_request() end |
#list_distributions_by_realtime_log_config(params = {}) ⇒ Types::ListDistributionsByRealtimeLogConfigResult
Gets a list of distributions that have a cache behavior that's associated with the specified real-time log configuration.
You can specify the real-time log configuration by its name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name to identify the real-time log configuration to list distributions for.
You can optionally specify the maximum number of items to receive in
the response. If the total number of items in the list exceeds the
maximum that you specify, or the default maximum, the response is
paginated. To get the next page of items, send a subsequent request
that specifies the NextMarker
value from the current response as the
Marker
value in the subsequent request.
6247 6248 6249 6250 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6247 def list_distributions_by_realtime_log_config(params = {}, = {}) req = build_request(:list_distributions_by_realtime_log_config, params) req.send_request() end |
#list_distributions_by_response_headers_policy_id(params = {}) ⇒ Types::ListDistributionsByResponseHeadersPolicyIdResult
Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified response headers policy.
You can optionally specify the maximum number of items to receive in
the response. If the total number of items in the list exceeds the
maximum that you specify, or the default maximum, the response is
paginated. To get the next page of items, send a subsequent request
that specifies the NextMarker
value from the current response as the
Marker
value in the subsequent request.
6304 6305 6306 6307 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6304 def list_distributions_by_response_headers_policy_id(params = {}, = {}) req = build_request(:list_distributions_by_response_headers_policy_id, params) req.send_request() end |
#list_distributions_by_web_acl_id(params = {}) ⇒ Types::ListDistributionsByWebACLIdResult
List the distributions that are associated with a specified WAF web ACL.
6522 6523 6524 6525 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6522 def list_distributions_by_web_acl_id(params = {}, = {}) req = build_request(:list_distributions_by_web_acl_id, params) req.send_request() end |
#list_field_level_encryption_configs(params = {}) ⇒ Types::ListFieldLevelEncryptionConfigsResult
List all field-level encryption configurations that have been created in CloudFront for this account.
6578 6579 6580 6581 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6578 def list_field_level_encryption_configs(params = {}, = {}) req = build_request(:list_field_level_encryption_configs, params) req.send_request() end |
#list_field_level_encryption_profiles(params = {}) ⇒ Types::ListFieldLevelEncryptionProfilesResult
Request a list of field-level encryption profiles that have been created in CloudFront for this account.
6630 6631 6632 6633 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6630 def list_field_level_encryption_profiles(params = {}, = {}) req = build_request(:list_field_level_encryption_profiles, params) req.send_request() end |
#list_functions(params = {}) ⇒ Types::ListFunctionsResult
Gets a list of all CloudFront functions in your Amazon Web Services account.
You can optionally apply a filter to return only the functions that
are in the specified stage, either DEVELOPMENT
or LIVE
.
You can optionally specify the maximum number of items to receive in
the response. If the total number of items in the list exceeds the
maximum that you specify, or the default maximum, the response is
paginated. To get the next page of items, send a subsequent request
that specifies the NextMarker
value from the current response as the
Marker
value in the subsequent request.
6696 6697 6698 6699 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6696 def list_functions(params = {}, = {}) req = build_request(:list_functions, params) req.send_request() end |
#list_invalidations(params = {}) ⇒ Types::ListInvalidationsResult
Lists invalidation batches.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6750 6751 6752 6753 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6750 def list_invalidations(params = {}, = {}) req = build_request(:list_invalidations, params) req.send_request() end |
#list_key_groups(params = {}) ⇒ Types::ListKeyGroupsResult
Gets a list of key groups.
You can optionally specify the maximum number of items to receive in
the response. If the total number of items in the list exceeds the
maximum that you specify, or the default maximum, the response is
paginated. To get the next page of items, send a subsequent request
that specifies the NextMarker
value from the current response as the
Marker
value in the subsequent request.
6802 6803 6804 6805 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6802 def list_key_groups(params = {}, = {}) req = build_request(:list_key_groups, params) req.send_request() end |
#list_key_value_stores(params = {}) ⇒ Types::ListKeyValueStoresResult
Specifies the key value stores to list.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
6879 6880 6881 6882 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6879 def list_key_value_stores(params = {}, = {}) req = build_request(:list_key_value_stores, params) req.send_request() end |
#list_origin_access_controls(params = {}) ⇒ Types::ListOriginAccessControlsResult
Gets the list of CloudFront origin access controls in this Amazon Web Services account.
You can optionally specify the maximum number of items to receive in
the response. If the total number of items in the list exceeds the
maximum that you specify, or the default maximum, the response is
paginated. To get the next page of items, send another request that
specifies the NextMarker
value from the current response as the
Marker
value in the next request.
6935 6936 6937 6938 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6935 def list_origin_access_controls(params = {}, = {}) req = build_request(:list_origin_access_controls, params) req.send_request() end |
#list_origin_request_policies(params = {}) ⇒ Types::ListOriginRequestPoliciesResult
Gets a list of origin request policies.
You can optionally apply a filter to return only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in
the response. If the total number of items in the list exceeds the
maximum that you specify, or the default maximum, the response is
paginated. To get the next page of items, send a subsequent request
that specifies the NextMarker
value from the current response as the
Marker
value in the subsequent request.
7014 7015 7016 7017 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7014 def list_origin_request_policies(params = {}, = {}) req = build_request(:list_origin_request_policies, params) req.send_request() end |
#list_public_keys(params = {}) ⇒ Types::ListPublicKeysResult
List all public keys that have been added to CloudFront for this account.
7059 7060 7061 7062 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7059 def list_public_keys(params = {}, = {}) req = build_request(:list_public_keys, params) req.send_request() end |
#list_realtime_log_configs(params = {}) ⇒ Types::ListRealtimeLogConfigsResult
Gets a list of real-time log configurations.
You can optionally specify the maximum number of items to receive in
the response. If the total number of items in the list exceeds the
maximum that you specify, or the default maximum, the response is
paginated. To get the next page of items, send a subsequent request
that specifies the NextMarker
value from the current response as the
Marker
value in the subsequent request.
7116 7117 7118 7119 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7116 def list_realtime_log_configs(params = {}, = {}) req = build_request(:list_realtime_log_configs, params) req.send_request() end |
#list_response_headers_policies(params = {}) ⇒ Types::ListResponseHeadersPoliciesResult
Gets a list of response headers policies.
You can optionally apply a filter to get only the managed policies created by Amazon Web Services, or only the custom policies created in your Amazon Web Services account.
You can optionally specify the maximum number of items to receive in
the response. If the total number of items in the list exceeds the
maximum that you specify, or the default maximum, the response is
paginated. To get the next page of items, send a subsequent request
that specifies the NextMarker
value from the current response as the
Marker
value in the subsequent request.
7223 7224 7225 7226 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7223 def list_response_headers_policies(params = {}, = {}) req = build_request(:list_response_headers_policies, params) req.send_request() end |
#list_streaming_distributions(params = {}) ⇒ Types::ListStreamingDistributionsResult
List streaming distributions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
7279 7280 7281 7282 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7279 def list_streaming_distributions(params = {}, = {}) req = build_request(:list_streaming_distributions, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult
List tags for a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
7315 7316 7317 7318 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7315 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#publish_function(params = {}) ⇒ Types::PublishFunctionResult
Publishes a CloudFront function by copying the function code from the
DEVELOPMENT
stage to LIVE
. This automatically updates all cache
behaviors that are using this function to use the newly published copy
in the LIVE
stage.
When a function is published to the LIVE
stage, you can attach the
function to a distribution's cache behavior, using the function's
Amazon Resource Name (ARN).
To publish a function, you must provide the function's name and
version (ETag
value). To get these values, you can use
ListFunctions
and DescribeFunction
.
7369 7370 7371 7372 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7369 def publish_function(params = {}, = {}) req = build_request(:publish_function, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Add tags to a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
7407 7408 7409 7410 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7407 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#test_function(params = {}) ⇒ Types::TestFunctionResult
Tests a CloudFront function.
To test a function, you provide an event object that represents an HTTP request or response that your CloudFront distribution could receive in production. CloudFront runs the function, passing it the event object that you provided, and returns the function's result (the modified event object) in the response. The response also contains function logs and error messages, if any exist. For more information about testing functions, see Testing functions in the Amazon CloudFront Developer Guide.
To test a function, you provide the function's name and version
(ETag
value) along with the event object. To get the function's
name and version, you can use ListFunctions
and DescribeFunction
.
7487 7488 7489 7490 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7487 def test_function(params = {}, = {}) req = build_request(:test_function, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Remove tags from a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
7521 7522 7523 7524 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7521 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_cache_policy(params = {}) ⇒ Types::UpdateCachePolicyResult
Updates a cache policy configuration.
When you update a cache policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a cache policy configuration:
Use
GetCachePolicyConfig
to get the current configuration.Locally modify the fields in the cache policy configuration that you want to update.
Call
UpdateCachePolicy
by providing the entire cache policy configuration, including the fields that you modified and those that you didn't.
7628 7629 7630 7631 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7628 def update_cache_policy(params = {}, = {}) req = build_request(:update_cache_policy, params) req.send_request() end |
#update_cloud_front_origin_access_identity(params = {}) ⇒ Types::UpdateCloudFrontOriginAccessIdentityResult
Update an origin access identity.
7673 7674 7675 7676 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7673 def update_cloud_front_origin_access_identity(params = {}, = {}) req = build_request(:update_cloud_front_origin_access_identity, params) req.send_request() end |
#update_continuous_deployment_policy(params = {}) ⇒ Types::UpdateContinuousDeploymentPolicyResult
Updates a continuous deployment policy. You can update a continuous deployment policy to enable or disable it, to change the percentage of traffic that it sends to the staging distribution, or to change the staging distribution that it sends traffic to.
When you update a continuous deployment policy configuration, all the fields are updated with the values that are provided in the request. You cannot update some fields independent of others. To update a continuous deployment policy configuration:
Use
GetContinuousDeploymentPolicyConfig
to get the current configuration.Locally modify the fields in the continuous deployment policy configuration that you want to update.
Use
UpdateContinuousDeploymentPolicy
, providing the entire continuous deployment policy configuration, including the fields that you modified and those that you didn't.
7762 7763 7764 7765 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7762 def update_continuous_deployment_policy(params = {}, = {}) req = build_request(:update_continuous_deployment_policy, params) req.send_request() end |
#update_distribution(params = {}) ⇒ Types::UpdateDistributionResult
Updates the configuration for a CloudFront distribution.
The update process includes getting the current distribution
configuration, updating it to make your changes, and then submitting
an UpdateDistribution
request to make the updates.
To update a web distribution using the CloudFront API
Use
GetDistributionConfig
to get the current configuration, including the version identifier (ETag
).Update the distribution configuration that was returned in the response. Note the following important requirements and restrictions:
You must rename the
ETag
field toIfMatch
, leaving the value unchanged. (Set the value ofIfMatch
to the value ofETag
, then remove theETag
field.)You can't change the value of
CallerReference
.
Submit an
UpdateDistribution
request, providing the distribution configuration. The new configuration replaces the existing configuration. The values that you specify in anUpdateDistribution
request are not merged into your existing configuration. Make sure to include all fields: the ones that you modified and also the ones that you didn't.
8264 8265 8266 8267 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 8264 def update_distribution(params = {}, = {}) req = build_request(:update_distribution, params) req.send_request() end |
#update_distribution_with_staging_config(params = {}) ⇒ Types::UpdateDistributionWithStagingConfigResult
Copies the staging distribution's configuration to its corresponding
primary distribution. The primary distribution retains its Aliases
(also known as alternate domain names or CNAMEs) and
ContinuousDeploymentPolicyId
value, but otherwise its configuration
is overwritten to match the staging distribution.
You can use this operation in a continuous deployment workflow after you have tested configuration changes on the staging distribution. After using a continuous deployment policy to move a portion of your domain name's traffic to the staging distribution and verifying that it works as intended, you can use this operation to copy the staging distribution's configuration to the primary distribution. This action will disable the continuous deployment policy and move your domain's traffic back to the primary distribution.
This API operation requires the following IAM permissions:
8514 8515 8516 8517 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 8514 def update_distribution_with_staging_config(params = {}, = {}) req = build_request(:update_distribution_with_staging_config, params) req.send_request() end |
#update_field_level_encryption_config(params = {}) ⇒ Types::UpdateFieldLevelEncryptionConfigResult
Update a field-level encryption configuration.
8595 8596 8597 8598 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 8595 def update_field_level_encryption_config(params = {}, = {}) req = build_request(:update_field_level_encryption_config, params) req.send_request() end |
#update_field_level_encryption_profile(params = {}) ⇒ Types::UpdateFieldLevelEncryptionProfileResult
Update a field-level encryption profile.
8662 8663 8664 8665 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 8662 def update_field_level_encryption_profile(params = {}, = {}) req = build_request(:update_field_level_encryption_profile, params) req.send_request() end |
#update_function(params = {}) ⇒ Types::UpdateFunctionResult
Updates a CloudFront function.
You can update a function's code or the comment that describes the function. You cannot update a function's name.
To update a function, you provide the function's name and version
(ETag
value) along with the updated function code. To get the name
and version, you can use ListFunctions
and DescribeFunction
.
8789 8790 8791 8792 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 8789 def update_function(params = {}, = {}) req = build_request(:update_function, params) req.send_request() end |
#update_key_group(params = {}) ⇒ Types::UpdateKeyGroupResult
Updates a key group.
When you update a key group, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update a key group:
Get the current key group with
GetKeyGroup
orGetKeyGroupConfig
.Locally modify the fields in the key group that you want to update. For example, add or remove public key IDs.
Call
UpdateKeyGroup
with the entire key group object, including the fields that you modified and those that you didn't.
8850 8851 8852 8853 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 8850 def update_key_group(params = {}, = {}) req = build_request(:update_key_group, params) req.send_request() end |
#update_key_value_store(params = {}) ⇒ Types::UpdateKeyValueStoreResult
Specifies the key value store to update.
8917 8918 8919 8920 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 8917 def update_key_value_store(params = {}, = {}) req = build_request(:update_key_value_store, params) req.send_request() end |
#update_origin_access_control(params = {}) ⇒ Types::UpdateOriginAccessControlResult
Updates a CloudFront origin access control.
8968 8969 8970 8971 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 8968 def update_origin_access_control(params = {}, = {}) req = build_request(:update_origin_access_control, params) req.send_request() end |
#update_origin_request_policy(params = {}) ⇒ Types::UpdateOriginRequestPolicyResult
Updates an origin request policy configuration.
When you update an origin request policy configuration, all the fields are updated with the values provided in the request. You cannot update some fields independent of others. To update an origin request policy configuration:
Use
GetOriginRequestPolicyConfig
to get the current configuration.Locally modify the fields in the origin request policy configuration that you want to update.
Call
UpdateOriginRequestPolicy
by providing the entire origin request policy configuration, including the fields that you modified and those that you didn't.
9065 9066 9067 9068 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 9065 def update_origin_request_policy(params = {}, = {}) req = build_request(:update_origin_request_policy, params) req.send_request() end |
#update_public_key(params = {}) ⇒ Types::UpdatePublicKeyResult
Update public key information. Note that the only value you can change is the comment.
9115 9116 9117 9118 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 9115 def update_public_key(params = {}, = {}) req = build_request(:update_public_key, params) req.send_request() end |
#update_realtime_log_config(params = {}) ⇒ Types::UpdateRealtimeLogConfigResult
Updates a real-time log configuration.
When you update a real-time log configuration, all the parameters are updated with the values provided in the request. You cannot update some parameters independent of others. To update a real-time log configuration:
Call
GetRealtimeLogConfig
to get the current real-time log configuration.Locally modify the parameters in the real-time log configuration that you want to update.
Call this API (
UpdateRealtimeLogConfig
) by providing the entire real-time log configuration, including the parameters that you modified and those that you didn't.
You cannot update a real-time log configuration's Name
or ARN
.
9203 9204 9205 9206 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 9203 def update_realtime_log_config(params = {}, = {}) req = build_request(:update_realtime_log_config, params) req.send_request() end |
#update_response_headers_policy(params = {}) ⇒ Types::UpdateResponseHeadersPolicyResult
Updates a response headers policy.
When you update a response headers policy, the entire policy is replaced. You cannot update some policy fields independent of others. To update a response headers policy configuration:
Use
GetResponseHeadersPolicyConfig
to get the current policy's configuration.Modify the fields in the response headers policy configuration that you want to update.
Call
UpdateResponseHeadersPolicy
, providing the entire response headers policy configuration, including the fields that you modified and those that you didn't.
9376 9377 9378 9379 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 9376 def update_response_headers_policy(params = {}, = {}) req = build_request(:update_response_headers_policy, params) req.send_request() end |
#update_streaming_distribution(params = {}) ⇒ Types::UpdateStreamingDistributionResult
Update a streaming distribution.
9466 9467 9468 9469 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 9466 def update_streaming_distribution(params = {}, = {}) req = build_request(:update_streaming_distribution, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
Basic Usage
A waiter will call an API operation until:
- It is successful
- It enters a terminal state
- It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Valid Waiters
The following table lists the valid waiter names, the operations they call,
and the default :delay
and :max_attempts
values.
waiter_name | params | :delay | :max_attempts |
---|---|---|---|
distribution_deployed | #get_distribution | 60 | 35 |
invalidation_completed | #get_invalidation | 20 | 30 |
streaming_distribution_deployed | #get_streaming_distribution | 60 | 25 |
9583 9584 9585 9586 9587 |
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 9583 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |