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.

Parameters:

options (Hash)

Options Hash (options):

:plugins (Array<Seahorse::Client::Plugin>) — default: []] —

A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.
:credentials (required, Aws::CredentialProvider) —
Your AWS credentials. This can be an instance of any one of the following classes:
- ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.
- ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.
- ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.
- ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.
- ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.
- ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.
- ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.
- ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.
- ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.
When ‘:credentials` are not configured directly, the following locations will be searched for credentials:
- ‘Aws.config`
- The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.
- ENV, ENV
- ‘~/.aws/credentials`
- ‘~/.aws/config`
- EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.
:region (required, String) —
The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:
- ‘Aws.config`
- ‘ENV`
- ‘ENV`
- ‘ENV`
- ‘~/.aws/credentials`
- ‘~/.aws/config`
:access_key_id (String)
:active_endpoint_cache (Boolean) — default: false —

When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.
:adaptive_retry_wait_to_fill (Boolean) — default: true —

Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.
:client_side_monitoring (Boolean) — default: false —

When ‘true`, client-side metrics will be collected for all API requests from this client.
:client_side_monitoring_client_id (String) — default: "" —

Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.
:client_side_monitoring_host (String) — default: "127.0.0.1" —

Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.
:client_side_monitoring_port (Integer) — default: 31000 —

Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.
:client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.
:convert_params (Boolean) — default: true —

When ‘true`, an attempt is made to coerce request parameters into the required types.
:correct_clock_skew (Boolean) — default: true —

Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.
:defaults_mode (String) — default: "legacy" —

See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.
:disable_host_prefix_injection (Boolean) — default: false —

Set to true to disable SDK automatically adding host prefix to default service endpoint when available.
:disable_request_compression (Boolean) — default: false —

When set to ‘true’ the request body will not be compressed for supported operations.
:endpoint (String, URI::HTTPS, URI::HTTP) —
Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:
```
'http://example.com'
'https://example.com'
'http://example.com:123'
```
:endpoint_cache_max_entries (Integer) — default: 1000 —

Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.
:endpoint_cache_max_threads (Integer) — default: 10 —

Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
:endpoint_cache_poll_interval (Integer) — default: 60 —

When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.
:endpoint_discovery (Boolean) — default: false —

When set to ‘true`, endpoint discovery will be enabled for operations when available.
:ignore_configured_endpoint_urls (Boolean) —

Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.
:log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

The log formatter.
:log_level (Symbol) — default: :info —

The log level to send messages to the ‘:logger` at.
:logger (Logger) —

The Logger instance to send log messages to. If this option is not set, logging will be disabled.
:max_attempts (Integer) — default: 3 —

An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.
:profile (String) — default: "default" —

Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.
:request_min_compression_size_bytes (Integer) — default: 10240 —

The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.
:retry_backoff (Proc) —

A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.
:retry_base_delay (Float) — default: 0.3 —

The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.
:retry_jitter (Symbol) — default: :none —

A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

@see www.awsarchitectureblog.com/2015/03/backoff.html
:retry_limit (Integer) — default: 3 —

The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.
:retry_max_delay (Integer) — default: 0 —

The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.
:retry_mode (String) — default: "legacy" —
Specifies which retry algorithm to use. Values are:
- ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.
- ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.
- ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.
:sdk_ua_app_id (String) —

A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
:secret_access_key (String)
:session_token (String)
:stub_responses (Boolean) — default: false —

Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.
:token_provider (Aws::TokenProvider) —
A Bearer Token Provider. This can be an instance of any one of the following classes:
- ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.
- ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.
When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.
:use_dualstack_endpoint (Boolean) —

When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.
:use_fips_endpoint (Boolean) —

When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.
:validate_params (Boolean) — default: true —

When ‘true`, request parameters are validated before sending the request.
:endpoint_provider (Aws::CloudFront::EndpointProvider) —

The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::CloudFront::EndpointParameters`
:http_continue_timeout (Float) — default: 1 —

The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.
:http_idle_timeout (Float) — default: 5 —

The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.
:http_open_timeout (Float) — default: 15 —

The default number of seconds to wait for response data. This value can safely be set per-request on the session.
:http_proxy (URI::HTTP, String) —

A proxy to send requests through. Formatted like ‘proxy.com:123’.
:http_read_timeout (Float) — default: 60 —

The default number of seconds to wait for response data. This value can safely be set per-request on the session.
:http_wire_trace (Boolean) — default: false —

When ‘true`, HTTP debug output will be sent to the `:logger`.
:on_chunk_received (Proc) —

When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).
:on_chunk_sent (Proc) —

When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.
:raise_response_errors (Boolean) — default: true —

When ‘true`, response errors are raised.
:ssl_ca_bundle (String) —

Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.
:ssl_ca_directory (String) —

Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.
:ssl_ca_store (String) —

Sets the X509::Store to verify peer certificate.
:ssl_timeout (Float) —

Sets the SSL timeout in seconds
:ssl_verify_peer (Boolean) — default: true —

When ‘true`, SSL peer certificates are verified when establishing a connection.



413
414
415

# File 'lib/aws-sdk-cloudfront/client.rb', line 413

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.



9581
9582
9583

# File 'lib/aws-sdk-cloudfront/client.rb', line 9581

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.



9584
9585
9586

# File 'lib/aws-sdk-cloudfront/client.rb', line 9584

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

Examples:

Request syntax with placeholder values


resp = client.associate_alias({
  target_distribution_id: "string", # required
  alias: "string", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:target_distribution_id (required, String) —

The ID of the distribution that you’re associating the alias with.
:alias (required, String) —

The alias (also known as a CNAME) to add to the target distribution.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 458

def associate_alias(params = {}, options = {})
  req = build_request(:associate_alias, params)
  req.send_request(options)
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.

Parameters:

params ({}) (defaults to: {})

# File 'lib/aws-sdk-cloudfront/client.rb', line 9442

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.95.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

Examples:

Request syntax with placeholder values


resp = client.copy_distribution({
  primary_distribution_id: "string", # required
  staging: false,
  if_match: "string",
  caller_reference: "string", # required
  enabled: false,
})

Response structure


resp.distribution.id #=> String
resp.distribution.arn #=> String
resp.distribution.status #=> String
resp.distribution.last_modified_time #=> Time
resp.distribution.in_progress_invalidation_batches #=> Integer
resp.distribution.domain_name #=> String
resp.distribution.active_trusted_signers.enabled #=> Boolean
resp.distribution.active_trusted_signers.quantity #=> Integer
resp.distribution.active_trusted_signers.items #=> Array
resp.distribution.active_trusted_signers.items[0].aws_account_number #=> String
resp.distribution.active_trusted_signers.items[0].key_pair_ids.quantity #=> Integer
resp.distribution.active_trusted_signers.items[0].key_pair_ids.items #=> Array
resp.distribution.active_trusted_signers.items[0].key_pair_ids.items[0] #=> String
resp.distribution.active_trusted_key_groups.enabled #=> Boolean
resp.distribution.active_trusted_key_groups.quantity #=> Integer
resp.distribution.active_trusted_key_groups.items #=> Array
resp.distribution.active_trusted_key_groups.items[0].key_group_id #=> String
resp.distribution.active_trusted_key_groups.items[0].key_pair_ids.quantity #=> Integer
resp.distribution.active_trusted_key_groups.items[0].key_pair_ids.items #=> Array
resp.distribution.active_trusted_key_groups.items[0].key_pair_ids.items[0] #=> String
resp.distribution.distribution_config.caller_reference #=> String
resp.distribution.distribution_config.aliases.quantity #=> Integer
resp.distribution.distribution_config.aliases.items #=> Array
resp.distribution.distribution_config.aliases.items[0] #=> String
resp.distribution.distribution_config.default_root_object #=> String
resp.distribution.distribution_config.origins.quantity #=> Integer
resp.distribution.distribution_config.origins.items #=> Array
resp.distribution.distribution_config.origins.items[0].id #=> String
resp.distribution.distribution_config.origins.items[0].domain_name #=> String
resp.distribution.distribution_config.origins.items[0].origin_path #=> String
resp.distribution.distribution_config.origins.items[0].custom_headers.quantity #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_headers.items #=> Array
resp.distribution.distribution_config.origins.items[0].custom_headers.items[0].header_name #=> String
resp.distribution.distribution_config.origins.items[0].custom_headers.items[0].header_value #=> String
resp.distribution.distribution_config.origins.items[0].s3_origin_config.origin_access_identity #=> String
resp.distribution.distribution_config.origins.items[0].custom_origin_config.http_port #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.https_port #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_protocol_policy #=> String, one of "http-only", "match-viewer", "https-only"
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.quantity #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.items #=> Array
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.items[0] #=> String, one of "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2"
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_read_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_keepalive_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].connection_attempts #=> Integer
resp.distribution.distribution_config.origins.items[0].connection_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].origin_shield.enabled #=> Boolean
resp.distribution.distribution_config.origins.items[0].origin_shield.origin_shield_region #=> String
resp.distribution.distribution_config.origins.items[0].origin_access_control_id #=> String
resp.distribution.distribution_config.origin_groups.quantity #=> Integer
resp.distribution.distribution_config.origin_groups.items #=> Array
resp.distribution.distribution_config.origin_groups.items[0].id #=> String
resp.distribution.distribution_config.origin_groups.items[0].failover_criteria.status_codes.quantity #=> Integer
resp.distribution.distribution_config.origin_groups.items[0].failover_criteria.status_codes.items #=> Array
resp.distribution.distribution_config.origin_groups.items[0].failover_criteria.status_codes.items[0] #=> Integer
resp.distribution.distribution_config.origin_groups.items[0].members.quantity #=> Integer
resp.distribution.distribution_config.origin_groups.items[0].members.items #=> Array
resp.distribution.distribution_config.origin_groups.items[0].members.items[0].origin_id #=> String
resp.distribution.distribution_config.default_cache_behavior.target_origin_id #=> String
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.enabled #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.enabled #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.viewer_protocol_policy #=> String, one of "allow-all", "https-only", "redirect-to-https"
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.cached_methods.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.cached_methods.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.cached_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.default_cache_behavior.smooth_streaming #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.compress #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items[0].lambda_function_arn #=> String
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items[0].include_body #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.function_associations.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.function_associations.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.function_associations.items[0].function_arn #=> String
resp.distribution.distribution_config.default_cache_behavior.function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.default_cache_behavior.field_level_encryption_id #=> String
resp.distribution.distribution_config.default_cache_behavior.realtime_log_config_arn #=> String
resp.distribution.distribution_config.default_cache_behavior.cache_policy_id #=> String
resp.distribution.distribution_config.default_cache_behavior.origin_request_policy_id #=> String
resp.distribution.distribution_config.default_cache_behavior.response_headers_policy_id #=> String
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.forward #=> String, one of "none", "whitelist", "all"
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.whitelisted_names.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.whitelisted_names.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.whitelisted_names.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.headers.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.headers.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.headers.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string_cache_keys.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string_cache_keys.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string_cache_keys.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.min_ttl #=> Integer
resp.distribution.distribution_config.default_cache_behavior.default_ttl #=> Integer
resp.distribution.distribution_config.default_cache_behavior.max_ttl #=> Integer
resp.distribution.distribution_config.cache_behaviors.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].path_pattern #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].target_origin_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.enabled #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.enabled #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].viewer_protocol_policy #=> String, one of "allow-all", "https-only", "redirect-to-https"
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.cached_methods.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.cached_methods.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.cached_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.cache_behaviors.items[0].smooth_streaming #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].compress #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items[0].lambda_function_arn #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items[0].include_body #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.items[0].function_arn #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.cache_behaviors.items[0].field_level_encryption_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].realtime_log_config_arn #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].cache_policy_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].origin_request_policy_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].response_headers_policy_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.forward #=> String, one of "none", "whitelist", "all"
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.headers.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.headers.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.headers.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string_cache_keys.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string_cache_keys.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string_cache_keys.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].min_ttl #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].default_ttl #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].max_ttl #=> Integer
resp.distribution.distribution_config.custom_error_responses.quantity #=> Integer
resp.distribution.distribution_config.custom_error_responses.items #=> Array
resp.distribution.distribution_config.custom_error_responses.items[0].error_code #=> Integer
resp.distribution.distribution_config.custom_error_responses.items[0].response_page_path #=> String
resp.distribution.distribution_config.custom_error_responses.items[0].response_code #=> String
resp.distribution.distribution_config.custom_error_responses.items[0].error_caching_min_ttl #=> Integer
resp.distribution.distribution_config.comment #=> String
resp.distribution.distribution_config.logging.enabled #=> Boolean
resp.distribution.distribution_config.logging.include_cookies #=> Boolean
resp.distribution.distribution_config.logging.bucket #=> String
resp.distribution.distribution_config.logging.prefix #=> String
resp.distribution.distribution_config.price_class #=> String, one of "PriceClass_100", "PriceClass_200", "PriceClass_All"
resp.distribution.distribution_config.enabled #=> Boolean
resp.distribution.distribution_config.viewer_certificate.cloud_front_default_certificate #=> Boolean
resp.distribution.distribution_config.viewer_certificate.iam_certificate_id #=> String
resp.distribution.distribution_config.viewer_certificate.acm_certificate_arn #=> String
resp.distribution.distribution_config.viewer_certificate.ssl_support_method #=> String, one of "sni-only", "vip", "static-ip"
resp.distribution.distribution_config.viewer_certificate.minimum_protocol_version #=> String, one of "SSLv3", "TLSv1", "TLSv1_2016", "TLSv1.1_2016", "TLSv1.2_2018", "TLSv1.2_2019", "TLSv1.2_2021"
resp.distribution.distribution_config.viewer_certificate.certificate #=> String
resp.distribution.distribution_config.viewer_certificate.certificate_source #=> String, one of "cloudfront", "iam", "acm"
resp.distribution.distribution_config.restrictions.geo_restriction.restriction_type #=> String, one of "blacklist", "whitelist", "none"
resp.distribution.distribution_config.restrictions.geo_restriction.quantity #=> Integer
resp.distribution.distribution_config.restrictions.geo_restriction.items #=> Array
resp.distribution.distribution_config.restrictions.geo_restriction.items[0] #=> String
resp.distribution.distribution_config.web_acl_id #=> String
resp.distribution.distribution_config.http_version #=> String, one of "http1.1", "http2", "http3", "http2and3"
resp.distribution.distribution_config.is_ipv6_enabled #=> Boolean
resp.distribution.distribution_config.continuous_deployment_policy_id #=> String
resp.distribution.distribution_config.staging #=> Boolean
resp.distribution.alias_icp_recordals #=> Array
resp.distribution.alias_icp_recordals[0].cname #=> String
resp.distribution.alias_icp_recordals[0].icp_recordal_status #=> String, one of "APPROVED", "SUSPENDED", "PENDING"
resp.location #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:primary_distribution_id (required, String) —

The identifier of the primary distribution whose configuration you are copying. To get a distribution ID, use ‘ListDistributions`.
:staging (Boolean) —

The type of distribution that your primary distribution will be copied to. The only valid value is ‘True`, indicating that you are copying to a staging distribution.
:if_match (String) —

The version identifier of the primary distribution whose configuration you are copying. This is the ‘ETag` value returned in the response to `GetDistribution` and `GetDistributionConfig`.
:caller_reference (required, String) —

A value that uniquely identifies a request to create a resource. This helps to prevent CloudFront from creating a duplicate resource if you accidentally resubmit an identical request.
:enabled (Boolean) —

A Boolean flag to specify the state of the staging distribution when it’s created. When you set this value to ‘True`, the staging distribution is enabled. When you set this value to `False`, the staging distribution is disabled.

If you omit this field, the default value is ‘True`.

Returns:

(Types::CopyDistributionResult) —
Returns a response object which responds to the following methods:
- #distribution => Types::Distribution
- #location => String
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 723

def copy_distribution(params = {}, options = {})
  req = build_request(:copy_distribution, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.create_cache_policy({
  cache_policy_config: { # required
    comment: "string",
    name: "string", # required
    default_ttl: 1,
    max_ttl: 1,
    min_ttl: 1, # required
    parameters_in_cache_key_and_forwarded_to_origin: {
      enable_accept_encoding_gzip: false, # required
      enable_accept_encoding_brotli: false,
      headers_config: { # required
        header_behavior: "none", # required, accepts none, whitelist
        headers: {
          quantity: 1, # required
          items: ["string"],
        },
      },
      cookies_config: { # required
        cookie_behavior: "none", # required, accepts none, whitelist, allExcept, all
        cookies: {
          quantity: 1, # required
          items: ["string"],
        },
      },
      query_strings_config: { # required
        query_string_behavior: "none", # required, accepts none, whitelist, allExcept, all
        query_strings: {
          quantity: 1, # required
          items: ["string"],
        },
      },
    },
  },
})

Response structure


resp.cache_policy.id #=> String
resp.cache_policy.last_modified_time #=> Time
resp.cache_policy.cache_policy_config.comment #=> String
resp.cache_policy.cache_policy_config.name #=> String
resp.cache_policy.cache_policy_config.default_ttl #=> Integer
resp.cache_policy.cache_policy_config.max_ttl #=> Integer
resp.cache_policy.cache_policy_config.min_ttl #=> Integer
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.enable_accept_encoding_gzip #=> Boolean
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.enable_accept_encoding_brotli #=> Boolean
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.headers_config.header_behavior #=> String, one of "none", "whitelist"
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.headers_config.headers.quantity #=> Integer
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.headers_config.headers.items #=> Array
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.headers_config.headers.items[0] #=> String
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookie_behavior #=> String, one of "none", "whitelist", "allExcept", "all"
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookies.quantity #=> Integer
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookies.items #=> Array
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookies.items[0] #=> String
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_string_behavior #=> String, one of "none", "whitelist", "allExcept", "all"
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_strings.quantity #=> Integer
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_strings.items #=> Array
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_strings.items[0] #=> String
resp.location #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:cache_policy_config (required, Types::CachePolicyConfig) —

A cache policy configuration.

Returns:

(Types::CreateCachePolicyResult) —
Returns a response object which responds to the following methods:
- #cache_policy => Types::CachePolicy
- #location => String
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 832

def create_cache_policy(params = {}, options = {})
  req = build_request(:create_cache_policy, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.create_cloud_front_origin_access_identity({
  cloud_front_origin_access_identity_config: { # required
    caller_reference: "string", # required
    comment: "string", # required
  },
})

Response structure


resp.cloud_front_origin_access_identity.id #=> String
resp.cloud_front_origin_access_identity.s3_canonical_user_id #=> String
resp.cloud_front_origin_access_identity.cloud_front_origin_access_identity_config.caller_reference #=> String
resp.cloud_front_origin_access_identity.cloud_front_origin_access_identity_config.comment #=> String
resp.location #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:cloud_front_origin_access_identity_config (required, Types::CloudFrontOriginAccessIdentityConfig) —

The current configuration information for the identity.

Returns:

(Types::CreateCloudFrontOriginAccessIdentityResult) —
Returns a response object which responds to the following methods:
- #cloud_front_origin_access_identity => Types::CloudFrontOriginAccessIdentity
- #location => String
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 879

def create_cloud_front_origin_access_identity(params = {}, options = {})
  req = build_request(:create_cloud_front_origin_access_identity, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.create_continuous_deployment_policy({
  continuous_deployment_policy_config: { # required
    staging_distribution_dns_names: { # required
      quantity: 1, # required
      items: ["string"],
    },
    enabled: false, # required
    traffic_config: {
      single_weight_config: {
        weight: 1.0, # required
        session_stickiness_config: {
          idle_ttl: 1, # required
          maximum_ttl: 1, # required
        },
      },
      single_header_config: {
        header: "string", # required
        value: "string", # required
      },
      type: "SingleWeight", # required, accepts SingleWeight, SingleHeader
    },
  },
})

Response structure


resp.continuous_deployment_policy.id #=> String
resp.continuous_deployment_policy.last_modified_time #=> Time
resp.continuous_deployment_policy.continuous_deployment_policy_config.staging_distribution_dns_names.quantity #=> Integer
resp.continuous_deployment_policy.continuous_deployment_policy_config.staging_distribution_dns_names.items #=> Array
resp.continuous_deployment_policy.continuous_deployment_policy_config.staging_distribution_dns_names.items[0] #=> String
resp.continuous_deployment_policy.continuous_deployment_policy_config.enabled #=> Boolean
resp.continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.single_weight_config.weight #=> Float
resp.continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.single_weight_config.session_stickiness_config.idle_ttl #=> Integer
resp.continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.single_weight_config.session_stickiness_config.maximum_ttl #=> Integer
resp.continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.single_header_config.header #=> String
resp.continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.single_header_config.value #=> String
resp.continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.type #=> String, one of "SingleWeight", "SingleHeader"
resp.location #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:continuous_deployment_policy_config (required, Types::ContinuousDeploymentPolicyConfig) —

Contains the configuration for a continuous deployment policy.

Returns:

(Types::CreateContinuousDeploymentPolicyResult) —
Returns a response object which responds to the following methods:
- #continuous_deployment_policy => Types::ContinuousDeploymentPolicy
- #location => String
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 953

def create_continuous_deployment_policy(params = {}, options = {})
  req = build_request(:create_continuous_deployment_policy, params)
  req.send_request(options)
end

#create_distribution(params = {}) ⇒ `Types::CreateDistributionResult`

Creates a CloudFront distribution.

Examples:

Request syntax with placeholder values


resp = client.create_distribution({
  distribution_config: { # required
    caller_reference: "string", # required
    aliases: {
      quantity: 1, # required
      items: ["string"],
    },
    default_root_object: "string",
    origins: { # required
      quantity: 1, # required
      items: [ # required
        {
          id: "string", # required
          domain_name: "string", # required
          origin_path: "string",
          custom_headers: {
            quantity: 1, # required
            items: [
              {
                header_name: "string", # required
                header_value: "sensitiveStringType", # required
              },
            ],
          },
          s3_origin_config: {
            origin_access_identity: "string", # required
          },
          custom_origin_config: {
            http_port: 1, # required
            https_port: 1, # required
            origin_protocol_policy: "http-only", # required, accepts http-only, match-viewer, https-only
            origin_ssl_protocols: {
              quantity: 1, # required
              items: ["SSLv3"], # required, accepts SSLv3, TLSv1, TLSv1.1, TLSv1.2
            },
            origin_read_timeout: 1,
            origin_keepalive_timeout: 1,
          },
          connection_attempts: 1,
          connection_timeout: 1,
          origin_shield: {
            enabled: false, # required
            origin_shield_region: "OriginShieldRegion",
          },
          origin_access_control_id: "string",
        },
      ],
    },
    origin_groups: {
      quantity: 1, # required
      items: [
        {
          id: "string", # required
          failover_criteria: { # required
            status_codes: { # required
              quantity: 1, # required
              items: [1], # required
            },
          },
          members: { # required
            quantity: 1, # required
            items: [ # required
              {
                origin_id: "string", # required
              },
            ],
          },
        },
      ],
    },
    default_cache_behavior: { # required
      target_origin_id: "string", # required
      trusted_signers: {
        enabled: false, # required
        quantity: 1, # required
        items: ["string"],
      },
      trusted_key_groups: {
        enabled: false, # required
        quantity: 1, # required
        items: ["string"],
      },
      viewer_protocol_policy: "allow-all", # required, accepts allow-all, https-only, redirect-to-https
      allowed_methods: {
        quantity: 1, # required
        items: ["GET"], # required, accepts GET, HEAD, POST, PUT, PATCH, OPTIONS, DELETE
        cached_methods: {
          quantity: 1, # required
          items: ["GET"], # required, accepts GET, HEAD, POST, PUT, PATCH, OPTIONS, DELETE
        },
      },
      smooth_streaming: false,
      compress: false,
      lambda_function_associations: {
        quantity: 1, # required
        items: [
          {
            lambda_function_arn: "LambdaFunctionARN", # required
            event_type: "viewer-request", # required, accepts viewer-request, viewer-response, origin-request, origin-response
            include_body: false,
          },
        ],
      },
      function_associations: {
        quantity: 1, # required
        items: [
          {
            function_arn: "FunctionARN", # required
            event_type: "viewer-request", # required, accepts viewer-request, viewer-response, origin-request, origin-response
          },
        ],
      },
      field_level_encryption_id: "string",
      realtime_log_config_arn: "string",
      cache_policy_id: "string",
      origin_request_policy_id: "string",
      response_headers_policy_id: "string",
      forwarded_values: {
        query_string: false, # required
        cookies: { # required
          forward: "none", # required, accepts none, whitelist, all
          whitelisted_names: {
            quantity: 1, # required
            items: ["string"],
          },
        },
        headers: {
          quantity: 1, # required
          items: ["string"],
        },
        query_string_cache_keys: {
          quantity: 1, # required
          items: ["string"],
        },
      },
      min_ttl: 1,
      default_ttl: 1,
      max_ttl: 1,
    },
    cache_behaviors: {
      quantity: 1, # required
      items: [
        {
          path_pattern: "string", # required
          target_origin_id: "string", # required
          trusted_signers: {
            enabled: false, # required
            quantity: 1, # required
            items: ["string"],
          },
          trusted_key_groups: {
            enabled: false, # required
            quantity: 1, # required
            items: ["string"],
          },
          viewer_protocol_policy: "allow-all", # required, accepts allow-all, https-only, redirect-to-https
          allowed_methods: {
            quantity: 1, # required
            items: ["GET"], # required, accepts GET, HEAD, POST, PUT, PATCH, OPTIONS, DELETE
            cached_methods: {
              quantity: 1, # required
              items: ["GET"], # required, accepts GET, HEAD, POST, PUT, PATCH, OPTIONS, DELETE
            },
          },
          smooth_streaming: false,
          compress: false,
          lambda_function_associations: {
            quantity: 1, # required
            items: [
              {
                lambda_function_arn: "LambdaFunctionARN", # required
                event_type: "viewer-request", # required, accepts viewer-request, viewer-response, origin-request, origin-response
                include_body: false,
              },
            ],
          },
          function_associations: {
            quantity: 1, # required
            items: [
              {
                function_arn: "FunctionARN", # required
                event_type: "viewer-request", # required, accepts viewer-request, viewer-response, origin-request, origin-response
              },
            ],
          },
          field_level_encryption_id: "string",
          realtime_log_config_arn: "string",
          cache_policy_id: "string",
          origin_request_policy_id: "string",
          response_headers_policy_id: "string",
          forwarded_values: {
            query_string: false, # required
            cookies: { # required
              forward: "none", # required, accepts none, whitelist, all
              whitelisted_names: {
                quantity: 1, # required
                items: ["string"],
              },
            },
            headers: {
              quantity: 1, # required
              items: ["string"],
            },
            query_string_cache_keys: {
              quantity: 1, # required
              items: ["string"],
            },
          },
          min_ttl: 1,
          default_ttl: 1,
          max_ttl: 1,
        },
      ],
    },
    custom_error_responses: {
      quantity: 1, # required
      items: [
        {
          error_code: 1, # required
          response_page_path: "string",
          response_code: "string",
          error_caching_min_ttl: 1,
        },
      ],
    },
    comment: "CommentType", # required
    logging: {
      enabled: false, # required
      include_cookies: false, # required
      bucket: "string", # required
      prefix: "string", # required
    },
    price_class: "PriceClass_100", # accepts PriceClass_100, PriceClass_200, PriceClass_All
    enabled: false, # required
    viewer_certificate: {
      cloud_front_default_certificate: false,
      iam_certificate_id: "string",
      acm_certificate_arn: "string",
      ssl_support_method: "sni-only", # accepts sni-only, vip, static-ip
      minimum_protocol_version: "SSLv3", # accepts SSLv3, TLSv1, TLSv1_2016, TLSv1.1_2016, TLSv1.2_2018, TLSv1.2_2019, TLSv1.2_2021
      certificate: "string",
      certificate_source: "cloudfront", # accepts cloudfront, iam, acm
    },
    restrictions: {
      geo_restriction: { # required
        restriction_type: "blacklist", # required, accepts blacklist, whitelist, none
        quantity: 1, # required
        items: ["string"],
      },
    },
    web_acl_id: "string",
    http_version: "http1.1", # accepts http1.1, http2, http3, http2and3
    is_ipv6_enabled: false,
    continuous_deployment_policy_id: "string",
    staging: false,
  },
})

Response structure


resp.distribution.id #=> String
resp.distribution.arn #=> String
resp.distribution.status #=> String
resp.distribution.last_modified_time #=> Time
resp.distribution.in_progress_invalidation_batches #=> Integer
resp.distribution.domain_name #=> String
resp.distribution.active_trusted_signers.enabled #=> Boolean
resp.distribution.active_trusted_signers.quantity #=> Integer
resp.distribution.active_trusted_signers.items #=> Array
resp.distribution.active_trusted_signers.items[0].aws_account_number #=> String
resp.distribution.active_trusted_signers.items[0].key_pair_ids.quantity #=> Integer
resp.distribution.active_trusted_signers.items[0].key_pair_ids.items #=> Array
resp.distribution.active_trusted_signers.items[0].key_pair_ids.items[0] #=> String
resp.distribution.active_trusted_key_groups.enabled #=> Boolean
resp.distribution.active_trusted_key_groups.quantity #=> Integer
resp.distribution.active_trusted_key_groups.items #=> Array
resp.distribution.active_trusted_key_groups.items[0].key_group_id #=> String
resp.distribution.active_trusted_key_groups.items[0].key_pair_ids.quantity #=> Integer
resp.distribution.active_trusted_key_groups.items[0].key_pair_ids.items #=> Array
resp.distribution.active_trusted_key_groups.items[0].key_pair_ids.items[0] #=> String
resp.distribution.distribution_config.caller_reference #=> String
resp.distribution.distribution_config.aliases.quantity #=> Integer
resp.distribution.distribution_config.aliases.items #=> Array
resp.distribution.distribution_config.aliases.items[0] #=> String
resp.distribution.distribution_config.default_root_object #=> String
resp.distribution.distribution_config.origins.quantity #=> Integer
resp.distribution.distribution_config.origins.items #=> Array
resp.distribution.distribution_config.origins.items[0].id #=> String
resp.distribution.distribution_config.origins.items[0].domain_name #=> String
resp.distribution.distribution_config.origins.items[0].origin_path #=> String
resp.distribution.distribution_config.origins.items[0].custom_headers.quantity #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_headers.items #=> Array
resp.distribution.distribution_config.origins.items[0].custom_headers.items[0].header_name #=> String
resp.distribution.distribution_config.origins.items[0].custom_headers.items[0].header_value #=> String
resp.distribution.distribution_config.origins.items[0].s3_origin_config.origin_access_identity #=> String
resp.distribution.distribution_config.origins.items[0].custom_origin_config.http_port #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.https_port #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_protocol_policy #=> String, one of "http-only", "match-viewer", "https-only"
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.quantity #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.items #=> Array
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.items[0] #=> String, one of "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2"
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_read_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_keepalive_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].connection_attempts #=> Integer
resp.distribution.distribution_config.origins.items[0].connection_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].origin_shield.enabled #=> Boolean
resp.distribution.distribution_config.origins.items[0].origin_shield.origin_shield_region #=> String
resp.distribution.distribution_config.origins.items[0].origin_access_control_id #=> String
resp.distribution.distribution_config.origin_groups.quantity #=> Integer
resp.distribution.distribution_config.origin_groups.items #=> Array
resp.distribution.distribution_config.origin_groups.items[0].id #=> String
resp.distribution.distribution_config.origin_groups.items[0].failover_criteria.status_codes.quantity #=> Integer
resp.distribution.distribution_config.origin_groups.items[0].failover_criteria.status_codes.items #=> Array
resp.distribution.distribution_config.origin_groups.items[0].failover_criteria.status_codes.items[0] #=> Integer
resp.distribution.distribution_config.origin_groups.items[0].members.quantity #=> Integer
resp.distribution.distribution_config.origin_groups.items[0].members.items #=> Array
resp.distribution.distribution_config.origin_groups.items[0].members.items[0].origin_id #=> String
resp.distribution.distribution_config.default_cache_behavior.target_origin_id #=> String
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.enabled #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.enabled #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.viewer_protocol_policy #=> String, one of "allow-all", "https-only", "redirect-to-https"
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.cached_methods.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.cached_methods.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.cached_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.default_cache_behavior.smooth_streaming #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.compress #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items[0].lambda_function_arn #=> String
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items[0].include_body #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.function_associations.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.function_associations.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.function_associations.items[0].function_arn #=> String
resp.distribution.distribution_config.default_cache_behavior.function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.default_cache_behavior.field_level_encryption_id #=> String
resp.distribution.distribution_config.default_cache_behavior.realtime_log_config_arn #=> String
resp.distribution.distribution_config.default_cache_behavior.cache_policy_id #=> String
resp.distribution.distribution_config.default_cache_behavior.origin_request_policy_id #=> String
resp.distribution.distribution_config.default_cache_behavior.response_headers_policy_id #=> String
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.forward #=> String, one of "none", "whitelist", "all"
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.whitelisted_names.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.whitelisted_names.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.whitelisted_names.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.headers.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.headers.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.headers.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string_cache_keys.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string_cache_keys.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string_cache_keys.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.min_ttl #=> Integer
resp.distribution.distribution_config.default_cache_behavior.default_ttl #=> Integer
resp.distribution.distribution_config.default_cache_behavior.max_ttl #=> Integer
resp.distribution.distribution_config.cache_behaviors.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].path_pattern #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].target_origin_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.enabled #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.enabled #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].viewer_protocol_policy #=> String, one of "allow-all", "https-only", "redirect-to-https"
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.cached_methods.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.cached_methods.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.cached_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.cache_behaviors.items[0].smooth_streaming #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].compress #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items[0].lambda_function_arn #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items[0].include_body #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.items[0].function_arn #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.cache_behaviors.items[0].field_level_encryption_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].realtime_log_config_arn #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].cache_policy_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].origin_request_policy_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].response_headers_policy_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.forward #=> String, one of "none", "whitelist", "all"
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.headers.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.headers.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.headers.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string_cache_keys.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string_cache_keys.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string_cache_keys.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].min_ttl #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].default_ttl #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].max_ttl #=> Integer
resp.distribution.distribution_config.custom_error_responses.quantity #=> Integer
resp.distribution.distribution_config.custom_error_responses.items #=> Array
resp.distribution.distribution_config.custom_error_responses.items[0].error_code #=> Integer
resp.distribution.distribution_config.custom_error_responses.items[0].response_page_path #=> String
resp.distribution.distribution_config.custom_error_responses.items[0].response_code #=> String
resp.distribution.distribution_config.custom_error_responses.items[0].error_caching_min_ttl #=> Integer
resp.distribution.distribution_config.comment #=> String
resp.distribution.distribution_config.logging.enabled #=> Boolean
resp.distribution.distribution_config.logging.include_cookies #=> Boolean
resp.distribution.distribution_config.logging.bucket #=> String
resp.distribution.distribution_config.logging.prefix #=> String
resp.distribution.distribution_config.price_class #=> String, one of "PriceClass_100", "PriceClass_200", "PriceClass_All"
resp.distribution.distribution_config.enabled #=> Boolean
resp.distribution.distribution_config.viewer_certificate.cloud_front_default_certificate #=> Boolean
resp.distribution.distribution_config.viewer_certificate.iam_certificate_id #=> String
resp.distribution.distribution_config.viewer_certificate.acm_certificate_arn #=> String
resp.distribution.distribution_config.viewer_certificate.ssl_support_method #=> String, one of "sni-only", "vip", "static-ip"
resp.distribution.distribution_config.viewer_certificate.minimum_protocol_version #=> String, one of "SSLv3", "TLSv1", "TLSv1_2016", "TLSv1.1_2016", "TLSv1.2_2018", "TLSv1.2_2019", "TLSv1.2_2021"
resp.distribution.distribution_config.viewer_certificate.certificate #=> String
resp.distribution.distribution_config.viewer_certificate.certificate_source #=> String, one of "cloudfront", "iam", "acm"
resp.distribution.distribution_config.restrictions.geo_restriction.restriction_type #=> String, one of "blacklist", "whitelist", "none"
resp.distribution.distribution_config.restrictions.geo_restriction.quantity #=> Integer
resp.distribution.distribution_config.restrictions.geo_restriction.items #=> Array
resp.distribution.distribution_config.restrictions.geo_restriction.items[0] #=> String
resp.distribution.distribution_config.web_acl_id #=> String
resp.distribution.distribution_config.http_version #=> String, one of "http1.1", "http2", "http3", "http2and3"
resp.distribution.distribution_config.is_ipv6_enabled #=> Boolean
resp.distribution.distribution_config.continuous_deployment_policy_id #=> String
resp.distribution.distribution_config.staging #=> Boolean
resp.distribution.alias_icp_recordals #=> Array
resp.distribution.alias_icp_recordals[0].cname #=> String
resp.distribution.alias_icp_recordals[0].icp_recordal_status #=> String, one of "APPROVED", "SUSPENDED", "PENDING"
resp.location #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:distribution_config (required, Types::DistributionConfig) —

The distribution’s configuration information.

Returns:

(Types::CreateDistributionResult) —
Returns a response object which responds to the following methods:
- #distribution => Types::Distribution
- #location => String
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 1422

