Class: Aws::CloudFront::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CloudFront::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- 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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
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].
-
#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], or with [field-level encryption].
-
#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 to `LIVE`.
-
#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.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#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.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
422 423 424 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 422 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
9590 9591 9592 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 9590 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
9593 9594 9595 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 9593 def errors_module Errors 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][1
-
in
the *Amazon CloudFront Developer Guide*.
[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-move
467 468 469 470 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 467 def associate_alias(params = {}, = {}) req = build_request(:associate_alias, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 9451 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-cloudfront' context[:gem_version] = '1.96.0' Seahorse::Client::Request.new(handlers, context) 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:
- GetDistribution][1
- CreateDistribution][2
- CopyDistribution][3
[1]: docs.aws.amazon.com/cloudfront/latest/APIReference/API_GetDistribution.html [2]: docs.aws.amazon.com/cloudfront/latest/APIReference/API_CreateDistribution.html [3]: docs.aws.amazon.com/cloudfront/latest/APIReference/API_CopyDistribution.html
732 733 734 735 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 732 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*.
[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html
841 842 843 844 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 841 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*.
[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html
888 889 890 891 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 888 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.
962 963 964 965 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 962 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.
1431 1432 1433 1434 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 1431 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:
- CreateDistribution][1
- TagResource][2
[1]: docs.aws.amazon.com/cloudfront/latest/APIReference/API_CreateDistribution.html [2]: docs.aws.amazon.com/cloudfront/latest/APIReference/API_TagResource.html
1920 1921 1922 1923 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 1920 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.
1994 1995 1996 1997 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 1994 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.
2054 2055 2056 2057 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 2054 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.
2186 2187 2188 2189 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 2186 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*.
[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html
2237 2238 2239 2240 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 2237 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*.
[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html
2294 2295 2296 2297 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 2294 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.
2375 2376 2377 2378 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 2375 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*.
2421 2422 2423 2424 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 2421 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*.
2479 2480 2481 2482 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 2479 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`, and `X-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*.
[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html
2578 2579 2580 2581 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 2578 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].
[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html [2]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html
2626 2627 2628 2629 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 2626 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][1
-
in the *Amazon CloudFront Developer Guide*.
[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html
2704 2705 2706 2707 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 2704 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*.
[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/modifying-response-headers.html
2875 2876 2877 2878 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 2875 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.
2964 2965 2966 2967 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 2964 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.
3063 3064 3065 3066 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3063 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`.
3100 3101 3102 3103 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3100 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.
3127 3128 3129 3130 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3127 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.
3159 3160 3161 3162 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3159 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.
3186 3187 3188 3189 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3186 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.
3213 3214 3215 3216 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3213 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.
3240 3241 3242 3243 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3240 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`.
3275 3276 3277 3278 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3275 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`.
3312 3313 3314 3315 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3312 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.
3348 3349 3350 3351 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3348 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.
3371 3372 3373 3374 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3371 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.
3403 3404 3405 3406 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3403 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`.
3443 3444 3445 3446 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3443 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.
3470 3471 3472 3473 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3470 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.
3507 3508 3509 3510 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3507 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`.
3548 3549 3550 3551 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3548 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 the `Etag` 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 of `Enabled` to `false`.
-
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 HTTP `If-Match` header to the value of the `ETag` header that CloudFront returned when you submitted the `GET 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 of `Status` is `Deployed`.
-
Submit a ‘DELETE Streaming Distribution` request. Set the value of the HTTP `If-Match` header to the value of the `ETag` header that CloudFront returned when you submitted the `GET 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*.
[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html
3618 3619 3620 3621 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3618 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`.
3668 3669 3670 3671 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3668 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.
3725 3726 3727 3728 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3725 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`.
3789 3790 3791 3792 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3789 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`.
3848 3849 3850 3851 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3848 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.
3881 3882 3883 3884 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3881 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.
3912 3913 3914 3915 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3912 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).
3955 3956 3957 3958 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3955 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.
3995 3996 3997 3998 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 3995 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
4214 4215 4216 4217 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 4214 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.
4405 4406 4407 4408 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 4405 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.
4450 4451 4452 4453 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 4450 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.
4493 4494 4495 4496 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 4493 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.
4534 4535 4536 4537 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 4534 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.
4574 4575 4576 4577 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 4574 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`.
4614 4615 4616 4617 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 4614 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
4658 4659 4660 4661 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 4658 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`.
4701 4702 4703 4704 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 4701 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`.
4742 4743 4744 4745 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 4742 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.
4772 4773 4774 4775 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 4772 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.
4808 4809 4810 4811 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 4808 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.
4842 4843 4844 4845 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 4842 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`.
4903 4904 4905 4906 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 4903 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`.
4958 4959 4960 4961 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 4958 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.
4993 4994 4995 4996 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 4993 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.
5026 5027 5028 5029 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 5026 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.
5072 5073 5074 5075 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 5072 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`.
5159 5160 5161 5162 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 5159 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`.
5243 5244 5245 5246 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 5243 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
5306 5307 5308 5309 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 5306 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.
5351 5352 5353 5354 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 5351 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.
5434 5435 5436 5437 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 5434 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.
5482 5483 5484 5485 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 5482 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.
[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-move
5567 5568 5569 5570 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 5567 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.
5627 5628 5629 5630 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 5627 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.
5832 5833 5834 5835 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 5832 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.
5887 5888 5889 5890 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 5887 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.
5942 5943 5944 5945 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 5942 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.
5997 5998 5999 6000 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 5997 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.
6223 6224 6225 6226 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 6223 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.
6280 6281 6282 6283 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 6280 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.
6498 6499 6500 6501 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 6498 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.
6554 6555 6556 6557 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 6554 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.
6606 6607 6608 6609 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 6606 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.
6672 6673 6674 6675 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 6672 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.
6726 6727 6728 6729 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 6726 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.
6778 6779 6780 6781 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 6778 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.
6855 6856 6857 6858 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 6855 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.
6911 6912 6913 6914 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 6911 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.
6990 6991 6992 6993 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 6990 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.
7035 7036 7037 7038 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 7035 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.
7092 7093 7094 7095 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 7092 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.
7199 7200 7201 7202 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 7199 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.
7255 7256 7257 7258 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 7255 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][1
-
in the *Amazon CloudFront Developer
Guide*.
[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/tagging.html
7291 7292 7293 7294 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 7291 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`.
7345 7346 7347 7348 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 7345 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*.
[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/tagging.html
7383 7384 7385 7386 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 7383 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`.
[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/managing-functions.html#test-function
7463 7464 7465 7466 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 7463 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][1
-
in the *Amazon CloudFront Developer
Guide*.
[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/tagging.html
7497 7498 7499 7500 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 7497 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.
7604 7605 7606 7607 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 7604 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.
7649 7650 7651 7652 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 7649 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.
7738 7739 7740 7741 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 7738 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 to `IfMatch`, leaving the value unchanged. (Set the value of `IfMatch` to the value of `ETag`, then remove the `ETag` 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 an `UpdateDistribution` 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.
8240 8241 8242 8243 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 8240 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:
- GetDistribution][1
- UpdateDistribution][2
[1]: docs.aws.amazon.com/cloudfront/latest/APIReference/API_GetDistribution.html [2]: docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html
8490 8491 8492 8493 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 8490 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.
8571 8572 8573 8574 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 8571 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.
8638 8639 8640 8641 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 8638 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`.
8765 8766 8767 8768 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 8765 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` or `GetKeyGroupConfig`.
-
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.
8826 8827 8828 8829 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 8826 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.
8893 8894 8895 8896 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 8893 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.
8944 8945 8946 8947 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 8944 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.
9041 9042 9043 9044 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 9041 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.
9091 9092 9093 9094 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 9091 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`.
9179 9180 9181 9182 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 9179 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.
9352 9353 9354 9355 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 9352 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.
9442 9443 9444 9445 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 9442 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 |
9554 9555 9556 9557 9558 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 9554 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
9562 9563 9564 |
# File 'lib/aws-sdk-cloudfront/client.rb', line 9562 def waiter_names waiters.keys end |