def create_distribution(params = {}, options = {})
  req = build_request(:create_distribution, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.create_distribution_with_tags({
  distribution_config_with_tags: { # required
    distribution_config: { # required
      caller_reference: "string", # required
      aliases: {
        quantity: 1, # required
        items: ["string"],
      },
      default_root_object: "string",
      origins: { # required
        quantity: 1, # required
        items: [ # required
          {
            id: "string", # required
            domain_name: "string", # required
            origin_path: "string",
            custom_headers: {
              quantity: 1, # required
              items: [
                {
                  header_name: "string", # required
                  header_value: "sensitiveStringType", # required
                },
              ],
            },
            s3_origin_config: {
              origin_access_identity: "string", # required
            },
            custom_origin_config: {
              http_port: 1, # required
              https_port: 1, # required
              origin_protocol_policy: "http-only", # required, accepts http-only, match-viewer, https-only
              origin_ssl_protocols: {
                quantity: 1, # required
                items: ["SSLv3"], # required, accepts SSLv3, TLSv1, TLSv1.1, TLSv1.2
              },
              origin_read_timeout: 1,
              origin_keepalive_timeout: 1,
            },
            connection_attempts: 1,
            connection_timeout: 1,
            origin_shield: {
              enabled: false, # required
              origin_shield_region: "OriginShieldRegion",
            },
            origin_access_control_id: "string",
          },
        ],
      },
      origin_groups: {
        quantity: 1, # required
        items: [
          {
            id: "string", # required
            failover_criteria: { # required
              status_codes: { # required
                quantity: 1, # required
                items: [1], # required
              },
            },
            members: { # required
              quantity: 1, # required
              items: [ # required
                {
                  origin_id: "string", # required
                },
              ],
            },
          },
        ],
      },
      default_cache_behavior: { # required
        target_origin_id: "string", # required
        trusted_signers: {
          enabled: false, # required
          quantity: 1, # required
          items: ["string"],
        },
        trusted_key_groups: {
          enabled: false, # required
          quantity: 1, # required
          items: ["string"],
        },
        viewer_protocol_policy: "allow-all", # required, accepts allow-all, https-only, redirect-to-https
        allowed_methods: {
          quantity: 1, # required
          items: ["GET"], # required, accepts GET, HEAD, POST, PUT, PATCH, OPTIONS, DELETE
          cached_methods: {
            quantity: 1, # required
            items: ["GET"], # required, accepts GET, HEAD, POST, PUT, PATCH, OPTIONS, DELETE
          },
        },
        smooth_streaming: false,
        compress: false,
        lambda_function_associations: {
          quantity: 1, # required
          items: [
            {
              lambda_function_arn: "LambdaFunctionARN", # required
              event_type: "viewer-request", # required, accepts viewer-request, viewer-response, origin-request, origin-response
              include_body: false,
            },
          ],
        },
        function_associations: {
          quantity: 1, # required
          items: [
            {
              function_arn: "FunctionARN", # required
              event_type: "viewer-request", # required, accepts viewer-request, viewer-response, origin-request, origin-response
            },
          ],
        },
        field_level_encryption_id: "string",
        realtime_log_config_arn: "string",
        cache_policy_id: "string",
        origin_request_policy_id: "string",
        response_headers_policy_id: "string",
        forwarded_values: {
          query_string: false, # required
          cookies: { # required
            forward: "none", # required, accepts none, whitelist, all
            whitelisted_names: {
              quantity: 1, # required
              items: ["string"],
            },
          },
          headers: {
            quantity: 1, # required
            items: ["string"],
          },
          query_string_cache_keys: {
            quantity: 1, # required
            items: ["string"],
          },
        },
        min_ttl: 1,
        default_ttl: 1,
        max_ttl: 1,
      },
      cache_behaviors: {
        quantity: 1, # required
        items: [
          {
            path_pattern: "string", # required
            target_origin_id: "string", # required
            trusted_signers: {
              enabled: false, # required
              quantity: 1, # required
              items: ["string"],
            },
            trusted_key_groups: {
              enabled: false, # required
              quantity: 1, # required
              items: ["string"],
            },
            viewer_protocol_policy: "allow-all", # required, accepts allow-all, https-only, redirect-to-https
            allowed_methods: {
              quantity: 1, # required
              items: ["GET"], # required, accepts GET, HEAD, POST, PUT, PATCH, OPTIONS, DELETE
              cached_methods: {
                quantity: 1, # required
                items: ["GET"], # required, accepts GET, HEAD, POST, PUT, PATCH, OPTIONS, DELETE
              },
            },
            smooth_streaming: false,
            compress: false,
            lambda_function_associations: {
              quantity: 1, # required
              items: [
                {
                  lambda_function_arn: "LambdaFunctionARN", # required
                  event_type: "viewer-request", # required, accepts viewer-request, viewer-response, origin-request, origin-response
                  include_body: false,
                },
              ],
            },
            function_associations: {
              quantity: 1, # required
              items: [
                {
                  function_arn: "FunctionARN", # required
                  event_type: "viewer-request", # required, accepts viewer-request, viewer-response, origin-request, origin-response
                },
              ],
            },
            field_level_encryption_id: "string",
            realtime_log_config_arn: "string",
            cache_policy_id: "string",
            origin_request_policy_id: "string",
            response_headers_policy_id: "string",
            forwarded_values: {
              query_string: false, # required
              cookies: { # required
                forward: "none", # required, accepts none, whitelist, all
                whitelisted_names: {
                  quantity: 1, # required
                  items: ["string"],
                },
              },
              headers: {
                quantity: 1, # required
                items: ["string"],
              },
              query_string_cache_keys: {
                quantity: 1, # required
                items: ["string"],
              },
            },
            min_ttl: 1,
            default_ttl: 1,
            max_ttl: 1,
          },
        ],
      },
      custom_error_responses: {
        quantity: 1, # required
        items: [
          {
            error_code: 1, # required
            response_page_path: "string",
            response_code: "string",
            error_caching_min_ttl: 1,
          },
        ],
      },
      comment: "CommentType", # required
      logging: {
        enabled: false, # required
        include_cookies: false, # required
        bucket: "string", # required
        prefix: "string", # required
      },
      price_class: "PriceClass_100", # accepts PriceClass_100, PriceClass_200, PriceClass_All
      enabled: false, # required
      viewer_certificate: {
        cloud_front_default_certificate: false,
        iam_certificate_id: "string",
        acm_certificate_arn: "string",
        ssl_support_method: "sni-only", # accepts sni-only, vip, static-ip
        minimum_protocol_version: "SSLv3", # accepts SSLv3, TLSv1, TLSv1_2016, TLSv1.1_2016, TLSv1.2_2018, TLSv1.2_2019, TLSv1.2_2021
        certificate: "string",
        certificate_source: "cloudfront", # accepts cloudfront, iam, acm
      },
      restrictions: {
        geo_restriction: { # required
          restriction_type: "blacklist", # required, accepts blacklist, whitelist, none
          quantity: 1, # required
          items: ["string"],
        },
      },
      web_acl_id: "string",
      http_version: "http1.1", # accepts http1.1, http2, http3, http2and3
      is_ipv6_enabled: false,
      continuous_deployment_policy_id: "string",
      staging: false,
    },
    tags: { # required
      items: [
        {
          key: "TagKey", # required
          value: "TagValue",
        },
      ],
    },
  },
})

Response structure


resp.distribution.id #=> String
resp.distribution.arn #=> String
resp.distribution.status #=> String
resp.distribution.last_modified_time #=> Time
resp.distribution.in_progress_invalidation_batches #=> Integer
resp.distribution.domain_name #=> String
resp.distribution.active_trusted_signers.enabled #=> Boolean
resp.distribution.active_trusted_signers.quantity #=> Integer
resp.distribution.active_trusted_signers.items #=> Array
resp.distribution.active_trusted_signers.items[0].aws_account_number #=> String
resp.distribution.active_trusted_signers.items[0].key_pair_ids.quantity #=> Integer
resp.distribution.active_trusted_signers.items[0].key_pair_ids.items #=> Array
resp.distribution.active_trusted_signers.items[0].key_pair_ids.items[0] #=> String
resp.distribution.active_trusted_key_groups.enabled #=> Boolean
resp.distribution.active_trusted_key_groups.quantity #=> Integer
resp.distribution.active_trusted_key_groups.items #=> Array
resp.distribution.active_trusted_key_groups.items[0].key_group_id #=> String
resp.distribution.active_trusted_key_groups.items[0].key_pair_ids.quantity #=> Integer
resp.distribution.active_trusted_key_groups.items[0].key_pair_ids.items #=> Array
resp.distribution.active_trusted_key_groups.items[0].key_pair_ids.items[0] #=> String
resp.distribution.distribution_config.caller_reference #=> String
resp.distribution.distribution_config.aliases.quantity #=> Integer
resp.distribution.distribution_config.aliases.items #=> Array
resp.distribution.distribution_config.aliases.items[0] #=> String
resp.distribution.distribution_config.default_root_object #=> String
resp.distribution.distribution_config.origins.quantity #=> Integer
resp.distribution.distribution_config.origins.items #=> Array
resp.distribution.distribution_config.origins.items[0].id #=> String
resp.distribution.distribution_config.origins.items[0].domain_name #=> String
resp.distribution.distribution_config.origins.items[0].origin_path #=> String
resp.distribution.distribution_config.origins.items[0].custom_headers.quantity #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_headers.items #=> Array
resp.distribution.distribution_config.origins.items[0].custom_headers.items[0].header_name #=> String
resp.distribution.distribution_config.origins.items[0].custom_headers.items[0].header_value #=> String
resp.distribution.distribution_config.origins.items[0].s3_origin_config.origin_access_identity #=> String
resp.distribution.distribution_config.origins.items[0].custom_origin_config.http_port #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.https_port #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_protocol_policy #=> String, one of "http-only", "match-viewer", "https-only"
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.quantity #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.items #=> Array
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.items[0] #=> String, one of "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2"
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_read_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_keepalive_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].connection_attempts #=> Integer
resp.distribution.distribution_config.origins.items[0].connection_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].origin_shield.enabled #=> Boolean
resp.distribution.distribution_config.origins.items[0].origin_shield.origin_shield_region #=> String
resp.distribution.distribution_config.origins.items[0].origin_access_control_id #=> String
resp.distribution.distribution_config.origin_groups.quantity #=> Integer
resp.distribution.distribution_config.origin_groups.items #=> Array
resp.distribution.distribution_config.origin_groups.items[0].id #=> String
resp.distribution.distribution_config.origin_groups.items[0].failover_criteria.status_codes.quantity #=> Integer
resp.distribution.distribution_config.origin_groups.items[0].failover_criteria.status_codes.items #=> Array
resp.distribution.distribution_config.origin_groups.items[0].failover_criteria.status_codes.items[0] #=> Integer
resp.distribution.distribution_config.origin_groups.items[0].members.quantity #=> Integer
resp.distribution.distribution_config.origin_groups.items[0].members.items #=> Array
resp.distribution.distribution_config.origin_groups.items[0].members.items[0].origin_id #=> String
resp.distribution.distribution_config.default_cache_behavior.target_origin_id #=> String
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.enabled #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.enabled #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.viewer_protocol_policy #=> String, one of "allow-all", "https-only", "redirect-to-https"
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.cached_methods.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.cached_methods.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.cached_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.default_cache_behavior.smooth_streaming #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.compress #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items[0].lambda_function_arn #=> String
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items[0].include_body #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.function_associations.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.function_associations.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.function_associations.items[0].function_arn #=> String
resp.distribution.distribution_config.default_cache_behavior.function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.default_cache_behavior.field_level_encryption_id #=> String
resp.distribution.distribution_config.default_cache_behavior.realtime_log_config_arn #=> String
resp.distribution.distribution_config.default_cache_behavior.cache_policy_id #=> String
resp.distribution.distribution_config.default_cache_behavior.origin_request_policy_id #=> String
resp.distribution.distribution_config.default_cache_behavior.response_headers_policy_id #=> String
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.forward #=> String, one of "none", "whitelist", "all"
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.whitelisted_names.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.whitelisted_names.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.whitelisted_names.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.headers.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.headers.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.headers.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string_cache_keys.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string_cache_keys.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string_cache_keys.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.min_ttl #=> Integer
resp.distribution.distribution_config.default_cache_behavior.default_ttl #=> Integer
resp.distribution.distribution_config.default_cache_behavior.max_ttl #=> Integer
resp.distribution.distribution_config.cache_behaviors.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].path_pattern #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].target_origin_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.enabled #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.enabled #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].viewer_protocol_policy #=> String, one of "allow-all", "https-only", "redirect-to-https"
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.cached_methods.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.cached_methods.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.cached_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.cache_behaviors.items[0].smooth_streaming #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].compress #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items[0].lambda_function_arn #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items[0].include_body #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.items[0].function_arn #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.cache_behaviors.items[0].field_level_encryption_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].realtime_log_config_arn #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].cache_policy_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].origin_request_policy_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].response_headers_policy_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.forward #=> String, one of "none", "whitelist", "all"
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.headers.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.headers.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.headers.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string_cache_keys.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string_cache_keys.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string_cache_keys.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].min_ttl #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].default_ttl #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].max_ttl #=> Integer
resp.distribution.distribution_config.custom_error_responses.quantity #=> Integer
resp.distribution.distribution_config.custom_error_responses.items #=> Array
resp.distribution.distribution_config.custom_error_responses.items[0].error_code #=> Integer
resp.distribution.distribution_config.custom_error_responses.items[0].response_page_path #=> String
resp.distribution.distribution_config.custom_error_responses.items[0].response_code #=> String
resp.distribution.distribution_config.custom_error_responses.items[0].error_caching_min_ttl #=> Integer
resp.distribution.distribution_config.comment #=> String
resp.distribution.distribution_config.logging.enabled #=> Boolean
resp.distribution.distribution_config.logging.include_cookies #=> Boolean
resp.distribution.distribution_config.logging.bucket #=> String
resp.distribution.distribution_config.logging.prefix #=> String
resp.distribution.distribution_config.price_class #=> String, one of "PriceClass_100", "PriceClass_200", "PriceClass_All"
resp.distribution.distribution_config.enabled #=> Boolean
resp.distribution.distribution_config.viewer_certificate.cloud_front_default_certificate #=> Boolean
resp.distribution.distribution_config.viewer_certificate.iam_certificate_id #=> String
resp.distribution.distribution_config.viewer_certificate.acm_certificate_arn #=> String
resp.distribution.distribution_config.viewer_certificate.ssl_support_method #=> String, one of "sni-only", "vip", "static-ip"
resp.distribution.distribution_config.viewer_certificate.minimum_protocol_version #=> String, one of "SSLv3", "TLSv1", "TLSv1_2016", "TLSv1.1_2016", "TLSv1.2_2018", "TLSv1.2_2019", "TLSv1.2_2021"
resp.distribution.distribution_config.viewer_certificate.certificate #=> String
resp.distribution.distribution_config.viewer_certificate.certificate_source #=> String, one of "cloudfront", "iam", "acm"
resp.distribution.distribution_config.restrictions.geo_restriction.restriction_type #=> String, one of "blacklist", "whitelist", "none"
resp.distribution.distribution_config.restrictions.geo_restriction.quantity #=> Integer
resp.distribution.distribution_config.restrictions.geo_restriction.items #=> Array
resp.distribution.distribution_config.restrictions.geo_restriction.items[0] #=> String
resp.distribution.distribution_config.web_acl_id #=> String
resp.distribution.distribution_config.http_version #=> String, one of "http1.1", "http2", "http3", "http2and3"
resp.distribution.distribution_config.is_ipv6_enabled #=> Boolean
resp.distribution.distribution_config.continuous_deployment_policy_id #=> String
resp.distribution.distribution_config.staging #=> Boolean
resp.distribution.alias_icp_recordals #=> Array
resp.distribution.alias_icp_recordals[0].cname #=> String
resp.distribution.alias_icp_recordals[0].icp_recordal_status #=> String, one of "APPROVED", "SUSPENDED", "PENDING"
resp.location #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:distribution_config_with_tags (required, Types::DistributionConfigWithTags) —

The distribution’s configuration information.

Returns:

(Types::CreateDistributionWithTagsResult) —
Returns a response object which responds to the following methods:
- #distribution => Types::Distribution
- #location => String
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 1911

def create_distribution_with_tags(params = {}, options = {})
  req = build_request(:create_distribution_with_tags, params)
  req.send_request(options)
end

#create_field_level_encryption_config(params = {}) ⇒ `Types::CreateFieldLevelEncryptionConfigResult`

Create a new field-level encryption configuration.

Examples:

Request syntax with placeholder values


resp = client.create_field_level_encryption_config({
  field_level_encryption_config: { # required
    caller_reference: "string", # required
    comment: "string",
    query_arg_profile_config: {
      forward_when_query_arg_profile_is_unknown: false, # required
      query_arg_profiles: {
        quantity: 1, # required
        items: [
          {
            query_arg: "string", # required
            profile_id: "string", # required
          },
        ],
      },
    },
    content_type_profile_config: {
      forward_when_content_type_is_unknown: false, # required
      content_type_profiles: {
        quantity: 1, # required
        items: [
          {
            format: "URLEncoded", # required, accepts URLEncoded
            profile_id: "string",
            content_type: "string", # required
          },
        ],
      },
    },
  },
})

Response structure


resp.field_level_encryption.id #=> String
resp.field_level_encryption.last_modified_time #=> Time
resp.field_level_encryption.field_level_encryption_config.caller_reference #=> String
resp.field_level_encryption.field_level_encryption_config.comment #=> String
resp.field_level_encryption.field_level_encryption_config.query_arg_profile_config.forward_when_query_arg_profile_is_unknown #=> Boolean
resp.field_level_encryption.field_level_encryption_config.query_arg_profile_config.query_arg_profiles.quantity #=> Integer
resp.field_level_encryption.field_level_encryption_config.query_arg_profile_config.query_arg_profiles.items #=> Array
resp.field_level_encryption.field_level_encryption_config.query_arg_profile_config.query_arg_profiles.items[0].query_arg #=> String
resp.field_level_encryption.field_level_encryption_config.query_arg_profile_config.query_arg_profiles.items[0].profile_id #=> String
resp.field_level_encryption.field_level_encryption_config.content_type_profile_config.forward_when_content_type_is_unknown #=> Boolean
resp.field_level_encryption.field_level_encryption_config.content_type_profile_config.content_type_profiles.quantity #=> Integer
resp.field_level_encryption.field_level_encryption_config.content_type_profile_config.content_type_profiles.items #=> Array
resp.field_level_encryption.field_level_encryption_config.content_type_profile_config.content_type_profiles.items[0].format #=> String, one of "URLEncoded"
resp.field_level_encryption.field_level_encryption_config.content_type_profile_config.content_type_profiles.items[0].profile_id #=> String
resp.field_level_encryption.field_level_encryption_config.content_type_profile_config.content_type_profiles.items[0].content_type #=> String
resp.location #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:field_level_encryption_config (required, Types::FieldLevelEncryptionConfig) —

The request to create a new field-level encryption configuration.

Returns:

(Types::CreateFieldLevelEncryptionConfigResult) —
Returns a response object which responds to the following methods:
- #field_level_encryption => Types::FieldLevelEncryption
- #location => String
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 1985

def create_field_level_encryption_config(params = {}, options = {})
  req = build_request(:create_field_level_encryption_config, params)
  req.send_request(options)
end

#create_field_level_encryption_profile(params = {}) ⇒ `Types::CreateFieldLevelEncryptionProfileResult`

Create a field-level encryption profile.

Examples:

Request syntax with placeholder values


resp = client.create_field_level_encryption_profile({
  field_level_encryption_profile_config: { # required
    name: "string", # required
    caller_reference: "string", # required
    comment: "string",
    encryption_entities: { # required
      quantity: 1, # required
      items: [
        {
          public_key_id: "string", # required
          provider_id: "string", # required
          field_patterns: { # required
            quantity: 1, # required
            items: ["string"],
          },
        },
      ],
    },
  },
})

Response structure


resp.field_level_encryption_profile.id #=> String
resp.field_level_encryption_profile.last_modified_time #=> Time
resp.field_level_encryption_profile.field_level_encryption_profile_config.name #=> String
resp.field_level_encryption_profile.field_level_encryption_profile_config.caller_reference #=> String
resp.field_level_encryption_profile.field_level_encryption_profile_config.comment #=> String
resp.field_level_encryption_profile.field_level_encryption_profile_config.encryption_entities.quantity #=> Integer
resp.field_level_encryption_profile.field_level_encryption_profile_config.encryption_entities.items #=> Array
resp.field_level_encryption_profile.field_level_encryption_profile_config.encryption_entities.items[0].public_key_id #=> String
resp.field_level_encryption_profile.field_level_encryption_profile_config.encryption_entities.items[0].provider_id #=> String
resp.field_level_encryption_profile.field_level_encryption_profile_config.encryption_entities.items[0].field_patterns.quantity #=> Integer
resp.field_level_encryption_profile.field_level_encryption_profile_config.encryption_entities.items[0].field_patterns.items #=> Array
resp.field_level_encryption_profile.field_level_encryption_profile_config.encryption_entities.items[0].field_patterns.items[0] #=> String
resp.location #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:field_level_encryption_profile_config (required, Types::FieldLevelEncryptionProfileConfig) —

The request to create a field-level encryption profile.

Returns:

(Types::CreateFieldLevelEncryptionProfileResult) —
Returns a response object which responds to the following methods:
- #field_level_encryption_profile => Types::FieldLevelEncryptionProfile
- #location => String
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 2045

def create_field_level_encryption_profile(params = {}, options = {})
  req = build_request(:create_field_level_encryption_profile, params)
  req.send_request(options)
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.

Examples:

Example: To create a function


# Use the following command to create a function.

resp = client.create_function({
  function_code: "function-code.js", 
  function_config: {
    comment: "my-function-comment", 
    key_value_store_associations: {
      items: [
        {
          key_value_store_arn: "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889", 
        }, 
      ], 
      quantity: 1, 
    }, 
    runtime: "cloudfront-js-2.0", 
  }, 
  name: "my-function-name", 
})

resp.to_h outputs the following:
{
  etag: "ETVPDKIKX0DER", 
  function_summary: {
    function_config: {
      comment: "my-function-comment", 
      key_value_store_associations: {
        items: [
          {
            key_value_store_arn: "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889", 
          }, 
        ], 
        quantity: 1, 
      }, 
      runtime: "cloudfront-js-2.0", 
    }, 
    function_metadata: {
      created_time: Time.parse("2023-11-07T19:53:50.334Z"), 
      function_arn: "arn:aws:cloudfront::123456789012:function/my-function-name", 
      last_modified_time: Time.parse("2023-11-07T19:53:50.334Z"), 
      stage: "DEVELOPMENT", 
    }, 
    name: "my-function-name", 
    status: "UNPUBLISHED", 
  }, 
  location: "https://cloudfront.amazonaws.com/2020-05-31/function/arn:aws:cloudfront::123456789012:function/my-function-name", 
}

Request syntax with placeholder values


resp = client.create_function({
  name: "FunctionName", # required
  function_config: { # required
    comment: "string", # required
    runtime: "cloudfront-js-1.0", # required, accepts cloudfront-js-1.0, cloudfront-js-2.0
    key_value_store_associations: {
      quantity: 1, # required
      items: [
        {
          key_value_store_arn: "KeyValueStoreARN", # required
        },
      ],
    },
  },
  function_code: "data", # required
})

Response structure


resp.function_summary.name #=> String
resp.function_summary.status #=> String
resp.function_summary.function_config.comment #=> String
resp.function_summary.function_config.runtime #=> String, one of "cloudfront-js-1.0", "cloudfront-js-2.0"
resp.function_summary.function_config.key_value_store_associations.quantity #=> Integer
resp.function_summary.function_config.key_value_store_associations.items #=> Array
resp.function_summary.function_config.key_value_store_associations.items[0].key_value_store_arn #=> String
resp.function_summary.function_metadata.function_arn #=> String
resp.function_summary.function_metadata.stage #=> String, one of "DEVELOPMENT", "LIVE"
resp.function_summary.function_metadata.created_time #=> Time
resp.function_summary.function_metadata.last_modified_time #=> Time
resp.location #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:name (required, String) —

A name to identify the function.
:function_config (required, Types::FunctionConfig) —

Configuration information about the function, including an optional comment and the function’s runtime.
:function_code (required, String, StringIO, File) —

The function code. For more information about writing a CloudFront function, see [Writing function code for CloudFront Functions] in the *Amazon CloudFront Developer Guide*.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html

Returns:

(Types::CreateFunctionResult) —
Returns a response object which responds to the following methods:
- #function_summary => Types::FunctionSummary
- #location => String
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 2177

def create_function(params = {}, options = {})
  req = build_request(:create_function, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.create_invalidation({
  distribution_id: "string", # required
  invalidation_batch: { # required
    paths: { # required
      quantity: 1, # required
      items: ["string"],
    },
    caller_reference: "string", # required
  },
})

Response structure


resp.location #=> String
resp.invalidation.id #=> String
resp.invalidation.status #=> String
resp.invalidation.create_time #=> Time
resp.invalidation.invalidation_batch.paths.quantity #=> Integer
resp.invalidation.invalidation_batch.paths.items #=> Array
resp.invalidation.invalidation_batch.paths.items[0] #=> String
resp.invalidation.invalidation_batch.caller_reference #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:distribution_id (required, String) —

The distribution’s id.
:invalidation_batch (required, Types::InvalidationBatch) —

The batch information for the invalidation.

Returns:

(Types::CreateInvalidationResult) —
Returns a response object which responds to the following methods:
- #location => String
- #invalidation => Types::Invalidation

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 2228

def create_invalidation(params = {}, options = {})
  req = build_request(:create_invalidation, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.create_key_group({
  key_group_config: { # required
    name: "string", # required
    items: ["string"], # required
    comment: "string",
  },
})

Response structure


resp.key_group.id #=> String
resp.key_group.last_modified_time #=> Time
resp.key_group.key_group_config.name #=> String
resp.key_group.key_group_config.items #=> Array
resp.key_group.key_group_config.items[0] #=> String
resp.key_group.key_group_config.comment #=> String
resp.location #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:key_group_config (required, Types::KeyGroupConfig) —

A key group configuration.

Returns:

(Types::CreateKeyGroupResult) —
Returns a response object which responds to the following methods:
- #key_group => Types::KeyGroup
- #location => String
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 2285

def create_key_group(params = {}, options = {})
  req = build_request(:create_key_group, params)
  req.send_request(options)
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.

Examples:

Example: To create a KeyValueStore


# Use the following command to create a KeyValueStore.

resp = client.create_key_value_store({
  comment: "my-key-valuestore-comment", 
  import_source: {
    source_arn: "arn:aws:s3:::my-bucket/validJSON.json", 
    source_type: "S3", 
  }, 
  name: "my-keyvaluestore-name", 
})

resp.to_h outputs the following:
{
  etag: "ETVPDKIKX0DER", 
  key_value_store: {
    arn: "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889", 
    comment: "my-key-valuestore-comment", 
    id: "54947df8-0e9e-4471-a2f9-9af509fb5889", 
    last_modified_time: Time.parse("2023-11-07T18:15:52.042Z"), 
    name: "my-keyvaluestore-name", 
    status: "PROVISIONING", 
  }, 
  location: "https://cloudfront.amazonaws.com/2020-05-31/key-value-store/arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889", 
}

Request syntax with placeholder values


resp = client.create_key_value_store({
  name: "KeyValueStoreName", # required
  comment: "KeyValueStoreComment",
  import_source: {
    source_type: "S3", # required, accepts S3
    source_arn: "string", # required
  },
})

Response structure


resp.key_value_store.name #=> String
resp.key_value_store.id #=> String
resp.key_value_store.comment #=> String
resp.key_value_store.arn #=> String
resp.key_value_store.status #=> String
resp.key_value_store.last_modified_time #=> Time
resp.etag #=> String
resp.location #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:name (required, String) —

The name of the key value store. The minimum length is 1 character and the maximum length is 64 characters.
:comment (String) —

The comment of the key value store.
:import_source (Types::ImportSource) —

The S3 bucket that provides the source for the import. The source must be in a valid JSON format.

Returns:

(Types::CreateKeyValueStoreResult) —
Returns a response object which responds to the following methods:
- #key_value_store => Types::KeyValueStore
- #etag => String
- #location => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 2366

def create_key_value_store(params = {}, options = {})
  req = build_request(:create_key_value_store, params)
  req.send_request(options)
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*.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/viewing-cloudfront-metrics.html#monitoring-console.distributions-additional

Examples:

Request syntax with placeholder values


resp = client.create_monitoring_subscription({
  distribution_id: "string", # required
  monitoring_subscription: { # required
    realtime_metrics_subscription_config: {
      realtime_metrics_subscription_status: "Enabled", # required, accepts Enabled, Disabled
    },
  },
})

Response structure


resp.monitoring_subscription.realtime_metrics_subscription_config.realtime_metrics_subscription_status #=> String, one of "Enabled", "Disabled"

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:distribution_id (required, String) —

The ID of the distribution that you are enabling metrics for.
:monitoring_subscription (required, Types::MonitoringSubscription) —

A monitoring subscription. This structure contains information about whether additional CloudWatch metrics are enabled for a given CloudFront distribution.

Returns:

(Types::CreateMonitoringSubscriptionResult) —
Returns a response object which responds to the following methods:
- #monitoring_subscription => Types::MonitoringSubscription

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 2412

def create_monitoring_subscription(params = {}, options = {})
  req = build_request(:create_monitoring_subscription, params)
  req.send_request(options)
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*.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-origin.html

Examples:

Request syntax with placeholder values


resp = client.create_origin_access_control({
  origin_access_control_config: { # required
    name: "string", # required
    description: "string",
    signing_protocol: "sigv4", # required, accepts sigv4
    signing_behavior: "never", # required, accepts never, always, no-override
    origin_access_control_origin_type: "s3", # required, accepts s3, mediastore, mediapackagev2, lambda
  },
})

Response structure


resp.origin_access_control.id #=> String
resp.origin_access_control.origin_access_control_config.name #=> String
resp.origin_access_control.origin_access_control_config.description #=> String
resp.origin_access_control.origin_access_control_config.signing_protocol #=> String, one of "sigv4"
resp.origin_access_control.origin_access_control_config.signing_behavior #=> String, one of "never", "always", "no-override"
resp.origin_access_control.origin_access_control_config.origin_access_control_origin_type #=> String, one of "s3", "mediastore", "mediapackagev2", "lambda"
resp.location #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:origin_access_control_config (required, Types::OriginAccessControlConfig) —

Contains the origin access control.

Returns:

(Types::CreateOriginAccessControlResult) —
Returns a response object which responds to the following methods:
- #origin_access_control => Types::OriginAccessControl
- #location => String
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 2470

def create_origin_access_control(params = {}, options = {})
  req = build_request(:create_origin_access_control, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.create_origin_request_policy({
  origin_request_policy_config: { # required
    comment: "string",
    name: "string", # required
    headers_config: { # required
      header_behavior: "none", # required, accepts none, whitelist, allViewer, allViewerAndWhitelistCloudFront, allExcept
      headers: {
        quantity: 1, # required
        items: ["string"],
      },
    },
    cookies_config: { # required
      cookie_behavior: "none", # required, accepts none, whitelist, all, allExcept
      cookies: {
        quantity: 1, # required
        items: ["string"],
      },
    },
    query_strings_config: { # required
      query_string_behavior: "none", # required, accepts none, whitelist, all, allExcept
      query_strings: {
        quantity: 1, # required
        items: ["string"],
      },
    },
  },
})

Response structure


resp.origin_request_policy.id #=> String
resp.origin_request_policy.last_modified_time #=> Time
resp.origin_request_policy.origin_request_policy_config.comment #=> String
resp.origin_request_policy.origin_request_policy_config.name #=> String
resp.origin_request_policy.origin_request_policy_config.headers_config.header_behavior #=> String, one of "none", "whitelist", "allViewer", "allViewerAndWhitelistCloudFront", "allExcept"
resp.origin_request_policy.origin_request_policy_config.headers_config.headers.quantity #=> Integer
resp.origin_request_policy.origin_request_policy_config.headers_config.headers.items #=> Array
resp.origin_request_policy.origin_request_policy_config.headers_config.headers.items[0] #=> String
resp.origin_request_policy.origin_request_policy_config.cookies_config.cookie_behavior #=> String, one of "none", "whitelist", "all", "allExcept"
resp.origin_request_policy.origin_request_policy_config.cookies_config.cookies.quantity #=> Integer
resp.origin_request_policy.origin_request_policy_config.cookies_config.cookies.items #=> Array
resp.origin_request_policy.origin_request_policy_config.cookies_config.cookies.items[0] #=> String
resp.origin_request_policy.origin_request_policy_config.query_strings_config.query_string_behavior #=> String, one of "none", "whitelist", "all", "allExcept"
resp.origin_request_policy.origin_request_policy_config.query_strings_config.query_strings.quantity #=> Integer
resp.origin_request_policy.origin_request_policy_config.query_strings_config.query_strings.items #=> Array
resp.origin_request_policy.origin_request_policy_config.query_strings_config.query_strings.items[0] #=> String
resp.location #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:origin_request_policy_config (required, Types::OriginRequestPolicyConfig) —

An origin request policy configuration.

Returns:

(Types::CreateOriginRequestPolicyResult) —
Returns a response object which responds to the following methods:
- #origin_request_policy => Types::OriginRequestPolicy
- #location => String
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 2569

def create_origin_request_policy(params = {}, options = {})
  req = build_request(:create_origin_request_policy, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.create_public_key({
  public_key_config: { # required
    caller_reference: "string", # required
    name: "string", # required
    encoded_key: "string", # required
    comment: "string",
  },
})

Response structure


resp.public_key.id #=> String
resp.public_key.created_time #=> Time
resp.public_key.public_key_config.caller_reference #=> String
resp.public_key.public_key_config.name #=> String
resp.public_key.public_key_config.encoded_key #=> String
resp.public_key.public_key_config.comment #=> String
resp.location #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:public_key_config (required, Types::PublicKeyConfig) —

A CloudFront public key configuration.

Returns:

(Types::CreatePublicKeyResult) —
Returns a response object which responds to the following methods:
- #public_key => Types::PublicKey
- #location => String
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 2617

def create_public_key(params = {}, options = {})
  req = build_request(:create_public_key, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.create_realtime_log_config({
  end_points: [ # required
    {
      stream_type: "string", # required
      kinesis_stream_config: {
        role_arn: "string", # required
        stream_arn: "string", # required
      },
    },
  ],
  fields: ["string"], # required
  name: "string", # required
  sampling_rate: 1, # required
})

Response structure


resp.realtime_log_config.arn #=> String
resp.realtime_log_config.name #=> String
resp.realtime_log_config.sampling_rate #=> Integer
resp.realtime_log_config.end_points #=> Array
resp.realtime_log_config.end_points[0].stream_type #=> String
resp.realtime_log_config.end_points[0].kinesis_stream_config.role_arn #=> String
resp.realtime_log_config.end_points[0].kinesis_stream_config.stream_arn #=> String
resp.realtime_log_config.fields #=> Array
resp.realtime_log_config.fields[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:end_points (required, Array<Types::EndPoint>) —

Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
:fields (required, Array<String>) —

A list of fields to include in each real-time log record.

For more information about fields, see [Real-time log configuration fields] in the *Amazon CloudFront Developer Guide*.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields
:name (required, String) —

A unique name to identify this real-time log configuration.
:sampling_rate (required, Integer) —

The sampling rate for this real-time log configuration. You can specify a whole number between 1 and 100 (inclusive) to determine the percentage of viewer requests that are represented in the real-time log data.

Returns:

(Types::CreateRealtimeLogConfigResult) —
Returns a response object which responds to the following methods:
- #realtime_log_config => Types::RealtimeLogConfig

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 2695

def create_realtime_log_config(params = {}, options = {})
  req = build_request(:create_realtime_log_config, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.create_response_headers_policy({
  response_headers_policy_config: { # required
    comment: "string",
    name: "string", # required
    cors_config: {
      access_control_allow_origins: { # required
        quantity: 1, # required
        items: ["string"], # required
      },
      access_control_allow_headers: { # required
        quantity: 1, # required
        items: ["string"], # required
      },
      access_control_allow_methods: { # required
        quantity: 1, # required
        items: ["GET"], # required, accepts GET, POST, OPTIONS, PUT, DELETE, PATCH, HEAD, ALL
      },
      access_control_allow_credentials: false, # required
      access_control_expose_headers: {
        quantity: 1, # required
        items: ["string"],
      },
      access_control_max_age_sec: 1,
      origin_override: false, # required
    },
    security_headers_config: {
      xss_protection: {
        override: false, # required
        protection: false, # required
        mode_block: false,
        report_uri: "string",
      },
      frame_options: {
        override: false, # required
        frame_option: "DENY", # required, accepts DENY, SAMEORIGIN
      },
      referrer_policy: {
        override: false, # required
        referrer_policy: "no-referrer", # required, accepts no-referrer, no-referrer-when-downgrade, origin, origin-when-cross-origin, same-origin, strict-origin, strict-origin-when-cross-origin, unsafe-url
      },
      content_security_policy: {
        override: false, # required
        content_security_policy: "string", # required
      },
      content_type_options: {
        override: false, # required
      },
      strict_transport_security: {
        override: false, # required
        include_subdomains: false,
        preload: false,
        access_control_max_age_sec: 1, # required
      },
    },
    server_timing_headers_config: {
      enabled: false, # required
      sampling_rate: 1.0,
    },
    custom_headers_config: {
      quantity: 1, # required
      items: [
        {
          header: "string", # required
          value: "string", # required
          override: false, # required
        },
      ],
    },
    remove_headers_config: {
      quantity: 1, # required
      items: [
        {
          header: "string", # required
        },
      ],
    },
  },
})

Response structure


resp.response_headers_policy.id #=> String
resp.response_headers_policy.last_modified_time #=> Time
resp.response_headers_policy.response_headers_policy_config.comment #=> String
resp.response_headers_policy.response_headers_policy_config.name #=> String
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_origins.quantity #=> Integer
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_origins.items #=> Array
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_origins.items[0] #=> String
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_headers.quantity #=> Integer
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_headers.items #=> Array
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_headers.items[0] #=> String
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_methods.quantity #=> Integer
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_methods.items #=> Array
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_methods.items[0] #=> String, one of "GET", "POST", "OPTIONS", "PUT", "DELETE", "PATCH", "HEAD", "ALL"
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_credentials #=> Boolean
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_expose_headers.quantity #=> Integer
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_expose_headers.items #=> Array
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_expose_headers.items[0] #=> String
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_max_age_sec #=> Integer
resp.response_headers_policy.response_headers_policy_config.cors_config.origin_override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.xss_protection.override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.xss_protection.protection #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.xss_protection.mode_block #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.xss_protection.report_uri #=> String
resp.response_headers_policy.response_headers_policy_config.security_headers_config.frame_options.override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.frame_options.frame_option #=> String, one of "DENY", "SAMEORIGIN"
resp.response_headers_policy.response_headers_policy_config.security_headers_config.referrer_policy.override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.referrer_policy.referrer_policy #=> String, one of "no-referrer", "no-referrer-when-downgrade", "origin", "origin-when-cross-origin", "same-origin", "strict-origin", "strict-origin-when-cross-origin", "unsafe-url"
resp.response_headers_policy.response_headers_policy_config.security_headers_config.content_security_policy.override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.content_security_policy.content_security_policy #=> String
resp.response_headers_policy.response_headers_policy_config.security_headers_config.content_type_options.override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.strict_transport_security.override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.strict_transport_security.include_subdomains #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.strict_transport_security.preload #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.strict_transport_security.access_control_max_age_sec #=> Integer
resp.response_headers_policy.response_headers_policy_config.server_timing_headers_config.enabled #=> Boolean
resp.response_headers_policy.response_headers_policy_config.server_timing_headers_config.sampling_rate #=> Float
resp.response_headers_policy.response_headers_policy_config.custom_headers_config.quantity #=> Integer
resp.response_headers_policy.response_headers_policy_config.custom_headers_config.items #=> Array
resp.response_headers_policy.response_headers_policy_config.custom_headers_config.items[0].header #=> String
resp.response_headers_policy.response_headers_policy_config.custom_headers_config.items[0].value #=> String
resp.response_headers_policy.response_headers_policy_config.custom_headers_config.items[0].override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.remove_headers_config.quantity #=> Integer
resp.response_headers_policy.response_headers_policy_config.remove_headers_config.items #=> Array
resp.response_headers_policy.response_headers_policy_config.remove_headers_config.items[0].header #=> String
resp.location #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:response_headers_policy_config (required, Types::ResponseHeadersPolicyConfig) —

Contains metadata about the response headers policy, and a set of configurations that specify the HTTP headers.

Returns:

(Types::CreateResponseHeadersPolicyResult) —
Returns a response object which responds to the following methods:
- #response_headers_policy => Types::ResponseHeadersPolicy
- #location => String
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 2866

def create_response_headers_policy(params = {}, options = {})
  req = build_request(:create_response_headers_policy, params)
  req.send_request(options)
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.

[1]: forums.aws.amazon.com/ann.jspa?annID=7356

Examples:

Request syntax with placeholder values


resp = client.create_streaming_distribution({
  streaming_distribution_config: { # required
    caller_reference: "string", # required
    s3_origin: { # required
      domain_name: "string", # required
      origin_access_identity: "string", # required
    },
    aliases: {
      quantity: 1, # required
      items: ["string"],
    },
    comment: "string", # required
    logging: {
      enabled: false, # required
      bucket: "string", # required
      prefix: "string", # required
    },
    trusted_signers: { # required
      enabled: false, # required
      quantity: 1, # required
      items: ["string"],
    },
    price_class: "PriceClass_100", # accepts PriceClass_100, PriceClass_200, PriceClass_All
    enabled: false, # required
  },
})

Response structure


resp.streaming_distribution.id #=> String
resp.streaming_distribution.arn #=> String
resp.streaming_distribution.status #=> String
resp.streaming_distribution.last_modified_time #=> Time
resp.streaming_distribution.domain_name #=> String
resp.streaming_distribution.active_trusted_signers.enabled #=> Boolean
resp.streaming_distribution.active_trusted_signers.quantity #=> Integer
resp.streaming_distribution.active_trusted_signers.items #=> Array
resp.streaming_distribution.active_trusted_signers.items[0].aws_account_number #=> String
resp.streaming_distribution.active_trusted_signers.items[0].key_pair_ids.quantity #=> Integer
resp.streaming_distribution.active_trusted_signers.items[0].key_pair_ids.items #=> Array
resp.streaming_distribution.active_trusted_signers.items[0].key_pair_ids.items[0] #=> String
resp.streaming_distribution.streaming_distribution_config.caller_reference #=> String
resp.streaming_distribution.streaming_distribution_config.s3_origin.domain_name #=> String
resp.streaming_distribution.streaming_distribution_config.s3_origin.origin_access_identity #=> String
resp.streaming_distribution.streaming_distribution_config.aliases.quantity #=> Integer
resp.streaming_distribution.streaming_distribution_config.aliases.items #=> Array
resp.streaming_distribution.streaming_distribution_config.aliases.items[0] #=> String
resp.streaming_distribution.streaming_distribution_config.comment #=> String
resp.streaming_distribution.streaming_distribution_config.logging.enabled #=> Boolean
resp.streaming_distribution.streaming_distribution_config.logging.bucket #=> String
resp.streaming_distribution.streaming_distribution_config.logging.prefix #=> String
resp.streaming_distribution.streaming_distribution_config.trusted_signers.enabled #=> Boolean
resp.streaming_distribution.streaming_distribution_config.trusted_signers.quantity #=> Integer
resp.streaming_distribution.streaming_distribution_config.trusted_signers.items #=> Array
resp.streaming_distribution.streaming_distribution_config.trusted_signers.items[0] #=> String
resp.streaming_distribution.streaming_distribution_config.price_class #=> String, one of "PriceClass_100", "PriceClass_200", "PriceClass_All"
resp.streaming_distribution.streaming_distribution_config.enabled #=> Boolean
resp.location #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:streaming_distribution_config (required, Types::StreamingDistributionConfig) —

The streaming distribution’s configuration information.

Returns:

(Types::CreateStreamingDistributionResult) —
Returns a response object which responds to the following methods:
- #streaming_distribution => Types::StreamingDistribution
- #location => String
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 2955

def create_streaming_distribution(params = {}, options = {})
  req = build_request(:create_streaming_distribution, params)
  req.send_request(options)
end

#create_streaming_distribution_with_tags(params = {}) ⇒ `Types::CreateStreamingDistributionWithTagsResult`

[1]: forums.aws.amazon.com/ann.jspa?annID=7356

Examples:

Request syntax with placeholder values


resp = client.create_streaming_distribution_with_tags({
  streaming_distribution_config_with_tags: { # required
    streaming_distribution_config: { # required
      caller_reference: "string", # required
      s3_origin: { # required
        domain_name: "string", # required
        origin_access_identity: "string", # required
      },
      aliases: {
        quantity: 1, # required
        items: ["string"],
      },
      comment: "string", # required
      logging: {
        enabled: false, # required
        bucket: "string", # required
        prefix: "string", # required
      },
      trusted_signers: { # required
        enabled: false, # required
        quantity: 1, # required
        items: ["string"],
      },
      price_class: "PriceClass_100", # accepts PriceClass_100, PriceClass_200, PriceClass_All
      enabled: false, # required
    },
    tags: { # required
      items: [
        {
          key: "TagKey", # required
          value: "TagValue",
        },
      ],
    },
  },
})

Response structure


resp.streaming_distribution.id #=> String
resp.streaming_distribution.arn #=> String
resp.streaming_distribution.status #=> String
resp.streaming_distribution.last_modified_time #=> Time
resp.streaming_distribution.domain_name #=> String
resp.streaming_distribution.active_trusted_signers.enabled #=> Boolean
resp.streaming_distribution.active_trusted_signers.quantity #=> Integer
resp.streaming_distribution.active_trusted_signers.items #=> Array
resp.streaming_distribution.active_trusted_signers.items[0].aws_account_number #=> String
resp.streaming_distribution.active_trusted_signers.items[0].key_pair_ids.quantity #=> Integer
resp.streaming_distribution.active_trusted_signers.items[0].key_pair_ids.items #=> Array
resp.streaming_distribution.active_trusted_signers.items[0].key_pair_ids.items[0] #=> String
resp.streaming_distribution.streaming_distribution_config.caller_reference #=> String
resp.streaming_distribution.streaming_distribution_config.s3_origin.domain_name #=> String
resp.streaming_distribution.streaming_distribution_config.s3_origin.origin_access_identity #=> String
resp.streaming_distribution.streaming_distribution_config.aliases.quantity #=> Integer
resp.streaming_distribution.streaming_distribution_config.aliases.items #=> Array
resp.streaming_distribution.streaming_distribution_config.aliases.items[0] #=> String
resp.streaming_distribution.streaming_distribution_config.comment #=> String
resp.streaming_distribution.streaming_distribution_config.logging.enabled #=> Boolean
resp.streaming_distribution.streaming_distribution_config.logging.bucket #=> String
resp.streaming_distribution.streaming_distribution_config.logging.prefix #=> String
resp.streaming_distribution.streaming_distribution_config.trusted_signers.enabled #=> Boolean
resp.streaming_distribution.streaming_distribution_config.trusted_signers.quantity #=> Integer
resp.streaming_distribution.streaming_distribution_config.trusted_signers.items #=> Array
resp.streaming_distribution.streaming_distribution_config.trusted_signers.items[0] #=> String
resp.streaming_distribution.streaming_distribution_config.price_class #=> String, one of "PriceClass_100", "PriceClass_200", "PriceClass_All"
resp.streaming_distribution.streaming_distribution_config.enabled #=> Boolean
resp.location #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:streaming_distribution_config_with_tags (required, Types::StreamingDistributionConfigWithTags) —

The streaming distribution’s configuration information.

Returns:

(Types::CreateStreamingDistributionWithTagsResult) —
Returns a response object which responds to the following methods:
- #streaming_distribution => Types::StreamingDistribution
- #location => String
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3054

def create_streaming_distribution_with_tags(params = {}, options = {})
  req = build_request(:create_streaming_distribution_with_tags, params)
  req.send_request(options)
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`.

Examples:

Request syntax with placeholder values


resp = client.delete_cache_policy({
  id: "string", # required
  if_match: "string",
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The unique identifier for the cache policy that you are deleting. To get the identifier, you can use ‘ListCachePolicies`.
:if_match (String) —

The version of the cache policy that you are deleting. The version is the cache policy’s ‘ETag` value, which you can get using `ListCachePolicies`, `GetCachePolicy`, or `GetCachePolicyConfig`.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3091

def delete_cache_policy(params = {}, options = {})
  req = build_request(:delete_cache_policy, params)
  req.send_request(options)
end

#delete_cloud_front_origin_access_identity(params = {}) ⇒ `Struct`

Delete an origin access identity.

Examples:

Request syntax with placeholder values


resp = client.delete_cloud_front_origin_access_identity({
  id: "string", # required
  if_match: "string",
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The origin access identity’s ID.
:if_match (String) —

The value of the ‘ETag` header you received from a previous `GET` or `PUT` request. For example: `E2QWRUHAPOMQZL`.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3118

def delete_cloud_front_origin_access_identity(params = {}, options = {})
  req = build_request(:delete_cloud_front_origin_access_identity, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.delete_continuous_deployment_policy({
  id: "string", # required
  if_match: "string",
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The identifier of the continuous deployment policy that you are deleting.
:if_match (String) —

The current version (‘ETag` value) of the continuous deployment policy that you are deleting.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3150

def delete_continuous_deployment_policy(params = {}, options = {})
  req = build_request(:delete_continuous_deployment_policy, params)
  req.send_request(options)
end

#delete_distribution(params = {}) ⇒ `Struct`

Delete a distribution.

Examples:

Request syntax with placeholder values


resp = client.delete_distribution({
  id: "string", # required
  if_match: "string",
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The distribution ID.
:if_match (String) —

The value of the ‘ETag` header that you received when you disabled the distribution. For example: `E2QWRUHAPOMQZL`.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3177

def delete_distribution(params = {}, options = {})
  req = build_request(:delete_distribution, params)
  req.send_request(options)
end

#delete_field_level_encryption_config(params = {}) ⇒ `Struct`

Remove a field-level encryption configuration.

Examples:

Request syntax with placeholder values


resp = client.delete_field_level_encryption_config({
  id: "string", # required
  if_match: "string",
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The ID of the configuration you want to delete from CloudFront.
:if_match (String) —

The value of the ‘ETag` header that you received when retrieving the configuration identity to delete. For example: `E2QWRUHAPOMQZL`.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3204

def delete_field_level_encryption_config(params = {}, options = {})
  req = build_request(:delete_field_level_encryption_config, params)
  req.send_request(options)
end

#delete_field_level_encryption_profile(params = {}) ⇒ `Struct`

Remove a field-level encryption profile.

Examples:

Request syntax with placeholder values


resp = client.delete_field_level_encryption_profile({
  id: "string", # required
  if_match: "string",
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

Request the ID of the profile you want to delete from CloudFront.
:if_match (String) —

The value of the ‘ETag` header that you received when retrieving the profile to delete. For example: `E2QWRUHAPOMQZL`.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3231

def delete_field_level_encryption_profile(params = {}, options = {})
  req = build_request(:delete_field_level_encryption_profile, params)
  req.send_request(options)
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`.

Examples:

Request syntax with placeholder values


resp = client.delete_function({
  name: "string", # required
  if_match: "string", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:name (required, String) —

The name of the function that you are deleting.
:if_match (required, String) —

The current version (‘ETag` value) of the function that you are deleting, which you can get using `DescribeFunction`.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3266

def delete_function(params = {}, options = {})
  req = build_request(:delete_function, params)
  req.send_request(options)
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`.

Examples:

Request syntax with placeholder values


resp = client.delete_key_group({
  id: "string", # required
  if_match: "string",
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The identifier of the key group that you are deleting. To get the identifier, use ‘ListKeyGroups`.
:if_match (String) —

The version of the key group that you are deleting. The version is the key group’s ‘ETag` value. To get the `ETag`, use `GetKeyGroup` or `GetKeyGroupConfig`.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3303

def delete_key_group(params = {}, options = {})
  req = build_request(:delete_key_group, params)
  req.send_request(options)
end

#delete_key_value_store(params = {}) ⇒ `Struct`

Specifies the key value store to delete.

Examples:

Example: To delete a KeyValueStore


# Use the following command to delete a KeyValueStore.

resp = client.delete_key_value_store({
  if_match: "ETVPDKIKX0DER", 
  name: "my-keyvaluestore-name", 
})

Request syntax with placeholder values


resp = client.delete_key_value_store({
  name: "KeyValueStoreName", # required
  if_match: "string", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:name (required, String) —

The name of the key value store.
:if_match (required, String) —

The key value store to delete, if a match occurs.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3339

def delete_key_value_store(params = {}, options = {})
  req = build_request(:delete_key_value_store, params)
  req.send_request(options)
end

#delete_monitoring_subscription(params = {}) ⇒ `Struct`

Disables additional CloudWatch metrics for the specified CloudFront distribution.

Examples:

Request syntax with placeholder values


resp = client.delete_monitoring_subscription({
  distribution_id: "string", # required
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:distribution_id (required, String) —

The ID of the distribution that you are disabling metrics for.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3362

def delete_monitoring_subscription(params = {}, options = {})
  req = build_request(:delete_monitoring_subscription, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.delete_origin_access_control({
  id: "string", # required
  if_match: "string",
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The unique identifier of the origin access control that you are deleting.
:if_match (String) —

The current version (‘ETag` value) of the origin access control that you are deleting.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3394

def delete_origin_access_control(params = {}, options = {})
  req = build_request(:delete_origin_access_control, params)
  req.send_request(options)
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`.

Examples:

Request syntax with placeholder values


resp = client.delete_origin_request_policy({
  id: "string", # required
  if_match: "string",
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The unique identifier for the origin request policy that you are deleting. To get the identifier, you can use ‘ListOriginRequestPolicies`.
:if_match (String) —

The version of the origin request policy that you are deleting. The version is the origin request policy’s ‘ETag` value, which you can get using `ListOriginRequestPolicies`, `GetOriginRequestPolicy`, or `GetOriginRequestPolicyConfig`.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3434

def delete_origin_request_policy(params = {}, options = {})
  req = build_request(:delete_origin_request_policy, params)
  req.send_request(options)
end

#delete_public_key(params = {}) ⇒ `Struct`

Remove a public key you previously added to CloudFront.

Examples:

Request syntax with placeholder values


resp = client.delete_public_key({
  id: "string", # required
  if_match: "string",
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The ID of the public key you want to remove from CloudFront.
:if_match (String) —

The value of the ‘ETag` header that you received when retrieving the public key identity to delete. For example: `E2QWRUHAPOMQZL`.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3461

def delete_public_key(params = {}, options = {})
  req = build_request(:delete_public_key, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.delete_realtime_log_config({
  name: "string",
  arn: "string",
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:name (String) —

The name of the real-time log configuration to delete.
:arn (String) —

The Amazon Resource Name (ARN) of the real-time log configuration to delete.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3498

def delete_realtime_log_config(params = {}, options = {})
  req = build_request(:delete_realtime_log_config, params)
  req.send_request(options)
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`.

Examples:

Request syntax with placeholder values


resp = client.delete_response_headers_policy({
  id: "string", # required
  if_match: "string",
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The identifier for the response headers policy that you are deleting.

To get the identifier, you can use ‘ListResponseHeadersPolicies`.
:if_match (String) —

The version of the response headers policy that you are deleting.

The version is the response headers policy’s ‘ETag` value, which you can get using `ListResponseHeadersPolicies`, `GetResponseHeadersPolicy`, or `GetResponseHeadersPolicyConfig`.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3539

def delete_response_headers_policy(params = {}, options = {})
  req = build_request(:delete_response_headers_policy, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.delete_streaming_distribution({
  id: "string", # required
  if_match: "string",
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The distribution ID.
:if_match (String) —

The value of the ‘ETag` header that you received when you disabled the streaming distribution. For example: `E2QWRUHAPOMQZL`.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3609

def delete_streaming_distribution(params = {}, options = {})
  req = build_request(:delete_streaming_distribution, params)
  req.send_request(options)
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`.

Examples:

Request syntax with placeholder values


resp = client.describe_function({
  name: "string", # required
  stage: "DEVELOPMENT", # accepts DEVELOPMENT, LIVE
})

Response structure


resp.function_summary.name #=> String
resp.function_summary.status #=> String
resp.function_summary.function_config.comment #=> String
resp.function_summary.function_config.runtime #=> String, one of "cloudfront-js-1.0", "cloudfront-js-2.0"
resp.function_summary.function_config.key_value_store_associations.quantity #=> Integer
resp.function_summary.function_config.key_value_store_associations.items #=> Array
resp.function_summary.function_config.key_value_store_associations.items[0].key_value_store_arn #=> String
resp.function_summary.function_metadata.function_arn #=> String
resp.function_summary.function_metadata.stage #=> String, one of "DEVELOPMENT", "LIVE"
resp.function_summary.function_metadata.created_time #=> Time
resp.function_summary.function_metadata.last_modified_time #=> Time
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:name (required, String) —

The name of the function that you are getting information about.
:stage (String) —

The function’s stage, either ‘DEVELOPMENT` or `LIVE`.

Returns:

(Types::DescribeFunctionResult) —
Returns a response object which responds to the following methods:
- #function_summary => Types::FunctionSummary
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3659

def describe_function(params = {}, options = {})
  req = build_request(:describe_function, params)
  req.send_request(options)
end

#describe_key_value_store(params = {}) ⇒ `Types::DescribeKeyValueStoreResult`

Specifies the key value store and its configuration.

Examples:

Example: To describe a KeyValueStore


# Use the following command to describe a KeyValueStore.

resp = client.describe_key_value_store({
  name: "my-keyvaluestore-name", 
})

resp.to_h outputs the following:
{
  etag: "ETVPDKIKX0DER", 
  key_value_store: {
    arn: "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889", 
    comment: "my-key-valuestore-comment", 
    id: "54947df8-0e9e-4471-a2f9-9af509fb5889", 
    last_modified_time: Time.parse("2023-11-07T18:20:33.056Z"), 
    name: "my-keyvaluestore-name", 
    status: "READY", 
  }, 
}

Request syntax with placeholder values


resp = client.describe_key_value_store({
  name: "KeyValueStoreName", # required
})

Response structure


resp.key_value_store.name #=> String
resp.key_value_store.id #=> String
resp.key_value_store.comment #=> String
resp.key_value_store.arn #=> String
resp.key_value_store.status #=> String
resp.key_value_store.last_modified_time #=> Time
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:name (required, String) —

The name of the key value store.

Returns:

(Types::DescribeKeyValueStoreResult) —
Returns a response object which responds to the following methods:
- #key_value_store => Types::KeyValueStore
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3716

def describe_key_value_store(params = {}, options = {})
  req = build_request(:describe_key_value_store, params)
  req.send_request(options)
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`.

Examples:

Request syntax with placeholder values


resp = client.get_cache_policy({
  id: "string", # required
})

Response structure


resp.cache_policy.id #=> String
resp.cache_policy.last_modified_time #=> Time
resp.cache_policy.cache_policy_config.comment #=> String
resp.cache_policy.cache_policy_config.name #=> String
resp.cache_policy.cache_policy_config.default_ttl #=> Integer
resp.cache_policy.cache_policy_config.max_ttl #=> Integer
resp.cache_policy.cache_policy_config.min_ttl #=> Integer
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.enable_accept_encoding_gzip #=> Boolean
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.enable_accept_encoding_brotli #=> Boolean
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.headers_config.header_behavior #=> String, one of "none", "whitelist"
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.headers_config.headers.quantity #=> Integer
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.headers_config.headers.items #=> Array
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.headers_config.headers.items[0] #=> String
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookie_behavior #=> String, one of "none", "whitelist", "allExcept", "all"
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookies.quantity #=> Integer
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookies.items #=> Array
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookies.items[0] #=> String
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_string_behavior #=> String, one of "none", "whitelist", "allExcept", "all"
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_strings.quantity #=> Integer
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_strings.items #=> Array
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_strings.items[0] #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The unique identifier for the cache policy. 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`.

Returns:

(Types::GetCachePolicyResult) —
Returns a response object which responds to the following methods:
- #cache_policy => Types::CachePolicy
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3780

def get_cache_policy(params = {}, options = {})
  req = build_request(:get_cache_policy, params)
  req.send_request(options)
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`.

Examples:

Request syntax with placeholder values


resp = client.get_cache_policy_config({
  id: "string", # required
})

Response structure


resp.cache_policy_config.comment #=> String
resp.cache_policy_config.name #=> String
resp.cache_policy_config.default_ttl #=> Integer
resp.cache_policy_config.max_ttl #=> Integer
resp.cache_policy_config.min_ttl #=> Integer
resp.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.enable_accept_encoding_gzip #=> Boolean
resp.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.enable_accept_encoding_brotli #=> Boolean
resp.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.headers_config.header_behavior #=> String, one of "none", "whitelist"
resp.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.headers_config.headers.quantity #=> Integer
resp.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.headers_config.headers.items #=> Array
resp.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.headers_config.headers.items[0] #=> String
resp.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookie_behavior #=> String, one of "none", "whitelist", "allExcept", "all"
resp.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookies.quantity #=> Integer
resp.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookies.items #=> Array
resp.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookies.items[0] #=> String
resp.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_string_behavior #=> String, one of "none", "whitelist", "allExcept", "all"
resp.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_strings.quantity #=> Integer
resp.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_strings.items #=> Array
resp.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_strings.items[0] #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The unique identifier for the cache policy. 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`.

Returns:

(Types::GetCachePolicyConfigResult) —
Returns a response object which responds to the following methods:
- #cache_policy_config => Types::CachePolicyConfig
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3839

def get_cache_policy_config(params = {}, options = {})
  req = build_request(:get_cache_policy_config, params)
  req.send_request(options)
end

#get_cloud_front_origin_access_identity(params = {}) ⇒ `Types::GetCloudFrontOriginAccessIdentityResult`

Get the information about an origin access identity.

Examples:

Request syntax with placeholder values


resp = client.get_cloud_front_origin_access_identity({
  id: "string", # required
})

Response structure


resp.cloud_front_origin_access_identity.id #=> String
resp.cloud_front_origin_access_identity.s3_canonical_user_id #=> String
resp.cloud_front_origin_access_identity.cloud_front_origin_access_identity_config.caller_reference #=> String
resp.cloud_front_origin_access_identity.cloud_front_origin_access_identity_config.comment #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The identity’s ID.

Returns:

(Types::GetCloudFrontOriginAccessIdentityResult) —
Returns a response object which responds to the following methods:
- #cloud_front_origin_access_identity => Types::CloudFrontOriginAccessIdentity
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3872

def get_cloud_front_origin_access_identity(params = {}, options = {})
  req = build_request(:get_cloud_front_origin_access_identity, params)
  req.send_request(options)
end

#get_cloud_front_origin_access_identity_config(params = {}) ⇒ `Types::GetCloudFrontOriginAccessIdentityConfigResult`

Get the configuration information about an origin access identity.

Examples:

Request syntax with placeholder values


resp = client.get_cloud_front_origin_access_identity_config({
  id: "string", # required
})

Response structure


resp.cloud_front_origin_access_identity_config.caller_reference #=> String
resp.cloud_front_origin_access_identity_config.comment #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The identity’s ID.

Returns:

(Types::GetCloudFrontOriginAccessIdentityConfigResult) —
Returns a response object which responds to the following methods:
- #cloud_front_origin_access_identity_config => Types::CloudFrontOriginAccessIdentityConfig
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3903

def get_cloud_front_origin_access_identity_config(params = {}, options = {})
  req = build_request(:get_cloud_front_origin_access_identity_config, params)
  req.send_request(options)
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).

Examples:

Request syntax with placeholder values


resp = client.get_continuous_deployment_policy({
  id: "string", # required
})

Response structure


resp.continuous_deployment_policy.id #=> String
resp.continuous_deployment_policy.last_modified_time #=> Time
resp.continuous_deployment_policy.continuous_deployment_policy_config.staging_distribution_dns_names.quantity #=> Integer
resp.continuous_deployment_policy.continuous_deployment_policy_config.staging_distribution_dns_names.items #=> Array
resp.continuous_deployment_policy.continuous_deployment_policy_config.staging_distribution_dns_names.items[0] #=> String
resp.continuous_deployment_policy.continuous_deployment_policy_config.enabled #=> Boolean
resp.continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.single_weight_config.weight #=> Float
resp.continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.single_weight_config.session_stickiness_config.idle_ttl #=> Integer
resp.continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.single_weight_config.session_stickiness_config.maximum_ttl #=> Integer
resp.continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.single_header_config.header #=> String
resp.continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.single_header_config.value #=> String
resp.continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.type #=> String, one of "SingleWeight", "SingleHeader"
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The identifier of the continuous deployment policy that you are getting.

Returns:

(Types::GetContinuousDeploymentPolicyResult) —
Returns a response object which responds to the following methods:
- #continuous_deployment_policy => Types::ContinuousDeploymentPolicy
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3946

def get_continuous_deployment_policy(params = {}, options = {})
  req = build_request(:get_continuous_deployment_policy, params)
  req.send_request(options)
end

#get_continuous_deployment_policy_config(params = {}) ⇒ `Types::GetContinuousDeploymentPolicyConfigResult`

Gets configuration information about a continuous deployment policy.

Examples:

Request syntax with placeholder values


resp = client.get_continuous_deployment_policy_config({
  id: "string", # required
})

Response structure


resp.continuous_deployment_policy_config.staging_distribution_dns_names.quantity #=> Integer
resp.continuous_deployment_policy_config.staging_distribution_dns_names.items #=> Array
resp.continuous_deployment_policy_config.staging_distribution_dns_names.items[0] #=> String
resp.continuous_deployment_policy_config.enabled #=> Boolean
resp.continuous_deployment_policy_config.traffic_config.single_weight_config.weight #=> Float
resp.continuous_deployment_policy_config.traffic_config.single_weight_config.session_stickiness_config.idle_ttl #=> Integer
resp.continuous_deployment_policy_config.traffic_config.single_weight_config.session_stickiness_config.maximum_ttl #=> Integer
resp.continuous_deployment_policy_config.traffic_config.single_header_config.header #=> String
resp.continuous_deployment_policy_config.traffic_config.single_header_config.value #=> String
resp.continuous_deployment_policy_config.traffic_config.type #=> String, one of "SingleWeight", "SingleHeader"
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The identifier of the continuous deployment policy whose configuration you are getting.

Returns:

(Types::GetContinuousDeploymentPolicyConfigResult) —
Returns a response object which responds to the following methods:
- #continuous_deployment_policy_config => Types::ContinuousDeploymentPolicyConfig
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 3986

def get_continuous_deployment_policy_config(params = {}, options = {})
  req = build_request(:get_continuous_deployment_policy_config, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.get_distribution({
  id: "string", # required
})

Response structure


resp.distribution.id #=> String
resp.distribution.arn #=> String
resp.distribution.status #=> String
resp.distribution.last_modified_time #=> Time
resp.distribution.in_progress_invalidation_batches #=> Integer
resp.distribution.domain_name #=> String
resp.distribution.active_trusted_signers.enabled #=> Boolean
resp.distribution.active_trusted_signers.quantity #=> Integer
resp.distribution.active_trusted_signers.items #=> Array
resp.distribution.active_trusted_signers.items[0].aws_account_number #=> String
resp.distribution.active_trusted_signers.items[0].key_pair_ids.quantity #=> Integer
resp.distribution.active_trusted_signers.items[0].key_pair_ids.items #=> Array
resp.distribution.active_trusted_signers.items[0].key_pair_ids.items[0] #=> String
resp.distribution.active_trusted_key_groups.enabled #=> Boolean
resp.distribution.active_trusted_key_groups.quantity #=> Integer
resp.distribution.active_trusted_key_groups.items #=> Array
resp.distribution.active_trusted_key_groups.items[0].key_group_id #=> String
resp.distribution.active_trusted_key_groups.items[0].key_pair_ids.quantity #=> Integer
resp.distribution.active_trusted_key_groups.items[0].key_pair_ids.items #=> Array
resp.distribution.active_trusted_key_groups.items[0].key_pair_ids.items[0] #=> String
resp.distribution.distribution_config.caller_reference #=> String
resp.distribution.distribution_config.aliases.quantity #=> Integer
resp.distribution.distribution_config.aliases.items #=> Array
resp.distribution.distribution_config.aliases.items[0] #=> String
resp.distribution.distribution_config.default_root_object #=> String
resp.distribution.distribution_config.origins.quantity #=> Integer
resp.distribution.distribution_config.origins.items #=> Array
resp.distribution.distribution_config.origins.items[0].id #=> String
resp.distribution.distribution_config.origins.items[0].domain_name #=> String
resp.distribution.distribution_config.origins.items[0].origin_path #=> String
resp.distribution.distribution_config.origins.items[0].custom_headers.quantity #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_headers.items #=> Array
resp.distribution.distribution_config.origins.items[0].custom_headers.items[0].header_name #=> String
resp.distribution.distribution_config.origins.items[0].custom_headers.items[0].header_value #=> String
resp.distribution.distribution_config.origins.items[0].s3_origin_config.origin_access_identity #=> String
resp.distribution.distribution_config.origins.items[0].custom_origin_config.http_port #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.https_port #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_protocol_policy #=> String, one of "http-only", "match-viewer", "https-only"
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.quantity #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.items #=> Array
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.items[0] #=> String, one of "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2"
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_read_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_keepalive_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].connection_attempts #=> Integer
resp.distribution.distribution_config.origins.items[0].connection_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].origin_shield.enabled #=> Boolean
resp.distribution.distribution_config.origins.items[0].origin_shield.origin_shield_region #=> String
resp.distribution.distribution_config.origins.items[0].origin_access_control_id #=> String
resp.distribution.distribution_config.origin_groups.quantity #=> Integer
resp.distribution.distribution_config.origin_groups.items #=> Array
resp.distribution.distribution_config.origin_groups.items[0].id #=> String
resp.distribution.distribution_config.origin_groups.items[0].failover_criteria.status_codes.quantity #=> Integer
resp.distribution.distribution_config.origin_groups.items[0].failover_criteria.status_codes.items #=> Array
resp.distribution.distribution_config.origin_groups.items[0].failover_criteria.status_codes.items[0] #=> Integer
resp.distribution.distribution_config.origin_groups.items[0].members.quantity #=> Integer
resp.distribution.distribution_config.origin_groups.items[0].members.items #=> Array
resp.distribution.distribution_config.origin_groups.items[0].members.items[0].origin_id #=> String
resp.distribution.distribution_config.default_cache_behavior.target_origin_id #=> String
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.enabled #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.enabled #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.viewer_protocol_policy #=> String, one of "allow-all", "https-only", "redirect-to-https"
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.cached_methods.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.cached_methods.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.cached_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.default_cache_behavior.smooth_streaming #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.compress #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items[0].lambda_function_arn #=> String
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items[0].include_body #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.function_associations.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.function_associations.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.function_associations.items[0].function_arn #=> String
resp.distribution.distribution_config.default_cache_behavior.function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.default_cache_behavior.field_level_encryption_id #=> String
resp.distribution.distribution_config.default_cache_behavior.realtime_log_config_arn #=> String
resp.distribution.distribution_config.default_cache_behavior.cache_policy_id #=> String
resp.distribution.distribution_config.default_cache_behavior.origin_request_policy_id #=> String
resp.distribution.distribution_config.default_cache_behavior.response_headers_policy_id #=> String
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.forward #=> String, one of "none", "whitelist", "all"
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.whitelisted_names.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.whitelisted_names.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.whitelisted_names.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.headers.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.headers.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.headers.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string_cache_keys.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string_cache_keys.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string_cache_keys.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.min_ttl #=> Integer
resp.distribution.distribution_config.default_cache_behavior.default_ttl #=> Integer
resp.distribution.distribution_config.default_cache_behavior.max_ttl #=> Integer
resp.distribution.distribution_config.cache_behaviors.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].path_pattern #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].target_origin_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.enabled #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.enabled #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].viewer_protocol_policy #=> String, one of "allow-all", "https-only", "redirect-to-https"
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.cached_methods.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.cached_methods.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.cached_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.cache_behaviors.items[0].smooth_streaming #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].compress #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items[0].lambda_function_arn #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items[0].include_body #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.items[0].function_arn #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.cache_behaviors.items[0].field_level_encryption_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].realtime_log_config_arn #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].cache_policy_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].origin_request_policy_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].response_headers_policy_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.forward #=> String, one of "none", "whitelist", "all"
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.headers.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.headers.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.headers.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string_cache_keys.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string_cache_keys.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string_cache_keys.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].min_ttl #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].default_ttl #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].max_ttl #=> Integer
resp.distribution.distribution_config.custom_error_responses.quantity #=> Integer
resp.distribution.distribution_config.custom_error_responses.items #=> Array
resp.distribution.distribution_config.custom_error_responses.items[0].error_code #=> Integer
resp.distribution.distribution_config.custom_error_responses.items[0].response_page_path #=> String
resp.distribution.distribution_config.custom_error_responses.items[0].response_code #=> String
resp.distribution.distribution_config.custom_error_responses.items[0].error_caching_min_ttl #=> Integer
resp.distribution.distribution_config.comment #=> String
resp.distribution.distribution_config.logging.enabled #=> Boolean
resp.distribution.distribution_config.logging.include_cookies #=> Boolean
resp.distribution.distribution_config.logging.bucket #=> String
resp.distribution.distribution_config.logging.prefix #=> String
resp.distribution.distribution_config.price_class #=> String, one of "PriceClass_100", "PriceClass_200", "PriceClass_All"
resp.distribution.distribution_config.enabled #=> Boolean
resp.distribution.distribution_config.viewer_certificate.cloud_front_default_certificate #=> Boolean
resp.distribution.distribution_config.viewer_certificate.iam_certificate_id #=> String
resp.distribution.distribution_config.viewer_certificate.acm_certificate_arn #=> String
resp.distribution.distribution_config.viewer_certificate.ssl_support_method #=> String, one of "sni-only", "vip", "static-ip"
resp.distribution.distribution_config.viewer_certificate.minimum_protocol_version #=> String, one of "SSLv3", "TLSv1", "TLSv1_2016", "TLSv1.1_2016", "TLSv1.2_2018", "TLSv1.2_2019", "TLSv1.2_2021"
resp.distribution.distribution_config.viewer_certificate.certificate #=> String
resp.distribution.distribution_config.viewer_certificate.certificate_source #=> String, one of "cloudfront", "iam", "acm"
resp.distribution.distribution_config.restrictions.geo_restriction.restriction_type #=> String, one of "blacklist", "whitelist", "none"
resp.distribution.distribution_config.restrictions.geo_restriction.quantity #=> Integer
resp.distribution.distribution_config.restrictions.geo_restriction.items #=> Array
resp.distribution.distribution_config.restrictions.geo_restriction.items[0] #=> String
resp.distribution.distribution_config.web_acl_id #=> String
resp.distribution.distribution_config.http_version #=> String, one of "http1.1", "http2", "http3", "http2and3"
resp.distribution.distribution_config.is_ipv6_enabled #=> Boolean
resp.distribution.distribution_config.continuous_deployment_policy_id #=> String
resp.distribution.distribution_config.staging #=> Boolean
resp.distribution.alias_icp_recordals #=> Array
resp.distribution.alias_icp_recordals[0].cname #=> String
resp.distribution.alias_icp_recordals[0].icp_recordal_status #=> String, one of "APPROVED", "SUSPENDED", "PENDING"
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The distribution’s ID. If the ID is empty, an empty distribution configuration is returned.

Returns:

(Types::GetDistributionResult) —
Returns a response object which responds to the following methods:
- #distribution => Types::Distribution
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 4205

def get_distribution(params = {}, options = {})
  req = build_request(:get_distribution, params)
  req.send_request(options)
end

#get_distribution_config(params = {}) ⇒ `Types::GetDistributionConfigResult`

Get the configuration information about a distribution.

Examples:

Request syntax with placeholder values


resp = client.get_distribution_config({
  id: "string", # required
})

Response structure


resp.distribution_config.caller_reference #=> String
resp.distribution_config.aliases.quantity #=> Integer
resp.distribution_config.aliases.items #=> Array
resp.distribution_config.aliases.items[0] #=> String
resp.distribution_config.default_root_object #=> String
resp.distribution_config.origins.quantity #=> Integer
resp.distribution_config.origins.items #=> Array
resp.distribution_config.origins.items[0].id #=> String
resp.distribution_config.origins.items[0].domain_name #=> String
resp.distribution_config.origins.items[0].origin_path #=> String
resp.distribution_config.origins.items[0].custom_headers.quantity #=> Integer
resp.distribution_config.origins.items[0].custom_headers.items #=> Array
resp.distribution_config.origins.items[0].custom_headers.items[0].header_name #=> String
resp.distribution_config.origins.items[0].custom_headers.items[0].header_value #=> String
resp.distribution_config.origins.items[0].s3_origin_config.origin_access_identity #=> String
resp.distribution_config.origins.items[0].custom_origin_config.http_port #=> Integer
resp.distribution_config.origins.items[0].custom_origin_config.https_port #=> Integer
resp.distribution_config.origins.items[0].custom_origin_config.origin_protocol_policy #=> String, one of "http-only", "match-viewer", "https-only"
resp.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.quantity #=> Integer
resp.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.items #=> Array
resp.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.items[0] #=> String, one of "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2"
resp.distribution_config.origins.items[0].custom_origin_config.origin_read_timeout #=> Integer
resp.distribution_config.origins.items[0].custom_origin_config.origin_keepalive_timeout #=> Integer
resp.distribution_config.origins.items[0].connection_attempts #=> Integer
resp.distribution_config.origins.items[0].connection_timeout #=> Integer
resp.distribution_config.origins.items[0].origin_shield.enabled #=> Boolean
resp.distribution_config.origins.items[0].origin_shield.origin_shield_region #=> String
resp.distribution_config.origins.items[0].origin_access_control_id #=> String
resp.distribution_config.origin_groups.quantity #=> Integer
resp.distribution_config.origin_groups.items #=> Array
resp.distribution_config.origin_groups.items[0].id #=> String
resp.distribution_config.origin_groups.items[0].failover_criteria.status_codes.quantity #=> Integer
resp.distribution_config.origin_groups.items[0].failover_criteria.status_codes.items #=> Array
resp.distribution_config.origin_groups.items[0].failover_criteria.status_codes.items[0] #=> Integer
resp.distribution_config.origin_groups.items[0].members.quantity #=> Integer
resp.distribution_config.origin_groups.items[0].members.items #=> Array
resp.distribution_config.origin_groups.items[0].members.items[0].origin_id #=> String
resp.distribution_config.default_cache_behavior.target_origin_id #=> String
resp.distribution_config.default_cache_behavior.trusted_signers.enabled #=> Boolean
resp.distribution_config.default_cache_behavior.trusted_signers.quantity #=> Integer
resp.distribution_config.default_cache_behavior.trusted_signers.items #=> Array
resp.distribution_config.default_cache_behavior.trusted_signers.items[0] #=> String
resp.distribution_config.default_cache_behavior.trusted_key_groups.enabled #=> Boolean
resp.distribution_config.default_cache_behavior.trusted_key_groups.quantity #=> Integer
resp.distribution_config.default_cache_behavior.trusted_key_groups.items #=> Array
resp.distribution_config.default_cache_behavior.trusted_key_groups.items[0] #=> String
resp.distribution_config.default_cache_behavior.viewer_protocol_policy #=> String, one of "allow-all", "https-only", "redirect-to-https"
resp.distribution_config.default_cache_behavior.allowed_methods.quantity #=> Integer
resp.distribution_config.default_cache_behavior.allowed_methods.items #=> Array
resp.distribution_config.default_cache_behavior.allowed_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution_config.default_cache_behavior.allowed_methods.cached_methods.quantity #=> Integer
resp.distribution_config.default_cache_behavior.allowed_methods.cached_methods.items #=> Array
resp.distribution_config.default_cache_behavior.allowed_methods.cached_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution_config.default_cache_behavior.smooth_streaming #=> Boolean
resp.distribution_config.default_cache_behavior.compress #=> Boolean
resp.distribution_config.default_cache_behavior.lambda_function_associations.quantity #=> Integer
resp.distribution_config.default_cache_behavior.lambda_function_associations.items #=> Array
resp.distribution_config.default_cache_behavior.lambda_function_associations.items[0].lambda_function_arn #=> String
resp.distribution_config.default_cache_behavior.lambda_function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution_config.default_cache_behavior.lambda_function_associations.items[0].include_body #=> Boolean
resp.distribution_config.default_cache_behavior.function_associations.quantity #=> Integer
resp.distribution_config.default_cache_behavior.function_associations.items #=> Array
resp.distribution_config.default_cache_behavior.function_associations.items[0].function_arn #=> String
resp.distribution_config.default_cache_behavior.function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution_config.default_cache_behavior.field_level_encryption_id #=> String
resp.distribution_config.default_cache_behavior.realtime_log_config_arn #=> String
resp.distribution_config.default_cache_behavior.cache_policy_id #=> String
resp.distribution_config.default_cache_behavior.origin_request_policy_id #=> String
resp.distribution_config.default_cache_behavior.response_headers_policy_id #=> String
resp.distribution_config.default_cache_behavior.forwarded_values.query_string #=> Boolean
resp.distribution_config.default_cache_behavior.forwarded_values.cookies.forward #=> String, one of "none", "whitelist", "all"
resp.distribution_config.default_cache_behavior.forwarded_values.cookies.whitelisted_names.quantity #=> Integer
resp.distribution_config.default_cache_behavior.forwarded_values.cookies.whitelisted_names.items #=> Array
resp.distribution_config.default_cache_behavior.forwarded_values.cookies.whitelisted_names.items[0] #=> String
resp.distribution_config.default_cache_behavior.forwarded_values.headers.quantity #=> Integer
resp.distribution_config.default_cache_behavior.forwarded_values.headers.items #=> Array
resp.distribution_config.default_cache_behavior.forwarded_values.headers.items[0] #=> String
resp.distribution_config.default_cache_behavior.forwarded_values.query_string_cache_keys.quantity #=> Integer
resp.distribution_config.default_cache_behavior.forwarded_values.query_string_cache_keys.items #=> Array
resp.distribution_config.default_cache_behavior.forwarded_values.query_string_cache_keys.items[0] #=> String
resp.distribution_config.default_cache_behavior.min_ttl #=> Integer
resp.distribution_config.default_cache_behavior.default_ttl #=> Integer
resp.distribution_config.default_cache_behavior.max_ttl #=> Integer
resp.distribution_config.cache_behaviors.quantity #=> Integer
resp.distribution_config.cache_behaviors.items #=> Array
resp.distribution_config.cache_behaviors.items[0].path_pattern #=> String
resp.distribution_config.cache_behaviors.items[0].target_origin_id #=> String
resp.distribution_config.cache_behaviors.items[0].trusted_signers.enabled #=> Boolean
resp.distribution_config.cache_behaviors.items[0].trusted_signers.quantity #=> Integer
resp.distribution_config.cache_behaviors.items[0].trusted_signers.items #=> Array
resp.distribution_config.cache_behaviors.items[0].trusted_signers.items[0] #=> String
resp.distribution_config.cache_behaviors.items[0].trusted_key_groups.enabled #=> Boolean
resp.distribution_config.cache_behaviors.items[0].trusted_key_groups.quantity #=> Integer
resp.distribution_config.cache_behaviors.items[0].trusted_key_groups.items #=> Array
resp.distribution_config.cache_behaviors.items[0].trusted_key_groups.items[0] #=> String
resp.distribution_config.cache_behaviors.items[0].viewer_protocol_policy #=> String, one of "allow-all", "https-only", "redirect-to-https"
resp.distribution_config.cache_behaviors.items[0].allowed_methods.quantity #=> Integer
resp.distribution_config.cache_behaviors.items[0].allowed_methods.items #=> Array
resp.distribution_config.cache_behaviors.items[0].allowed_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution_config.cache_behaviors.items[0].allowed_methods.cached_methods.quantity #=> Integer
resp.distribution_config.cache_behaviors.items[0].allowed_methods.cached_methods.items #=> Array
resp.distribution_config.cache_behaviors.items[0].allowed_methods.cached_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution_config.cache_behaviors.items[0].smooth_streaming #=> Boolean
resp.distribution_config.cache_behaviors.items[0].compress #=> Boolean
resp.distribution_config.cache_behaviors.items[0].lambda_function_associations.quantity #=> Integer
resp.distribution_config.cache_behaviors.items[0].lambda_function_associations.items #=> Array
resp.distribution_config.cache_behaviors.items[0].lambda_function_associations.items[0].lambda_function_arn #=> String
resp.distribution_config.cache_behaviors.items[0].lambda_function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution_config.cache_behaviors.items[0].lambda_function_associations.items[0].include_body #=> Boolean
resp.distribution_config.cache_behaviors.items[0].function_associations.quantity #=> Integer
resp.distribution_config.cache_behaviors.items[0].function_associations.items #=> Array
resp.distribution_config.cache_behaviors.items[0].function_associations.items[0].function_arn #=> String
resp.distribution_config.cache_behaviors.items[0].function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution_config.cache_behaviors.items[0].field_level_encryption_id #=> String
resp.distribution_config.cache_behaviors.items[0].realtime_log_config_arn #=> String
resp.distribution_config.cache_behaviors.items[0].cache_policy_id #=> String
resp.distribution_config.cache_behaviors.items[0].origin_request_policy_id #=> String
resp.distribution_config.cache_behaviors.items[0].response_headers_policy_id #=> String
resp.distribution_config.cache_behaviors.items[0].forwarded_values.query_string #=> Boolean
resp.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.forward #=> String, one of "none", "whitelist", "all"
resp.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.quantity #=> Integer
resp.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.items #=> Array
resp.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.items[0] #=> String
resp.distribution_config.cache_behaviors.items[0].forwarded_values.headers.quantity #=> Integer
resp.distribution_config.cache_behaviors.items[0].forwarded_values.headers.items #=> Array
resp.distribution_config.cache_behaviors.items[0].forwarded_values.headers.items[0] #=> String
resp.distribution_config.cache_behaviors.items[0].forwarded_values.query_string_cache_keys.quantity #=> Integer
resp.distribution_config.cache_behaviors.items[0].forwarded_values.query_string_cache_keys.items #=> Array
resp.distribution_config.cache_behaviors.items[0].forwarded_values.query_string_cache_keys.items[0] #=> String
resp.distribution_config.cache_behaviors.items[0].min_ttl #=> Integer
resp.distribution_config.cache_behaviors.items[0].default_ttl #=> Integer
resp.distribution_config.cache_behaviors.items[0].max_ttl #=> Integer
resp.distribution_config.custom_error_responses.quantity #=> Integer
resp.distribution_config.custom_error_responses.items #=> Array
resp.distribution_config.custom_error_responses.items[0].error_code #=> Integer
resp.distribution_config.custom_error_responses.items[0].response_page_path #=> String
resp.distribution_config.custom_error_responses.items[0].response_code #=> String
resp.distribution_config.custom_error_responses.items[0].error_caching_min_ttl #=> Integer
resp.distribution_config.comment #=> String
resp.distribution_config.logging.enabled #=> Boolean
resp.distribution_config.logging.include_cookies #=> Boolean
resp.distribution_config.logging.bucket #=> String
resp.distribution_config.logging.prefix #=> String
resp.distribution_config.price_class #=> String, one of "PriceClass_100", "PriceClass_200", "PriceClass_All"
resp.distribution_config.enabled #=> Boolean
resp.distribution_config.viewer_certificate.cloud_front_default_certificate #=> Boolean
resp.distribution_config.viewer_certificate.iam_certificate_id #=> String
resp.distribution_config.viewer_certificate.acm_certificate_arn #=> String
resp.distribution_config.viewer_certificate.ssl_support_method #=> String, one of "sni-only", "vip", "static-ip"
resp.distribution_config.viewer_certificate.minimum_protocol_version #=> String, one of "SSLv3", "TLSv1", "TLSv1_2016", "TLSv1.1_2016", "TLSv1.2_2018", "TLSv1.2_2019", "TLSv1.2_2021"
resp.distribution_config.viewer_certificate.certificate #=> String
resp.distribution_config.viewer_certificate.certificate_source #=> String, one of "cloudfront", "iam", "acm"
resp.distribution_config.restrictions.geo_restriction.restriction_type #=> String, one of "blacklist", "whitelist", "none"
resp.distribution_config.restrictions.geo_restriction.quantity #=> Integer
resp.distribution_config.restrictions.geo_restriction.items #=> Array
resp.distribution_config.restrictions.geo_restriction.items[0] #=> String
resp.distribution_config.web_acl_id #=> String
resp.distribution_config.http_version #=> String, one of "http1.1", "http2", "http3", "http2and3"
resp.distribution_config.is_ipv6_enabled #=> Boolean
resp.distribution_config.continuous_deployment_policy_id #=> String
resp.distribution_config.staging #=> Boolean
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The distribution’s ID. If the ID is empty, an empty distribution configuration is returned.

Returns:

(Types::GetDistributionConfigResult) —
Returns a response object which responds to the following methods:
- #distribution_config => Types::DistributionConfig
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 4396

def get_distribution_config(params = {}, options = {})
  req = build_request(:get_distribution_config, params)
  req.send_request(options)
end

#get_field_level_encryption(params = {}) ⇒ `Types::GetFieldLevelEncryptionResult`

Get the field-level encryption configuration information.

Examples:

Request syntax with placeholder values


resp = client.get_field_level_encryption({
  id: "string", # required
})

Response structure


resp.field_level_encryption.id #=> String
resp.field_level_encryption.last_modified_time #=> Time
resp.field_level_encryption.field_level_encryption_config.caller_reference #=> String
resp.field_level_encryption.field_level_encryption_config.comment #=> String
resp.field_level_encryption.field_level_encryption_config.query_arg_profile_config.forward_when_query_arg_profile_is_unknown #=> Boolean
resp.field_level_encryption.field_level_encryption_config.query_arg_profile_config.query_arg_profiles.quantity #=> Integer
resp.field_level_encryption.field_level_encryption_config.query_arg_profile_config.query_arg_profiles.items #=> Array
resp.field_level_encryption.field_level_encryption_config.query_arg_profile_config.query_arg_profiles.items[0].query_arg #=> String
resp.field_level_encryption.field_level_encryption_config.query_arg_profile_config.query_arg_profiles.items[0].profile_id #=> String
resp.field_level_encryption.field_level_encryption_config.content_type_profile_config.forward_when_content_type_is_unknown #=> Boolean
resp.field_level_encryption.field_level_encryption_config.content_type_profile_config.content_type_profiles.quantity #=> Integer
resp.field_level_encryption.field_level_encryption_config.content_type_profile_config.content_type_profiles.items #=> Array
resp.field_level_encryption.field_level_encryption_config.content_type_profile_config.content_type_profiles.items[0].format #=> String, one of "URLEncoded"
resp.field_level_encryption.field_level_encryption_config.content_type_profile_config.content_type_profiles.items[0].profile_id #=> String
resp.field_level_encryption.field_level_encryption_config.content_type_profile_config.content_type_profiles.items[0].content_type #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

Request the ID for the field-level encryption configuration information.

Returns:

(Types::GetFieldLevelEncryptionResult) —
Returns a response object which responds to the following methods:
- #field_level_encryption => Types::FieldLevelEncryption
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 4441

def get_field_level_encryption(params = {}, options = {})
  req = build_request(:get_field_level_encryption, params)
  req.send_request(options)
end

#get_field_level_encryption_config(params = {}) ⇒ `Types::GetFieldLevelEncryptionConfigResult`

Get the field-level encryption configuration information.

Examples:

Request syntax with placeholder values


resp = client.get_field_level_encryption_config({
  id: "string", # required
})

Response structure


resp.field_level_encryption_config.caller_reference #=> String
resp.field_level_encryption_config.comment #=> String
resp.field_level_encryption_config.query_arg_profile_config.forward_when_query_arg_profile_is_unknown #=> Boolean
resp.field_level_encryption_config.query_arg_profile_config.query_arg_profiles.quantity #=> Integer
resp.field_level_encryption_config.query_arg_profile_config.query_arg_profiles.items #=> Array
resp.field_level_encryption_config.query_arg_profile_config.query_arg_profiles.items[0].query_arg #=> String
resp.field_level_encryption_config.query_arg_profile_config.query_arg_profiles.items[0].profile_id #=> String
resp.field_level_encryption_config.content_type_profile_config.forward_when_content_type_is_unknown #=> Boolean
resp.field_level_encryption_config.content_type_profile_config.content_type_profiles.quantity #=> Integer
resp.field_level_encryption_config.content_type_profile_config.content_type_profiles.items #=> Array
resp.field_level_encryption_config.content_type_profile_config.content_type_profiles.items[0].format #=> String, one of "URLEncoded"
resp.field_level_encryption_config.content_type_profile_config.content_type_profiles.items[0].profile_id #=> String
resp.field_level_encryption_config.content_type_profile_config.content_type_profiles.items[0].content_type #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

Request the ID for the field-level encryption configuration information.

Returns:

(Types::GetFieldLevelEncryptionConfigResult) —
Returns a response object which responds to the following methods:
- #field_level_encryption_config => Types::FieldLevelEncryptionConfig
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 4484

def get_field_level_encryption_config(params = {}, options = {})
  req = build_request(:get_field_level_encryption_config, params)
  req.send_request(options)
end

#get_field_level_encryption_profile(params = {}) ⇒ `Types::GetFieldLevelEncryptionProfileResult`

Get the field-level encryption profile information.

Examples:

Request syntax with placeholder values


resp = client.get_field_level_encryption_profile({
  id: "string", # required
})

Response structure


resp.field_level_encryption_profile.id #=> String
resp.field_level_encryption_profile.last_modified_time #=> Time
resp.field_level_encryption_profile.field_level_encryption_profile_config.name #=> String
resp.field_level_encryption_profile.field_level_encryption_profile_config.caller_reference #=> String
resp.field_level_encryption_profile.field_level_encryption_profile_config.comment #=> String
resp.field_level_encryption_profile.field_level_encryption_profile_config.encryption_entities.quantity #=> Integer
resp.field_level_encryption_profile.field_level_encryption_profile_config.encryption_entities.items #=> Array
resp.field_level_encryption_profile.field_level_encryption_profile_config.encryption_entities.items[0].public_key_id #=> String
resp.field_level_encryption_profile.field_level_encryption_profile_config.encryption_entities.items[0].provider_id #=> String
resp.field_level_encryption_profile.field_level_encryption_profile_config.encryption_entities.items[0].field_patterns.quantity #=> Integer
resp.field_level_encryption_profile.field_level_encryption_profile_config.encryption_entities.items[0].field_patterns.items #=> Array
resp.field_level_encryption_profile.field_level_encryption_profile_config.encryption_entities.items[0].field_patterns.items[0] #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

Get the ID for the field-level encryption profile information.

Returns:

(Types::GetFieldLevelEncryptionProfileResult) —
Returns a response object which responds to the following methods:
- #field_level_encryption_profile => Types::FieldLevelEncryptionProfile
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 4525

def get_field_level_encryption_profile(params = {}, options = {})
  req = build_request(:get_field_level_encryption_profile, params)
  req.send_request(options)
end

#get_field_level_encryption_profile_config(params = {}) ⇒ `Types::GetFieldLevelEncryptionProfileConfigResult`

Get the field-level encryption profile configuration information.

Examples:

Request syntax with placeholder values


resp = client.get_field_level_encryption_profile_config({
  id: "string", # required
})

Response structure


resp.field_level_encryption_profile_config.name #=> String
resp.field_level_encryption_profile_config.caller_reference #=> String
resp.field_level_encryption_profile_config.comment #=> String
resp.field_level_encryption_profile_config.encryption_entities.quantity #=> Integer
resp.field_level_encryption_profile_config.encryption_entities.items #=> Array
resp.field_level_encryption_profile_config.encryption_entities.items[0].public_key_id #=> String
resp.field_level_encryption_profile_config.encryption_entities.items[0].provider_id #=> String
resp.field_level_encryption_profile_config.encryption_entities.items[0].field_patterns.quantity #=> Integer
resp.field_level_encryption_profile_config.encryption_entities.items[0].field_patterns.items #=> Array
resp.field_level_encryption_profile_config.encryption_entities.items[0].field_patterns.items[0] #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

Get the ID for the field-level encryption profile configuration information.

Returns:

(Types::GetFieldLevelEncryptionProfileConfigResult) —
Returns a response object which responds to the following methods:
- #field_level_encryption_profile_config => Types::FieldLevelEncryptionProfileConfig
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 4565

def get_field_level_encryption_profile_config(params = {}, options = {})
  req = build_request(:get_field_level_encryption_profile_config, params)
  req.send_request(options)
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`.

Examples:

Request syntax with placeholder values


resp = client.get_function({
  name: "string", # required
  stage: "DEVELOPMENT", # accepts DEVELOPMENT, LIVE
})

Response structure


resp.function_code #=> String
resp.etag #=> String
resp.content_type #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:name (required, String) —

The name of the function whose code you are getting.
:stage (String) —

The function’s stage, either ‘DEVELOPMENT` or `LIVE`.

Returns:

(Types::GetFunctionResult) —
Returns a response object which responds to the following methods:
- #function_code => String
- #etag => String
- #content_type => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 4605

def get_function(params = {}, options = {})
  req = build_request(:get_function, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.get_invalidation({
  distribution_id: "string", # required
  id: "string", # required
})

Response structure


resp.invalidation.id #=> String
resp.invalidation.status #=> String
resp.invalidation.create_time #=> Time
resp.invalidation.invalidation_batch.paths.quantity #=> Integer
resp.invalidation.invalidation_batch.paths.items #=> Array
resp.invalidation.invalidation_batch.paths.items[0] #=> String
resp.invalidation.invalidation_batch.caller_reference #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:distribution_id (required, String) —

The distribution’s ID.
:id (required, String) —

The identifier for the invalidation request, for example, ‘IDFDVBD632BHDS5`.

Returns:

(Types::GetInvalidationResult) —
Returns a response object which responds to the following methods:
- #invalidation => Types::Invalidation

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 4649

def get_invalidation(params = {}, options = {})
  req = build_request(:get_invalidation, params)
  req.send_request(options)
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`.

Examples:

Request syntax with placeholder values


resp = client.get_key_group({
  id: "string", # required
})

Response structure


resp.key_group.id #=> String
resp.key_group.last_modified_time #=> Time
resp.key_group.key_group_config.name #=> String
resp.key_group.key_group_config.items #=> Array
resp.key_group.key_group_config.items[0] #=> String
resp.key_group.key_group_config.comment #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The identifier of the key group that you are getting. To get the identifier, use ‘ListKeyGroups`.

Returns:

(Types::GetKeyGroupResult) —
Returns a response object which responds to the following methods:
- #key_group => Types::KeyGroup
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 4692

def get_key_group(params = {}, options = {})
  req = build_request(:get_key_group, params)
  req.send_request(options)
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`.

Examples:

Request syntax with placeholder values


resp = client.get_key_group_config({
  id: "string", # required
})

Response structure


resp.key_group_config.name #=> String
resp.key_group_config.items #=> Array
resp.key_group_config.items[0] #=> String
resp.key_group_config.comment #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The identifier of the key group whose configuration you are getting. To get the identifier, use ‘ListKeyGroups`.

Returns:

(Types::GetKeyGroupConfigResult) —
Returns a response object which responds to the following methods:
- #key_group_config => Types::KeyGroupConfig
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 4733

def get_key_group_config(params = {}, options = {})
  req = build_request(:get_key_group_config, params)
  req.send_request(options)
end

#get_monitoring_subscription(params = {}) ⇒ `Types::GetMonitoringSubscriptionResult`

Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution.

Examples:

Request syntax with placeholder values


resp = client.get_monitoring_subscription({
  distribution_id: "string", # required
})

Response structure


resp.monitoring_subscription.realtime_metrics_subscription_config.realtime_metrics_subscription_status #=> String, one of "Enabled", "Disabled"

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:distribution_id (required, String) —

The ID of the distribution that you are getting metrics information for.

Returns:

(Types::GetMonitoringSubscriptionResult) —
Returns a response object which responds to the following methods:
- #monitoring_subscription => Types::MonitoringSubscription

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 4763

def get_monitoring_subscription(params = {}, options = {})
  req = build_request(:get_monitoring_subscription, params)
  req.send_request(options)
end

#get_origin_access_control(params = {}) ⇒ `Types::GetOriginAccessControlResult`

Gets a CloudFront origin access control, including its unique identifier.

Examples:

Request syntax with placeholder values


resp = client.get_origin_access_control({
  id: "string", # required
})

Response structure


resp.origin_access_control.id #=> String
resp.origin_access_control.origin_access_control_config.name #=> String
resp.origin_access_control.origin_access_control_config.description #=> String
resp.origin_access_control.origin_access_control_config.signing_protocol #=> String, one of "sigv4"
resp.origin_access_control.origin_access_control_config.signing_behavior #=> String, one of "never", "always", "no-override"
resp.origin_access_control.origin_access_control_config.origin_access_control_origin_type #=> String, one of "s3", "mediastore", "mediapackagev2", "lambda"
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The unique identifier of the origin access control.

Returns:

(Types::GetOriginAccessControlResult) —
Returns a response object which responds to the following methods:
- #origin_access_control => Types::OriginAccessControl
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 4799

def get_origin_access_control(params = {}, options = {})
  req = build_request(:get_origin_access_control, params)
  req.send_request(options)
end

#get_origin_access_control_config(params = {}) ⇒ `Types::GetOriginAccessControlConfigResult`

Gets a CloudFront origin access control configuration.

Examples:

Request syntax with placeholder values


resp = client.get_origin_access_control_config({
  id: "string", # required
})

Response structure


resp.origin_access_control_config.name #=> String
resp.origin_access_control_config.description #=> String
resp.origin_access_control_config.signing_protocol #=> String, one of "sigv4"
resp.origin_access_control_config.signing_behavior #=> String, one of "never", "always", "no-override"
resp.origin_access_control_config.origin_access_control_origin_type #=> String, one of "s3", "mediastore", "mediapackagev2", "lambda"
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The unique identifier of the origin access control.

Returns:

(Types::GetOriginAccessControlConfigResult) —
Returns a response object which responds to the following methods:
- #origin_access_control_config => Types::OriginAccessControlConfig
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 4833

def get_origin_access_control_config(params = {}, options = {})
  req = build_request(:get_origin_access_control_config, params)
  req.send_request(options)
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`.

Examples:

Request syntax with placeholder values


resp = client.get_origin_request_policy({
  id: "string", # required
})

Response structure


resp.origin_request_policy.id #=> String
resp.origin_request_policy.last_modified_time #=> Time
resp.origin_request_policy.origin_request_policy_config.comment #=> String
resp.origin_request_policy.origin_request_policy_config.name #=> String
resp.origin_request_policy.origin_request_policy_config.headers_config.header_behavior #=> String, one of "none", "whitelist", "allViewer", "allViewerAndWhitelistCloudFront", "allExcept"
resp.origin_request_policy.origin_request_policy_config.headers_config.headers.quantity #=> Integer
resp.origin_request_policy.origin_request_policy_config.headers_config.headers.items #=> Array
resp.origin_request_policy.origin_request_policy_config.headers_config.headers.items[0] #=> String
resp.origin_request_policy.origin_request_policy_config.cookies_config.cookie_behavior #=> String, one of "none", "whitelist", "all", "allExcept"
resp.origin_request_policy.origin_request_policy_config.cookies_config.cookies.quantity #=> Integer
resp.origin_request_policy.origin_request_policy_config.cookies_config.cookies.items #=> Array
resp.origin_request_policy.origin_request_policy_config.cookies_config.cookies.items[0] #=> String
resp.origin_request_policy.origin_request_policy_config.query_strings_config.query_string_behavior #=> String, one of "none", "whitelist", "all", "allExcept"
resp.origin_request_policy.origin_request_policy_config.query_strings_config.query_strings.quantity #=> Integer
resp.origin_request_policy.origin_request_policy_config.query_strings_config.query_strings.items #=> Array
resp.origin_request_policy.origin_request_policy_config.query_strings_config.query_strings.items[0] #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The unique identifier for the origin request policy. 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`.

Returns:

(Types::GetOriginRequestPolicyResult) —
Returns a response object which responds to the following methods:
- #origin_request_policy => Types::OriginRequestPolicy
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 4894

def get_origin_request_policy(params = {}, options = {})
  req = build_request(:get_origin_request_policy, params)
  req.send_request(options)
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`.

Examples:

Request syntax with placeholder values


resp = client.get_origin_request_policy_config({
  id: "string", # required
})

Response structure


resp.origin_request_policy_config.comment #=> String
resp.origin_request_policy_config.name #=> String
resp.origin_request_policy_config.headers_config.header_behavior #=> String, one of "none", "whitelist", "allViewer", "allViewerAndWhitelistCloudFront", "allExcept"
resp.origin_request_policy_config.headers_config.headers.quantity #=> Integer
resp.origin_request_policy_config.headers_config.headers.items #=> Array
resp.origin_request_policy_config.headers_config.headers.items[0] #=> String
resp.origin_request_policy_config.cookies_config.cookie_behavior #=> String, one of "none", "whitelist", "all", "allExcept"
resp.origin_request_policy_config.cookies_config.cookies.quantity #=> Integer
resp.origin_request_policy_config.cookies_config.cookies.items #=> Array
resp.origin_request_policy_config.cookies_config.cookies.items[0] #=> String
resp.origin_request_policy_config.query_strings_config.query_string_behavior #=> String, one of "none", "whitelist", "all", "allExcept"
resp.origin_request_policy_config.query_strings_config.query_strings.quantity #=> Integer
resp.origin_request_policy_config.query_strings_config.query_strings.items #=> Array
resp.origin_request_policy_config.query_strings_config.query_strings.items[0] #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The unique identifier for the origin request policy. 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`.

Returns:

(Types::GetOriginRequestPolicyConfigResult) —
Returns a response object which responds to the following methods:
- #origin_request_policy_config => Types::OriginRequestPolicyConfig
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 4949

def get_origin_request_policy_config(params = {}, options = {})
  req = build_request(:get_origin_request_policy_config, params)
  req.send_request(options)
end

#get_public_key(params = {}) ⇒ `Types::GetPublicKeyResult`

Gets a public key.

Examples:

Request syntax with placeholder values


resp = client.get_public_key({
  id: "string", # required
})

Response structure


resp.public_key.id #=> String
resp.public_key.created_time #=> Time
resp.public_key.public_key_config.caller_reference #=> String
resp.public_key.public_key_config.name #=> String
resp.public_key.public_key_config.encoded_key #=> String
resp.public_key.public_key_config.comment #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The identifier of the public key you are getting.

Returns:

(Types::GetPublicKeyResult) —
Returns a response object which responds to the following methods:
- #public_key => Types::PublicKey
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 4984

def get_public_key(params = {}, options = {})
  req = build_request(:get_public_key, params)
  req.send_request(options)
end

#get_public_key_config(params = {}) ⇒ `Types::GetPublicKeyConfigResult`

Gets a public key configuration.

Examples:

Request syntax with placeholder values


resp = client.get_public_key_config({
  id: "string", # required
})

Response structure


resp.public_key_config.caller_reference #=> String
resp.public_key_config.name #=> String
resp.public_key_config.encoded_key #=> String
resp.public_key_config.comment #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The identifier of the public key whose configuration you are getting.

Returns:

(Types::GetPublicKeyConfigResult) —
Returns a response object which responds to the following methods:
- #public_key_config => Types::PublicKeyConfig
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 5017

def get_public_key_config(params = {}, options = {})
  req = build_request(:get_public_key_config, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.get_realtime_log_config({
  name: "string",
  arn: "string",
})

Response structure


resp.realtime_log_config.arn #=> String
resp.realtime_log_config.name #=> String
resp.realtime_log_config.sampling_rate #=> Integer
resp.realtime_log_config.end_points #=> Array
resp.realtime_log_config.end_points[0].stream_type #=> String
resp.realtime_log_config.end_points[0].kinesis_stream_config.role_arn #=> String
resp.realtime_log_config.end_points[0].kinesis_stream_config.stream_arn #=> String
resp.realtime_log_config.fields #=> Array
resp.realtime_log_config.fields[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:name (String) —

The name of the real-time log configuration to get.
:arn (String) —

The Amazon Resource Name (ARN) of the real-time log configuration to get.

Returns:

(Types::GetRealtimeLogConfigResult) —
Returns a response object which responds to the following methods:
- #realtime_log_config => Types::RealtimeLogConfig

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 5063

def get_realtime_log_config(params = {}, options = {})
  req = build_request(:get_realtime_log_config, params)
  req.send_request(options)
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`.

Examples:

Request syntax with placeholder values


resp = client.get_response_headers_policy({
  id: "string", # required
})

Response structure


resp.response_headers_policy.id #=> String
resp.response_headers_policy.last_modified_time #=> Time
resp.response_headers_policy.response_headers_policy_config.comment #=> String
resp.response_headers_policy.response_headers_policy_config.name #=> String
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_origins.quantity #=> Integer
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_origins.items #=> Array
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_origins.items[0] #=> String
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_headers.quantity #=> Integer
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_headers.items #=> Array
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_headers.items[0] #=> String
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_methods.quantity #=> Integer
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_methods.items #=> Array
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_methods.items[0] #=> String, one of "GET", "POST", "OPTIONS", "PUT", "DELETE", "PATCH", "HEAD", "ALL"
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_credentials #=> Boolean
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_expose_headers.quantity #=> Integer
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_expose_headers.items #=> Array
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_expose_headers.items[0] #=> String
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_max_age_sec #=> Integer
resp.response_headers_policy.response_headers_policy_config.cors_config.origin_override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.xss_protection.override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.xss_protection.protection #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.xss_protection.mode_block #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.xss_protection.report_uri #=> String
resp.response_headers_policy.response_headers_policy_config.security_headers_config.frame_options.override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.frame_options.frame_option #=> String, one of "DENY", "SAMEORIGIN"
resp.response_headers_policy.response_headers_policy_config.security_headers_config.referrer_policy.override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.referrer_policy.referrer_policy #=> String, one of "no-referrer", "no-referrer-when-downgrade", "origin", "origin-when-cross-origin", "same-origin", "strict-origin", "strict-origin-when-cross-origin", "unsafe-url"
resp.response_headers_policy.response_headers_policy_config.security_headers_config.content_security_policy.override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.content_security_policy.content_security_policy #=> String
resp.response_headers_policy.response_headers_policy_config.security_headers_config.content_type_options.override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.strict_transport_security.override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.strict_transport_security.include_subdomains #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.strict_transport_security.preload #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.strict_transport_security.access_control_max_age_sec #=> Integer
resp.response_headers_policy.response_headers_policy_config.server_timing_headers_config.enabled #=> Boolean
resp.response_headers_policy.response_headers_policy_config.server_timing_headers_config.sampling_rate #=> Float
resp.response_headers_policy.response_headers_policy_config.custom_headers_config.quantity #=> Integer
resp.response_headers_policy.response_headers_policy_config.custom_headers_config.items #=> Array
resp.response_headers_policy.response_headers_policy_config.custom_headers_config.items[0].header #=> String
resp.response_headers_policy.response_headers_policy_config.custom_headers_config.items[0].value #=> String
resp.response_headers_policy.response_headers_policy_config.custom_headers_config.items[0].override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.remove_headers_config.quantity #=> Integer
resp.response_headers_policy.response_headers_policy_config.remove_headers_config.items #=> Array
resp.response_headers_policy.response_headers_policy_config.remove_headers_config.items[0].header #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The identifier for the response headers policy.

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`.

Returns:

(Types::GetResponseHeadersPolicyResult) —
Returns a response object which responds to the following methods:
- #response_headers_policy => Types::ResponseHeadersPolicy
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 5150

def get_response_headers_policy(params = {}, options = {})
  req = build_request(:get_response_headers_policy, params)
  req.send_request(options)
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`.

Examples:

Request syntax with placeholder values


resp = client.get_response_headers_policy_config({
  id: "string", # required
})

Response structure


resp.response_headers_policy_config.comment #=> String
resp.response_headers_policy_config.name #=> String
resp.response_headers_policy_config.cors_config.access_control_allow_origins.quantity #=> Integer
resp.response_headers_policy_config.cors_config.access_control_allow_origins.items #=> Array
resp.response_headers_policy_config.cors_config.access_control_allow_origins.items[0] #=> String
resp.response_headers_policy_config.cors_config.access_control_allow_headers.quantity #=> Integer
resp.response_headers_policy_config.cors_config.access_control_allow_headers.items #=> Array
resp.response_headers_policy_config.cors_config.access_control_allow_headers.items[0] #=> String
resp.response_headers_policy_config.cors_config.access_control_allow_methods.quantity #=> Integer
resp.response_headers_policy_config.cors_config.access_control_allow_methods.items #=> Array
resp.response_headers_policy_config.cors_config.access_control_allow_methods.items[0] #=> String, one of "GET", "POST", "OPTIONS", "PUT", "DELETE", "PATCH", "HEAD", "ALL"
resp.response_headers_policy_config.cors_config.access_control_allow_credentials #=> Boolean
resp.response_headers_policy_config.cors_config.access_control_expose_headers.quantity #=> Integer
resp.response_headers_policy_config.cors_config.access_control_expose_headers.items #=> Array
resp.response_headers_policy_config.cors_config.access_control_expose_headers.items[0] #=> String
resp.response_headers_policy_config.cors_config.access_control_max_age_sec #=> Integer
resp.response_headers_policy_config.cors_config.origin_override #=> Boolean
resp.response_headers_policy_config.security_headers_config.xss_protection.override #=> Boolean
resp.response_headers_policy_config.security_headers_config.xss_protection.protection #=> Boolean
resp.response_headers_policy_config.security_headers_config.xss_protection.mode_block #=> Boolean
resp.response_headers_policy_config.security_headers_config.xss_protection.report_uri #=> String
resp.response_headers_policy_config.security_headers_config.frame_options.override #=> Boolean
resp.response_headers_policy_config.security_headers_config.frame_options.frame_option #=> String, one of "DENY", "SAMEORIGIN"
resp.response_headers_policy_config.security_headers_config.referrer_policy.override #=> Boolean
resp.response_headers_policy_config.security_headers_config.referrer_policy.referrer_policy #=> String, one of "no-referrer", "no-referrer-when-downgrade", "origin", "origin-when-cross-origin", "same-origin", "strict-origin", "strict-origin-when-cross-origin", "unsafe-url"
resp.response_headers_policy_config.security_headers_config.content_security_policy.override #=> Boolean
resp.response_headers_policy_config.security_headers_config.content_security_policy.content_security_policy #=> String
resp.response_headers_policy_config.security_headers_config.content_type_options.override #=> Boolean
resp.response_headers_policy_config.security_headers_config.strict_transport_security.override #=> Boolean
resp.response_headers_policy_config.security_headers_config.strict_transport_security.include_subdomains #=> Boolean
resp.response_headers_policy_config.security_headers_config.strict_transport_security.preload #=> Boolean
resp.response_headers_policy_config.security_headers_config.strict_transport_security.access_control_max_age_sec #=> Integer
resp.response_headers_policy_config.server_timing_headers_config.enabled #=> Boolean
resp.response_headers_policy_config.server_timing_headers_config.sampling_rate #=> Float
resp.response_headers_policy_config.custom_headers_config.quantity #=> Integer
resp.response_headers_policy_config.custom_headers_config.items #=> Array
resp.response_headers_policy_config.custom_headers_config.items[0].header #=> String
resp.response_headers_policy_config.custom_headers_config.items[0].value #=> String
resp.response_headers_policy_config.custom_headers_config.items[0].override #=> Boolean
resp.response_headers_policy_config.remove_headers_config.quantity #=> Integer
resp.response_headers_policy_config.remove_headers_config.items #=> Array
resp.response_headers_policy_config.remove_headers_config.items[0].header #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The identifier for the response headers policy.

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`.

Returns:

(Types::GetResponseHeadersPolicyConfigResult) —
Returns a response object which responds to the following methods:
- #response_headers_policy_config => Types::ResponseHeadersPolicyConfig
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 5234

def get_response_headers_policy_config(params = {}, options = {})
  req = build_request(:get_response_headers_policy_config, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.get_streaming_distribution({
  id: "string", # required
})

Response structure


resp.streaming_distribution.id #=> String
resp.streaming_distribution.arn #=> String
resp.streaming_distribution.status #=> String
resp.streaming_distribution.last_modified_time #=> Time
resp.streaming_distribution.domain_name #=> String
resp.streaming_distribution.active_trusted_signers.enabled #=> Boolean
resp.streaming_distribution.active_trusted_signers.quantity #=> Integer
resp.streaming_distribution.active_trusted_signers.items #=> Array
resp.streaming_distribution.active_trusted_signers.items[0].aws_account_number #=> String
resp.streaming_distribution.active_trusted_signers.items[0].key_pair_ids.quantity #=> Integer
resp.streaming_distribution.active_trusted_signers.items[0].key_pair_ids.items #=> Array
resp.streaming_distribution.active_trusted_signers.items[0].key_pair_ids.items[0] #=> String
resp.streaming_distribution.streaming_distribution_config.caller_reference #=> String
resp.streaming_distribution.streaming_distribution_config.s3_origin.domain_name #=> String
resp.streaming_distribution.streaming_distribution_config.s3_origin.origin_access_identity #=> String
resp.streaming_distribution.streaming_distribution_config.aliases.quantity #=> Integer
resp.streaming_distribution.streaming_distribution_config.aliases.items #=> Array
resp.streaming_distribution.streaming_distribution_config.aliases.items[0] #=> String
resp.streaming_distribution.streaming_distribution_config.comment #=> String
resp.streaming_distribution.streaming_distribution_config.logging.enabled #=> Boolean
resp.streaming_distribution.streaming_distribution_config.logging.bucket #=> String
resp.streaming_distribution.streaming_distribution_config.logging.prefix #=> String
resp.streaming_distribution.streaming_distribution_config.trusted_signers.enabled #=> Boolean
resp.streaming_distribution.streaming_distribution_config.trusted_signers.quantity #=> Integer
resp.streaming_distribution.streaming_distribution_config.trusted_signers.items #=> Array
resp.streaming_distribution.streaming_distribution_config.trusted_signers.items[0] #=> String
resp.streaming_distribution.streaming_distribution_config.price_class #=> String, one of "PriceClass_100", "PriceClass_200", "PriceClass_All"
resp.streaming_distribution.streaming_distribution_config.enabled #=> Boolean
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The streaming distribution’s ID.

Returns:

(Types::GetStreamingDistributionResult) —
Returns a response object which responds to the following methods:
- #streaming_distribution => Types::StreamingDistribution
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 5297

def get_streaming_distribution(params = {}, options = {})
  req = build_request(:get_streaming_distribution, params)
  req.send_request(options)
end

#get_streaming_distribution_config(params = {}) ⇒ `Types::GetStreamingDistributionConfigResult`

Get the configuration information about a streaming distribution.

Examples:

Request syntax with placeholder values


resp = client.get_streaming_distribution_config({
  id: "string", # required
})

Response structure


resp.streaming_distribution_config.caller_reference #=> String
resp.streaming_distribution_config.s3_origin.domain_name #=> String
resp.streaming_distribution_config.s3_origin.origin_access_identity #=> String
resp.streaming_distribution_config.aliases.quantity #=> Integer
resp.streaming_distribution_config.aliases.items #=> Array
resp.streaming_distribution_config.aliases.items[0] #=> String
resp.streaming_distribution_config.comment #=> String
resp.streaming_distribution_config.logging.enabled #=> Boolean
resp.streaming_distribution_config.logging.bucket #=> String
resp.streaming_distribution_config.logging.prefix #=> String
resp.streaming_distribution_config.trusted_signers.enabled #=> Boolean
resp.streaming_distribution_config.trusted_signers.quantity #=> Integer
resp.streaming_distribution_config.trusted_signers.items #=> Array
resp.streaming_distribution_config.trusted_signers.items[0] #=> String
resp.streaming_distribution_config.price_class #=> String, one of "PriceClass_100", "PriceClass_200", "PriceClass_All"
resp.streaming_distribution_config.enabled #=> Boolean
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The streaming distribution’s ID.

Returns:

(Types::GetStreamingDistributionConfigResult) —
Returns a response object which responds to the following methods:
- #streaming_distribution_config => Types::StreamingDistributionConfig
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 5342

def get_streaming_distribution_config(params = {}, options = {})
  req = build_request(:get_streaming_distribution_config, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_cache_policies({
  type: "managed", # accepts managed, custom
  marker: "string",
  max_items: 1,
})

Response structure


resp.cache_policy_list.next_marker #=> String
resp.cache_policy_list.max_items #=> Integer
resp.cache_policy_list.quantity #=> Integer
resp.cache_policy_list.items #=> Array
resp.cache_policy_list.items[0].type #=> String, one of "managed", "custom"
resp.cache_policy_list.items[0].cache_policy.id #=> String
resp.cache_policy_list.items[0].cache_policy.last_modified_time #=> Time
resp.cache_policy_list.items[0].cache_policy.cache_policy_config.comment #=> String
resp.cache_policy_list.items[0].cache_policy.cache_policy_config.name #=> String
resp.cache_policy_list.items[0].cache_policy.cache_policy_config.default_ttl #=> Integer
resp.cache_policy_list.items[0].cache_policy.cache_policy_config.max_ttl #=> Integer
resp.cache_policy_list.items[0].cache_policy.cache_policy_config.min_ttl #=> Integer
resp.cache_policy_list.items[0].cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.enable_accept_encoding_gzip #=> Boolean
resp.cache_policy_list.items[0].cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.enable_accept_encoding_brotli #=> Boolean
resp.cache_policy_list.items[0].cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.headers_config.header_behavior #=> String, one of "none", "whitelist"
resp.cache_policy_list.items[0].cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.headers_config.headers.quantity #=> Integer
resp.cache_policy_list.items[0].cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.headers_config.headers.items #=> Array
resp.cache_policy_list.items[0].cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.headers_config.headers.items[0] #=> String
resp.cache_policy_list.items[0].cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookie_behavior #=> String, one of "none", "whitelist", "allExcept", "all"
resp.cache_policy_list.items[0].cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookies.quantity #=> Integer
resp.cache_policy_list.items[0].cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookies.items #=> Array
resp.cache_policy_list.items[0].cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookies.items[0] #=> String
resp.cache_policy_list.items[0].cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_string_behavior #=> String, one of "none", "whitelist", "allExcept", "all"
resp.cache_policy_list.items[0].cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_strings.quantity #=> Integer
resp.cache_policy_list.items[0].cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_strings.items #=> Array
resp.cache_policy_list.items[0].cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_strings.items[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:type (String) —
A filter to return only the specified kinds of cache policies. Valid values are:
- ‘managed` – Returns only the managed policies created by Amazon Web Services.
- ‘custom` – Returns only the custom policies created in your Amazon Web Services account.
:marker (String) —

Use this field when paginating results to indicate where to begin in your list of cache policies. The response includes cache policies in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of ‘NextMarker` from the current page’s response.
:max_items (Integer) —

The maximum number of cache policies that you want in the response.

Returns:

(Types::ListCachePoliciesResult) —
Returns a response object which responds to the following methods:
- #cache_policy_list => Types::CachePolicyList

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 5425

def list_cache_policies(params = {}, options = {})
  req = build_request(:list_cache_policies, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_cloud_front_origin_access_identities({
  marker: "string",
  max_items: 1,
})

Response structure


resp.cloud_front_origin_access_identity_list.marker #=> String
resp.cloud_front_origin_access_identity_list.next_marker #=> String
resp.cloud_front_origin_access_identity_list.max_items #=> Integer
resp.cloud_front_origin_access_identity_list.is_truncated #=> Boolean
resp.cloud_front_origin_access_identity_list.quantity #=> Integer
resp.cloud_front_origin_access_identity_list.items #=> Array
resp.cloud_front_origin_access_identity_list.items[0].id #=> String
resp.cloud_front_origin_access_identity_list.items[0].s3_canonical_user_id #=> String
resp.cloud_front_origin_access_identity_list.items[0].comment #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:marker (String) —

Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the ‘Marker` to the value of the `NextMarker` from the current page’s response (which is also the ID of the last identity on that page).
:max_items (Integer) —

The maximum number of origin access identities you want in the response body.

Returns:

(Types::ListCloudFrontOriginAccessIdentitiesResult) —
Returns a response object which responds to the following methods:
- #cloud_front_origin_access_identity_list => Types::CloudFrontOriginAccessIdentityList

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 5473

def list_cloud_front_origin_access_identities(params = {}, options = {})
  req = build_request(:list_cloud_front_origin_access_identities, params)
  req.send_request(options)
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*.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html#alternate-domain-names-move

Examples:

Request syntax with placeholder values


resp = client.list_conflicting_aliases({
  distribution_id: "distributionIdString", # required
  alias: "aliasString", # required
  marker: "string",
  max_items: 1,
})

Response structure


resp.conflicting_aliases_list.next_marker #=> String
resp.conflicting_aliases_list.max_items #=> Integer
resp.conflicting_aliases_list.quantity #=> Integer
resp.conflicting_aliases_list.items #=> Array
resp.conflicting_aliases_list.items[0].alias #=> String
resp.conflicting_aliases_list.items[0].distribution_id #=> String
resp.conflicting_aliases_list.items[0].account_id #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:distribution_id (required, String) —

The ID of a distribution in your account that has an attached SSL/TLS certificate that includes the provided alias.
:alias (required, String) —

The alias (also called a CNAME) to search for conflicting aliases.
:marker (String) —

Use this field when paginating results to indicate where to begin in the list of conflicting aliases. The response includes conflicting aliases in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of ‘NextMarker` from the current page’s response.
:max_items (Integer) —

The maximum number of conflicting aliases that you want in the response.

Returns:

(Types::ListConflictingAliasesResult) —
Returns a response object which responds to the following methods:
- #conflicting_aliases_list => Types::ConflictingAliasesList

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 5558

def list_conflicting_aliases(params = {}, options = {})
  req = build_request(:list_conflicting_aliases, params)
  req.send_request(options)
end

#list_continuous_deployment_policies(params = {}) ⇒ `Types::ListContinuousDeploymentPoliciesResult`

Gets a list of the continuous deployment policies in your Amazon Web Services account.

Examples:

Request syntax with placeholder values


resp = client.list_continuous_deployment_policies({
  marker: "string",
  max_items: 1,
})

Response structure


resp.continuous_deployment_policy_list.next_marker #=> String
resp.continuous_deployment_policy_list.max_items #=> Integer
resp.continuous_deployment_policy_list.quantity #=> Integer
resp.continuous_deployment_policy_list.items #=> Array
resp.continuous_deployment_policy_list.items[0].continuous_deployment_policy.id #=> String
resp.continuous_deployment_policy_list.items[0].continuous_deployment_policy.last_modified_time #=> Time
resp.continuous_deployment_policy_list.items[0].continuous_deployment_policy.continuous_deployment_policy_config.staging_distribution_dns_names.quantity #=> Integer
resp.continuous_deployment_policy_list.items[0].continuous_deployment_policy.continuous_deployment_policy_config.staging_distribution_dns_names.items #=> Array
resp.continuous_deployment_policy_list.items[0].continuous_deployment_policy.continuous_deployment_policy_config.staging_distribution_dns_names.items[0] #=> String
resp.continuous_deployment_policy_list.items[0].continuous_deployment_policy.continuous_deployment_policy_config.enabled #=> Boolean
resp.continuous_deployment_policy_list.items[0].continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.single_weight_config.weight #=> Float
resp.continuous_deployment_policy_list.items[0].continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.single_weight_config.session_stickiness_config.idle_ttl #=> Integer
resp.continuous_deployment_policy_list.items[0].continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.single_weight_config.session_stickiness_config.maximum_ttl #=> Integer
resp.continuous_deployment_policy_list.items[0].continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.single_header_config.header #=> String
resp.continuous_deployment_policy_list.items[0].continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.single_header_config.value #=> String
resp.continuous_deployment_policy_list.items[0].continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.type #=> String, one of "SingleWeight", "SingleHeader"

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:marker (String) —

Use this field when paginating results to indicate where to begin in your list of continuous deployment policies. The response includes policies in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of ‘NextMarker` from the current page’s response.
:max_items (Integer) —

The maximum number of continuous deployment policies that you want returned in the response.

Returns:

(Types::ListContinuousDeploymentPoliciesResult) —
Returns a response object which responds to the following methods:
- #continuous_deployment_policy_list => Types::ContinuousDeploymentPolicyList

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 5618

def list_continuous_deployment_policies(params = {}, options = {})
  req = build_request(:list_continuous_deployment_policies, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_distributions({
  marker: "string",
  max_items: 1,
})

Response structure


resp.distribution_list.marker #=> String
resp.distribution_list.next_marker #=> String
resp.distribution_list.max_items #=> Integer
resp.distribution_list.is_truncated #=> Boolean
resp.distribution_list.quantity #=> Integer
resp.distribution_list.items #=> Array
resp.distribution_list.items[0].id #=> String
resp.distribution_list.items[0].arn #=> String
resp.distribution_list.items[0].status #=> String
resp.distribution_list.items[0].last_modified_time #=> Time
resp.distribution_list.items[0].domain_name #=> String
resp.distribution_list.items[0].aliases.quantity #=> Integer
resp.distribution_list.items[0].aliases.items #=> Array
resp.distribution_list.items[0].aliases.items[0] #=> String
resp.distribution_list.items[0].origins.quantity #=> Integer
resp.distribution_list.items[0].origins.items #=> Array
resp.distribution_list.items[0].origins.items[0].id #=> String
resp.distribution_list.items[0].origins.items[0].domain_name #=> String
resp.distribution_list.items[0].origins.items[0].origin_path #=> String
resp.distribution_list.items[0].origins.items[0].custom_headers.quantity #=> Integer
resp.distribution_list.items[0].origins.items[0].custom_headers.items #=> Array
resp.distribution_list.items[0].origins.items[0].custom_headers.items[0].header_name #=> String
resp.distribution_list.items[0].origins.items[0].custom_headers.items[0].header_value #=> String
resp.distribution_list.items[0].origins.items[0].s3_origin_config.origin_access_identity #=> String
resp.distribution_list.items[0].origins.items[0].custom_origin_config.http_port #=> Integer
resp.distribution_list.items[0].origins.items[0].custom_origin_config.https_port #=> Integer
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_protocol_policy #=> String, one of "http-only", "match-viewer", "https-only"
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_ssl_protocols.quantity #=> Integer
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_ssl_protocols.items #=> Array
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_ssl_protocols.items[0] #=> String, one of "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2"
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_read_timeout #=> Integer
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_keepalive_timeout #=> Integer
resp.distribution_list.items[0].origins.items[0].connection_attempts #=> Integer
resp.distribution_list.items[0].origins.items[0].connection_timeout #=> Integer
resp.distribution_list.items[0].origins.items[0].origin_shield.enabled #=> Boolean
resp.distribution_list.items[0].origins.items[0].origin_shield.origin_shield_region #=> String
resp.distribution_list.items[0].origins.items[0].origin_access_control_id #=> String
resp.distribution_list.items[0].origin_groups.quantity #=> Integer
resp.distribution_list.items[0].origin_groups.items #=> Array
resp.distribution_list.items[0].origin_groups.items[0].id #=> String
resp.distribution_list.items[0].origin_groups.items[0].failover_criteria.status_codes.quantity #=> Integer
resp.distribution_list.items[0].origin_groups.items[0].failover_criteria.status_codes.items #=> Array
resp.distribution_list.items[0].origin_groups.items[0].failover_criteria.status_codes.items[0] #=> Integer
resp.distribution_list.items[0].origin_groups.items[0].members.quantity #=> Integer
resp.distribution_list.items[0].origin_groups.items[0].members.items #=> Array
resp.distribution_list.items[0].origin_groups.items[0].members.items[0].origin_id #=> String
resp.distribution_list.items[0].default_cache_behavior.target_origin_id #=> String
resp.distribution_list.items[0].default_cache_behavior.trusted_signers.enabled #=> Boolean
resp.distribution_list.items[0].default_cache_behavior.trusted_signers.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.trusted_signers.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.trusted_signers.items[0] #=> String
resp.distribution_list.items[0].default_cache_behavior.trusted_key_groups.enabled #=> Boolean
resp.distribution_list.items[0].default_cache_behavior.trusted_key_groups.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.trusted_key_groups.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.trusted_key_groups.items[0] #=> String
resp.distribution_list.items[0].default_cache_behavior.viewer_protocol_policy #=> String, one of "allow-all", "https-only", "redirect-to-https"
resp.distribution_list.items[0].default_cache_behavior.allowed_methods.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.allowed_methods.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.allowed_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution_list.items[0].default_cache_behavior.allowed_methods.cached_methods.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.allowed_methods.cached_methods.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.allowed_methods.cached_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution_list.items[0].default_cache_behavior.smooth_streaming #=> Boolean
resp.distribution_list.items[0].default_cache_behavior.compress #=> Boolean
resp.distribution_list.items[0].default_cache_behavior.lambda_function_associations.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.lambda_function_associations.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.lambda_function_associations.items[0].lambda_function_arn #=> String
resp.distribution_list.items[0].default_cache_behavior.lambda_function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution_list.items[0].default_cache_behavior.lambda_function_associations.items[0].include_body #=> Boolean
resp.distribution_list.items[0].default_cache_behavior.function_associations.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.function_associations.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.function_associations.items[0].function_arn #=> String
resp.distribution_list.items[0].default_cache_behavior.function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution_list.items[0].default_cache_behavior.field_level_encryption_id #=> String
resp.distribution_list.items[0].default_cache_behavior.realtime_log_config_arn #=> String
resp.distribution_list.items[0].default_cache_behavior.cache_policy_id #=> String
resp.distribution_list.items[0].default_cache_behavior.origin_request_policy_id #=> String
resp.distribution_list.items[0].default_cache_behavior.response_headers_policy_id #=> String
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.query_string #=> Boolean
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.cookies.forward #=> String, one of "none", "whitelist", "all"
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.cookies.whitelisted_names.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.cookies.whitelisted_names.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.cookies.whitelisted_names.items[0] #=> String
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.headers.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.headers.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.headers.items[0] #=> String
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.query_string_cache_keys.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.query_string_cache_keys.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.query_string_cache_keys.items[0] #=> String
resp.distribution_list.items[0].default_cache_behavior.min_ttl #=> Integer
resp.distribution_list.items[0].default_cache_behavior.default_ttl #=> Integer
resp.distribution_list.items[0].default_cache_behavior.max_ttl #=> Integer
resp.distribution_list.items[0].cache_behaviors.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].path_pattern #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].target_origin_id #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_signers.enabled #=> Boolean
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_signers.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_signers.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_signers.items[0] #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_key_groups.enabled #=> Boolean
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_key_groups.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_key_groups.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_key_groups.items[0] #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].viewer_protocol_policy #=> String, one of "allow-all", "https-only", "redirect-to-https"
resp.distribution_list.items[0].cache_behaviors.items[0].allowed_methods.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].allowed_methods.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].allowed_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution_list.items[0].cache_behaviors.items[0].allowed_methods.cached_methods.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].allowed_methods.cached_methods.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].allowed_methods.cached_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution_list.items[0].cache_behaviors.items[0].smooth_streaming #=> Boolean
resp.distribution_list.items[0].cache_behaviors.items[0].compress #=> Boolean
resp.distribution_list.items[0].cache_behaviors.items[0].lambda_function_associations.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].lambda_function_associations.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].lambda_function_associations.items[0].lambda_function_arn #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].lambda_function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution_list.items[0].cache_behaviors.items[0].lambda_function_associations.items[0].include_body #=> Boolean
resp.distribution_list.items[0].cache_behaviors.items[0].function_associations.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].function_associations.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].function_associations.items[0].function_arn #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution_list.items[0].cache_behaviors.items[0].field_level_encryption_id #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].realtime_log_config_arn #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].cache_policy_id #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].origin_request_policy_id #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].response_headers_policy_id #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.query_string #=> Boolean
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.cookies.forward #=> String, one of "none", "whitelist", "all"
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.items[0] #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.headers.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.headers.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.headers.items[0] #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.query_string_cache_keys.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.query_string_cache_keys.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.query_string_cache_keys.items[0] #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].min_ttl #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].default_ttl #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].max_ttl #=> Integer
resp.distribution_list.items[0].custom_error_responses.quantity #=> Integer
resp.distribution_list.items[0].custom_error_responses.items #=> Array
resp.distribution_list.items[0].custom_error_responses.items[0].error_code #=> Integer
resp.distribution_list.items[0].custom_error_responses.items[0].response_page_path #=> String
resp.distribution_list.items[0].custom_error_responses.items[0].response_code #=> String
resp.distribution_list.items[0].custom_error_responses.items[0].error_caching_min_ttl #=> Integer
resp.distribution_list.items[0].comment #=> String
resp.distribution_list.items[0].price_class #=> String, one of "PriceClass_100", "PriceClass_200", "PriceClass_All"
resp.distribution_list.items[0].enabled #=> Boolean
resp.distribution_list.items[0].viewer_certificate.cloud_front_default_certificate #=> Boolean
resp.distribution_list.items[0].viewer_certificate.iam_certificate_id #=> String
resp.distribution_list.items[0].viewer_certificate.acm_certificate_arn #=> String
resp.distribution_list.items[0].viewer_certificate.ssl_support_method #=> String, one of "sni-only", "vip", "static-ip"
resp.distribution_list.items[0].viewer_certificate.minimum_protocol_version #=> String, one of "SSLv3", "TLSv1", "TLSv1_2016", "TLSv1.1_2016", "TLSv1.2_2018", "TLSv1.2_2019", "TLSv1.2_2021"
resp.distribution_list.items[0].viewer_certificate.certificate #=> String
resp.distribution_list.items[0].viewer_certificate.certificate_source #=> String, one of "cloudfront", "iam", "acm"
resp.distribution_list.items[0].restrictions.geo_restriction.restriction_type #=> String, one of "blacklist", "whitelist", "none"
resp.distribution_list.items[0].restrictions.geo_restriction.quantity #=> Integer
resp.distribution_list.items[0].restrictions.geo_restriction.items #=> Array
resp.distribution_list.items[0].restrictions.geo_restriction.items[0] #=> String
resp.distribution_list.items[0].web_acl_id #=> String
resp.distribution_list.items[0].http_version #=> String, one of "http1.1", "http2", "http3", "http2and3"
resp.distribution_list.items[0].is_ipv6_enabled #=> Boolean
resp.distribution_list.items[0].alias_icp_recordals #=> Array
resp.distribution_list.items[0].alias_icp_recordals[0].cname #=> String
resp.distribution_list.items[0].alias_icp_recordals[0].icp_recordal_status #=> String, one of "APPROVED", "SUSPENDED", "PENDING"
resp.distribution_list.items[0].staging #=> Boolean

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:marker (String) —

Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the ‘Marker` to the value of the `NextMarker` from the current page’s response (which is also the ID of the last distribution on that page).
:max_items (Integer) —

The maximum number of distributions you want in the response body.

Returns:

(Types::ListDistributionsResult) —
Returns a response object which responds to the following methods:
- #distribution_list => Types::DistributionList

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 5823

def list_distributions(params = {}, options = {})
  req = build_request(:list_distributions, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_distributions_by_cache_policy_id({
  marker: "string",
  max_items: 1,
  cache_policy_id: "string", # required
})

Response structure


resp.distribution_id_list.marker #=> String
resp.distribution_id_list.next_marker #=> String
resp.distribution_id_list.max_items #=> Integer
resp.distribution_id_list.is_truncated #=> Boolean
resp.distribution_id_list.quantity #=> Integer
resp.distribution_id_list.items #=> Array
resp.distribution_id_list.items[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:marker (String) —

Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of ‘NextMarker` from the current page’s response.
:max_items (Integer) —

The maximum number of distribution IDs that you want in the response.
:cache_policy_id (required, String) —

The ID of the cache policy whose associated distribution IDs you want to list.

Returns:

(Types::ListDistributionsByCachePolicyIdResult) —
Returns a response object which responds to the following methods:
- #distribution_id_list => Types::DistributionIdList

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 5878

def list_distributions_by_cache_policy_id(params = {}, options = {})
  req = build_request(:list_distributions_by_cache_policy_id, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_distributions_by_key_group({
  marker: "string",
  max_items: 1,
  key_group_id: "string", # required
})

Response structure


resp.distribution_id_list.marker #=> String
resp.distribution_id_list.next_marker #=> String
resp.distribution_id_list.max_items #=> Integer
resp.distribution_id_list.is_truncated #=> Boolean
resp.distribution_id_list.quantity #=> Integer
resp.distribution_id_list.items #=> Array
resp.distribution_id_list.items[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:marker (String) —

Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of ‘NextMarker` from the current page’s response.
:max_items (Integer) —

The maximum number of distribution IDs that you want in the response.
:key_group_id (required, String) —

The ID of the key group whose associated distribution IDs you are listing.

Returns:

(Types::ListDistributionsByKeyGroupResult) —
Returns a response object which responds to the following methods:
- #distribution_id_list => Types::DistributionIdList

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 5933

def list_distributions_by_key_group(params = {}, options = {})
  req = build_request(:list_distributions_by_key_group, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_distributions_by_origin_request_policy_id({
  marker: "string",
  max_items: 1,
  origin_request_policy_id: "string", # required
})

Response structure


resp.distribution_id_list.marker #=> String
resp.distribution_id_list.next_marker #=> String
resp.distribution_id_list.max_items #=> Integer
resp.distribution_id_list.is_truncated #=> Boolean
resp.distribution_id_list.quantity #=> Integer
resp.distribution_id_list.items #=> Array
resp.distribution_id_list.items[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:marker (String) —

Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of ‘NextMarker` from the current page’s response.
:max_items (Integer) —

The maximum number of distribution IDs that you want in the response.
:origin_request_policy_id (required, String) —

The ID of the origin request policy whose associated distribution IDs you want to list.

Returns:

(Types::ListDistributionsByOriginRequestPolicyIdResult) —
Returns a response object which responds to the following methods:
- #distribution_id_list => Types::DistributionIdList

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 5988

def list_distributions_by_origin_request_policy_id(params = {}, options = {})
  req = build_request(:list_distributions_by_origin_request_policy_id, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_distributions_by_realtime_log_config({
  marker: "string",
  max_items: 1,
  realtime_log_config_name: "string",
  realtime_log_config_arn: "string",
})

Response structure


resp.distribution_list.marker #=> String
resp.distribution_list.next_marker #=> String
resp.distribution_list.max_items #=> Integer
resp.distribution_list.is_truncated #=> Boolean
resp.distribution_list.quantity #=> Integer
resp.distribution_list.items #=> Array
resp.distribution_list.items[0].id #=> String
resp.distribution_list.items[0].arn #=> String
resp.distribution_list.items[0].status #=> String
resp.distribution_list.items[0].last_modified_time #=> Time
resp.distribution_list.items[0].domain_name #=> String
resp.distribution_list.items[0].aliases.quantity #=> Integer
resp.distribution_list.items[0].aliases.items #=> Array
resp.distribution_list.items[0].aliases.items[0] #=> String
resp.distribution_list.items[0].origins.quantity #=> Integer
resp.distribution_list.items[0].origins.items #=> Array
resp.distribution_list.items[0].origins.items[0].id #=> String
resp.distribution_list.items[0].origins.items[0].domain_name #=> String
resp.distribution_list.items[0].origins.items[0].origin_path #=> String
resp.distribution_list.items[0].origins.items[0].custom_headers.quantity #=> Integer
resp.distribution_list.items[0].origins.items[0].custom_headers.items #=> Array
resp.distribution_list.items[0].origins.items[0].custom_headers.items[0].header_name #=> String
resp.distribution_list.items[0].origins.items[0].custom_headers.items[0].header_value #=> String
resp.distribution_list.items[0].origins.items[0].s3_origin_config.origin_access_identity #=> String
resp.distribution_list.items[0].origins.items[0].custom_origin_config.http_port #=> Integer
resp.distribution_list.items[0].origins.items[0].custom_origin_config.https_port #=> Integer
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_protocol_policy #=> String, one of "http-only", "match-viewer", "https-only"
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_ssl_protocols.quantity #=> Integer
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_ssl_protocols.items #=> Array
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_ssl_protocols.items[0] #=> String, one of "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2"
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_read_timeout #=> Integer
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_keepalive_timeout #=> Integer
resp.distribution_list.items[0].origins.items[0].connection_attempts #=> Integer
resp.distribution_list.items[0].origins.items[0].connection_timeout #=> Integer
resp.distribution_list.items[0].origins.items[0].origin_shield.enabled #=> Boolean
resp.distribution_list.items[0].origins.items[0].origin_shield.origin_shield_region #=> String
resp.distribution_list.items[0].origins.items[0].origin_access_control_id #=> String
resp.distribution_list.items[0].origin_groups.quantity #=> Integer
resp.distribution_list.items[0].origin_groups.items #=> Array
resp.distribution_list.items[0].origin_groups.items[0].id #=> String
resp.distribution_list.items[0].origin_groups.items[0].failover_criteria.status_codes.quantity #=> Integer
resp.distribution_list.items[0].origin_groups.items[0].failover_criteria.status_codes.items #=> Array
resp.distribution_list.items[0].origin_groups.items[0].failover_criteria.status_codes.items[0] #=> Integer
resp.distribution_list.items[0].origin_groups.items[0].members.quantity #=> Integer
resp.distribution_list.items[0].origin_groups.items[0].members.items #=> Array
resp.distribution_list.items[0].origin_groups.items[0].members.items[0].origin_id #=> String
resp.distribution_list.items[0].default_cache_behavior.target_origin_id #=> String
resp.distribution_list.items[0].default_cache_behavior.trusted_signers.enabled #=> Boolean
resp.distribution_list.items[0].default_cache_behavior.trusted_signers.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.trusted_signers.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.trusted_signers.items[0] #=> String
resp.distribution_list.items[0].default_cache_behavior.trusted_key_groups.enabled #=> Boolean
resp.distribution_list.items[0].default_cache_behavior.trusted_key_groups.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.trusted_key_groups.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.trusted_key_groups.items[0] #=> String
resp.distribution_list.items[0].default_cache_behavior.viewer_protocol_policy #=> String, one of "allow-all", "https-only", "redirect-to-https"
resp.distribution_list.items[0].default_cache_behavior.allowed_methods.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.allowed_methods.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.allowed_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution_list.items[0].default_cache_behavior.allowed_methods.cached_methods.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.allowed_methods.cached_methods.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.allowed_methods.cached_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution_list.items[0].default_cache_behavior.smooth_streaming #=> Boolean
resp.distribution_list.items[0].default_cache_behavior.compress #=> Boolean
resp.distribution_list.items[0].default_cache_behavior.lambda_function_associations.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.lambda_function_associations.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.lambda_function_associations.items[0].lambda_function_arn #=> String
resp.distribution_list.items[0].default_cache_behavior.lambda_function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution_list.items[0].default_cache_behavior.lambda_function_associations.items[0].include_body #=> Boolean
resp.distribution_list.items[0].default_cache_behavior.function_associations.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.function_associations.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.function_associations.items[0].function_arn #=> String
resp.distribution_list.items[0].default_cache_behavior.function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution_list.items[0].default_cache_behavior.field_level_encryption_id #=> String
resp.distribution_list.items[0].default_cache_behavior.realtime_log_config_arn #=> String
resp.distribution_list.items[0].default_cache_behavior.cache_policy_id #=> String
resp.distribution_list.items[0].default_cache_behavior.origin_request_policy_id #=> String
resp.distribution_list.items[0].default_cache_behavior.response_headers_policy_id #=> String
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.query_string #=> Boolean
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.cookies.forward #=> String, one of "none", "whitelist", "all"
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.cookies.whitelisted_names.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.cookies.whitelisted_names.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.cookies.whitelisted_names.items[0] #=> String
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.headers.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.headers.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.headers.items[0] #=> String
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.query_string_cache_keys.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.query_string_cache_keys.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.query_string_cache_keys.items[0] #=> String
resp.distribution_list.items[0].default_cache_behavior.min_ttl #=> Integer
resp.distribution_list.items[0].default_cache_behavior.default_ttl #=> Integer
resp.distribution_list.items[0].default_cache_behavior.max_ttl #=> Integer
resp.distribution_list.items[0].cache_behaviors.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].path_pattern #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].target_origin_id #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_signers.enabled #=> Boolean
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_signers.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_signers.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_signers.items[0] #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_key_groups.enabled #=> Boolean
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_key_groups.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_key_groups.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_key_groups.items[0] #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].viewer_protocol_policy #=> String, one of "allow-all", "https-only", "redirect-to-https"
resp.distribution_list.items[0].cache_behaviors.items[0].allowed_methods.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].allowed_methods.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].allowed_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution_list.items[0].cache_behaviors.items[0].allowed_methods.cached_methods.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].allowed_methods.cached_methods.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].allowed_methods.cached_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution_list.items[0].cache_behaviors.items[0].smooth_streaming #=> Boolean
resp.distribution_list.items[0].cache_behaviors.items[0].compress #=> Boolean
resp.distribution_list.items[0].cache_behaviors.items[0].lambda_function_associations.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].lambda_function_associations.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].lambda_function_associations.items[0].lambda_function_arn #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].lambda_function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution_list.items[0].cache_behaviors.items[0].lambda_function_associations.items[0].include_body #=> Boolean
resp.distribution_list.items[0].cache_behaviors.items[0].function_associations.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].function_associations.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].function_associations.items[0].function_arn #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution_list.items[0].cache_behaviors.items[0].field_level_encryption_id #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].realtime_log_config_arn #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].cache_policy_id #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].origin_request_policy_id #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].response_headers_policy_id #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.query_string #=> Boolean
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.cookies.forward #=> String, one of "none", "whitelist", "all"
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.items[0] #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.headers.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.headers.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.headers.items[0] #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.query_string_cache_keys.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.query_string_cache_keys.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.query_string_cache_keys.items[0] #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].min_ttl #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].default_ttl #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].max_ttl #=> Integer
resp.distribution_list.items[0].custom_error_responses.quantity #=> Integer
resp.distribution_list.items[0].custom_error_responses.items #=> Array
resp.distribution_list.items[0].custom_error_responses.items[0].error_code #=> Integer
resp.distribution_list.items[0].custom_error_responses.items[0].response_page_path #=> String
resp.distribution_list.items[0].custom_error_responses.items[0].response_code #=> String
resp.distribution_list.items[0].custom_error_responses.items[0].error_caching_min_ttl #=> Integer
resp.distribution_list.items[0].comment #=> String
resp.distribution_list.items[0].price_class #=> String, one of "PriceClass_100", "PriceClass_200", "PriceClass_All"
resp.distribution_list.items[0].enabled #=> Boolean
resp.distribution_list.items[0].viewer_certificate.cloud_front_default_certificate #=> Boolean
resp.distribution_list.items[0].viewer_certificate.iam_certificate_id #=> String
resp.distribution_list.items[0].viewer_certificate.acm_certificate_arn #=> String
resp.distribution_list.items[0].viewer_certificate.ssl_support_method #=> String, one of "sni-only", "vip", "static-ip"
resp.distribution_list.items[0].viewer_certificate.minimum_protocol_version #=> String, one of "SSLv3", "TLSv1", "TLSv1_2016", "TLSv1.1_2016", "TLSv1.2_2018", "TLSv1.2_2019", "TLSv1.2_2021"
resp.distribution_list.items[0].viewer_certificate.certificate #=> String
resp.distribution_list.items[0].viewer_certificate.certificate_source #=> String, one of "cloudfront", "iam", "acm"
resp.distribution_list.items[0].restrictions.geo_restriction.restriction_type #=> String, one of "blacklist", "whitelist", "none"
resp.distribution_list.items[0].restrictions.geo_restriction.quantity #=> Integer
resp.distribution_list.items[0].restrictions.geo_restriction.items #=> Array
resp.distribution_list.items[0].restrictions.geo_restriction.items[0] #=> String
resp.distribution_list.items[0].web_acl_id #=> String
resp.distribution_list.items[0].http_version #=> String, one of "http1.1", "http2", "http3", "http2and3"
resp.distribution_list.items[0].is_ipv6_enabled #=> Boolean
resp.distribution_list.items[0].alias_icp_recordals #=> Array
resp.distribution_list.items[0].alias_icp_recordals[0].cname #=> String
resp.distribution_list.items[0].alias_icp_recordals[0].icp_recordal_status #=> String, one of "APPROVED", "SUSPENDED", "PENDING"
resp.distribution_list.items[0].staging #=> Boolean

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:marker (String) —

Use this field when paginating results to indicate where to begin in your list of distributions. The response includes distributions in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of ‘NextMarker` from the current page’s response.
:max_items (Integer) —

The maximum number of distributions that you want in the response.
:realtime_log_config_name (String) —

The name of the real-time log configuration whose associated distributions you want to list.
:realtime_log_config_arn (String) —

The Amazon Resource Name (ARN) of the real-time log configuration whose associated distributions you want to list.

Returns:

(Types::ListDistributionsByRealtimeLogConfigResult) —
Returns a response object which responds to the following methods:
- #distribution_list => Types::DistributionList

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 6214

def list_distributions_by_realtime_log_config(params = {}, options = {})
  req = build_request(:list_distributions_by_realtime_log_config, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_distributions_by_response_headers_policy_id({
  marker: "string",
  max_items: 1,
  response_headers_policy_id: "string", # required
})

Response structure


resp.distribution_id_list.marker #=> String
resp.distribution_id_list.next_marker #=> String
resp.distribution_id_list.max_items #=> Integer
resp.distribution_id_list.is_truncated #=> Boolean
resp.distribution_id_list.quantity #=> Integer
resp.distribution_id_list.items #=> Array
resp.distribution_id_list.items[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:marker (String) —

Use this field when paginating results to indicate where to begin in your list of distribution IDs. The response includes distribution IDs in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of ‘NextMarker` from the current page’s response.
:max_items (Integer) —

The maximum number of distribution IDs that you want to get in the response.
:response_headers_policy_id (required, String) —

The ID of the response headers policy whose associated distribution IDs you want to list.

Returns:

(Types::ListDistributionsByResponseHeadersPolicyIdResult) —
Returns a response object which responds to the following methods:
- #distribution_id_list => Types::DistributionIdList

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 6271

def list_distributions_by_response_headers_policy_id(params = {}, options = {})
  req = build_request(:list_distributions_by_response_headers_policy_id, params)
  req.send_request(options)
end

#list_distributions_by_web_acl_id(params = {}) ⇒ `Types::ListDistributionsByWebACLIdResult`

List the distributions that are associated with a specified WAF web ACL.

Examples:

Request syntax with placeholder values


resp = client.list_distributions_by_web_acl_id({
  marker: "string",
  max_items: 1,
  web_acl_id: "string", # required
})

Response structure


resp.distribution_list.marker #=> String
resp.distribution_list.next_marker #=> String
resp.distribution_list.max_items #=> Integer
resp.distribution_list.is_truncated #=> Boolean
resp.distribution_list.quantity #=> Integer
resp.distribution_list.items #=> Array
resp.distribution_list.items[0].id #=> String
resp.distribution_list.items[0].arn #=> String
resp.distribution_list.items[0].status #=> String
resp.distribution_list.items[0].last_modified_time #=> Time
resp.distribution_list.items[0].domain_name #=> String
resp.distribution_list.items[0].aliases.quantity #=> Integer
resp.distribution_list.items[0].aliases.items #=> Array
resp.distribution_list.items[0].aliases.items[0] #=> String
resp.distribution_list.items[0].origins.quantity #=> Integer
resp.distribution_list.items[0].origins.items #=> Array
resp.distribution_list.items[0].origins.items[0].id #=> String
resp.distribution_list.items[0].origins.items[0].domain_name #=> String
resp.distribution_list.items[0].origins.items[0].origin_path #=> String
resp.distribution_list.items[0].origins.items[0].custom_headers.quantity #=> Integer
resp.distribution_list.items[0].origins.items[0].custom_headers.items #=> Array
resp.distribution_list.items[0].origins.items[0].custom_headers.items[0].header_name #=> String
resp.distribution_list.items[0].origins.items[0].custom_headers.items[0].header_value #=> String
resp.distribution_list.items[0].origins.items[0].s3_origin_config.origin_access_identity #=> String
resp.distribution_list.items[0].origins.items[0].custom_origin_config.http_port #=> Integer
resp.distribution_list.items[0].origins.items[0].custom_origin_config.https_port #=> Integer
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_protocol_policy #=> String, one of "http-only", "match-viewer", "https-only"
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_ssl_protocols.quantity #=> Integer
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_ssl_protocols.items #=> Array
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_ssl_protocols.items[0] #=> String, one of "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2"
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_read_timeout #=> Integer
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_keepalive_timeout #=> Integer
resp.distribution_list.items[0].origins.items[0].connection_attempts #=> Integer
resp.distribution_list.items[0].origins.items[0].connection_timeout #=> Integer
resp.distribution_list.items[0].origins.items[0].origin_shield.enabled #=> Boolean
resp.distribution_list.items[0].origins.items[0].origin_shield.origin_shield_region #=> String
resp.distribution_list.items[0].origins.items[0].origin_access_control_id #=> String
resp.distribution_list.items[0].origin_groups.quantity #=> Integer
resp.distribution_list.items[0].origin_groups.items #=> Array
resp.distribution_list.items[0].origin_groups.items[0].id #=> String
resp.distribution_list.items[0].origin_groups.items[0].failover_criteria.status_codes.quantity #=> Integer
resp.distribution_list.items[0].origin_groups.items[0].failover_criteria.status_codes.items #=> Array
resp.distribution_list.items[0].origin_groups.items[0].failover_criteria.status_codes.items[0] #=> Integer
resp.distribution_list.items[0].origin_groups.items[0].members.quantity #=> Integer
resp.distribution_list.items[0].origin_groups.items[0].members.items #=> Array
resp.distribution_list.items[0].origin_groups.items[0].members.items[0].origin_id #=> String
resp.distribution_list.items[0].default_cache_behavior.target_origin_id #=> String
resp.distribution_list.items[0].default_cache_behavior.trusted_signers.enabled #=> Boolean
resp.distribution_list.items[0].default_cache_behavior.trusted_signers.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.trusted_signers.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.trusted_signers.items[0] #=> String
resp.distribution_list.items[0].default_cache_behavior.trusted_key_groups.enabled #=> Boolean
resp.distribution_list.items[0].default_cache_behavior.trusted_key_groups.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.trusted_key_groups.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.trusted_key_groups.items[0] #=> String
resp.distribution_list.items[0].default_cache_behavior.viewer_protocol_policy #=> String, one of "allow-all", "https-only", "redirect-to-https"
resp.distribution_list.items[0].default_cache_behavior.allowed_methods.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.allowed_methods.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.allowed_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution_list.items[0].default_cache_behavior.allowed_methods.cached_methods.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.allowed_methods.cached_methods.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.allowed_methods.cached_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution_list.items[0].default_cache_behavior.smooth_streaming #=> Boolean
resp.distribution_list.items[0].default_cache_behavior.compress #=> Boolean
resp.distribution_list.items[0].default_cache_behavior.lambda_function_associations.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.lambda_function_associations.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.lambda_function_associations.items[0].lambda_function_arn #=> String
resp.distribution_list.items[0].default_cache_behavior.lambda_function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution_list.items[0].default_cache_behavior.lambda_function_associations.items[0].include_body #=> Boolean
resp.distribution_list.items[0].default_cache_behavior.function_associations.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.function_associations.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.function_associations.items[0].function_arn #=> String
resp.distribution_list.items[0].default_cache_behavior.function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution_list.items[0].default_cache_behavior.field_level_encryption_id #=> String
resp.distribution_list.items[0].default_cache_behavior.realtime_log_config_arn #=> String
resp.distribution_list.items[0].default_cache_behavior.cache_policy_id #=> String
resp.distribution_list.items[0].default_cache_behavior.origin_request_policy_id #=> String
resp.distribution_list.items[0].default_cache_behavior.response_headers_policy_id #=> String
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.query_string #=> Boolean
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.cookies.forward #=> String, one of "none", "whitelist", "all"
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.cookies.whitelisted_names.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.cookies.whitelisted_names.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.cookies.whitelisted_names.items[0] #=> String
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.headers.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.headers.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.headers.items[0] #=> String
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.query_string_cache_keys.quantity #=> Integer
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.query_string_cache_keys.items #=> Array
resp.distribution_list.items[0].default_cache_behavior.forwarded_values.query_string_cache_keys.items[0] #=> String
resp.distribution_list.items[0].default_cache_behavior.min_ttl #=> Integer
resp.distribution_list.items[0].default_cache_behavior.default_ttl #=> Integer
resp.distribution_list.items[0].default_cache_behavior.max_ttl #=> Integer
resp.distribution_list.items[0].cache_behaviors.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].path_pattern #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].target_origin_id #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_signers.enabled #=> Boolean
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_signers.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_signers.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_signers.items[0] #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_key_groups.enabled #=> Boolean
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_key_groups.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_key_groups.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].trusted_key_groups.items[0] #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].viewer_protocol_policy #=> String, one of "allow-all", "https-only", "redirect-to-https"
resp.distribution_list.items[0].cache_behaviors.items[0].allowed_methods.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].allowed_methods.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].allowed_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution_list.items[0].cache_behaviors.items[0].allowed_methods.cached_methods.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].allowed_methods.cached_methods.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].allowed_methods.cached_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution_list.items[0].cache_behaviors.items[0].smooth_streaming #=> Boolean
resp.distribution_list.items[0].cache_behaviors.items[0].compress #=> Boolean
resp.distribution_list.items[0].cache_behaviors.items[0].lambda_function_associations.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].lambda_function_associations.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].lambda_function_associations.items[0].lambda_function_arn #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].lambda_function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution_list.items[0].cache_behaviors.items[0].lambda_function_associations.items[0].include_body #=> Boolean
resp.distribution_list.items[0].cache_behaviors.items[0].function_associations.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].function_associations.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].function_associations.items[0].function_arn #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution_list.items[0].cache_behaviors.items[0].field_level_encryption_id #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].realtime_log_config_arn #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].cache_policy_id #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].origin_request_policy_id #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].response_headers_policy_id #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.query_string #=> Boolean
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.cookies.forward #=> String, one of "none", "whitelist", "all"
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.items[0] #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.headers.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.headers.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.headers.items[0] #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.query_string_cache_keys.quantity #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.query_string_cache_keys.items #=> Array
resp.distribution_list.items[0].cache_behaviors.items[0].forwarded_values.query_string_cache_keys.items[0] #=> String
resp.distribution_list.items[0].cache_behaviors.items[0].min_ttl #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].default_ttl #=> Integer
resp.distribution_list.items[0].cache_behaviors.items[0].max_ttl #=> Integer
resp.distribution_list.items[0].custom_error_responses.quantity #=> Integer
resp.distribution_list.items[0].custom_error_responses.items #=> Array
resp.distribution_list.items[0].custom_error_responses.items[0].error_code #=> Integer
resp.distribution_list.items[0].custom_error_responses.items[0].response_page_path #=> String
resp.distribution_list.items[0].custom_error_responses.items[0].response_code #=> String
resp.distribution_list.items[0].custom_error_responses.items[0].error_caching_min_ttl #=> Integer
resp.distribution_list.items[0].comment #=> String
resp.distribution_list.items[0].price_class #=> String, one of "PriceClass_100", "PriceClass_200", "PriceClass_All"
resp.distribution_list.items[0].enabled #=> Boolean
resp.distribution_list.items[0].viewer_certificate.cloud_front_default_certificate #=> Boolean
resp.distribution_list.items[0].viewer_certificate.iam_certificate_id #=> String
resp.distribution_list.items[0].viewer_certificate.acm_certificate_arn #=> String
resp.distribution_list.items[0].viewer_certificate.ssl_support_method #=> String, one of "sni-only", "vip", "static-ip"
resp.distribution_list.items[0].viewer_certificate.minimum_protocol_version #=> String, one of "SSLv3", "TLSv1", "TLSv1_2016", "TLSv1.1_2016", "TLSv1.2_2018", "TLSv1.2_2019", "TLSv1.2_2021"
resp.distribution_list.items[0].viewer_certificate.certificate #=> String
resp.distribution_list.items[0].viewer_certificate.certificate_source #=> String, one of "cloudfront", "iam", "acm"
resp.distribution_list.items[0].restrictions.geo_restriction.restriction_type #=> String, one of "blacklist", "whitelist", "none"
resp.distribution_list.items[0].restrictions.geo_restriction.quantity #=> Integer
resp.distribution_list.items[0].restrictions.geo_restriction.items #=> Array
resp.distribution_list.items[0].restrictions.geo_restriction.items[0] #=> String
resp.distribution_list.items[0].web_acl_id #=> String
resp.distribution_list.items[0].http_version #=> String, one of "http1.1", "http2", "http3", "http2and3"
resp.distribution_list.items[0].is_ipv6_enabled #=> Boolean
resp.distribution_list.items[0].alias_icp_recordals #=> Array
resp.distribution_list.items[0].alias_icp_recordals[0].cname #=> String
resp.distribution_list.items[0].alias_icp_recordals[0].icp_recordal_status #=> String, one of "APPROVED", "SUSPENDED", "PENDING"
resp.distribution_list.items[0].staging #=> Boolean

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:marker (String) —

Use ‘Marker` and `MaxItems` to control pagination of results. If you have more than `MaxItems` distributions that satisfy the request, the response includes a `NextMarker` element. To get the next page of results, submit another request. For the value of `Marker`, specify the value of `NextMarker` from the last response. (For the first request, omit `Marker`.)
:max_items (Integer) —

The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.
:web_acl_id (required, String) —

The ID of the WAF web ACL that you want to list the associated distributions. If you specify “null” for the ID, the request returns a list of the distributions that aren’t associated with a web ACL.

For WAFV2, this is the ARN of the web ACL, such as ‘arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`.

For WAF Classic, this is the ID of the web ACL, such as ‘a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`.

Returns:

(Types::ListDistributionsByWebACLIdResult) —
Returns a response object which responds to the following methods:
- #distribution_list => Types::DistributionList

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 6489

def list_distributions_by_web_acl_id(params = {}, options = {})
  req = build_request(:list_distributions_by_web_acl_id, params)
  req.send_request(options)
end

#list_field_level_encryption_configs(params = {}) ⇒ `Types::ListFieldLevelEncryptionConfigsResult`

List all field-level encryption configurations that have been created in CloudFront for this account.

Examples:

Request syntax with placeholder values


resp = client.list_field_level_encryption_configs({
  marker: "string",
  max_items: 1,
})

Response structure


resp.field_level_encryption_list.next_marker #=> String
resp.field_level_encryption_list.max_items #=> Integer
resp.field_level_encryption_list.quantity #=> Integer
resp.field_level_encryption_list.items #=> Array
resp.field_level_encryption_list.items[0].id #=> String
resp.field_level_encryption_list.items[0].last_modified_time #=> Time
resp.field_level_encryption_list.items[0].comment #=> String
resp.field_level_encryption_list.items[0].query_arg_profile_config.forward_when_query_arg_profile_is_unknown #=> Boolean
resp.field_level_encryption_list.items[0].query_arg_profile_config.query_arg_profiles.quantity #=> Integer
resp.field_level_encryption_list.items[0].query_arg_profile_config.query_arg_profiles.items #=> Array
resp.field_level_encryption_list.items[0].query_arg_profile_config.query_arg_profiles.items[0].query_arg #=> String
resp.field_level_encryption_list.items[0].query_arg_profile_config.query_arg_profiles.items[0].profile_id #=> String
resp.field_level_encryption_list.items[0].content_type_profile_config.forward_when_content_type_is_unknown #=> Boolean
resp.field_level_encryption_list.items[0].content_type_profile_config.content_type_profiles.quantity #=> Integer
resp.field_level_encryption_list.items[0].content_type_profile_config.content_type_profiles.items #=> Array
resp.field_level_encryption_list.items[0].content_type_profile_config.content_type_profiles.items[0].format #=> String, one of "URLEncoded"
resp.field_level_encryption_list.items[0].content_type_profile_config.content_type_profiles.items[0].profile_id #=> String
resp.field_level_encryption_list.items[0].content_type_profile_config.content_type_profiles.items[0].content_type #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:marker (String) —

Use this when paginating results to indicate where to begin in your list of configurations. The results include configurations in the list that occur after the marker. To get the next page of results, set the ‘Marker` to the value of the `NextMarker` from the current page’s response (which is also the ID of the last configuration on that page).
:max_items (Integer) —

The maximum number of field-level encryption configurations you want in the response body.

Returns:

(Types::ListFieldLevelEncryptionConfigsResult) —
Returns a response object which responds to the following methods:
- #field_level_encryption_list => Types::FieldLevelEncryptionList

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 6545

def list_field_level_encryption_configs(params = {}, options = {})
  req = build_request(:list_field_level_encryption_configs, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_field_level_encryption_profiles({
  marker: "string",
  max_items: 1,
})

Response structure


resp.field_level_encryption_profile_list.next_marker #=> String
resp.field_level_encryption_profile_list.max_items #=> Integer
resp.field_level_encryption_profile_list.quantity #=> Integer
resp.field_level_encryption_profile_list.items #=> Array
resp.field_level_encryption_profile_list.items[0].id #=> String
resp.field_level_encryption_profile_list.items[0].last_modified_time #=> Time
resp.field_level_encryption_profile_list.items[0].name #=> String
resp.field_level_encryption_profile_list.items[0].encryption_entities.quantity #=> Integer
resp.field_level_encryption_profile_list.items[0].encryption_entities.items #=> Array
resp.field_level_encryption_profile_list.items[0].encryption_entities.items[0].public_key_id #=> String
resp.field_level_encryption_profile_list.items[0].encryption_entities.items[0].provider_id #=> String
resp.field_level_encryption_profile_list.items[0].encryption_entities.items[0].field_patterns.quantity #=> Integer
resp.field_level_encryption_profile_list.items[0].encryption_entities.items[0].field_patterns.items #=> Array
resp.field_level_encryption_profile_list.items[0].encryption_entities.items[0].field_patterns.items[0] #=> String
resp.field_level_encryption_profile_list.items[0].comment #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:marker (String) —

Use this when paginating results to indicate where to begin in your list of profiles. The results include profiles in the list that occur after the marker. To get the next page of results, set the ‘Marker` to the value of the `NextMarker` from the current page’s response (which is also the ID of the last profile on that page).
:max_items (Integer) —

The maximum number of field-level encryption profiles you want in the response body.

Returns:

(Types::ListFieldLevelEncryptionProfilesResult) —
Returns a response object which responds to the following methods:
- #field_level_encryption_profile_list => Types::FieldLevelEncryptionProfileList

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 6597

def list_field_level_encryption_profiles(params = {}, options = {})
  req = build_request(:list_field_level_encryption_profiles, params)
  req.send_request(options)
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`.

Examples:

Request syntax with placeholder values


resp = client.list_functions({
  marker: "string",
  max_items: 1,
  stage: "DEVELOPMENT", # accepts DEVELOPMENT, LIVE
})

Response structure


resp.function_list.next_marker #=> String
resp.function_list.max_items #=> Integer
resp.function_list.quantity #=> Integer
resp.function_list.items #=> Array
resp.function_list.items[0].name #=> String
resp.function_list.items[0].status #=> String
resp.function_list.items[0].function_config.comment #=> String
resp.function_list.items[0].function_config.runtime #=> String, one of "cloudfront-js-1.0", "cloudfront-js-2.0"
resp.function_list.items[0].function_config.key_value_store_associations.quantity #=> Integer
resp.function_list.items[0].function_config.key_value_store_associations.items #=> Array
resp.function_list.items[0].function_config.key_value_store_associations.items[0].key_value_store_arn #=> String
resp.function_list.items[0].function_metadata.function_arn #=> String
resp.function_list.items[0].function_metadata.stage #=> String, one of "DEVELOPMENT", "LIVE"
resp.function_list.items[0].function_metadata.created_time #=> Time
resp.function_list.items[0].function_metadata.last_modified_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:marker (String) —

Use this field when paginating results to indicate where to begin in your list of functions. The response includes functions in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of ‘NextMarker` from the current page’s response.
:max_items (Integer) —

The maximum number of functions that you want in the response.
:stage (String) —

An optional filter to return only the functions that are in the specified stage, either ‘DEVELOPMENT` or `LIVE`.

Returns:

(Types::ListFunctionsResult) —
Returns a response object which responds to the following methods:
- #function_list => Types::FunctionList

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 6663

def list_functions(params = {}, options = {})
  req = build_request(:list_functions, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_invalidations({
  distribution_id: "string", # required
  marker: "string",
  max_items: 1,
})

Response structure


resp.invalidation_list.marker #=> String
resp.invalidation_list.next_marker #=> String
resp.invalidation_list.max_items #=> Integer
resp.invalidation_list.is_truncated #=> Boolean
resp.invalidation_list.quantity #=> Integer
resp.invalidation_list.items #=> Array
resp.invalidation_list.items[0].id #=> String
resp.invalidation_list.items[0].create_time #=> Time
resp.invalidation_list.items[0].status #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:distribution_id (required, String) —

The distribution’s ID.
:marker (String) —

Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set ‘Marker` to the value of the `NextMarker` from the current page’s response. This value is the same as the ID of the last invalidation batch on that page.
:max_items (Integer) —

The maximum number of invalidation batches that you want in the response body.

Returns:

(Types::ListInvalidationsResult) —
Returns a response object which responds to the following methods:
- #invalidation_list => Types::InvalidationList

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 6717

def list_invalidations(params = {}, options = {})
  req = build_request(:list_invalidations, params)
  req.send_request(options)
end

#list_key_groups(params = {}) ⇒ `Types::ListKeyGroupsResult`

Gets a list of key groups.

Examples:

Request syntax with placeholder values


resp = client.list_key_groups({
  marker: "string",
  max_items: 1,
})

Response structure


resp.key_group_list.next_marker #=> String
resp.key_group_list.max_items #=> Integer
resp.key_group_list.quantity #=> Integer
resp.key_group_list.items #=> Array
resp.key_group_list.items[0].key_group.id #=> String
resp.key_group_list.items[0].key_group.last_modified_time #=> Time
resp.key_group_list.items[0].key_group.key_group_config.name #=> String
resp.key_group_list.items[0].key_group.key_group_config.items #=> Array
resp.key_group_list.items[0].key_group.key_group_config.items[0] #=> String
resp.key_group_list.items[0].key_group.key_group_config.comment #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:marker (String) —

Use this field when paginating results to indicate where to begin in your list of key groups. The response includes key groups in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of ‘NextMarker` from the current page’s response.
:max_items (Integer) —

The maximum number of key groups that you want in the response.

Returns:

(Types::ListKeyGroupsResult) —
Returns a response object which responds to the following methods:
- #key_group_list => Types::KeyGroupList

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 6769

def list_key_groups(params = {}, options = {})
  req = build_request(:list_key_groups, params)
  req.send_request(options)
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.

Examples:

Example: To get a list of KeyValueStores


# The following command retrieves a list of KeyValueStores with READY status.

resp = client.list_key_value_stores({
  marker: "", 
  max_items: 100, 
  status: "READY", 
})

resp.to_h outputs the following:
{
  key_value_store_list: {
    items: [
      {
        arn: "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889", 
        comment: "", 
        id: "54947df8-0e9e-4471-a2f9-9af509fb5889", 
        last_modified_time: Time.parse("2023-11-07T18:45:21.069Z"), 
        name: "my-keyvaluestore-name", 
        status: "READY", 
      }, 
    ], 
    max_items: 100, 
    next_marker: "", 
    quantity: 1, 
  }, 
}

Request syntax with placeholder values


resp = client.list_key_value_stores({
  marker: "string",
  max_items: 1,
  status: "string",
})

Response structure


resp.key_value_store_list.next_marker #=> String
resp.key_value_store_list.max_items #=> Integer
resp.key_value_store_list.quantity #=> Integer
resp.key_value_store_list.items #=> Array
resp.key_value_store_list.items[0].name #=> String
resp.key_value_store_list.items[0].id #=> String
resp.key_value_store_list.items[0].comment #=> String
resp.key_value_store_list.items[0].arn #=> String
resp.key_value_store_list.items[0].status #=> String
resp.key_value_store_list.items[0].last_modified_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:marker (String) —

The marker associated with the key value stores list.
:max_items (Integer) —

The maximum number of items in the key value stores list.
:status (String) —

The status of the request for the key value stores list.

Returns:

(Types::ListKeyValueStoresResult) —
Returns a response object which responds to the following methods:
- #key_value_store_list => Types::KeyValueStoreList

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 6846

def list_key_value_stores(params = {}, options = {})
  req = build_request(:list_key_value_stores, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_origin_access_controls({
  marker: "string",
  max_items: 1,
})

Response structure


resp.origin_access_control_list.marker #=> String
resp.origin_access_control_list.next_marker #=> String
resp.origin_access_control_list.max_items #=> Integer
resp.origin_access_control_list.is_truncated #=> Boolean
resp.origin_access_control_list.quantity #=> Integer
resp.origin_access_control_list.items #=> Array
resp.origin_access_control_list.items[0].id #=> String
resp.origin_access_control_list.items[0].description #=> String
resp.origin_access_control_list.items[0].name #=> String
resp.origin_access_control_list.items[0].signing_protocol #=> String, one of "sigv4"
resp.origin_access_control_list.items[0].signing_behavior #=> String, one of "never", "always", "no-override"
resp.origin_access_control_list.items[0].origin_access_control_origin_type #=> String, one of "s3", "mediastore", "mediapackagev2", "lambda"

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:marker (String) —

Use this field when paginating results to indicate where to begin in your list of origin access controls. The response includes the items in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of ‘NextMarker` from the current page’s response.
:max_items (Integer) —

The maximum number of origin access controls that you want in the response.

Returns:

(Types::ListOriginAccessControlsResult) —
Returns a response object which responds to the following methods:
- #origin_access_control_list => Types::OriginAccessControlList

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 6902

def list_origin_access_controls(params = {}, options = {})
  req = build_request(:list_origin_access_controls, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_origin_request_policies({
  type: "managed", # accepts managed, custom
  marker: "string",
  max_items: 1,
})

Response structure


resp.origin_request_policy_list.next_marker #=> String
resp.origin_request_policy_list.max_items #=> Integer
resp.origin_request_policy_list.quantity #=> Integer
resp.origin_request_policy_list.items #=> Array
resp.origin_request_policy_list.items[0].type #=> String, one of "managed", "custom"
resp.origin_request_policy_list.items[0].origin_request_policy.id #=> String
resp.origin_request_policy_list.items[0].origin_request_policy.last_modified_time #=> Time
resp.origin_request_policy_list.items[0].origin_request_policy.origin_request_policy_config.comment #=> String
resp.origin_request_policy_list.items[0].origin_request_policy.origin_request_policy_config.name #=> String
resp.origin_request_policy_list.items[0].origin_request_policy.origin_request_policy_config.headers_config.header_behavior #=> String, one of "none", "whitelist", "allViewer", "allViewerAndWhitelistCloudFront", "allExcept"
resp.origin_request_policy_list.items[0].origin_request_policy.origin_request_policy_config.headers_config.headers.quantity #=> Integer
resp.origin_request_policy_list.items[0].origin_request_policy.origin_request_policy_config.headers_config.headers.items #=> Array
resp.origin_request_policy_list.items[0].origin_request_policy.origin_request_policy_config.headers_config.headers.items[0] #=> String
resp.origin_request_policy_list.items[0].origin_request_policy.origin_request_policy_config.cookies_config.cookie_behavior #=> String, one of "none", "whitelist", "all", "allExcept"
resp.origin_request_policy_list.items[0].origin_request_policy.origin_request_policy_config.cookies_config.cookies.quantity #=> Integer
resp.origin_request_policy_list.items[0].origin_request_policy.origin_request_policy_config.cookies_config.cookies.items #=> Array
resp.origin_request_policy_list.items[0].origin_request_policy.origin_request_policy_config.cookies_config.cookies.items[0] #=> String
resp.origin_request_policy_list.items[0].origin_request_policy.origin_request_policy_config.query_strings_config.query_string_behavior #=> String, one of "none", "whitelist", "all", "allExcept"
resp.origin_request_policy_list.items[0].origin_request_policy.origin_request_policy_config.query_strings_config.query_strings.quantity #=> Integer
resp.origin_request_policy_list.items[0].origin_request_policy.origin_request_policy_config.query_strings_config.query_strings.items #=> Array
resp.origin_request_policy_list.items[0].origin_request_policy.origin_request_policy_config.query_strings_config.query_strings.items[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:type (String) —
A filter to return only the specified kinds of origin request policies. Valid values are:
- ‘managed` – Returns only the managed policies created by Amazon Web Services.
- ‘custom` – Returns only the custom policies created in your Amazon Web Services account.
:marker (String) —

Use this field when paginating results to indicate where to begin in your list of origin request policies. The response includes origin request policies in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of ‘NextMarker` from the current page’s response.
:max_items (Integer) —

The maximum number of origin request policies that you want in the response.

Returns:

(Types::ListOriginRequestPoliciesResult) —
Returns a response object which responds to the following methods:
- #origin_request_policy_list => Types::OriginRequestPolicyList

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 6981

def list_origin_request_policies(params = {}, options = {})
  req = build_request(:list_origin_request_policies, params)
  req.send_request(options)
end

#list_public_keys(params = {}) ⇒ `Types::ListPublicKeysResult`

List all public keys that have been added to CloudFront for this account.

Examples:

Request syntax with placeholder values


resp = client.list_public_keys({
  marker: "string",
  max_items: 1,
})

Response structure


resp.public_key_list.next_marker #=> String
resp.public_key_list.max_items #=> Integer
resp.public_key_list.quantity #=> Integer
resp.public_key_list.items #=> Array
resp.public_key_list.items[0].id #=> String
resp.public_key_list.items[0].name #=> String
resp.public_key_list.items[0].created_time #=> Time
resp.public_key_list.items[0].encoded_key #=> String
resp.public_key_list.items[0].comment #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:marker (String) —

Use this when paginating results to indicate where to begin in your list of public keys. The results include public keys in the list that occur after the marker. To get the next page of results, set the ‘Marker` to the value of the `NextMarker` from the current page’s response (which is also the ID of the last public key on that page).
:max_items (Integer) —

The maximum number of public keys you want in the response body.

Returns:

(Types::ListPublicKeysResult) —
Returns a response object which responds to the following methods:
- #public_key_list => Types::PublicKeyList

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 7026

def list_public_keys(params = {}, options = {})
  req = build_request(:list_public_keys, params)
  req.send_request(options)
end

#list_realtime_log_configs(params = {}) ⇒ `Types::ListRealtimeLogConfigsResult`

Gets a list of real-time log configurations.

Examples:

Request syntax with placeholder values


resp = client.list_realtime_log_configs({
  max_items: 1,
  marker: "string",
})

Response structure


resp.realtime_log_configs.max_items #=> Integer
resp.realtime_log_configs.items #=> Array
resp.realtime_log_configs.items[0].arn #=> String
resp.realtime_log_configs.items[0].name #=> String
resp.realtime_log_configs.items[0].sampling_rate #=> Integer
resp.realtime_log_configs.items[0].end_points #=> Array
resp.realtime_log_configs.items[0].end_points[0].stream_type #=> String
resp.realtime_log_configs.items[0].end_points[0].kinesis_stream_config.role_arn #=> String
resp.realtime_log_configs.items[0].end_points[0].kinesis_stream_config.stream_arn #=> String
resp.realtime_log_configs.items[0].fields #=> Array
resp.realtime_log_configs.items[0].fields[0] #=> String
resp.realtime_log_configs.is_truncated #=> Boolean
resp.realtime_log_configs.marker #=> String
resp.realtime_log_configs.next_marker #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:max_items (Integer) —

The maximum number of real-time log configurations that you want in the response.
:marker (String) —

Use this field when paginating results to indicate where to begin in your list of real-time log configurations. The response includes real-time log configurations in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of ‘NextMarker` from the current page’s response.

Returns:

(Types::ListRealtimeLogConfigsResult) —
Returns a response object which responds to the following methods:
- #realtime_log_configs => Types::RealtimeLogConfigs

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 7083

def list_realtime_log_configs(params = {}, options = {})
  req = build_request(:list_realtime_log_configs, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_response_headers_policies({
  type: "managed", # accepts managed, custom
  marker: "string",
  max_items: 1,
})

Response structure


resp.response_headers_policy_list.next_marker #=> String
resp.response_headers_policy_list.max_items #=> Integer
resp.response_headers_policy_list.quantity #=> Integer
resp.response_headers_policy_list.items #=> Array
resp.response_headers_policy_list.items[0].type #=> String, one of "managed", "custom"
resp.response_headers_policy_list.items[0].response_headers_policy.id #=> String
resp.response_headers_policy_list.items[0].response_headers_policy.last_modified_time #=> Time
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.comment #=> String
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.name #=> String
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_origins.quantity #=> Integer
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_origins.items #=> Array
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_origins.items[0] #=> String
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_headers.quantity #=> Integer
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_headers.items #=> Array
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_headers.items[0] #=> String
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_methods.quantity #=> Integer
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_methods.items #=> Array
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_methods.items[0] #=> String, one of "GET", "POST", "OPTIONS", "PUT", "DELETE", "PATCH", "HEAD", "ALL"
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_credentials #=> Boolean
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.cors_config.access_control_expose_headers.quantity #=> Integer
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.cors_config.access_control_expose_headers.items #=> Array
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.cors_config.access_control_expose_headers.items[0] #=> String
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.cors_config.access_control_max_age_sec #=> Integer
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.cors_config.origin_override #=> Boolean
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.security_headers_config.xss_protection.override #=> Boolean
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.security_headers_config.xss_protection.protection #=> Boolean
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.security_headers_config.xss_protection.mode_block #=> Boolean
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.security_headers_config.xss_protection.report_uri #=> String
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.security_headers_config.frame_options.override #=> Boolean
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.security_headers_config.frame_options.frame_option #=> String, one of "DENY", "SAMEORIGIN"
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.security_headers_config.referrer_policy.override #=> Boolean
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.security_headers_config.referrer_policy.referrer_policy #=> String, one of "no-referrer", "no-referrer-when-downgrade", "origin", "origin-when-cross-origin", "same-origin", "strict-origin", "strict-origin-when-cross-origin", "unsafe-url"
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.security_headers_config.content_security_policy.override #=> Boolean
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.security_headers_config.content_security_policy.content_security_policy #=> String
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.security_headers_config.content_type_options.override #=> Boolean
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.security_headers_config.strict_transport_security.override #=> Boolean
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.security_headers_config.strict_transport_security.include_subdomains #=> Boolean
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.security_headers_config.strict_transport_security.preload #=> Boolean
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.security_headers_config.strict_transport_security.access_control_max_age_sec #=> Integer
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.server_timing_headers_config.enabled #=> Boolean
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.server_timing_headers_config.sampling_rate #=> Float
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.custom_headers_config.quantity #=> Integer
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.custom_headers_config.items #=> Array
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.custom_headers_config.items[0].header #=> String
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.custom_headers_config.items[0].value #=> String
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.custom_headers_config.items[0].override #=> Boolean
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.remove_headers_config.quantity #=> Integer
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.remove_headers_config.items #=> Array
resp.response_headers_policy_list.items[0].response_headers_policy.response_headers_policy_config.remove_headers_config.items[0].header #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:type (String) —
A filter to get only the specified kind of response headers policies. Valid values are:
- ‘managed` – Gets only the managed policies created by Amazon Web Services.
- ‘custom` – Gets only the custom policies created in your Amazon Web Services account.
:marker (String) —

Use this field when paginating results to indicate where to begin in your list of response headers policies. The response includes response headers policies in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of ‘NextMarker` from the current page’s response.
:max_items (Integer) —

The maximum number of response headers policies that you want to get in the response.

Returns:

(Types::ListResponseHeadersPoliciesResult) —
Returns a response object which responds to the following methods:
- #response_headers_policy_list => Types::ResponseHeadersPolicyList

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 7190

def list_response_headers_policies(params = {}, options = {})
  req = build_request(:list_response_headers_policies, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_streaming_distributions({
  marker: "string",
  max_items: 1,
})

Response structure


resp.streaming_distribution_list.marker #=> String
resp.streaming_distribution_list.next_marker #=> String
resp.streaming_distribution_list.max_items #=> Integer
resp.streaming_distribution_list.is_truncated #=> Boolean
resp.streaming_distribution_list.quantity #=> Integer
resp.streaming_distribution_list.items #=> Array
resp.streaming_distribution_list.items[0].id #=> String
resp.streaming_distribution_list.items[0].arn #=> String
resp.streaming_distribution_list.items[0].status #=> String
resp.streaming_distribution_list.items[0].last_modified_time #=> Time
resp.streaming_distribution_list.items[0].domain_name #=> String
resp.streaming_distribution_list.items[0].s3_origin.domain_name #=> String
resp.streaming_distribution_list.items[0].s3_origin.origin_access_identity #=> String
resp.streaming_distribution_list.items[0].aliases.quantity #=> Integer
resp.streaming_distribution_list.items[0].aliases.items #=> Array
resp.streaming_distribution_list.items[0].aliases.items[0] #=> String
resp.streaming_distribution_list.items[0].trusted_signers.enabled #=> Boolean
resp.streaming_distribution_list.items[0].trusted_signers.quantity #=> Integer
resp.streaming_distribution_list.items[0].trusted_signers.items #=> Array
resp.streaming_distribution_list.items[0].trusted_signers.items[0] #=> String
resp.streaming_distribution_list.items[0].comment #=> String
resp.streaming_distribution_list.items[0].price_class #=> String, one of "PriceClass_100", "PriceClass_200", "PriceClass_All"
resp.streaming_distribution_list.items[0].enabled #=> Boolean

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:marker (String) —

The value that you provided for the ‘Marker` request parameter.
:max_items (Integer) —

The value that you provided for the ‘MaxItems` request parameter.

Returns:

(Types::ListStreamingDistributionsResult) —
Returns a response object which responds to the following methods:
- #streaming_distribution_list => Types::StreamingDistributionList

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 7246

def list_streaming_distributions(params = {}, options = {})
  req = build_request(:list_streaming_distributions, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource: "ResourceARN", # required
})

Response structure


resp.tags.items #=> Array
resp.tags.items[0].key #=> String
resp.tags.items[0].value #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:resource (required, String) —

An ARN of a CloudFront resource.

Returns:

(Types::ListTagsForResourceResult) —
Returns a response object which responds to the following methods:
- #tags => Types::Tags

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 7282

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
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`.

Examples:

Request syntax with placeholder values


resp = client.publish_function({
  name: "string", # required
  if_match: "string", # required
})

Response structure


resp.function_summary.name #=> String
resp.function_summary.status #=> String
resp.function_summary.function_config.comment #=> String
resp.function_summary.function_config.runtime #=> String, one of "cloudfront-js-1.0", "cloudfront-js-2.0"
resp.function_summary.function_config.key_value_store_associations.quantity #=> Integer
resp.function_summary.function_config.key_value_store_associations.items #=> Array
resp.function_summary.function_config.key_value_store_associations.items[0].key_value_store_arn #=> String
resp.function_summary.function_metadata.function_arn #=> String
resp.function_summary.function_metadata.stage #=> String, one of "DEVELOPMENT", "LIVE"
resp.function_summary.function_metadata.created_time #=> Time
resp.function_summary.function_metadata.last_modified_time #=> Time

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:name (required, String) —

The name of the function that you are publishing.
:if_match (required, String) —

The current version (‘ETag` value) of the function that you are publishing, which you can get using `DescribeFunction`.

Returns:

(Types::PublishFunctionResult) —
Returns a response object which responds to the following methods:
- #function_summary => Types::FunctionSummary

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 7336

def publish_function(params = {}, options = {})
  req = build_request(:publish_function, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource: "ResourceARN", # required
  tags: { # required
    items: [
      {
        key: "TagKey", # required
        value: "TagValue",
      },
    ],
  },
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:resource (required, String) —

An ARN of a CloudFront resource.
:tags (required, Types::Tags) —

A complex type that contains zero or more ‘Tag` elements.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 7374

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.test_function({
  name: "string", # required
  if_match: "string", # required
  stage: "DEVELOPMENT", # accepts DEVELOPMENT, LIVE
  event_object: "data", # required
})

Response structure


resp.test_result.function_summary.name #=> String
resp.test_result.function_summary.status #=> String
resp.test_result.function_summary.function_config.comment #=> String
resp.test_result.function_summary.function_config.runtime #=> String, one of "cloudfront-js-1.0", "cloudfront-js-2.0"
resp.test_result.function_summary.function_config.key_value_store_associations.quantity #=> Integer
resp.test_result.function_summary.function_config.key_value_store_associations.items #=> Array
resp.test_result.function_summary.function_config.key_value_store_associations.items[0].key_value_store_arn #=> String
resp.test_result.function_summary.function_metadata.function_arn #=> String
resp.test_result.function_summary.function_metadata.stage #=> String, one of "DEVELOPMENT", "LIVE"
resp.test_result.function_summary.function_metadata.created_time #=> Time
resp.test_result.function_summary.function_metadata.last_modified_time #=> Time
resp.test_result.compute_utilization #=> String
resp.test_result.function_execution_logs #=> Array
resp.test_result.function_execution_logs[0] #=> String
resp.test_result.function_error_message #=> String
resp.test_result.function_output #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:name (required, String) —

The name of the function that you are testing.
:if_match (required, String) —

The current version (‘ETag` value) of the function that you are testing, which you can get using `DescribeFunction`.
:stage (String) —

The stage of the function that you are testing, either ‘DEVELOPMENT` or `LIVE`.
:event_object (required, String, StringIO, File) —

The event object to test the function with. For more information about the structure of the event object, see [Testing functions] in the *Amazon CloudFront Developer Guide*.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/managing-functions.html#test-function

Returns:

(Types::TestFunctionResult) —
Returns a response object which responds to the following methods:
- #test_result => Types::TestResult

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 7454

def test_function(params = {}, options = {})
  req = build_request(:test_function, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource: "ResourceARN", # required
  tag_keys: { # required
    items: ["TagKey"],
  },
})

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:resource (required, String) —

An ARN of a CloudFront resource.
:tag_keys (required, Types::TagKeys) —

A complex type that contains zero or more ‘Tag` key elements.

Returns:

(Struct) —

Returns an empty response.

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 7488

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.update_cache_policy({
  cache_policy_config: { # required
    comment: "string",
    name: "string", # required
    default_ttl: 1,
    max_ttl: 1,
    min_ttl: 1, # required
    parameters_in_cache_key_and_forwarded_to_origin: {
      enable_accept_encoding_gzip: false, # required
      enable_accept_encoding_brotli: false,
      headers_config: { # required
        header_behavior: "none", # required, accepts none, whitelist
        headers: {
          quantity: 1, # required
          items: ["string"],
        },
      },
      cookies_config: { # required
        cookie_behavior: "none", # required, accepts none, whitelist, allExcept, all
        cookies: {
          quantity: 1, # required
          items: ["string"],
        },
      },
      query_strings_config: { # required
        query_string_behavior: "none", # required, accepts none, whitelist, allExcept, all
        query_strings: {
          quantity: 1, # required
          items: ["string"],
        },
      },
    },
  },
  id: "string", # required
  if_match: "string",
})

Response structure


resp.cache_policy.id #=> String
resp.cache_policy.last_modified_time #=> Time
resp.cache_policy.cache_policy_config.comment #=> String
resp.cache_policy.cache_policy_config.name #=> String
resp.cache_policy.cache_policy_config.default_ttl #=> Integer
resp.cache_policy.cache_policy_config.max_ttl #=> Integer
resp.cache_policy.cache_policy_config.min_ttl #=> Integer
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.enable_accept_encoding_gzip #=> Boolean
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.enable_accept_encoding_brotli #=> Boolean
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.headers_config.header_behavior #=> String, one of "none", "whitelist"
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.headers_config.headers.quantity #=> Integer
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.headers_config.headers.items #=> Array
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.headers_config.headers.items[0] #=> String
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookie_behavior #=> String, one of "none", "whitelist", "allExcept", "all"
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookies.quantity #=> Integer
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookies.items #=> Array
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.cookies_config.cookies.items[0] #=> String
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_string_behavior #=> String, one of "none", "whitelist", "allExcept", "all"
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_strings.quantity #=> Integer
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_strings.items #=> Array
resp.cache_policy.cache_policy_config.parameters_in_cache_key_and_forwarded_to_origin.query_strings_config.query_strings.items[0] #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:cache_policy_config (required, Types::CachePolicyConfig) —

A cache policy configuration.
:id (required, String) —

The unique identifier for the cache policy that you are updating. The identifier is returned in a cache behavior’s ‘CachePolicyId` field in the response to `GetDistributionConfig`.
:if_match (String) —

The version of the cache policy that you are updating. The version is returned in the cache policy’s ‘ETag` field in the response to `GetCachePolicyConfig`.

Returns:

(Types::UpdateCachePolicyResult) —
Returns a response object which responds to the following methods:
- #cache_policy => Types::CachePolicy
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 7595

def update_cache_policy(params = {}, options = {})
  req = build_request(:update_cache_policy, params)
  req.send_request(options)
end

#update_cloud_front_origin_access_identity(params = {}) ⇒ `Types::UpdateCloudFrontOriginAccessIdentityResult`

Update an origin access identity.

Examples:

Request syntax with placeholder values


resp = client.update_cloud_front_origin_access_identity({
  cloud_front_origin_access_identity_config: { # required
    caller_reference: "string", # required
    comment: "string", # required
  },
  id: "string", # required
  if_match: "string",
})

Response structure


resp.cloud_front_origin_access_identity.id #=> String
resp.cloud_front_origin_access_identity.s3_canonical_user_id #=> String
resp.cloud_front_origin_access_identity.cloud_front_origin_access_identity_config.caller_reference #=> String
resp.cloud_front_origin_access_identity.cloud_front_origin_access_identity_config.comment #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:cloud_front_origin_access_identity_config (required, Types::CloudFrontOriginAccessIdentityConfig) —

The identity’s configuration information.
:id (required, String) —

The identity’s id.
:if_match (String) —

The value of the ‘ETag` header that you received when retrieving the identity’s configuration. For example: ‘E2QWRUHAPOMQZL`.

Returns:

(Types::UpdateCloudFrontOriginAccessIdentityResult) —
Returns a response object which responds to the following methods:
- #cloud_front_origin_access_identity => Types::CloudFrontOriginAccessIdentity
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 7640

def update_cloud_front_origin_access_identity(params = {}, options = {})
  req = build_request(:update_cloud_front_origin_access_identity, params)
  req.send_request(options)
end

#update_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.

Examples:

Request syntax with placeholder values


resp = client.update_continuous_deployment_policy({
  continuous_deployment_policy_config: { # required
    staging_distribution_dns_names: { # required
      quantity: 1, # required
      items: ["string"],
    },
    enabled: false, # required
    traffic_config: {
      single_weight_config: {
        weight: 1.0, # required
        session_stickiness_config: {
          idle_ttl: 1, # required
          maximum_ttl: 1, # required
        },
      },
      single_header_config: {
        header: "string", # required
        value: "string", # required
      },
      type: "SingleWeight", # required, accepts SingleWeight, SingleHeader
    },
  },
  id: "string", # required
  if_match: "string",
})

Response structure


resp.continuous_deployment_policy.id #=> String
resp.continuous_deployment_policy.last_modified_time #=> Time
resp.continuous_deployment_policy.continuous_deployment_policy_config.staging_distribution_dns_names.quantity #=> Integer
resp.continuous_deployment_policy.continuous_deployment_policy_config.staging_distribution_dns_names.items #=> Array
resp.continuous_deployment_policy.continuous_deployment_policy_config.staging_distribution_dns_names.items[0] #=> String
resp.continuous_deployment_policy.continuous_deployment_policy_config.enabled #=> Boolean
resp.continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.single_weight_config.weight #=> Float
resp.continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.single_weight_config.session_stickiness_config.idle_ttl #=> Integer
resp.continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.single_weight_config.session_stickiness_config.maximum_ttl #=> Integer
resp.continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.single_header_config.header #=> String
resp.continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.single_header_config.value #=> String
resp.continuous_deployment_policy.continuous_deployment_policy_config.traffic_config.type #=> String, one of "SingleWeight", "SingleHeader"
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:continuous_deployment_policy_config (required, Types::ContinuousDeploymentPolicyConfig) —

The continuous deployment policy configuration.
:id (required, String) —

The identifier of the continuous deployment policy that you are updating.
:if_match (String) —

The current version (‘ETag` value) of the continuous deployment policy that you are updating.

Returns:

(Types::UpdateContinuousDeploymentPolicyResult) —
Returns a response object which responds to the following methods:
- #continuous_deployment_policy => Types::ContinuousDeploymentPolicy
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 7729

def update_continuous_deployment_policy(params = {}, options = {})
  req = build_request(:update_continuous_deployment_policy, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.update_distribution({
  distribution_config: { # required
    caller_reference: "string", # required
    aliases: {
      quantity: 1, # required
      items: ["string"],
    },
    default_root_object: "string",
    origins: { # required
      quantity: 1, # required
      items: [ # required
        {
          id: "string", # required
          domain_name: "string", # required
          origin_path: "string",
          custom_headers: {
            quantity: 1, # required
            items: [
              {
                header_name: "string", # required
                header_value: "sensitiveStringType", # required
              },
            ],
          },
          s3_origin_config: {
            origin_access_identity: "string", # required
          },
          custom_origin_config: {
            http_port: 1, # required
            https_port: 1, # required
            origin_protocol_policy: "http-only", # required, accepts http-only, match-viewer, https-only
            origin_ssl_protocols: {
              quantity: 1, # required
              items: ["SSLv3"], # required, accepts SSLv3, TLSv1, TLSv1.1, TLSv1.2
            },
            origin_read_timeout: 1,
            origin_keepalive_timeout: 1,
          },
          connection_attempts: 1,
          connection_timeout: 1,
          origin_shield: {
            enabled: false, # required
            origin_shield_region: "OriginShieldRegion",
          },
          origin_access_control_id: "string",
        },
      ],
    },
    origin_groups: {
      quantity: 1, # required
      items: [
        {
          id: "string", # required
          failover_criteria: { # required
            status_codes: { # required
              quantity: 1, # required
              items: [1], # required
            },
          },
          members: { # required
            quantity: 1, # required
            items: [ # required
              {
                origin_id: "string", # required
              },
            ],
          },
        },
      ],
    },
    default_cache_behavior: { # required
      target_origin_id: "string", # required
      trusted_signers: {
        enabled: false, # required
        quantity: 1, # required
        items: ["string"],
      },
      trusted_key_groups: {
        enabled: false, # required
        quantity: 1, # required
        items: ["string"],
      },
      viewer_protocol_policy: "allow-all", # required, accepts allow-all, https-only, redirect-to-https
      allowed_methods: {
        quantity: 1, # required
        items: ["GET"], # required, accepts GET, HEAD, POST, PUT, PATCH, OPTIONS, DELETE
        cached_methods: {
          quantity: 1, # required
          items: ["GET"], # required, accepts GET, HEAD, POST, PUT, PATCH, OPTIONS, DELETE
        },
      },
      smooth_streaming: false,
      compress: false,
      lambda_function_associations: {
        quantity: 1, # required
        items: [
          {
            lambda_function_arn: "LambdaFunctionARN", # required
            event_type: "viewer-request", # required, accepts viewer-request, viewer-response, origin-request, origin-response
            include_body: false,
          },
        ],
      },
      function_associations: {
        quantity: 1, # required
        items: [
          {
            function_arn: "FunctionARN", # required
            event_type: "viewer-request", # required, accepts viewer-request, viewer-response, origin-request, origin-response
          },
        ],
      },
      field_level_encryption_id: "string",
      realtime_log_config_arn: "string",
      cache_policy_id: "string",
      origin_request_policy_id: "string",
      response_headers_policy_id: "string",
      forwarded_values: {
        query_string: false, # required
        cookies: { # required
          forward: "none", # required, accepts none, whitelist, all
          whitelisted_names: {
            quantity: 1, # required
            items: ["string"],
          },
        },
        headers: {
          quantity: 1, # required
          items: ["string"],
        },
        query_string_cache_keys: {
          quantity: 1, # required
          items: ["string"],
        },
      },
      min_ttl: 1,
      default_ttl: 1,
      max_ttl: 1,
    },
    cache_behaviors: {
      quantity: 1, # required
      items: [
        {
          path_pattern: "string", # required
          target_origin_id: "string", # required
          trusted_signers: {
            enabled: false, # required
            quantity: 1, # required
            items: ["string"],
          },
          trusted_key_groups: {
            enabled: false, # required
            quantity: 1, # required
            items: ["string"],
          },
          viewer_protocol_policy: "allow-all", # required, accepts allow-all, https-only, redirect-to-https
          allowed_methods: {
            quantity: 1, # required
            items: ["GET"], # required, accepts GET, HEAD, POST, PUT, PATCH, OPTIONS, DELETE
            cached_methods: {
              quantity: 1, # required
              items: ["GET"], # required, accepts GET, HEAD, POST, PUT, PATCH, OPTIONS, DELETE
            },
          },
          smooth_streaming: false,
          compress: false,
          lambda_function_associations: {
            quantity: 1, # required
            items: [
              {
                lambda_function_arn: "LambdaFunctionARN", # required
                event_type: "viewer-request", # required, accepts viewer-request, viewer-response, origin-request, origin-response
                include_body: false,
              },
            ],
          },
          function_associations: {
            quantity: 1, # required
            items: [
              {
                function_arn: "FunctionARN", # required
                event_type: "viewer-request", # required, accepts viewer-request, viewer-response, origin-request, origin-response
              },
            ],
          },
          field_level_encryption_id: "string",
          realtime_log_config_arn: "string",
          cache_policy_id: "string",
          origin_request_policy_id: "string",
          response_headers_policy_id: "string",
          forwarded_values: {
            query_string: false, # required
            cookies: { # required
              forward: "none", # required, accepts none, whitelist, all
              whitelisted_names: {
                quantity: 1, # required
                items: ["string"],
              },
            },
            headers: {
              quantity: 1, # required
              items: ["string"],
            },
            query_string_cache_keys: {
              quantity: 1, # required
              items: ["string"],
            },
          },
          min_ttl: 1,
          default_ttl: 1,
          max_ttl: 1,
        },
      ],
    },
    custom_error_responses: {
      quantity: 1, # required
      items: [
        {
          error_code: 1, # required
          response_page_path: "string",
          response_code: "string",
          error_caching_min_ttl: 1,
        },
      ],
    },
    comment: "CommentType", # required
    logging: {
      enabled: false, # required
      include_cookies: false, # required
      bucket: "string", # required
      prefix: "string", # required
    },
    price_class: "PriceClass_100", # accepts PriceClass_100, PriceClass_200, PriceClass_All
    enabled: false, # required
    viewer_certificate: {
      cloud_front_default_certificate: false,
      iam_certificate_id: "string",
      acm_certificate_arn: "string",
      ssl_support_method: "sni-only", # accepts sni-only, vip, static-ip
      minimum_protocol_version: "SSLv3", # accepts SSLv3, TLSv1, TLSv1_2016, TLSv1.1_2016, TLSv1.2_2018, TLSv1.2_2019, TLSv1.2_2021
      certificate: "string",
      certificate_source: "cloudfront", # accepts cloudfront, iam, acm
    },
    restrictions: {
      geo_restriction: { # required
        restriction_type: "blacklist", # required, accepts blacklist, whitelist, none
        quantity: 1, # required
        items: ["string"],
      },
    },
    web_acl_id: "string",
    http_version: "http1.1", # accepts http1.1, http2, http3, http2and3
    is_ipv6_enabled: false,
    continuous_deployment_policy_id: "string",
    staging: false,
  },
  id: "string", # required
  if_match: "string",
})

Response structure


resp.distribution.id #=> String
resp.distribution.arn #=> String
resp.distribution.status #=> String
resp.distribution.last_modified_time #=> Time
resp.distribution.in_progress_invalidation_batches #=> Integer
resp.distribution.domain_name #=> String
resp.distribution.active_trusted_signers.enabled #=> Boolean
resp.distribution.active_trusted_signers.quantity #=> Integer
resp.distribution.active_trusted_signers.items #=> Array
resp.distribution.active_trusted_signers.items[0].aws_account_number #=> String
resp.distribution.active_trusted_signers.items[0].key_pair_ids.quantity #=> Integer
resp.distribution.active_trusted_signers.items[0].key_pair_ids.items #=> Array
resp.distribution.active_trusted_signers.items[0].key_pair_ids.items[0] #=> String
resp.distribution.active_trusted_key_groups.enabled #=> Boolean
resp.distribution.active_trusted_key_groups.quantity #=> Integer
resp.distribution.active_trusted_key_groups.items #=> Array
resp.distribution.active_trusted_key_groups.items[0].key_group_id #=> String
resp.distribution.active_trusted_key_groups.items[0].key_pair_ids.quantity #=> Integer
resp.distribution.active_trusted_key_groups.items[0].key_pair_ids.items #=> Array
resp.distribution.active_trusted_key_groups.items[0].key_pair_ids.items[0] #=> String
resp.distribution.distribution_config.caller_reference #=> String
resp.distribution.distribution_config.aliases.quantity #=> Integer
resp.distribution.distribution_config.aliases.items #=> Array
resp.distribution.distribution_config.aliases.items[0] #=> String
resp.distribution.distribution_config.default_root_object #=> String
resp.distribution.distribution_config.origins.quantity #=> Integer
resp.distribution.distribution_config.origins.items #=> Array
resp.distribution.distribution_config.origins.items[0].id #=> String
resp.distribution.distribution_config.origins.items[0].domain_name #=> String
resp.distribution.distribution_config.origins.items[0].origin_path #=> String
resp.distribution.distribution_config.origins.items[0].custom_headers.quantity #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_headers.items #=> Array
resp.distribution.distribution_config.origins.items[0].custom_headers.items[0].header_name #=> String
resp.distribution.distribution_config.origins.items[0].custom_headers.items[0].header_value #=> String
resp.distribution.distribution_config.origins.items[0].s3_origin_config.origin_access_identity #=> String
resp.distribution.distribution_config.origins.items[0].custom_origin_config.http_port #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.https_port #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_protocol_policy #=> String, one of "http-only", "match-viewer", "https-only"
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.quantity #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.items #=> Array
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.items[0] #=> String, one of "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2"
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_read_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_keepalive_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].connection_attempts #=> Integer
resp.distribution.distribution_config.origins.items[0].connection_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].origin_shield.enabled #=> Boolean
resp.distribution.distribution_config.origins.items[0].origin_shield.origin_shield_region #=> String
resp.distribution.distribution_config.origins.items[0].origin_access_control_id #=> String
resp.distribution.distribution_config.origin_groups.quantity #=> Integer
resp.distribution.distribution_config.origin_groups.items #=> Array
resp.distribution.distribution_config.origin_groups.items[0].id #=> String
resp.distribution.distribution_config.origin_groups.items[0].failover_criteria.status_codes.quantity #=> Integer
resp.distribution.distribution_config.origin_groups.items[0].failover_criteria.status_codes.items #=> Array
resp.distribution.distribution_config.origin_groups.items[0].failover_criteria.status_codes.items[0] #=> Integer
resp.distribution.distribution_config.origin_groups.items[0].members.quantity #=> Integer
resp.distribution.distribution_config.origin_groups.items[0].members.items #=> Array
resp.distribution.distribution_config.origin_groups.items[0].members.items[0].origin_id #=> String
resp.distribution.distribution_config.default_cache_behavior.target_origin_id #=> String
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.enabled #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.enabled #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.viewer_protocol_policy #=> String, one of "allow-all", "https-only", "redirect-to-https"
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.cached_methods.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.cached_methods.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.cached_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.default_cache_behavior.smooth_streaming #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.compress #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items[0].lambda_function_arn #=> String
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items[0].include_body #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.function_associations.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.function_associations.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.function_associations.items[0].function_arn #=> String
resp.distribution.distribution_config.default_cache_behavior.function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.default_cache_behavior.field_level_encryption_id #=> String
resp.distribution.distribution_config.default_cache_behavior.realtime_log_config_arn #=> String
resp.distribution.distribution_config.default_cache_behavior.cache_policy_id #=> String
resp.distribution.distribution_config.default_cache_behavior.origin_request_policy_id #=> String
resp.distribution.distribution_config.default_cache_behavior.response_headers_policy_id #=> String
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.forward #=> String, one of "none", "whitelist", "all"
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.whitelisted_names.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.whitelisted_names.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.whitelisted_names.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.headers.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.headers.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.headers.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string_cache_keys.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string_cache_keys.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string_cache_keys.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.min_ttl #=> Integer
resp.distribution.distribution_config.default_cache_behavior.default_ttl #=> Integer
resp.distribution.distribution_config.default_cache_behavior.max_ttl #=> Integer
resp.distribution.distribution_config.cache_behaviors.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].path_pattern #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].target_origin_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.enabled #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.enabled #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].viewer_protocol_policy #=> String, one of "allow-all", "https-only", "redirect-to-https"
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.cached_methods.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.cached_methods.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.cached_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.cache_behaviors.items[0].smooth_streaming #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].compress #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items[0].lambda_function_arn #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items[0].include_body #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.items[0].function_arn #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.cache_behaviors.items[0].field_level_encryption_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].realtime_log_config_arn #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].cache_policy_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].origin_request_policy_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].response_headers_policy_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.forward #=> String, one of "none", "whitelist", "all"
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.headers.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.headers.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.headers.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string_cache_keys.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string_cache_keys.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string_cache_keys.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].min_ttl #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].default_ttl #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].max_ttl #=> Integer
resp.distribution.distribution_config.custom_error_responses.quantity #=> Integer
resp.distribution.distribution_config.custom_error_responses.items #=> Array
resp.distribution.distribution_config.custom_error_responses.items[0].error_code #=> Integer
resp.distribution.distribution_config.custom_error_responses.items[0].response_page_path #=> String
resp.distribution.distribution_config.custom_error_responses.items[0].response_code #=> String
resp.distribution.distribution_config.custom_error_responses.items[0].error_caching_min_ttl #=> Integer
resp.distribution.distribution_config.comment #=> String
resp.distribution.distribution_config.logging.enabled #=> Boolean
resp.distribution.distribution_config.logging.include_cookies #=> Boolean
resp.distribution.distribution_config.logging.bucket #=> String
resp.distribution.distribution_config.logging.prefix #=> String
resp.distribution.distribution_config.price_class #=> String, one of "PriceClass_100", "PriceClass_200", "PriceClass_All"
resp.distribution.distribution_config.enabled #=> Boolean
resp.distribution.distribution_config.viewer_certificate.cloud_front_default_certificate #=> Boolean
resp.distribution.distribution_config.viewer_certificate.iam_certificate_id #=> String
resp.distribution.distribution_config.viewer_certificate.acm_certificate_arn #=> String
resp.distribution.distribution_config.viewer_certificate.ssl_support_method #=> String, one of "sni-only", "vip", "static-ip"
resp.distribution.distribution_config.viewer_certificate.minimum_protocol_version #=> String, one of "SSLv3", "TLSv1", "TLSv1_2016", "TLSv1.1_2016", "TLSv1.2_2018", "TLSv1.2_2019", "TLSv1.2_2021"
resp.distribution.distribution_config.viewer_certificate.certificate #=> String
resp.distribution.distribution_config.viewer_certificate.certificate_source #=> String, one of "cloudfront", "iam", "acm"
resp.distribution.distribution_config.restrictions.geo_restriction.restriction_type #=> String, one of "blacklist", "whitelist", "none"
resp.distribution.distribution_config.restrictions.geo_restriction.quantity #=> Integer
resp.distribution.distribution_config.restrictions.geo_restriction.items #=> Array
resp.distribution.distribution_config.restrictions.geo_restriction.items[0] #=> String
resp.distribution.distribution_config.web_acl_id #=> String
resp.distribution.distribution_config.http_version #=> String, one of "http1.1", "http2", "http3", "http2and3"
resp.distribution.distribution_config.is_ipv6_enabled #=> Boolean
resp.distribution.distribution_config.continuous_deployment_policy_id #=> String
resp.distribution.distribution_config.staging #=> Boolean
resp.distribution.alias_icp_recordals #=> Array
resp.distribution.alias_icp_recordals[0].cname #=> String
resp.distribution.alias_icp_recordals[0].icp_recordal_status #=> String, one of "APPROVED", "SUSPENDED", "PENDING"
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:distribution_config (required, Types::DistributionConfig) —

The distribution’s configuration information.
:id (required, String) —

The distribution’s id.
:if_match (String) —

The value of the ‘ETag` header that you received when retrieving the distribution’s configuration. For example: ‘E2QWRUHAPOMQZL`.

Returns:

(Types::UpdateDistributionResult) —
Returns a response object which responds to the following methods:
- #distribution => Types::Distribution
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 8231

def update_distribution(params = {}, options = {})
  req = build_request(:update_distribution, params)
  req.send_request(options)
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

Examples:

Request syntax with placeholder values


resp = client.update_distribution_with_staging_config({
  id: "string", # required
  staging_distribution_id: "string",
  if_match: "string",
})

Response structure


resp.distribution.id #=> String
resp.distribution.arn #=> String
resp.distribution.status #=> String
resp.distribution.last_modified_time #=> Time
resp.distribution.in_progress_invalidation_batches #=> Integer
resp.distribution.domain_name #=> String
resp.distribution.active_trusted_signers.enabled #=> Boolean
resp.distribution.active_trusted_signers.quantity #=> Integer
resp.distribution.active_trusted_signers.items #=> Array
resp.distribution.active_trusted_signers.items[0].aws_account_number #=> String
resp.distribution.active_trusted_signers.items[0].key_pair_ids.quantity #=> Integer
resp.distribution.active_trusted_signers.items[0].key_pair_ids.items #=> Array
resp.distribution.active_trusted_signers.items[0].key_pair_ids.items[0] #=> String
resp.distribution.active_trusted_key_groups.enabled #=> Boolean
resp.distribution.active_trusted_key_groups.quantity #=> Integer
resp.distribution.active_trusted_key_groups.items #=> Array
resp.distribution.active_trusted_key_groups.items[0].key_group_id #=> String
resp.distribution.active_trusted_key_groups.items[0].key_pair_ids.quantity #=> Integer
resp.distribution.active_trusted_key_groups.items[0].key_pair_ids.items #=> Array
resp.distribution.active_trusted_key_groups.items[0].key_pair_ids.items[0] #=> String
resp.distribution.distribution_config.caller_reference #=> String
resp.distribution.distribution_config.aliases.quantity #=> Integer
resp.distribution.distribution_config.aliases.items #=> Array
resp.distribution.distribution_config.aliases.items[0] #=> String
resp.distribution.distribution_config.default_root_object #=> String
resp.distribution.distribution_config.origins.quantity #=> Integer
resp.distribution.distribution_config.origins.items #=> Array
resp.distribution.distribution_config.origins.items[0].id #=> String
resp.distribution.distribution_config.origins.items[0].domain_name #=> String
resp.distribution.distribution_config.origins.items[0].origin_path #=> String
resp.distribution.distribution_config.origins.items[0].custom_headers.quantity #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_headers.items #=> Array
resp.distribution.distribution_config.origins.items[0].custom_headers.items[0].header_name #=> String
resp.distribution.distribution_config.origins.items[0].custom_headers.items[0].header_value #=> String
resp.distribution.distribution_config.origins.items[0].s3_origin_config.origin_access_identity #=> String
resp.distribution.distribution_config.origins.items[0].custom_origin_config.http_port #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.https_port #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_protocol_policy #=> String, one of "http-only", "match-viewer", "https-only"
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.quantity #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.items #=> Array
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_ssl_protocols.items[0] #=> String, one of "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2"
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_read_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_keepalive_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].connection_attempts #=> Integer
resp.distribution.distribution_config.origins.items[0].connection_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].origin_shield.enabled #=> Boolean
resp.distribution.distribution_config.origins.items[0].origin_shield.origin_shield_region #=> String
resp.distribution.distribution_config.origins.items[0].origin_access_control_id #=> String
resp.distribution.distribution_config.origin_groups.quantity #=> Integer
resp.distribution.distribution_config.origin_groups.items #=> Array
resp.distribution.distribution_config.origin_groups.items[0].id #=> String
resp.distribution.distribution_config.origin_groups.items[0].failover_criteria.status_codes.quantity #=> Integer
resp.distribution.distribution_config.origin_groups.items[0].failover_criteria.status_codes.items #=> Array
resp.distribution.distribution_config.origin_groups.items[0].failover_criteria.status_codes.items[0] #=> Integer
resp.distribution.distribution_config.origin_groups.items[0].members.quantity #=> Integer
resp.distribution.distribution_config.origin_groups.items[0].members.items #=> Array
resp.distribution.distribution_config.origin_groups.items[0].members.items[0].origin_id #=> String
resp.distribution.distribution_config.default_cache_behavior.target_origin_id #=> String
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.enabled #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.trusted_signers.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.enabled #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.trusted_key_groups.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.viewer_protocol_policy #=> String, one of "allow-all", "https-only", "redirect-to-https"
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.cached_methods.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.cached_methods.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.allowed_methods.cached_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.default_cache_behavior.smooth_streaming #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.compress #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items[0].lambda_function_arn #=> String
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.default_cache_behavior.lambda_function_associations.items[0].include_body #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.function_associations.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.function_associations.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.function_associations.items[0].function_arn #=> String
resp.distribution.distribution_config.default_cache_behavior.function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.default_cache_behavior.field_level_encryption_id #=> String
resp.distribution.distribution_config.default_cache_behavior.realtime_log_config_arn #=> String
resp.distribution.distribution_config.default_cache_behavior.cache_policy_id #=> String
resp.distribution.distribution_config.default_cache_behavior.origin_request_policy_id #=> String
resp.distribution.distribution_config.default_cache_behavior.response_headers_policy_id #=> String
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string #=> Boolean
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.forward #=> String, one of "none", "whitelist", "all"
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.whitelisted_names.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.whitelisted_names.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.cookies.whitelisted_names.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.headers.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.headers.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.headers.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string_cache_keys.quantity #=> Integer
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string_cache_keys.items #=> Array
resp.distribution.distribution_config.default_cache_behavior.forwarded_values.query_string_cache_keys.items[0] #=> String
resp.distribution.distribution_config.default_cache_behavior.min_ttl #=> Integer
resp.distribution.distribution_config.default_cache_behavior.default_ttl #=> Integer
resp.distribution.distribution_config.default_cache_behavior.max_ttl #=> Integer
resp.distribution.distribution_config.cache_behaviors.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].path_pattern #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].target_origin_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.enabled #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_signers.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.enabled #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].trusted_key_groups.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].viewer_protocol_policy #=> String, one of "allow-all", "https-only", "redirect-to-https"
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.cached_methods.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.cached_methods.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].allowed_methods.cached_methods.items[0] #=> String, one of "GET", "HEAD", "POST", "PUT", "PATCH", "OPTIONS", "DELETE"
resp.distribution.distribution_config.cache_behaviors.items[0].smooth_streaming #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].compress #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items[0].lambda_function_arn #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.cache_behaviors.items[0].lambda_function_associations.items[0].include_body #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.items[0].function_arn #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].function_associations.items[0].event_type #=> String, one of "viewer-request", "viewer-response", "origin-request", "origin-response"
resp.distribution.distribution_config.cache_behaviors.items[0].field_level_encryption_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].realtime_log_config_arn #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].cache_policy_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].origin_request_policy_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].response_headers_policy_id #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string #=> Boolean
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.forward #=> String, one of "none", "whitelist", "all"
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.cookies.whitelisted_names.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.headers.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.headers.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.headers.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string_cache_keys.quantity #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string_cache_keys.items #=> Array
resp.distribution.distribution_config.cache_behaviors.items[0].forwarded_values.query_string_cache_keys.items[0] #=> String
resp.distribution.distribution_config.cache_behaviors.items[0].min_ttl #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].default_ttl #=> Integer
resp.distribution.distribution_config.cache_behaviors.items[0].max_ttl #=> Integer
resp.distribution.distribution_config.custom_error_responses.quantity #=> Integer
resp.distribution.distribution_config.custom_error_responses.items #=> Array
resp.distribution.distribution_config.custom_error_responses.items[0].error_code #=> Integer
resp.distribution.distribution_config.custom_error_responses.items[0].response_page_path #=> String
resp.distribution.distribution_config.custom_error_responses.items[0].response_code #=> String
resp.distribution.distribution_config.custom_error_responses.items[0].error_caching_min_ttl #=> Integer
resp.distribution.distribution_config.comment #=> String
resp.distribution.distribution_config.logging.enabled #=> Boolean
resp.distribution.distribution_config.logging.include_cookies #=> Boolean
resp.distribution.distribution_config.logging.bucket #=> String
resp.distribution.distribution_config.logging.prefix #=> String
resp.distribution.distribution_config.price_class #=> String, one of "PriceClass_100", "PriceClass_200", "PriceClass_All"
resp.distribution.distribution_config.enabled #=> Boolean
resp.distribution.distribution_config.viewer_certificate.cloud_front_default_certificate #=> Boolean
resp.distribution.distribution_config.viewer_certificate.iam_certificate_id #=> String
resp.distribution.distribution_config.viewer_certificate.acm_certificate_arn #=> String
resp.distribution.distribution_config.viewer_certificate.ssl_support_method #=> String, one of "sni-only", "vip", "static-ip"
resp.distribution.distribution_config.viewer_certificate.minimum_protocol_version #=> String, one of "SSLv3", "TLSv1", "TLSv1_2016", "TLSv1.1_2016", "TLSv1.2_2018", "TLSv1.2_2019", "TLSv1.2_2021"
resp.distribution.distribution_config.viewer_certificate.certificate #=> String
resp.distribution.distribution_config.viewer_certificate.certificate_source #=> String, one of "cloudfront", "iam", "acm"
resp.distribution.distribution_config.restrictions.geo_restriction.restriction_type #=> String, one of "blacklist", "whitelist", "none"
resp.distribution.distribution_config.restrictions.geo_restriction.quantity #=> Integer
resp.distribution.distribution_config.restrictions.geo_restriction.items #=> Array
resp.distribution.distribution_config.restrictions.geo_restriction.items[0] #=> String
resp.distribution.distribution_config.web_acl_id #=> String
resp.distribution.distribution_config.http_version #=> String, one of "http1.1", "http2", "http3", "http2and3"
resp.distribution.distribution_config.is_ipv6_enabled #=> Boolean
resp.distribution.distribution_config.continuous_deployment_policy_id #=> String
resp.distribution.distribution_config.staging #=> Boolean
resp.distribution.alias_icp_recordals #=> Array
resp.distribution.alias_icp_recordals[0].cname #=> String
resp.distribution.alias_icp_recordals[0].icp_recordal_status #=> String, one of "APPROVED", "SUSPENDED", "PENDING"
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:id (required, String) —

The identifier of the primary distribution to which you are copying a staging distribution’s configuration.
:staging_distribution_id (String) —

The identifier of the staging distribution whose configuration you are copying to the primary distribution.
:if_match (String) —

The current versions (‘ETag` values) of both primary and staging distributions. Provide these in the following format:

‘<primary ETag>, <staging ETag>`

Returns:

(Types::UpdateDistributionWithStagingConfigResult) —
Returns a response object which responds to the following methods:
- #distribution => Types::Distribution
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 8481

def update_distribution_with_staging_config(params = {}, options = {})
  req = build_request(:update_distribution_with_staging_config, params)
  req.send_request(options)
end

#update_field_level_encryption_config(params = {}) ⇒ `Types::UpdateFieldLevelEncryptionConfigResult`

Update a field-level encryption configuration.

Examples:

Request syntax with placeholder values


resp = client.update_field_level_encryption_config({
  field_level_encryption_config: { # required
    caller_reference: "string", # required
    comment: "string",
    query_arg_profile_config: {
      forward_when_query_arg_profile_is_unknown: false, # required
      query_arg_profiles: {
        quantity: 1, # required
        items: [
          {
            query_arg: "string", # required
            profile_id: "string", # required
          },
        ],
      },
    },
    content_type_profile_config: {
      forward_when_content_type_is_unknown: false, # required
      content_type_profiles: {
        quantity: 1, # required
        items: [
          {
            format: "URLEncoded", # required, accepts URLEncoded
            profile_id: "string",
            content_type: "string", # required
          },
        ],
      },
    },
  },
  id: "string", # required
  if_match: "string",
})

Response structure


resp.field_level_encryption.id #=> String
resp.field_level_encryption.last_modified_time #=> Time
resp.field_level_encryption.field_level_encryption_config.caller_reference #=> String
resp.field_level_encryption.field_level_encryption_config.comment #=> String
resp.field_level_encryption.field_level_encryption_config.query_arg_profile_config.forward_when_query_arg_profile_is_unknown #=> Boolean
resp.field_level_encryption.field_level_encryption_config.query_arg_profile_config.query_arg_profiles.quantity #=> Integer
resp.field_level_encryption.field_level_encryption_config.query_arg_profile_config.query_arg_profiles.items #=> Array
resp.field_level_encryption.field_level_encryption_config.query_arg_profile_config.query_arg_profiles.items[0].query_arg #=> String
resp.field_level_encryption.field_level_encryption_config.query_arg_profile_config.query_arg_profiles.items[0].profile_id #=> String
resp.field_level_encryption.field_level_encryption_config.content_type_profile_config.forward_when_content_type_is_unknown #=> Boolean
resp.field_level_encryption.field_level_encryption_config.content_type_profile_config.content_type_profiles.quantity #=> Integer
resp.field_level_encryption.field_level_encryption_config.content_type_profile_config.content_type_profiles.items #=> Array
resp.field_level_encryption.field_level_encryption_config.content_type_profile_config.content_type_profiles.items[0].format #=> String, one of "URLEncoded"
resp.field_level_encryption.field_level_encryption_config.content_type_profile_config.content_type_profiles.items[0].profile_id #=> String
resp.field_level_encryption.field_level_encryption_config.content_type_profile_config.content_type_profiles.items[0].content_type #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:field_level_encryption_config (required, Types::FieldLevelEncryptionConfig) —

Request to update a field-level encryption configuration.
:id (required, String) —

The ID of the configuration you want to update.
:if_match (String) —

The value of the ‘ETag` header that you received when retrieving the configuration identity to update. For example: `E2QWRUHAPOMQZL`.

Returns:

(Types::UpdateFieldLevelEncryptionConfigResult) —
Returns a response object which responds to the following methods:
- #field_level_encryption => Types::FieldLevelEncryption
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 8562

def update_field_level_encryption_config(params = {}, options = {})
  req = build_request(:update_field_level_encryption_config, params)
  req.send_request(options)
end

#update_field_level_encryption_profile(params = {}) ⇒ `Types::UpdateFieldLevelEncryptionProfileResult`

Update a field-level encryption profile.

Examples:

Request syntax with placeholder values


resp = client.update_field_level_encryption_profile({
  field_level_encryption_profile_config: { # required
    name: "string", # required
    caller_reference: "string", # required
    comment: "string",
    encryption_entities: { # required
      quantity: 1, # required
      items: [
        {
          public_key_id: "string", # required
          provider_id: "string", # required
          field_patterns: { # required
            quantity: 1, # required
            items: ["string"],
          },
        },
      ],
    },
  },
  id: "string", # required
  if_match: "string",
})

Response structure


resp.field_level_encryption_profile.id #=> String
resp.field_level_encryption_profile.last_modified_time #=> Time
resp.field_level_encryption_profile.field_level_encryption_profile_config.name #=> String
resp.field_level_encryption_profile.field_level_encryption_profile_config.caller_reference #=> String
resp.field_level_encryption_profile.field_level_encryption_profile_config.comment #=> String
resp.field_level_encryption_profile.field_level_encryption_profile_config.encryption_entities.quantity #=> Integer
resp.field_level_encryption_profile.field_level_encryption_profile_config.encryption_entities.items #=> Array
resp.field_level_encryption_profile.field_level_encryption_profile_config.encryption_entities.items[0].public_key_id #=> String
resp.field_level_encryption_profile.field_level_encryption_profile_config.encryption_entities.items[0].provider_id #=> String
resp.field_level_encryption_profile.field_level_encryption_profile_config.encryption_entities.items[0].field_patterns.quantity #=> Integer
resp.field_level_encryption_profile.field_level_encryption_profile_config.encryption_entities.items[0].field_patterns.items #=> Array
resp.field_level_encryption_profile.field_level_encryption_profile_config.encryption_entities.items[0].field_patterns.items[0] #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:field_level_encryption_profile_config (required, Types::FieldLevelEncryptionProfileConfig) —

Request to update a field-level encryption profile.
:id (required, String) —

The ID of the field-level encryption profile request.
:if_match (String) —

The value of the ‘ETag` header that you received when retrieving the profile identity to update. For example: `E2QWRUHAPOMQZL`.

Returns:

(Types::UpdateFieldLevelEncryptionProfileResult) —
Returns a response object which responds to the following methods:
- #field_level_encryption_profile => Types::FieldLevelEncryptionProfile
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 8629

def update_field_level_encryption_profile(params = {}, options = {})
  req = build_request(:update_field_level_encryption_profile, params)
  req.send_request(options)
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`.

Examples:

Example: To update a function


# Use the following command to update a function.

resp = client.update_function({
  function_code: "function-code-changed.js", 
  function_config: {
    comment: "my-changed-comment", 
    key_value_store_associations: {
      items: [
        {
          key_value_store_arn: "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889", 
        }, 
      ], 
      quantity: 1, 
    }, 
    runtime: "cloudfront-js-2.0", 
  }, 
  if_match: "ETVPDKIKX0DER", 
  name: "my-function-name", 
})

resp.to_h outputs the following:
{
  etag: "E3UN6WX5RRO2AG", 
  function_summary: {
    function_config: {
      comment: "my-changed-comment", 
      key_value_store_associations: {
        items: [
          {
            key_value_store_arn: "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889", 
          }, 
        ], 
        quantity: 1, 
      }, 
      runtime: "cloudfront-js-2.0", 
    }, 
    function_metadata: {
      created_time: Time.parse("2023-11-07T19:53:50.334Z"), 
      function_arn: "arn:aws:cloudfront::123456789012:function/my-function-name", 
      last_modified_time: Time.parse("2023-11-07T20:01:37.174Z"), 
      stage: "DEVELOPMENT", 
    }, 
    name: "my-function-name", 
    status: "UNPUBLISHED", 
  }, 
}

Request syntax with placeholder values


resp = client.update_function({
  name: "string", # required
  if_match: "string", # required
  function_config: { # required
    comment: "string", # required
    runtime: "cloudfront-js-1.0", # required, accepts cloudfront-js-1.0, cloudfront-js-2.0
    key_value_store_associations: {
      quantity: 1, # required
      items: [
        {
          key_value_store_arn: "KeyValueStoreARN", # required
        },
      ],
    },
  },
  function_code: "data", # required
})

Response structure


resp.function_summary.name #=> String
resp.function_summary.status #=> String
resp.function_summary.function_config.comment #=> String
resp.function_summary.function_config.runtime #=> String, one of "cloudfront-js-1.0", "cloudfront-js-2.0"
resp.function_summary.function_config.key_value_store_associations.quantity #=> Integer
resp.function_summary.function_config.key_value_store_associations.items #=> Array
resp.function_summary.function_config.key_value_store_associations.items[0].key_value_store_arn #=> String
resp.function_summary.function_metadata.function_arn #=> String
resp.function_summary.function_metadata.stage #=> String, one of "DEVELOPMENT", "LIVE"
resp.function_summary.function_metadata.created_time #=> Time
resp.function_summary.function_metadata.last_modified_time #=> Time
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:name (required, String) —

The name of the function that you are updating.
:if_match (required, String) —

The current version (‘ETag` value) of the function that you are updating, which you can get using `DescribeFunction`.
:function_config (required, Types::FunctionConfig) —

Configuration information about the function.
:function_code (required, String, StringIO, File) —

The function code. For more information about writing a CloudFront function, see [Writing function code for CloudFront Functions] in the *Amazon CloudFront Developer Guide*.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html

Returns:

(Types::UpdateFunctionResult) —
Returns a response object which responds to the following methods:
- #function_summary => Types::FunctionSummary
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 8756

def update_function(params = {}, options = {})
  req = build_request(:update_function, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.update_key_group({
  key_group_config: { # required
    name: "string", # required
    items: ["string"], # required
    comment: "string",
  },
  id: "string", # required
  if_match: "string",
})

Response structure


resp.key_group.id #=> String
resp.key_group.last_modified_time #=> Time
resp.key_group.key_group_config.name #=> String
resp.key_group.key_group_config.items #=> Array
resp.key_group.key_group_config.items[0] #=> String
resp.key_group.key_group_config.comment #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:key_group_config (required, Types::KeyGroupConfig) —

The key group configuration.
:id (required, String) —

The identifier of the key group that you are updating.
:if_match (String) —

The version of the key group that you are updating. The version is the key group’s ‘ETag` value.

Returns:

(Types::UpdateKeyGroupResult) —
Returns a response object which responds to the following methods:
- #key_group => Types::KeyGroup
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 8817

def update_key_group(params = {}, options = {})
  req = build_request(:update_key_group, params)
  req.send_request(options)
end

#update_key_value_store(params = {}) ⇒ `Types::UpdateKeyValueStoreResult`

Specifies the key value store to update.

Examples:

Example: To update a KeyValueStore


# Use the following command to update a KeyValueStore.

resp = client.update_key_value_store({
  comment: "my-changed-comment", 
  if_match: "ETVPDKIKX0DER", 
  name: "my-keyvaluestore-name", 
})

resp.to_h outputs the following:
{
  etag: "E3UN6WX5RRO2AG", 
  key_value_store: {
    arn: "arn:aws:cloudfront::123456789012:key-value-store/54947df8-0e9e-4471-a2f9-9af509fb5889", 
    comment: "my-changed-comment", 
    id: "54947df8-0e9e-4471-a2f9-9af509fb5889", 
    last_modified_time: Time.parse("2023-11-07T18:45:21.069Z"), 
    name: "my-keyvaluestore-name", 
    status: "READY", 
  }, 
}

Request syntax with placeholder values


resp = client.update_key_value_store({
  name: "KeyValueStoreName", # required
  comment: "KeyValueStoreComment", # required
  if_match: "string", # required
})

Response structure


resp.key_value_store.name #=> String
resp.key_value_store.id #=> String
resp.key_value_store.comment #=> String
resp.key_value_store.arn #=> String
resp.key_value_store.status #=> String
resp.key_value_store.last_modified_time #=> Time
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:name (required, String) —

The name of the key value store to update.
:comment (required, String) —

The comment of the key value store to update.
:if_match (required, String) —

The key value store to update, if a match occurs.

Returns:

(Types::UpdateKeyValueStoreResult) —
Returns a response object which responds to the following methods:
- #key_value_store => Types::KeyValueStore
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 8884

def update_key_value_store(params = {}, options = {})
  req = build_request(:update_key_value_store, params)
  req.send_request(options)
end

#update_origin_access_control(params = {}) ⇒ `Types::UpdateOriginAccessControlResult`

Updates a CloudFront origin access control.

Examples:

Request syntax with placeholder values


resp = client.update_origin_access_control({
  origin_access_control_config: { # required
    name: "string", # required
    description: "string",
    signing_protocol: "sigv4", # required, accepts sigv4
    signing_behavior: "never", # required, accepts never, always, no-override
    origin_access_control_origin_type: "s3", # required, accepts s3, mediastore, mediapackagev2, lambda
  },
  id: "string", # required
  if_match: "string",
})

Response structure


resp.origin_access_control.id #=> String
resp.origin_access_control.origin_access_control_config.name #=> String
resp.origin_access_control.origin_access_control_config.description #=> String
resp.origin_access_control.origin_access_control_config.signing_protocol #=> String, one of "sigv4"
resp.origin_access_control.origin_access_control_config.signing_behavior #=> String, one of "never", "always", "no-override"
resp.origin_access_control.origin_access_control_config.origin_access_control_origin_type #=> String, one of "s3", "mediastore", "mediapackagev2", "lambda"
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:origin_access_control_config (required, Types::OriginAccessControlConfig) —

An origin access control.
:id (required, String) —

The unique identifier of the origin access control that you are updating.
:if_match (String) —

The current version (‘ETag` value) of the origin access control that you are updating.

Returns:

(Types::UpdateOriginAccessControlResult) —
Returns a response object which responds to the following methods:
- #origin_access_control => Types::OriginAccessControl
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 8935

def update_origin_access_control(params = {}, options = {})
  req = build_request(:update_origin_access_control, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.update_origin_request_policy({
  origin_request_policy_config: { # required
    comment: "string",
    name: "string", # required
    headers_config: { # required
      header_behavior: "none", # required, accepts none, whitelist, allViewer, allViewerAndWhitelistCloudFront, allExcept
      headers: {
        quantity: 1, # required
        items: ["string"],
      },
    },
    cookies_config: { # required
      cookie_behavior: "none", # required, accepts none, whitelist, all, allExcept
      cookies: {
        quantity: 1, # required
        items: ["string"],
      },
    },
    query_strings_config: { # required
      query_string_behavior: "none", # required, accepts none, whitelist, all, allExcept
      query_strings: {
        quantity: 1, # required
        items: ["string"],
      },
    },
  },
  id: "string", # required
  if_match: "string",
})

Response structure


resp.origin_request_policy.id #=> String
resp.origin_request_policy.last_modified_time #=> Time
resp.origin_request_policy.origin_request_policy_config.comment #=> String
resp.origin_request_policy.origin_request_policy_config.name #=> String
resp.origin_request_policy.origin_request_policy_config.headers_config.header_behavior #=> String, one of "none", "whitelist", "allViewer", "allViewerAndWhitelistCloudFront", "allExcept"
resp.origin_request_policy.origin_request_policy_config.headers_config.headers.quantity #=> Integer
resp.origin_request_policy.origin_request_policy_config.headers_config.headers.items #=> Array
resp.origin_request_policy.origin_request_policy_config.headers_config.headers.items[0] #=> String
resp.origin_request_policy.origin_request_policy_config.cookies_config.cookie_behavior #=> String, one of "none", "whitelist", "all", "allExcept"
resp.origin_request_policy.origin_request_policy_config.cookies_config.cookies.quantity #=> Integer
resp.origin_request_policy.origin_request_policy_config.cookies_config.cookies.items #=> Array
resp.origin_request_policy.origin_request_policy_config.cookies_config.cookies.items[0] #=> String
resp.origin_request_policy.origin_request_policy_config.query_strings_config.query_string_behavior #=> String, one of "none", "whitelist", "all", "allExcept"
resp.origin_request_policy.origin_request_policy_config.query_strings_config.query_strings.quantity #=> Integer
resp.origin_request_policy.origin_request_policy_config.query_strings_config.query_strings.items #=> Array
resp.origin_request_policy.origin_request_policy_config.query_strings_config.query_strings.items[0] #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:origin_request_policy_config (required, Types::OriginRequestPolicyConfig) —

An origin request policy configuration.
:id (required, String) —

The unique identifier for the origin request policy that you are updating. The identifier is returned in a cache behavior’s ‘OriginRequestPolicyId` field in the response to `GetDistributionConfig`.
:if_match (String) —

The version of the origin request policy that you are updating. The version is returned in the origin request policy’s ‘ETag` field in the response to `GetOriginRequestPolicyConfig`.

Returns:

(Types::UpdateOriginRequestPolicyResult) —
Returns a response object which responds to the following methods:
- #origin_request_policy => Types::OriginRequestPolicy
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 9032

def update_origin_request_policy(params = {}, options = {})
  req = build_request(:update_origin_request_policy, params)
  req.send_request(options)
end

#update_public_key(params = {}) ⇒ `Types::UpdatePublicKeyResult`

Update public key information. Note that the only value you can change is the comment.

Examples:

Request syntax with placeholder values


resp = client.update_public_key({
  public_key_config: { # required
    caller_reference: "string", # required
    name: "string", # required
    encoded_key: "string", # required
    comment: "string",
  },
  id: "string", # required
  if_match: "string",
})

Response structure


resp.public_key.id #=> String
resp.public_key.created_time #=> Time
resp.public_key.public_key_config.caller_reference #=> String
resp.public_key.public_key_config.name #=> String
resp.public_key.public_key_config.encoded_key #=> String
resp.public_key.public_key_config.comment #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:public_key_config (required, Types::PublicKeyConfig) —

A public key configuration.
:id (required, String) —

The identifier of the public key that you are updating.
:if_match (String) —

The value of the ‘ETag` header that you received when retrieving the public key to update. For example: `E2QWRUHAPOMQZL`.

Returns:

(Types::UpdatePublicKeyResult) —
Returns a response object which responds to the following methods:
- #public_key => Types::PublicKey
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 9082

def update_public_key(params = {}, options = {})
  req = build_request(:update_public_key, params)
  req.send_request(options)
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`.

Examples:

Request syntax with placeholder values


resp = client.update_realtime_log_config({
  end_points: [
    {
      stream_type: "string", # required
      kinesis_stream_config: {
        role_arn: "string", # required
        stream_arn: "string", # required
      },
    },
  ],
  fields: ["string"],
  name: "string",
  arn: "string",
  sampling_rate: 1,
})

Response structure


resp.realtime_log_config.arn #=> String
resp.realtime_log_config.name #=> String
resp.realtime_log_config.sampling_rate #=> Integer
resp.realtime_log_config.end_points #=> Array
resp.realtime_log_config.end_points[0].stream_type #=> String
resp.realtime_log_config.end_points[0].kinesis_stream_config.role_arn #=> String
resp.realtime_log_config.end_points[0].kinesis_stream_config.stream_arn #=> String
resp.realtime_log_config.fields #=> Array
resp.realtime_log_config.fields[0] #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:end_points (Array<Types::EndPoint>) —

Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
:fields (Array<String>) —

A list of fields to include in each real-time log record.

For more information about fields, see [Real-time log configuration fields] in the *Amazon CloudFront Developer Guide*.

[1]: docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html#understand-real-time-log-config-fields
:name (String) —

The name for this real-time log configuration.
:arn (String) —

The Amazon Resource Name (ARN) for this real-time log configuration.
:sampling_rate (Integer) —

The sampling rate for this real-time log configuration. The sampling rate determines the percentage of viewer requests that are represented in the real-time log data. You must provide an integer between 1 and 100, inclusive.

Returns:

(Types::UpdateRealtimeLogConfigResult) —
Returns a response object which responds to the following methods:
- #realtime_log_config => Types::RealtimeLogConfig

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 9170

def update_realtime_log_config(params = {}, options = {})
  req = build_request(:update_realtime_log_config, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.update_response_headers_policy({
  response_headers_policy_config: { # required
    comment: "string",
    name: "string", # required
    cors_config: {
      access_control_allow_origins: { # required
        quantity: 1, # required
        items: ["string"], # required
      },
      access_control_allow_headers: { # required
        quantity: 1, # required
        items: ["string"], # required
      },
      access_control_allow_methods: { # required
        quantity: 1, # required
        items: ["GET"], # required, accepts GET, POST, OPTIONS, PUT, DELETE, PATCH, HEAD, ALL
      },
      access_control_allow_credentials: false, # required
      access_control_expose_headers: {
        quantity: 1, # required
        items: ["string"],
      },
      access_control_max_age_sec: 1,
      origin_override: false, # required
    },
    security_headers_config: {
      xss_protection: {
        override: false, # required
        protection: false, # required
        mode_block: false,
        report_uri: "string",
      },
      frame_options: {
        override: false, # required
        frame_option: "DENY", # required, accepts DENY, SAMEORIGIN
      },
      referrer_policy: {
        override: false, # required
        referrer_policy: "no-referrer", # required, accepts no-referrer, no-referrer-when-downgrade, origin, origin-when-cross-origin, same-origin, strict-origin, strict-origin-when-cross-origin, unsafe-url
      },
      content_security_policy: {
        override: false, # required
        content_security_policy: "string", # required
      },
      content_type_options: {
        override: false, # required
      },
      strict_transport_security: {
        override: false, # required
        include_subdomains: false,
        preload: false,
        access_control_max_age_sec: 1, # required
      },
    },
    server_timing_headers_config: {
      enabled: false, # required
      sampling_rate: 1.0,
    },
    custom_headers_config: {
      quantity: 1, # required
      items: [
        {
          header: "string", # required
          value: "string", # required
          override: false, # required
        },
      ],
    },
    remove_headers_config: {
      quantity: 1, # required
      items: [
        {
          header: "string", # required
        },
      ],
    },
  },
  id: "string", # required
  if_match: "string",
})

Response structure


resp.response_headers_policy.id #=> String
resp.response_headers_policy.last_modified_time #=> Time
resp.response_headers_policy.response_headers_policy_config.comment #=> String
resp.response_headers_policy.response_headers_policy_config.name #=> String
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_origins.quantity #=> Integer
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_origins.items #=> Array
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_origins.items[0] #=> String
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_headers.quantity #=> Integer
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_headers.items #=> Array
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_headers.items[0] #=> String
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_methods.quantity #=> Integer
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_methods.items #=> Array
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_methods.items[0] #=> String, one of "GET", "POST", "OPTIONS", "PUT", "DELETE", "PATCH", "HEAD", "ALL"
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_allow_credentials #=> Boolean
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_expose_headers.quantity #=> Integer
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_expose_headers.items #=> Array
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_expose_headers.items[0] #=> String
resp.response_headers_policy.response_headers_policy_config.cors_config.access_control_max_age_sec #=> Integer
resp.response_headers_policy.response_headers_policy_config.cors_config.origin_override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.xss_protection.override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.xss_protection.protection #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.xss_protection.mode_block #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.xss_protection.report_uri #=> String
resp.response_headers_policy.response_headers_policy_config.security_headers_config.frame_options.override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.frame_options.frame_option #=> String, one of "DENY", "SAMEORIGIN"
resp.response_headers_policy.response_headers_policy_config.security_headers_config.referrer_policy.override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.referrer_policy.referrer_policy #=> String, one of "no-referrer", "no-referrer-when-downgrade", "origin", "origin-when-cross-origin", "same-origin", "strict-origin", "strict-origin-when-cross-origin", "unsafe-url"
resp.response_headers_policy.response_headers_policy_config.security_headers_config.content_security_policy.override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.content_security_policy.content_security_policy #=> String
resp.response_headers_policy.response_headers_policy_config.security_headers_config.content_type_options.override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.strict_transport_security.override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.strict_transport_security.include_subdomains #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.strict_transport_security.preload #=> Boolean
resp.response_headers_policy.response_headers_policy_config.security_headers_config.strict_transport_security.access_control_max_age_sec #=> Integer
resp.response_headers_policy.response_headers_policy_config.server_timing_headers_config.enabled #=> Boolean
resp.response_headers_policy.response_headers_policy_config.server_timing_headers_config.sampling_rate #=> Float
resp.response_headers_policy.response_headers_policy_config.custom_headers_config.quantity #=> Integer
resp.response_headers_policy.response_headers_policy_config.custom_headers_config.items #=> Array
resp.response_headers_policy.response_headers_policy_config.custom_headers_config.items[0].header #=> String
resp.response_headers_policy.response_headers_policy_config.custom_headers_config.items[0].value #=> String
resp.response_headers_policy.response_headers_policy_config.custom_headers_config.items[0].override #=> Boolean
resp.response_headers_policy.response_headers_policy_config.remove_headers_config.quantity #=> Integer
resp.response_headers_policy.response_headers_policy_config.remove_headers_config.items #=> Array
resp.response_headers_policy.response_headers_policy_config.remove_headers_config.items[0].header #=> String
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:response_headers_policy_config (required, Types::ResponseHeadersPolicyConfig) —

A response headers policy configuration.
:id (required, String) —

The identifier for the response headers policy that you are updating.
:if_match (String) —

The version of the response headers policy that you are updating.

The version is returned in the cache policy’s ‘ETag` field in the response to `GetResponseHeadersPolicyConfig`.

Returns:

(Types::UpdateResponseHeadersPolicyResult) —
Returns a response object which responds to the following methods:
- #response_headers_policy => Types::ResponseHeadersPolicy
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 9343

def update_response_headers_policy(params = {}, options = {})
  req = build_request(:update_response_headers_policy, params)
  req.send_request(options)
end

#update_streaming_distribution(params = {}) ⇒ `Types::UpdateStreamingDistributionResult`

Update a streaming distribution.

Examples:

Request syntax with placeholder values


resp = client.update_streaming_distribution({
  streaming_distribution_config: { # required
    caller_reference: "string", # required
    s3_origin: { # required
      domain_name: "string", # required
      origin_access_identity: "string", # required
    },
    aliases: {
      quantity: 1, # required
      items: ["string"],
    },
    comment: "string", # required
    logging: {
      enabled: false, # required
      bucket: "string", # required
      prefix: "string", # required
    },
    trusted_signers: { # required
      enabled: false, # required
      quantity: 1, # required
      items: ["string"],
    },
    price_class: "PriceClass_100", # accepts PriceClass_100, PriceClass_200, PriceClass_All
    enabled: false, # required
  },
  id: "string", # required
  if_match: "string",
})

Response structure


resp.streaming_distribution.id #=> String
resp.streaming_distribution.arn #=> String
resp.streaming_distribution.status #=> String
resp.streaming_distribution.last_modified_time #=> Time
resp.streaming_distribution.domain_name #=> String
resp.streaming_distribution.active_trusted_signers.enabled #=> Boolean
resp.streaming_distribution.active_trusted_signers.quantity #=> Integer
resp.streaming_distribution.active_trusted_signers.items #=> Array
resp.streaming_distribution.active_trusted_signers.items[0].aws_account_number #=> String
resp.streaming_distribution.active_trusted_signers.items[0].key_pair_ids.quantity #=> Integer
resp.streaming_distribution.active_trusted_signers.items[0].key_pair_ids.items #=> Array
resp.streaming_distribution.active_trusted_signers.items[0].key_pair_ids.items[0] #=> String
resp.streaming_distribution.streaming_distribution_config.caller_reference #=> String
resp.streaming_distribution.streaming_distribution_config.s3_origin.domain_name #=> String
resp.streaming_distribution.streaming_distribution_config.s3_origin.origin_access_identity #=> String
resp.streaming_distribution.streaming_distribution_config.aliases.quantity #=> Integer
resp.streaming_distribution.streaming_distribution_config.aliases.items #=> Array
resp.streaming_distribution.streaming_distribution_config.aliases.items[0] #=> String
resp.streaming_distribution.streaming_distribution_config.comment #=> String
resp.streaming_distribution.streaming_distribution_config.logging.enabled #=> Boolean
resp.streaming_distribution.streaming_distribution_config.logging.bucket #=> String
resp.streaming_distribution.streaming_distribution_config.logging.prefix #=> String
resp.streaming_distribution.streaming_distribution_config.trusted_signers.enabled #=> Boolean
resp.streaming_distribution.streaming_distribution_config.trusted_signers.quantity #=> Integer
resp.streaming_distribution.streaming_distribution_config.trusted_signers.items #=> Array
resp.streaming_distribution.streaming_distribution_config.trusted_signers.items[0] #=> String
resp.streaming_distribution.streaming_distribution_config.price_class #=> String, one of "PriceClass_100", "PriceClass_200", "PriceClass_All"
resp.streaming_distribution.streaming_distribution_config.enabled #=> Boolean
resp.etag #=> String

Parameters:

params (Hash) (defaults to: {}) —

({})

Options Hash (params):

:streaming_distribution_config (required, Types::StreamingDistributionConfig) —

The streaming distribution’s configuration information.
:id (required, String) —

The streaming distribution’s id.
:if_match (String) —

The value of the ‘ETag` header that you received when retrieving the streaming distribution’s configuration. For example: ‘E2QWRUHAPOMQZL`.

Returns:

(Types::UpdateStreamingDistributionResult) —
Returns a response object which responds to the following methods:
- #streaming_distribution => Types::StreamingDistribution
- #etag => String

See Also:

AWS API Documentation

# File 'lib/aws-sdk-cloudfront/client.rb', line 9433

def update_streaming_distribution(params = {}, options = {})
  req = build_request(:update_streaming_distribution, params)
  req.send_request(options)
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 |

Parameters:

waiter_name (Symbol)
params (Hash) (defaults to: {}) —

({})
options (Hash) (defaults to: {}) —

({})

Options Hash (options):

:max_attempts (Integer)
:delay (Integer)
:before_attempt (Proc)
:before_wait (Proc)

Yields:

(w.waiter)

Returns:

(Boolean) —

Returns ‘true` if the waiter was successful.

Raises:

(Errors::FailureStateError) —

Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.
(Errors::TooManyAttemptsError) —

Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.
(Errors::UnexpectedError) —

Raised when an error is encounted while polling for a resource that is not expected.
(Errors::NoSuchWaiterError) —

Raised when you request to wait for an unknown state.

# File 'lib/aws-sdk-cloudfront/client.rb', line 9545

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  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.

Deprecated.



9553
9554
9555

# File 'lib/aws-sdk-cloudfront/client.rb', line 9553

def waiter_names
  waiters.keys
end

Class: Aws::CloudFront::Client

Overview

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Class Attribute Details

.identifier ⇒ Object (readonly)

Class Method Details

.errors_module ⇒ Object

Instance Method Details

#associate_alias(params = {}) ⇒ Struct

#build_request(operation_name, params = {}) ⇒ Object

#copy_distribution(params = {}) ⇒ Types::CopyDistributionResult

#create_cache_policy(params = {}) ⇒ Types::CreateCachePolicyResult

#create_cloud_front_origin_access_identity(params = {}) ⇒ Types::CreateCloudFrontOriginAccessIdentityResult

#create_continuous_deployment_policy(params = {}) ⇒ Types::CreateContinuousDeploymentPolicyResult

#create_distribution(params = {}) ⇒ Types::CreateDistributionResult

#create_distribution_with_tags(params = {}) ⇒ Types::CreateDistributionWithTagsResult

#create_field_level_encryption_config(params = {}) ⇒ Types::CreateFieldLevelEncryptionConfigResult

#create_field_level_encryption_profile(params = {}) ⇒ Types::CreateFieldLevelEncryptionProfileResult

#create_function(params = {}) ⇒ Types::CreateFunctionResult

#create_invalidation(params = {}) ⇒ Types::CreateInvalidationResult

#create_key_group(params = {}) ⇒ Types::CreateKeyGroupResult

#create_key_value_store(params = {}) ⇒ Types::CreateKeyValueStoreResult

#create_monitoring_subscription(params = {}) ⇒ Types::CreateMonitoringSubscriptionResult

#create_origin_access_control(params = {}) ⇒ Types::CreateOriginAccessControlResult

#create_origin_request_policy(params = {}) ⇒ Types::CreateOriginRequestPolicyResult

#create_public_key(params = {}) ⇒ Types::CreatePublicKeyResult

#create_realtime_log_config(params = {}) ⇒ Types::CreateRealtimeLogConfigResult

#create_response_headers_policy(params = {}) ⇒ Types::CreateResponseHeadersPolicyResult

#create_streaming_distribution(params = {}) ⇒ Types::CreateStreamingDistributionResult

#create_streaming_distribution_with_tags(params = {}) ⇒ Types::CreateStreamingDistributionWithTagsResult

#delete_cache_policy(params = {}) ⇒ Struct

#delete_cloud_front_origin_access_identity(params = {}) ⇒ Struct

#delete_continuous_deployment_policy(params = {}) ⇒ Struct

#delete_distribution(params = {}) ⇒ Struct

#delete_field_level_encryption_config(params = {}) ⇒ Struct

#delete_field_level_encryption_profile(params = {}) ⇒ Struct

#delete_function(params = {}) ⇒ Struct

#delete_key_group(params = {}) ⇒ Struct

#delete_key_value_store(params = {}) ⇒ Struct

#delete_monitoring_subscription(params = {}) ⇒ Struct

#delete_origin_access_control(params = {}) ⇒ Struct

#delete_origin_request_policy(params = {}) ⇒ Struct

#delete_public_key(params = {}) ⇒ Struct

#delete_realtime_log_config(params = {}) ⇒ Struct

#delete_response_headers_policy(params = {}) ⇒ Struct

#delete_streaming_distribution(params = {}) ⇒ Struct

#describe_function(params = {}) ⇒ Types::DescribeFunctionResult

#describe_key_value_store(params = {}) ⇒ Types::DescribeKeyValueStoreResult

#get_cache_policy(params = {}) ⇒ Types::GetCachePolicyResult

#get_cache_policy_config(params = {}) ⇒ Types::GetCachePolicyConfigResult

#get_cloud_front_origin_access_identity(params = {}) ⇒ Types::GetCloudFrontOriginAccessIdentityResult

#get_cloud_front_origin_access_identity_config(params = {}) ⇒ Types::GetCloudFrontOriginAccessIdentityConfigResult

#get_continuous_deployment_policy(params = {}) ⇒ Types::GetContinuousDeploymentPolicyResult

#get_continuous_deployment_policy_config(params = {}) ⇒ Types::GetContinuousDeploymentPolicyConfigResult

#get_distribution(params = {}) ⇒ Types::GetDistributionResult

#get_distribution_config(params = {}) ⇒ Types::GetDistributionConfigResult

#get_field_level_encryption(params = {}) ⇒ Types::GetFieldLevelEncryptionResult

#get_field_level_encryption_config(params = {}) ⇒ Types::GetFieldLevelEncryptionConfigResult

#get_field_level_encryption_profile(params = {}) ⇒ Types::GetFieldLevelEncryptionProfileResult

#get_field_level_encryption_profile_config(params = {}) ⇒ Types::GetFieldLevelEncryptionProfileConfigResult

#get_function(params = {}) ⇒ Types::GetFunctionResult

#get_invalidation(params = {}) ⇒ Types::GetInvalidationResult

#get_key_group(params = {}) ⇒ Types::GetKeyGroupResult

#get_key_group_config(params = {}) ⇒ Types::GetKeyGroupConfigResult

#get_monitoring_subscription(params = {}) ⇒ Types::GetMonitoringSubscriptionResult

#get_origin_access_control(params = {}) ⇒ Types::GetOriginAccessControlResult

#get_origin_access_control_config(params = {}) ⇒ Types::GetOriginAccessControlConfigResult

#get_origin_request_policy(params = {}) ⇒ Types::GetOriginRequestPolicyResult

#get_origin_request_policy_config(params = {}) ⇒ Types::GetOriginRequestPolicyConfigResult

#get_public_key(params = {}) ⇒ Types::GetPublicKeyResult

#get_public_key_config(params = {}) ⇒ Types::GetPublicKeyConfigResult

#get_realtime_log_config(params = {}) ⇒ Types::GetRealtimeLogConfigResult

#get_response_headers_policy(params = {}) ⇒ Types::GetResponseHeadersPolicyResult

#get_response_headers_policy_config(params = {}) ⇒ Types::GetResponseHeadersPolicyConfigResult

#get_streaming_distribution(params = {}) ⇒ Types::GetStreamingDistributionResult

#initialize(options) ⇒ `Client`

.identifier ⇒ `Object` (readonly)

.errors_module ⇒ `Object`

#associate_alias(params = {}) ⇒ `Struct`

#build_request(operation_name, params = {}) ⇒ `Object`

#copy_distribution(params = {}) ⇒ `Types::CopyDistributionResult`

#create_cache_policy(params = {}) ⇒ `Types::CreateCachePolicyResult`

#create_cloud_front_origin_access_identity(params = {}) ⇒ `Types::CreateCloudFrontOriginAccessIdentityResult`

#create_continuous_deployment_policy(params = {}) ⇒ `Types::CreateContinuousDeploymentPolicyResult`

#create_distribution(params = {}) ⇒ `Types::CreateDistributionResult`

#create_distribution_with_tags(params = {}) ⇒ `Types::CreateDistributionWithTagsResult`

#create_field_level_encryption_config(params = {}) ⇒ `Types::CreateFieldLevelEncryptionConfigResult`

#create_field_level_encryption_profile(params = {}) ⇒ `Types::CreateFieldLevelEncryptionProfileResult`

#create_function(params = {}) ⇒ `Types::CreateFunctionResult`

#create_invalidation(params = {}) ⇒ `Types::CreateInvalidationResult`

#create_key_group(params = {}) ⇒ `Types::CreateKeyGroupResult`

#create_key_value_store(params = {}) ⇒ `Types::CreateKeyValueStoreResult`

#create_monitoring_subscription(params = {}) ⇒ `Types::CreateMonitoringSubscriptionResult`

#create_origin_access_control(params = {}) ⇒ `Types::CreateOriginAccessControlResult`

#create_origin_request_policy(params = {}) ⇒ `Types::CreateOriginRequestPolicyResult`

#create_public_key(params = {}) ⇒ `Types::CreatePublicKeyResult`

#create_realtime_log_config(params = {}) ⇒ `Types::CreateRealtimeLogConfigResult`

#create_response_headers_policy(params = {}) ⇒ `Types::CreateResponseHeadersPolicyResult`

#create_streaming_distribution(params = {}) ⇒ `Types::CreateStreamingDistributionResult`

#create_streaming_distribution_with_tags(params = {}) ⇒ `Types::CreateStreamingDistributionWithTagsResult`

#delete_cache_policy(params = {}) ⇒ `Struct`

#delete_cloud_front_origin_access_identity(params = {}) ⇒ `Struct`

#delete_continuous_deployment_policy(params = {}) ⇒ `Struct`

#delete_distribution(params = {}) ⇒ `Struct`

#delete_field_level_encryption_config(params = {}) ⇒ `Struct`

#delete_field_level_encryption_profile(params = {}) ⇒ `Struct`

#delete_function(params = {}) ⇒ `Struct`

#delete_key_group(params = {}) ⇒ `Struct`

#delete_key_value_store(params = {}) ⇒ `Struct`

#delete_monitoring_subscription(params = {}) ⇒ `Struct`

#delete_origin_access_control(params = {}) ⇒ `Struct`

#delete_origin_request_policy(params = {}) ⇒ `Struct`

#delete_public_key(params = {}) ⇒ `Struct`

#delete_realtime_log_config(params = {}) ⇒ `Struct`

#delete_response_headers_policy(params = {}) ⇒ `Struct`

#delete_streaming_distribution(params = {}) ⇒ `Struct`

#describe_function(params = {}) ⇒ `Types::DescribeFunctionResult`

#describe_key_value_store(params = {}) ⇒ `Types::DescribeKeyValueStoreResult`

#get_cache_policy(params = {}) ⇒ `Types::GetCachePolicyResult`

#get_cache_policy_config(params = {}) ⇒ `Types::GetCachePolicyConfigResult`

#get_cloud_front_origin_access_identity(params = {}) ⇒ `Types::GetCloudFrontOriginAccessIdentityResult`

#get_cloud_front_origin_access_identity_config(params = {}) ⇒ `Types::GetCloudFrontOriginAccessIdentityConfigResult`

#get_continuous_deployment_policy(params = {}) ⇒ `Types::GetContinuousDeploymentPolicyResult`

#get_continuous_deployment_policy_config(params = {}) ⇒ `Types::GetContinuousDeploymentPolicyConfigResult`

#get_distribution(params = {}) ⇒ `Types::GetDistributionResult`

#get_distribution_config(params = {}) ⇒ `Types::GetDistributionConfigResult`

#get_field_level_encryption(params = {}) ⇒ `Types::GetFieldLevelEncryptionResult`

#get_field_level_encryption_config(params = {}) ⇒ `Types::GetFieldLevelEncryptionConfigResult`

#get_field_level_encryption_profile(params = {}) ⇒ `Types::GetFieldLevelEncryptionProfileResult`

#get_field_level_encryption_profile_config(params = {}) ⇒ `Types::GetFieldLevelEncryptionProfileConfigResult`

#get_function(params = {}) ⇒ `Types::GetFunctionResult`

#get_invalidation(params = {}) ⇒ `Types::GetInvalidationResult`

#get_key_group(params = {}) ⇒ `Types::GetKeyGroupResult`

#get_key_group_config(params = {}) ⇒ `Types::GetKeyGroupConfigResult`

#get_monitoring_subscription(params = {}) ⇒ `Types::GetMonitoringSubscriptionResult`

#get_origin_access_control(params = {}) ⇒ `Types::GetOriginAccessControlResult`

#get_origin_access_control_config(params = {}) ⇒ `Types::GetOriginAccessControlConfigResult`

#get_origin_request_policy(params = {}) ⇒ `Types::GetOriginRequestPolicyResult`

#get_origin_request_policy_config(params = {}) ⇒ `Types::GetOriginRequestPolicyConfigResult`

#get_public_key(params = {}) ⇒ `Types::GetPublicKeyResult`

#get_public_key_config(params = {}) ⇒ `Types::GetPublicKeyConfigResult`

#get_realtime_log_config(params = {}) ⇒ `Types::GetRealtimeLogConfigResult`

#get_response_headers_policy(params = {}) ⇒ `Types::GetResponseHeadersPolicyResult`

#get_response_headers_policy_config(params = {}) ⇒ `Types::GetResponseHeadersPolicyConfigResult`

#get_streaming_distribution(params = {}) ⇒ `Types::GetStreamingDistributionResult`

#get_streaming_distribution_config(params = {}) ⇒ `Types::GetStreamingDistributionConfigResult`

#list_cache_policies(params = {}) ⇒ `Types::ListCachePoliciesResult`

#list_cloud_front_origin_access_identities(params = {}) ⇒ `Types::ListCloudFrontOriginAccessIdentitiesResult`

#list_conflicting_aliases(params = {}) ⇒ `Types::ListConflictingAliasesResult`

#list_continuous_deployment_policies(params = {}) ⇒ `Types::ListContinuousDeploymentPoliciesResult`

#list_distributions(params = {}) ⇒ `Types::ListDistributionsResult`

#list_distributions_by_cache_policy_id(params = {}) ⇒ `Types::ListDistributionsByCachePolicyIdResult`

#list_distributions_by_key_group(params = {}) ⇒ `Types::ListDistributionsByKeyGroupResult`

#list_distributions_by_origin_request_policy_id(params = {}) ⇒ `Types::ListDistributionsByOriginRequestPolicyIdResult`

#list_distributions_by_realtime_log_config(params = {}) ⇒ `Types::ListDistributionsByRealtimeLogConfigResult`