Class: Aws::CloudFront::Client

Inherits:
Seahorse::Client::Base show all
Includes:
Aws::ClientStubs
Defined in:
gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb

Overview

An API client for CloudFront. To construct a client, you need to configure a :region and :credentials.

client = Aws::CloudFront::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

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 used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or 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[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.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::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] 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[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_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.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :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 —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :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_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :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.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :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 https://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)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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 Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or 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 'http://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_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :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.



473
474
475
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 473

def initialize(*args)
  super
end

Instance Method Details

#associate_alias(params = {}) ⇒ Struct

The AssociateAlias API operation only supports standard distributions. To move domains between distribution tenants and/or standard distributions, we recommend that you use the UpdateDomainAssociation API operation instead.

Associates an alias with a CloudFront standard distribution. An alias is commonly known as a custom domain or vanity domain. It can also be called a CNAME or alternate domain name.

With this operation, you can move an alias that's already used for a standard distribution to a different standard distribution. This prevents the downtime that could occur if you first remove the alias from one standard distribution and then separately add the alias to another standard distribution.

To use this operation, specify the alias and the ID of the target standard distribution.

For more information, including how to set up the target standard distribution, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different standard distribution or distribution tenant in the Amazon CloudFront Developer Guide.

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 standard distribution that you're associating the alias with.

  • :alias (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



532
533
534
535
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 532

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

#associate_distribution_tenant_web_acl(params = {}) ⇒ Types::AssociateDistributionTenantWebACLResult

Associates the WAF web ACL with a distribution tenant.

Examples:

Request syntax with placeholder values


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

Response structure


resp.id #=> String
resp.web_acl_arn #=> String
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the distribution tenant.

  • :web_acl_arn (required, String) —

    The Amazon Resource Name (ARN) of the WAF web ACL to associate.

  • :if_match (String) —

    The current ETag of the distribution tenant. This value is returned in the response of the GetDistributionTenant API operation.

Returns:

See Also:



573
574
575
576
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 573

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

#associate_distribution_web_acl(params = {}) ⇒ Types::AssociateDistributionWebACLResult

Associates the WAF web ACL with a distribution.

Examples:

Request syntax with placeholder values


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

Response structure


resp.id #=> String
resp.web_acl_arn #=> String
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the distribution.

  • :web_acl_arn (required, String) —

    The Amazon Resource Name (ARN) of the WAF web ACL to associate.

  • :if_match (String) —

    The value of the ETag header that you received when retrieving the distribution that you're associating with the WAF web ACL.

Returns:

See Also:



614
615
616
617
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 614

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

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]. #=> 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].s3_origin_config.origin_read_timeout #=> Integer
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].custom_origin_config.ip_address_type #=> String, one of "ipv4", "ipv6", "dualstack"
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_mtls_config.client_certificate_arn #=> String
resp.distribution.distribution_config.origins.items[0].vpc_origin_config.vpc_origin_id #=> String
resp.distribution.distribution_config.origins.items[0].vpc_origin_config. #=> String
resp.distribution.distribution_config.origins.items[0].vpc_origin_config.origin_read_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].vpc_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].response_completion_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.origin_groups.items[0].selection_criteria #=> String, one of "default", "media-quality-based"
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.grpc_config.enabled #=> Boolean
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].grpc_config.enabled #=> Boolean
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", "None"
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", "TLSv1.3_2025", "TLSv1.2_2025"
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.distribution_config.anycast_ip_list_id #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions #=> Array
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].name #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].definition.string_schema.comment #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].definition.string_schema.default_value #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].definition.string_schema.required #=> Boolean
resp.distribution.distribution_config.connection_mode #=> String, one of "direct", "tenant-only"
resp.distribution.distribution_config.viewer_mtls_config.mode #=> String, one of "required", "optional"
resp.distribution.distribution_config.viewer_mtls_config.trust_store_config.trust_store_id #=> String
resp.distribution.distribution_config.viewer_mtls_config.trust_store_config.advertise_trust_store_ca_names #=> Boolean
resp.distribution.distribution_config.viewer_mtls_config.trust_store_config.ignore_certificate_expiry #=> Boolean
resp.distribution.distribution_config.connection_function_association.id #=> String
resp.distribution.distribution_config.cache_tag_config.header_name #=> String
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:

See Also:



903
904
905
906
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 903

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

#create_anycast_ip_list(params = {}) ⇒ Types::CreateAnycastIpListResult

Creates an Anycast static IP list.

Examples:

Request syntax with placeholder values


resp = client.create_anycast_ip_list({
  name: "AnycastIpListName", # required
  ip_count: 1, # required
  tags: {
    items: [
      {
        key: "TagKey", # required
        value: "TagValue",
      },
    ],
  },
  ip_address_type: "ipv4", # accepts ipv4, ipv6, dualstack
  ipam_cidr_configs: [
    {
      cidr: "string", # required
      ipam_pool_arn: "string", # required
      anycast_ip: "string",
      status: "provisioned", # accepts provisioned, failed-provision, provisioning, deprovisioned, failed-deprovision, deprovisioning, advertised, failed-advertise, advertising, withdrawn, failed-withdraw, withdrawing
    },
  ],
})

Response structure


resp.anycast_ip_list.id #=> String
resp.anycast_ip_list.name #=> String
resp.anycast_ip_list.status #=> String
resp.anycast_ip_list.arn #=> String
resp.anycast_ip_list.ip_address_type #=> String, one of "ipv4", "ipv6", "dualstack"
resp.anycast_ip_list.ipam_config.quantity #=> Integer
resp.anycast_ip_list.ipam_config.ipam_cidr_configs #=> Array
resp.anycast_ip_list.ipam_config.ipam_cidr_configs[0].cidr #=> String
resp.anycast_ip_list.ipam_config.ipam_cidr_configs[0].ipam_pool_arn #=> String
resp.anycast_ip_list.ipam_config.ipam_cidr_configs[0].anycast_ip #=> String
resp.anycast_ip_list.ipam_config.ipam_cidr_configs[0].status #=> String, one of "provisioned", "failed-provision", "provisioning", "deprovisioned", "failed-deprovision", "deprovisioning", "advertised", "failed-advertise", "advertising", "withdrawn", "failed-withdraw", "withdrawing"
resp.anycast_ip_list.anycast_ips #=> Array
resp.anycast_ip_list.anycast_ips[0] #=> String
resp.anycast_ip_list.ip_count #=> Integer
resp.anycast_ip_list.last_modified_time #=> Time
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    Name of the Anycast static IP list.

  • :ip_count (required, Integer) —

    The number of static IP addresses that are allocated to the Anycast static IP list. Valid values: 21 or 3.

  • :tags (Types::Tags) —

    A complex type that contains zero or more Tag elements.

  • :ip_address_type (String) —

    The IP address type for the Anycast static IP list. You can specify one of the following options:

    • ipv4 only

    • ipv6 only

    • dualstack - Allocate a list of both IPv4 and IPv6 addresses

  • :ipam_cidr_configs (Array<Types::IpamCidrConfig>) —

    A list of IPAM CIDR configurations that specify the IP address ranges and IPAM pool settings for creating the Anycast static IP list.

Returns:

See Also:



986
987
988
989
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 986

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

    If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the Cache-Control: no-cache, no-store, or private directives are present in the origin headers.

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.

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):

Returns:

See Also:



1100
1101
1102
1103
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 1100

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.

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):

Returns:

See Also:



1147
1148
1149
1150
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 1147

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_connection_function(params = {}) ⇒ Types::CreateConnectionFunctionResult

Creates a connection function.

Examples:

Request syntax with placeholder values


resp = client.create_connection_function({
  name: "FunctionName", # required
  connection_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
        },
      ],
    },
  },
  connection_function_code: "data", # required
  tags: {
    items: [
      {
        key: "TagKey", # required
        value: "TagValue",
      },
    ],
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    A name for the connection function.

  • :connection_function_config (required, Types::FunctionConfig) —

    Contains configuration information about a CloudFront function.

  • :connection_function_code (required, String, StringIO, File) —

    The code for the connection function.

  • :tags (Types::Tags) —

    A complex type that contains zero or more Tag elements.

Returns:

See Also:



1220
1221
1222
1223
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 1220

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

#create_connection_group(params = {}) ⇒ Types::CreateConnectionGroupResult

Creates a connection group.

Examples:

Request syntax with placeholder values


resp = client.create_connection_group({
  name: "string", # required
  ipv_6_enabled: false,
  tags: {
    items: [
      {
        key: "TagKey", # required
        value: "TagValue",
      },
    ],
  },
  anycast_ip_list_id: "string",
  enabled: false,
})

Response structure


resp.connection_group.id #=> String
resp.connection_group.name #=> String
resp.connection_group.arn #=> String
resp.connection_group.created_time #=> Time
resp.connection_group.last_modified_time #=> Time
resp.connection_group.tags.items #=> Array
resp.connection_group.tags.items[0].key #=> String
resp.connection_group.tags.items[0].value #=> String
resp.connection_group.ipv_6_enabled #=> Boolean
resp.connection_group.routing_endpoint #=> String
resp.connection_group.anycast_ip_list_id #=> String
resp.connection_group.status #=> String
resp.connection_group.enabled #=> Boolean
resp.connection_group.is_default #=> Boolean
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the connection group. Enter a friendly identifier that is unique within your Amazon Web Services account. This name can't be updated after you create the connection group.

  • :ipv_6_enabled (Boolean) —

    Enable IPv6 for the connection group. The default is true. For more information, see Enable IPv6 in the Amazon CloudFront Developer Guide.

  • :tags (Types::Tags) —

    A complex type that contains zero or more Tag elements.

  • :anycast_ip_list_id (String) —

    The ID of the Anycast static IP list.

  • :enabled (Boolean) —

    Enable the connection group.

Returns:

See Also:



1294
1295
1296
1297
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 1294

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

Returns:

See Also:



1368
1369
1370
1371
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 1368

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
            origin_read_timeout: 1,
          },
          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,
            ip_address_type: "ipv4", # accepts ipv4, ipv6, dualstack
            origin_mtls_config: {
              client_certificate_arn: "string", # required
            },
          },
          vpc_origin_config: {
            vpc_origin_id: "string", # required
            owner_account_id: "string",
            origin_read_timeout: 1,
            origin_keepalive_timeout: 1,
          },
          connection_attempts: 1,
          connection_timeout: 1,
          response_completion_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
              },
            ],
          },
          selection_criteria: "default", # accepts default, media-quality-based
        },
      ],
    },
    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",
      grpc_config: {
        enabled: false, # required
      },
      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",
          grpc_config: {
            enabled: false, # required
          },
          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,
      include_cookies: false,
      bucket: "string",
      prefix: "string",
    },
    price_class: "PriceClass_100", # accepts PriceClass_100, PriceClass_200, PriceClass_All, None
    enabled: false, # required
    viewer_certificate: {
      cloud_front_default_certificate: false,
      iam_certificate_id: "ServerCertificateId",
      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, TLSv1.3_2025, TLSv1.2_2025
      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,
    anycast_ip_list_id: "string",
    tenant_config: {
      parameter_definitions: [
        {
          name: "ParameterName", # required
          definition: { # required
            string_schema: {
              comment: "sensitiveStringType",
              default_value: "ParameterValue",
              required: false, # required
            },
          },
        },
      ],
    },
    connection_mode: "direct", # accepts direct, tenant-only
    viewer_mtls_config: {
      mode: "required", # accepts required, optional
      trust_store_config: {
        trust_store_id: "string", # required
        advertise_trust_store_ca_names: false,
        ignore_certificate_expiry: false,
      },
    },
    connection_function_association: {
      id: "ResourceId", # required
    },
    cache_tag_config: {
      header_name: "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]. #=> 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].s3_origin_config.origin_read_timeout #=> Integer
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].custom_origin_config.ip_address_type #=> String, one of "ipv4", "ipv6", "dualstack"
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_mtls_config.client_certificate_arn #=> String
resp.distribution.distribution_config.origins.items[0].vpc_origin_config.vpc_origin_id #=> String
resp.distribution.distribution_config.origins.items[0].vpc_origin_config. #=> String
resp.distribution.distribution_config.origins.items[0].vpc_origin_config.origin_read_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].vpc_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].response_completion_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.origin_groups.items[0].selection_criteria #=> String, one of "default", "media-quality-based"
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.grpc_config.enabled #=> Boolean
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].grpc_config.enabled #=> Boolean
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", "None"
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", "TLSv1.3_2025", "TLSv1.2_2025"
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.distribution_config.anycast_ip_list_id #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions #=> Array
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].name #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].definition.string_schema.comment #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].definition.string_schema.default_value #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].definition.string_schema.required #=> Boolean
resp.distribution.distribution_config.connection_mode #=> String, one of "direct", "tenant-only"
resp.distribution.distribution_config.viewer_mtls_config.mode #=> String, one of "required", "optional"
resp.distribution.distribution_config.viewer_mtls_config.trust_store_config.trust_store_id #=> String
resp.distribution.distribution_config.viewer_mtls_config.trust_store_config.advertise_trust_store_ca_names #=> Boolean
resp.distribution.distribution_config.viewer_mtls_config.trust_store_config.ignore_certificate_expiry #=> Boolean
resp.distribution.distribution_config.connection_function_association.id #=> String
resp.distribution.distribution_config.cache_tag_config.header_name #=> String
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):

Returns:

See Also:



1910
1911
1912
1913
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 1910

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

#create_distribution_tenant(params = {}) ⇒ Types::CreateDistributionTenantResult

Creates a distribution tenant.

Examples:

Request syntax with placeholder values


resp = client.create_distribution_tenant({
  distribution_id: "string", # required
  name: "CreateDistributionTenantRequestNameString", # required
  domains: [ # required
    {
      domain: "string", # required
    },
  ],
  tags: {
    items: [
      {
        key: "TagKey", # required
        value: "TagValue",
      },
    ],
  },
  customizations: {
    web_acl: {
      action: "override", # required, accepts override, disable
      arn: "string",
    },
    certificate: {
      arn: "string", # required
    },
    geo_restrictions: {
      restriction_type: "blacklist", # required, accepts blacklist, whitelist, none
      locations: ["string"],
    },
  },
  parameters: [
    {
      name: "ParameterName", # required
      value: "ParameterValue", # required
    },
  ],
  connection_group_id: "string",
  managed_certificate_request: {
    validation_token_host: "cloudfront", # required, accepts cloudfront, self-hosted
    primary_domain_name: "string",
    certificate_transparency_logging_preference: "enabled", # accepts enabled, disabled
  },
  enabled: false,
})

Response structure


resp.distribution_tenant.id #=> String
resp.distribution_tenant.distribution_id #=> String
resp.distribution_tenant.name #=> String
resp.distribution_tenant.arn #=> String
resp.distribution_tenant.domains #=> Array
resp.distribution_tenant.domains[0].domain #=> String
resp.distribution_tenant.domains[0].status #=> String, one of "active", "inactive"
resp.distribution_tenant.tags.items #=> Array
resp.distribution_tenant.tags.items[0].key #=> String
resp.distribution_tenant.tags.items[0].value #=> String
resp.distribution_tenant.customizations.web_acl.action #=> String, one of "override", "disable"
resp.distribution_tenant.customizations.web_acl.arn #=> String
resp.distribution_tenant.customizations.certificate.arn #=> String
resp.distribution_tenant.customizations.geo_restrictions.restriction_type #=> String, one of "blacklist", "whitelist", "none"
resp.distribution_tenant.customizations.geo_restrictions.locations #=> Array
resp.distribution_tenant.customizations.geo_restrictions.locations[0] #=> String
resp.distribution_tenant.parameters #=> Array
resp.distribution_tenant.parameters[0].name #=> String
resp.distribution_tenant.parameters[0].value #=> String
resp.distribution_tenant.connection_group_id #=> String
resp.distribution_tenant.created_time #=> Time
resp.distribution_tenant.last_modified_time #=> Time
resp.distribution_tenant.enabled #=> Boolean
resp.distribution_tenant.status #=> String
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :distribution_id (required, String) —

    The ID of the multi-tenant distribution to use for creating the distribution tenant.

  • :name (required, String) —

    The name of the distribution tenant. Enter a friendly identifier that is unique within your Amazon Web Services account. This name can't be updated after you create the distribution tenant.

  • :domains (required, Array<Types::DomainItem>) —

    The domains associated with the distribution tenant. You must specify at least one domain in the request.

  • :tags (Types::Tags) —

    A complex type that contains zero or more Tag elements.

  • :customizations (Types::Customizations) —

    Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.

  • :parameters (Array<Types::Parameter>) —

    A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.

  • :connection_group_id (String) —

    The ID of the connection group to associate with the distribution tenant.

  • :managed_certificate_request (Types::ManagedCertificateRequest) —

    The configuration for the CloudFront managed ACM certificate request.

  • :enabled (Boolean) —

    Indicates whether the distribution tenant should be enabled when created. If the distribution tenant is disabled, the distribution tenant won't serve traffic.

Returns:

See Also:



2042
2043
2044
2045
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 2042

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

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
              origin_read_timeout: 1,
            },
            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,
              ip_address_type: "ipv4", # accepts ipv4, ipv6, dualstack
              origin_mtls_config: {
                client_certificate_arn: "string", # required
              },
            },
            vpc_origin_config: {
              vpc_origin_id: "string", # required
              owner_account_id: "string",
              origin_read_timeout: 1,
              origin_keepalive_timeout: 1,
            },
            connection_attempts: 1,
            connection_timeout: 1,
            response_completion_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
                },
              ],
            },
            selection_criteria: "default", # accepts default, media-quality-based
          },
        ],
      },
      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",
        grpc_config: {
          enabled: false, # required
        },
        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",
            grpc_config: {
              enabled: false, # required
            },
            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,
        include_cookies: false,
        bucket: "string",
        prefix: "string",
      },
      price_class: "PriceClass_100", # accepts PriceClass_100, PriceClass_200, PriceClass_All, None
      enabled: false, # required
      viewer_certificate: {
        cloud_front_default_certificate: false,
        iam_certificate_id: "ServerCertificateId",
        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, TLSv1.3_2025, TLSv1.2_2025
        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,
      anycast_ip_list_id: "string",
      tenant_config: {
        parameter_definitions: [
          {
            name: "ParameterName", # required
            definition: { # required
              string_schema: {
                comment: "sensitiveStringType",
                default_value: "ParameterValue",
                required: false, # required
              },
            },
          },
        ],
      },
      connection_mode: "direct", # accepts direct, tenant-only
      viewer_mtls_config: {
        mode: "required", # accepts required, optional
        trust_store_config: {
          trust_store_id: "string", # required
          advertise_trust_store_ca_names: false,
          ignore_certificate_expiry: false,
        },
      },
      connection_function_association: {
        id: "ResourceId", # required
      },
      cache_tag_config: {
        header_name: "string", # required
      },
    },
    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]. #=> 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].s3_origin_config.origin_read_timeout #=> Integer
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].custom_origin_config.ip_address_type #=> String, one of "ipv4", "ipv6", "dualstack"
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_mtls_config.client_certificate_arn #=> String
resp.distribution.distribution_config.origins.items[0].vpc_origin_config.vpc_origin_id #=> String
resp.distribution.distribution_config.origins.items[0].vpc_origin_config. #=> String
resp.distribution.distribution_config.origins.items[0].vpc_origin_config.origin_read_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].vpc_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].response_completion_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.origin_groups.items[0].selection_criteria #=> String, one of "default", "media-quality-based"
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.grpc_config.enabled #=> Boolean
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].grpc_config.enabled #=> Boolean
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", "None"
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", "TLSv1.3_2025", "TLSv1.2_2025"
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.distribution_config.anycast_ip_list_id #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions #=> Array
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].name #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].definition.string_schema.comment #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].definition.string_schema.default_value #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].definition.string_schema.required #=> Boolean
resp.distribution.distribution_config.connection_mode #=> String, one of "direct", "tenant-only"
resp.distribution.distribution_config.viewer_mtls_config.mode #=> String, one of "required", "optional"
resp.distribution.distribution_config.viewer_mtls_config.trust_store_config.trust_store_id #=> String
resp.distribution.distribution_config.viewer_mtls_config.trust_store_config.advertise_trust_store_ca_names #=> Boolean
resp.distribution.distribution_config.viewer_mtls_config.trust_store_config.ignore_certificate_expiry #=> Boolean
resp.distribution.distribution_config.connection_function_association.id #=> String
resp.distribution.distribution_config.cache_tag_config.header_name #=> String
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):

Returns:

See Also:



2604
2605
2606
2607
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 2604

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):

Returns:

See Also:



2678
2679
2680
2681
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 2678

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):

Returns:

See Also:



2738
2739
2740
2741
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 2738

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.

Returns:

See Also:



2870
2871
2872
2873
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 2870

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.

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:

See Also:



2921
2922
2923
2924
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 2921

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

#create_invalidation_for_distribution_tenant(params = {}) ⇒ Types::CreateInvalidationForDistributionTenantResult

Creates an invalidation for a distribution tenant. For more information, see Invalidating files in the Amazon CloudFront Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_invalidation_for_distribution_tenant({
  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):

  • :id (required, String) —

    The ID of the distribution tenant.

  • :invalidation_batch (required, Types::InvalidationBatch) —

    An invalidation batch.

Returns:

See Also:



2973
2974
2975
2976
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 2973

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

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):

Returns:

See Also:



3030
3031
3032
3033
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3030

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:::amzn-s3-demo-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:

See Also:



3111
3112
3113
3114
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3111

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 or disables additional Amazon 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.

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:

See Also:



3158
3159
3160
3161
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3158

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.

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):

Returns:

See Also:



3216
3217
3218
3219
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3216

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.

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):

Returns:

See Also:



3315
3316
3317
3318
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3315

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.

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):

Returns:

See Also:



3363
3364
3365
3366
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3363

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 in the Amazon CloudFront Developer Guide.

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.

  • :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:

See Also:



3441
3442
3443
3444
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3441

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.

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:

See Also:



3612
3613
3614
3615
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3612

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.

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, None
    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]. #=> 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", "None"
resp.streaming_distribution.streaming_distribution_config.enabled #=> Boolean
resp.location #=> String
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



3701
3702
3703
3704
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3701

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

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.

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, None
      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]. #=> 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", "None"
resp.streaming_distribution.streaming_distribution_config.enabled #=> Boolean
resp.location #=> String
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



3800
3801
3802
3803
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3800

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

#create_trust_store(params = {}) ⇒ Types::CreateTrustStoreResult

Creates a trust store.

Examples:

Request syntax with placeholder values


resp = client.create_trust_store({
  name: "string", # required
  ca_certificates_bundle_source: { # required
    ca_certificates_bundle_s3_location: {
      bucket: "string", # required
      key: "string", # required
      region: "CaCertificatesBundleS3LocationRegionString", # required
      version: "string",
    },
  },
  tags: {
    items: [
      {
        key: "TagKey", # required
        value: "TagValue",
      },
    ],
  },
})

Response structure


resp.trust_store.id #=> String
resp.trust_store.arn #=> String
resp.trust_store.name #=> String
resp.trust_store.status #=> String, one of "pending", "active", "failed"
resp.trust_store.number_of_ca_certificates #=> Integer
resp.trust_store.last_modified_time #=> Time
resp.trust_store.reason #=> String
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    A name for the trust store.

  • :ca_certificates_bundle_source (required, Types::CaCertificatesBundleSource) —

    The CA certificates bundle source for the trust store.

  • :tags (Types::Tags) —

    A complex type that contains zero or more Tag elements.

Returns:

See Also:



3858
3859
3860
3861
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3858

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

#create_vpc_origin(params = {}) ⇒ Types::CreateVpcOriginResult

Create an Amazon CloudFront VPC origin.

Examples:

Example: To create a VPC origin


# The following command creates a VPC origin:

resp = client.create_vpc_origin({
  vpc_origin_endpoint_config: {
    arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-alb-us-west-2/e6aa5c7d26415c6d", 
    http_port: 80, 
    https_port: 443, 
    name: "my-vpcorigin-name", 
    origin_protocol_policy: "match-viewer", 
    origin_ssl_protocols: {
      items: [
        "TLSv1.1", 
        "TLSv1.2", 
      ], 
      quantity: 2, 
    }, 
  }, 
})

resp.to_h outputs the following:
{
  etag: "E23ZP02F085DFQ", 
  location: "https://cloudfront.amazonaws.com/2020-05-31/vpc-origin/vo_BQwjxxQxjCaBcQLzJUFkDM", 
  vpc_origin: {
    arn: "arn:aws:cloudfront::123456789012:vpcorigin/vo_BQwjxxQxjCaBcQLzJUFkDM", 
    created_time: Time.parse("2024-10-15T17:19:42.318Z"), 
    id: "vo_BQwjxxQxjCaBcQLzJUFkDM", 
    last_modified_time: Time.parse("2024-10-15T17:19:42.318Z"), 
    status: "Deploying", 
    vpc_origin_endpoint_config: {
      arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-alb-us-west-2/e6aa5c7d26415c6d", 
      http_port: 80, 
      https_port: 443, 
      name: "my-vpcorigin-name", 
      origin_protocol_policy: "match-viewer", 
      origin_ssl_protocols: {
        items: [
          "TLSv1.1", 
          "TLSv1.2", 
        ], 
        quantity: 2, 
      }, 
    }, 
  }, 
}

Request syntax with placeholder values


resp = client.create_vpc_origin({
  vpc_origin_endpoint_config: { # required
    name: "string", # required
    arn: "string", # required
    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
    },
  },
  tags: {
    items: [
      {
        key: "TagKey", # required
        value: "TagValue",
      },
    ],
  },
})

Response structure


resp.vpc_origin.id #=> String
resp.vpc_origin.arn #=> String
resp.vpc_origin. #=> String
resp.vpc_origin.status #=> String
resp.vpc_origin.created_time #=> Time
resp.vpc_origin.last_modified_time #=> Time
resp.vpc_origin.vpc_origin_endpoint_config.name #=> String
resp.vpc_origin.vpc_origin_endpoint_config.arn #=> String
resp.vpc_origin.vpc_origin_endpoint_config.http_port #=> Integer
resp.vpc_origin.vpc_origin_endpoint_config.https_port #=> Integer
resp.vpc_origin.vpc_origin_endpoint_config.origin_protocol_policy #=> String, one of "http-only", "match-viewer", "https-only"
resp.vpc_origin.vpc_origin_endpoint_config.origin_ssl_protocols.quantity #=> Integer
resp.vpc_origin.vpc_origin_endpoint_config.origin_ssl_protocols.items #=> Array
resp.vpc_origin.vpc_origin_endpoint_config.origin_ssl_protocols.items[0] #=> String, one of "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2"
resp.location #=> String
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



3973
3974
3975
3976
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 3973

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

#delete_anycast_ip_list(params = {}) ⇒ Struct

Deletes an Anycast static IP list.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the Anycast static IP list.

  • :if_match (required, String) —

    The current version (ETag value) of the Anycast static IP list that you are deleting.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4000
4001
4002
4003
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4000

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



4037
4038
4039
4040
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4037

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:



4064
4065
4066
4067
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4064

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_connection_function(params = {}) ⇒ Struct

Deletes a connection function.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The connection function's ID.

  • :if_match (required, String) —

    The current version (ETag value) of the connection function you are deleting.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4091
4092
4093
4094
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4091

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

#delete_connection_group(params = {}) ⇒ Struct

Deletes a connection group.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the connection group to delete.

  • :if_match (required, String) —

    The value of the ETag header that you received when retrieving the connection group to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4118
4119
4120
4121
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4118

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



4150
4151
4152
4153
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4150

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.

Before you can delete a distribution, you must disable it, which requires permission to update the distribution. Once deleted, a distribution cannot be recovered.

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:



4181
4182
4183
4184
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4181

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

#delete_distribution_tenant(params = {}) ⇒ Struct

Deletes a distribution tenant. If you use this API operation to delete a distribution tenant that is currently enabled, the request will fail.

To delete a distribution tenant, you must first disable the distribution tenant by using the UpdateDistributionTenant API operation.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the distribution tenant to delete.

  • :if_match (required, String) —

    The value of the ETag header that you received when retrieving the distribution tenant. This value is returned in the response of the GetDistributionTenant API operation.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4215
4216
4217
4218
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4215

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



4242
4243
4244
4245
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4242

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:



4269
4270
4271
4272
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4269

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: "FunctionName", # 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:



4304
4305
4306
4307
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4304

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:



4341
4342
4343
4344
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4341

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:



4377
4378
4379
4380
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4377

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:



4400
4401
4402
4403
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4400

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:



4432
4433
4434
4435
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4432

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:



4472
4473
4474
4475
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4472

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:



4499
4500
4501
4502
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4499

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:



4536
4537
4538
4539
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4536

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

#delete_resource_policy(params = {}) ⇒ Struct

Deletes the resource policy attached to the CloudFront resource.

Examples:

Request syntax with placeholder values


resp = client.delete_resource_policy({
  resource_arn: "string", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the CloudFront resource for which the resource policy should be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4559
4560
4561
4562
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4559

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



4600
4601
4602
4603
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4600

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:

  1. Disable the RTMP distribution.

  2. Submit a GET Streaming Distribution Config request to get the current configuration and the Etag header for the distribution.

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

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

  5. Review the response to the PUT Streaming Distribution Config request to confirm that the distribution was successfully disabled.

  6. Submit a GET Streaming Distribution Config request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

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

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

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:



4670
4671
4672
4673
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4670

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

#delete_trust_store(params = {}) ⇒ Struct

Deletes a trust store.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The trust store's ID.

  • :if_match (required, String) —

    The current version (ETag value) of the trust store you are deleting.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4697
4698
4699
4700
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4697

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

#delete_vpc_origin(params = {}) ⇒ Types::DeleteVpcOriginResult

Delete an Amazon CloudFront VPC origin.

Examples:

Example: To delete a VPC origin


# The following command deletes a VPC origin:

resp = client.delete_vpc_origin({
  id: "vo_BQwjxxQxjCaBcQLzJUFkDM", 
  if_match: "E1F83G8C2ARO7P", 
})

resp.to_h outputs the following:
{
  etag: "E1PA6795UKMFR9", 
  vpc_origin: {
    arn: "arn:aws:cloudfront::123456789012:vpcorigin/vo_BQwjxxQxjCaBcQLzJUFkDM", 
    created_time: Time.parse("2024-10-15T17:19:42.318Z"), 
    id: "vo_BQwjxxQxjCaBcQLzJUFkDM", 
    last_modified_time: Time.parse("2024-10-15T17:57:08.965Z"), 
    status: "Deploying", 
    vpc_origin_endpoint_config: {
      arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-alb-us-west-2/e6aa5c7d26415c6d", 
      http_port: 80, 
      https_port: 443, 
      name: "my-vpcorigin-name", 
      origin_protocol_policy: "match-viewer", 
      origin_ssl_protocols: {
        items: [
          "TLSv1.1", 
          "TLSv1.2", 
        ], 
        quantity: 2, 
      }, 
    }, 
  }, 
}

Request syntax with placeholder values


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

Response structure


resp.vpc_origin.id #=> String
resp.vpc_origin.arn #=> String
resp.vpc_origin. #=> String
resp.vpc_origin.status #=> String
resp.vpc_origin.created_time #=> Time
resp.vpc_origin.last_modified_time #=> Time
resp.vpc_origin.vpc_origin_endpoint_config.name #=> String
resp.vpc_origin.vpc_origin_endpoint_config.arn #=> String
resp.vpc_origin.vpc_origin_endpoint_config.http_port #=> Integer
resp.vpc_origin.vpc_origin_endpoint_config.https_port #=> Integer
resp.vpc_origin.vpc_origin_endpoint_config.origin_protocol_policy #=> String, one of "http-only", "match-viewer", "https-only"
resp.vpc_origin.vpc_origin_endpoint_config.origin_ssl_protocols.quantity #=> Integer
resp.vpc_origin.vpc_origin_endpoint_config.origin_ssl_protocols.items #=> Array
resp.vpc_origin.vpc_origin_endpoint_config.origin_ssl_protocols.items[0] #=> String, one of "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2"
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The VPC origin ID.

  • :if_match (required, String) —

    The version identifier of the VPC origin to delete. This is the ETag value returned in the response to GetVpcOrigin.

Returns:

See Also:



4781
4782
4783
4784
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4781

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

#describe_connection_function(params = {}) ⇒ Types::DescribeConnectionFunctionResult

Describes a connection function.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The connection function's identifier.

  • :stage (String) —

    The connection function's stage.

Returns:

See Also:



4826
4827
4828
4829
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4826

def describe_connection_function(params = {}, options = {})
  req = build_request(:describe_connection_function, 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: "FunctionName", # 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:

See Also:



4876
4877
4878
4879
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4876

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:

See Also:



4933
4934
4935
4936
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4933

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

#disassociate_distribution_tenant_web_acl(params = {}) ⇒ Types::DisassociateDistributionTenantWebACLResult

Disassociates a distribution tenant from the WAF web ACL.

Examples:

Request syntax with placeholder values


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

Response structure


resp.id #=> String
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the distribution tenant.

  • :if_match (String) —

    The current version of the distribution tenant that you're disassociating from the WAF web ACL. This is the ETag value returned in the response to the GetDistributionTenant API operation.

Returns:

See Also:



4969
4970
4971
4972
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 4969

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

#disassociate_distribution_web_acl(params = {}) ⇒ Types::DisassociateDistributionWebACLResult

Disassociates a distribution from the WAF web ACL.

Examples:

Request syntax with placeholder values


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

Response structure


resp.id #=> String
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the distribution.

  • :if_match (String) —

    The value of the ETag header that you received when retrieving the distribution that you're disassociating from the WAF web ACL.

Returns:

See Also:



5004
5005
5006
5007
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5004

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

#get_anycast_ip_list(params = {}) ⇒ Types::GetAnycastIpListResult

Gets an Anycast static IP list.

Examples:

Request syntax with placeholder values


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

Response structure


resp.anycast_ip_list.id #=> String
resp.anycast_ip_list.name #=> String
resp.anycast_ip_list.status #=> String
resp.anycast_ip_list.arn #=> String
resp.anycast_ip_list.ip_address_type #=> String, one of "ipv4", "ipv6", "dualstack"
resp.anycast_ip_list.ipam_config.quantity #=> Integer
resp.anycast_ip_list.ipam_config.ipam_cidr_configs #=> Array
resp.anycast_ip_list.ipam_config.ipam_cidr_configs[0].cidr #=> String
resp.anycast_ip_list.ipam_config.ipam_cidr_configs[0].ipam_pool_arn #=> String
resp.anycast_ip_list.ipam_config.ipam_cidr_configs[0].anycast_ip #=> String
resp.anycast_ip_list.ipam_config.ipam_cidr_configs[0].status #=> String, one of "provisioned", "failed-provision", "provisioning", "deprovisioned", "failed-deprovision", "deprovisioning", "advertised", "failed-advertise", "advertising", "withdrawn", "failed-withdraw", "withdrawing"
resp.anycast_ip_list.anycast_ips #=> Array
resp.anycast_ip_list.anycast_ips[0] #=> String
resp.anycast_ip_list.ip_count #=> Integer
resp.anycast_ip_list.last_modified_time #=> Time
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the Anycast static IP list.

Returns:

See Also:



5048
5049
5050
5051
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5048

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

See Also:



5112
5113
5114
5115
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5112

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:

See Also:



5171
5172
5173
5174
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5171

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:

See Also:



5204
5205
5206
5207
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5204

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:

See Also:



5235
5236
5237
5238
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5235

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_connection_function(params = {}) ⇒ Types::GetConnectionFunctionResult

Gets a connection function.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The connection function's identifier.

  • :stage (String) —

    The connection function's stage.

Returns:

See Also:



5271
5272
5273
5274
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5271

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

#get_connection_group(params = {}) ⇒ Types::GetConnectionGroupResult

Gets information about a connection group.

Examples:

Request syntax with placeholder values


resp = client.get_connection_group({
  identifier: "string", # required
})

Response structure


resp.connection_group.id #=> String
resp.connection_group.name #=> String
resp.connection_group.arn #=> String
resp.connection_group.created_time #=> Time
resp.connection_group.last_modified_time #=> Time
resp.connection_group.tags.items #=> Array
resp.connection_group.tags.items[0].key #=> String
resp.connection_group.tags.items[0].value #=> String
resp.connection_group.ipv_6_enabled #=> Boolean
resp.connection_group.routing_endpoint #=> String
resp.connection_group.anycast_ip_list_id #=> String
resp.connection_group.status #=> String
resp.connection_group.enabled #=> Boolean
resp.connection_group.is_default #=> Boolean
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The ID, name, or Amazon Resource Name (ARN) of the connection group.

Returns:

See Also:



5314
5315
5316
5317
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5314

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

#get_connection_group_by_routing_endpoint(params = {}) ⇒ Types::GetConnectionGroupByRoutingEndpointResult

Gets information about a connection group by using the endpoint that you specify.

Examples:

Request syntax with placeholder values


resp = client.get_connection_group_by_routing_endpoint({
  routing_endpoint: "string", # required
})

Response structure


resp.connection_group.id #=> String
resp.connection_group.name #=> String
resp.connection_group.arn #=> String
resp.connection_group.created_time #=> Time
resp.connection_group.last_modified_time #=> Time
resp.connection_group.tags.items #=> Array
resp.connection_group.tags.items[0].key #=> String
resp.connection_group.tags.items[0].value #=> String
resp.connection_group.ipv_6_enabled #=> Boolean
resp.connection_group.routing_endpoint #=> String
resp.connection_group.anycast_ip_list_id #=> String
resp.connection_group.status #=> String
resp.connection_group.enabled #=> Boolean
resp.connection_group.is_default #=> Boolean
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :routing_endpoint (required, String) —

    The routing endpoint for the target connection group, such as d111111abcdef8.cloudfront.net.

Returns:

See Also:



5359
5360
5361
5362
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5359

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

See Also:



5402
5403
5404
5405
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5402

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:

See Also:



5442
5443
5444
5445
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5442

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]. #=> 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].s3_origin_config.origin_read_timeout #=> Integer
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].custom_origin_config.ip_address_type #=> String, one of "ipv4", "ipv6", "dualstack"
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_mtls_config.client_certificate_arn #=> String
resp.distribution.distribution_config.origins.items[0].vpc_origin_config.vpc_origin_id #=> String
resp.distribution.distribution_config.origins.items[0].vpc_origin_config. #=> String
resp.distribution.distribution_config.origins.items[0].vpc_origin_config.origin_read_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].vpc_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].response_completion_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.origin_groups.items[0].selection_criteria #=> String, one of "default", "media-quality-based"
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.grpc_config.enabled #=> Boolean
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].grpc_config.enabled #=> Boolean
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", "None"
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", "TLSv1.3_2025", "TLSv1.2_2025"
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.distribution_config.anycast_ip_list_id #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions #=> Array
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].name #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].definition.string_schema.comment #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].definition.string_schema.default_value #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].definition.string_schema.required #=> Boolean
resp.distribution.distribution_config.connection_mode #=> String, one of "direct", "tenant-only"
resp.distribution.distribution_config.viewer_mtls_config.mode #=> String, one of "required", "optional"
resp.distribution.distribution_config.viewer_mtls_config.trust_store_config.trust_store_id #=> String
resp.distribution.distribution_config.viewer_mtls_config.trust_store_config.advertise_trust_store_ca_names #=> Boolean
resp.distribution.distribution_config.viewer_mtls_config.trust_store_config.ignore_certificate_expiry #=> Boolean
resp.distribution.distribution_config.connection_function_association.id #=> String
resp.distribution.distribution_config.cache_tag_config.header_name #=> String
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:

See Also:



5685
5686
5687
5688
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5685

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].s3_origin_config.origin_read_timeout #=> Integer
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].custom_origin_config.ip_address_type #=> String, one of "ipv4", "ipv6", "dualstack"
resp.distribution_config.origins.items[0].custom_origin_config.origin_mtls_config.client_certificate_arn #=> String
resp.distribution_config.origins.items[0].vpc_origin_config.vpc_origin_id #=> String
resp.distribution_config.origins.items[0].vpc_origin_config. #=> String
resp.distribution_config.origins.items[0].vpc_origin_config.origin_read_timeout #=> Integer
resp.distribution_config.origins.items[0].vpc_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].response_completion_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.origin_groups.items[0].selection_criteria #=> String, one of "default", "media-quality-based"
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.grpc_config.enabled #=> Boolean
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].grpc_config.enabled #=> Boolean
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", "None"
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", "TLSv1.3_2025", "TLSv1.2_2025"
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.distribution_config.anycast_ip_list_id #=> String
resp.distribution_config.tenant_config.parameter_definitions #=> Array
resp.distribution_config.tenant_config.parameter_definitions[0].name #=> String
resp.distribution_config.tenant_config.parameter_definitions[0].definition.string_schema.comment #=> String
resp.distribution_config.tenant_config.parameter_definitions[0].definition.string_schema.default_value #=> String
resp.distribution_config.tenant_config.parameter_definitions[0].definition.string_schema.required #=> Boolean
resp.distribution_config.connection_mode #=> String, one of "direct", "tenant-only"
resp.distribution_config.viewer_mtls_config.mode #=> String, one of "required", "optional"
resp.distribution_config.viewer_mtls_config.trust_store_config.trust_store_id #=> String
resp.distribution_config.viewer_mtls_config.trust_store_config.advertise_trust_store_ca_names #=> Boolean
resp.distribution_config.viewer_mtls_config.trust_store_config.ignore_certificate_expiry #=> Boolean
resp.distribution_config.connection_function_association.id #=> String
resp.distribution_config.cache_tag_config.header_name #=> String
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:

See Also:



5900
5901
5902
5903
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5900

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

#get_distribution_tenant(params = {}) ⇒ Types::GetDistributionTenantResult

Gets information about a distribution tenant.

Examples:

Request syntax with placeholder values


resp = client.get_distribution_tenant({
  identifier: "string", # required
})

Response structure


resp.distribution_tenant.id #=> String
resp.distribution_tenant.distribution_id #=> String
resp.distribution_tenant.name #=> String
resp.distribution_tenant.arn #=> String
resp.distribution_tenant.domains #=> Array
resp.distribution_tenant.domains[0].domain #=> String
resp.distribution_tenant.domains[0].status #=> String, one of "active", "inactive"
resp.distribution_tenant.tags.items #=> Array
resp.distribution_tenant.tags.items[0].key #=> String
resp.distribution_tenant.tags.items[0].value #=> String
resp.distribution_tenant.customizations.web_acl.action #=> String, one of "override", "disable"
resp.distribution_tenant.customizations.web_acl.arn #=> String
resp.distribution_tenant.customizations.certificate.arn #=> String
resp.distribution_tenant.customizations.geo_restrictions.restriction_type #=> String, one of "blacklist", "whitelist", "none"
resp.distribution_tenant.customizations.geo_restrictions.locations #=> Array
resp.distribution_tenant.customizations.geo_restrictions.locations[0] #=> String
resp.distribution_tenant.parameters #=> Array
resp.distribution_tenant.parameters[0].name #=> String
resp.distribution_tenant.parameters[0].value #=> String
resp.distribution_tenant.connection_group_id #=> String
resp.distribution_tenant.created_time #=> Time
resp.distribution_tenant.last_modified_time #=> Time
resp.distribution_tenant.enabled #=> Boolean
resp.distribution_tenant.status #=> String
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The identifier of the distribution tenant. You can specify the ARN, ID, or name of the distribution tenant.

Returns:

See Also:



5954
5955
5956
5957
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 5954

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

#get_distribution_tenant_by_domain(params = {}) ⇒ Types::GetDistributionTenantByDomainResult

Gets information about a distribution tenant by the associated domain.

Examples:

Request syntax with placeholder values


resp = client.get_distribution_tenant_by_domain({
  domain: "string", # required
})

Response structure


resp.distribution_tenant.id #=> String
resp.distribution_tenant.distribution_id #=> String
resp.distribution_tenant.name #=> String
resp.distribution_tenant.arn #=> String
resp.distribution_tenant.domains #=> Array
resp.distribution_tenant.domains[0].domain #=> String
resp.distribution_tenant.domains[0].status #=> String, one of "active", "inactive"
resp.distribution_tenant.tags.items #=> Array
resp.distribution_tenant.tags.items[0].key #=> String
resp.distribution_tenant.tags.items[0].value #=> String
resp.distribution_tenant.customizations.web_acl.action #=> String, one of "override", "disable"
resp.distribution_tenant.customizations.web_acl.arn #=> String
resp.distribution_tenant.customizations.certificate.arn #=> String
resp.distribution_tenant.customizations.geo_restrictions.restriction_type #=> String, one of "blacklist", "whitelist", "none"
resp.distribution_tenant.customizations.geo_restrictions.locations #=> Array
resp.distribution_tenant.customizations.geo_restrictions.locations[0] #=> String
resp.distribution_tenant.parameters #=> Array
resp.distribution_tenant.parameters[0].name #=> String
resp.distribution_tenant.parameters[0].value #=> String
resp.distribution_tenant.connection_group_id #=> String
resp.distribution_tenant.created_time #=> Time
resp.distribution_tenant.last_modified_time #=> Time
resp.distribution_tenant.enabled #=> Boolean
resp.distribution_tenant.status #=> String
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain (required, String) —

    A domain name associated with the target distribution tenant.

Returns:

See Also:



6007
6008
6009
6010
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6007

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

See Also:



6052
6053
6054
6055
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6052

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:

See Also:



6095
6096
6097
6098
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6095

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:

See Also:



6136
6137
6138
6139
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6136

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:

See Also:



6176
6177
6178
6179
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6176

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: "FunctionName", # 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:

See Also:



6216
6217
6218
6219
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6216

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:

See Also:



6260
6261
6262
6263
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6260

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

#get_invalidation_for_distribution_tenant(params = {}) ⇒ Types::GetInvalidationForDistributionTenantResult

Gets information about a specific invalidation for a distribution tenant.

The following waiters are defined for this operation (see #wait_until for detailed usage):

  • invalidation_for_distribution_tenant_completed

Examples:

Request syntax with placeholder values


resp = client.get_invalidation_for_distribution_tenant({
  distribution_tenant_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_tenant_id (required, String) —

    The ID of the distribution tenant.

  • :id (required, String) —

    The ID of the invalidation to retrieve.

Returns:

See Also:



6304
6305
6306
6307
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6304

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

See Also:



6347
6348
6349
6350
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6347

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:

See Also:



6388
6389
6390
6391
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6388

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

#get_managed_certificate_details(params = {}) ⇒ Types::GetManagedCertificateDetailsResult

Gets details about the CloudFront managed ACM certificate.

Examples:

Request syntax with placeholder values


resp = client.get_managed_certificate_details({
  identifier: "string", # required
})

Response structure


resp.managed_certificate_details.certificate_arn #=> String
resp.managed_certificate_details.certificate_status #=> String, one of "pending-validation", "issued", "inactive", "expired", "validation-timed-out", "revoked", "failed"
resp.managed_certificate_details.validation_token_host #=> String, one of "cloudfront", "self-hosted"
resp.managed_certificate_details.validation_token_details #=> Array
resp.managed_certificate_details.validation_token_details[0].domain #=> String
resp.managed_certificate_details.validation_token_details[0].redirect_to #=> String
resp.managed_certificate_details.validation_token_details[0].redirect_from #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The identifier of the distribution tenant. You can specify the ARN, ID, or name of the distribution tenant.

Returns:

See Also:



6423
6424
6425
6426
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6423

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

See Also:



6453
6454
6455
6456
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6453

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:

See Also:



6489
6490
6491
6492
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6489

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:

See Also:



6523
6524
6525
6526
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6523

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:

See Also:



6584
6585
6586
6587
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6584

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:

See Also:



6639
6640
6641
6642
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6639

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:

See Also:



6674
6675
6676
6677
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6674

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:

See Also:



6707
6708
6709
6710
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6707

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:

See Also:



6753
6754
6755
6756
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6753

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

#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResult

Retrieves the resource policy for the specified CloudFront resource that you own and have shared.

Examples:

Request syntax with placeholder values


resp = client.get_resource_policy({
  resource_arn: "string", # required
})

Response structure


resp.resource_arn #=> String
resp.policy_document #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the CloudFront resource that is associated with the resource policy.

Returns:

See Also:



6785
6786
6787
6788
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6785

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

See Also:



6872
6873
6874
6875
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6872

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:

See Also:



6956
6957
6958
6959
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 6956

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]. #=> 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", "None"
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:

See Also:



7019
7020
7021
7022
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7019

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", "None"
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:

See Also:



7064
7065
7066
7067
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7064

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

#get_trust_store(params = {}) ⇒ Types::GetTrustStoreResult

Gets a trust store.

Examples:

Request syntax with placeholder values


resp = client.get_trust_store({
  identifier: "string", # required
})

Response structure


resp.trust_store.id #=> String
resp.trust_store.arn #=> String
resp.trust_store.name #=> String
resp.trust_store.status #=> String, one of "pending", "active", "failed"
resp.trust_store.number_of_ca_certificates #=> Integer
resp.trust_store.last_modified_time #=> Time
resp.trust_store.reason #=> String
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The trust store's identifier.

Returns:

See Also:



7100
7101
7102
7103
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7100

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

#get_vpc_origin(params = {}) ⇒ Types::GetVpcOriginResult

Get the details of an Amazon CloudFront VPC origin.

Examples:

Example: To get a VPC origin


# The following command gets a VPC origin:

resp = client.get_vpc_origin({
  id: "vo_BQwjxxQxjCaBcQLzJUFkDM", 
})

resp.to_h outputs the following:
{
  etag: "ETVPDKIKX0DER", 
  vpc_origin: {
    arn: "arn:aws:cloudfront::123456789012:vpcorigin/vo_BQwjxxQxjCaBcQLzJUFkDM", 
    created_time: Time.parse("2024-10-15T17:19:42.318Z"), 
    id: "vo_BQwjxxQxjCaBcQLzJUFkDM", 
    last_modified_time: Time.parse("2024-10-15T17:24:35.188Z"), 
    status: "Deployed", 
    vpc_origin_endpoint_config: {
      arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-alb-us-west-2/e6aa5c7d26415c6d", 
      http_port: 80, 
      https_port: 443, 
      name: "my-vpcorigin-name", 
      origin_protocol_policy: "match-viewer", 
      origin_ssl_protocols: {
        items: [
          "TLSv1.1", 
          "TLSv1.2", 
        ], 
        quantity: 2, 
      }, 
    }, 
  }, 
}

Request syntax with placeholder values


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

Response structure


resp.vpc_origin.id #=> String
resp.vpc_origin.arn #=> String
resp.vpc_origin. #=> String
resp.vpc_origin.status #=> String
resp.vpc_origin.created_time #=> Time
resp.vpc_origin.last_modified_time #=> Time
resp.vpc_origin.vpc_origin_endpoint_config.name #=> String
resp.vpc_origin.vpc_origin_endpoint_config.arn #=> String
resp.vpc_origin.vpc_origin_endpoint_config.http_port #=> Integer
resp.vpc_origin.vpc_origin_endpoint_config.https_port #=> Integer
resp.vpc_origin.vpc_origin_endpoint_config.origin_protocol_policy #=> String, one of "http-only", "match-viewer", "https-only"
resp.vpc_origin.vpc_origin_endpoint_config.origin_ssl_protocols.quantity #=> Integer
resp.vpc_origin.vpc_origin_endpoint_config.origin_ssl_protocols.items #=> Array
resp.vpc_origin.vpc_origin_endpoint_config.origin_ssl_protocols.items[0] #=> String, one of "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2"
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The VPC origin ID.

Returns:

See Also:



7178
7179
7180
7181
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7178

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

#list_anycast_ip_lists(params = {}) ⇒ Types::ListAnycastIpListsResult

Lists your Anycast static IP lists.

Examples:

Request syntax with placeholder values


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

Response structure


resp.anycast_ip_lists.items #=> Array
resp.anycast_ip_lists.items[0].id #=> String
resp.anycast_ip_lists.items[0].name #=> String
resp.anycast_ip_lists.items[0].status #=> String
resp.anycast_ip_lists.items[0].arn #=> String
resp.anycast_ip_lists.items[0].ip_count #=> Integer
resp.anycast_ip_lists.items[0].last_modified_time #=> Time
resp.anycast_ip_lists.items[0].ip_address_type #=> String, one of "ipv4", "ipv6", "dualstack"
resp.anycast_ip_lists.items[0].etag #=> String
resp.anycast_ip_lists.items[0].ipam_config.quantity #=> Integer
resp.anycast_ip_lists.items[0].ipam_config.ipam_cidr_configs #=> Array
resp.anycast_ip_lists.items[0].ipam_config.ipam_cidr_configs[0].cidr #=> String
resp.anycast_ip_lists.items[0].ipam_config.ipam_cidr_configs[0].ipam_pool_arn #=> String
resp.anycast_ip_lists.items[0].ipam_config.ipam_cidr_configs[0].anycast_ip #=> String
resp.anycast_ip_lists.items[0].ipam_config.ipam_cidr_configs[0].status #=> String, one of "provisioned", "failed-provision", "provisioning", "deprovisioned", "failed-deprovision", "deprovisioning", "advertised", "failed-advertise", "advertising", "withdrawn", "failed-withdraw", "withdrawing"
resp.anycast_ip_lists.marker #=> String
resp.anycast_ip_lists.next_marker #=> String
resp.anycast_ip_lists.max_items #=> Integer
resp.anycast_ip_lists.is_truncated #=> Boolean
resp.anycast_ip_lists.quantity #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :marker (String) —

    Use this field when paginating results to indicate where to begin in your list. The response includes 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 Anycast static IP lists that you want returned in the response.

Returns:

See Also:



7233
7234
7235
7236
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7233

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

See Also:



7316
7317
7318
7319
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7316

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:

See Also:



7364
7365
7366
7367
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7364

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

The ListConflictingAliases API operation only supports standard distributions. To list domain conflicts for both standard distributions and distribution tenants, we recommend that you use the ListDomainConflicts API operation instead.

Gets a list of aliases that conflict or overlap with the provided alias, and the associated CloudFront standard distribution and Amazon Web Services accounts for each conflicting alias. An alias is commonly known as a custom domain or vanity domain. It can also be called a CNAME or alternate domain name.

In the returned list, the standard distribution and account IDs are partially hidden, which allows you to identify the standard distribution and accounts that you own, and 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</code>), if they exist. If you provide </em>.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.</p> To list conflicting aliases, specify the alias to search and the ID of a standard distribution in your account that has an attached TLS certificate that includes the provided alias. For more information, including how to set up the standard distribution and certificate, see Moving an alternate domain name to a different standard distribution or distribution tenant in the Amazon CloudFront Developer Guide. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.</p>

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]. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :distribution_id (required, String) —

    The ID of a standard distribution in your account that has an attached 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:

See Also:



7459
7460
7461
7462
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7459

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

#list_connection_functions(params = {}) ⇒ Types::ListConnectionFunctionsResult

Lists connection functions.

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_connection_functions({
  marker: "string",
  max_items: 1,
  stage: "DEVELOPMENT", # accepts DEVELOPMENT, LIVE
})

Response structure


resp.next_marker #=> String
resp.connection_functions #=> Array
resp.connection_functions[0].name #=> String
resp.connection_functions[0].id #=> String
resp.connection_functions[0].connection_function_config.comment #=> String
resp.connection_functions[0].connection_function_config.runtime #=> String, one of "cloudfront-js-1.0", "cloudfront-js-2.0"
resp.connection_functions[0].connection_function_config.key_value_store_associations.quantity #=> Integer
resp.connection_functions[0].connection_function_config.key_value_store_associations.items #=> Array
resp.connection_functions[0].connection_function_config.key_value_store_associations.items[0].key_value_store_arn #=> String
resp.connection_functions[0].connection_function_arn #=> String
resp.connection_functions[0].status #=> String
resp.connection_functions[0].stage #=> String, one of "DEVELOPMENT", "LIVE"
resp.connection_functions[0].created_time #=> Time
resp.connection_functions[0].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. The response includes 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 connection functions that you want returned in the response.

  • :stage (String) —

    The connection function's stage.

Returns:

See Also:



7515
7516
7517
7518
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7515

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

#list_connection_groups(params = {}) ⇒ Types::ListConnectionGroupsResult

Lists the connection groups in your Amazon Web Services account.

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_connection_groups({
  association_filter: {
    anycast_ip_list_id: "string",
  },
  marker: "string",
  max_items: 1,
})

Response structure


resp.next_marker #=> String
resp.connection_groups #=> Array
resp.connection_groups[0].id #=> String
resp.connection_groups[0].name #=> String
resp.connection_groups[0].arn #=> String
resp.connection_groups[0].routing_endpoint #=> String
resp.connection_groups[0].created_time #=> Time
resp.connection_groups[0].last_modified_time #=> Time
resp.connection_groups[0].etag #=> String
resp.connection_groups[0].anycast_ip_list_id #=> String
resp.connection_groups[0].enabled #=> Boolean
resp.connection_groups[0].status #=> String
resp.connection_groups[0].is_default #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :association_filter (Types::ConnectionGroupAssociationFilter) —

    Filter by associated Anycast IP list ID.

  • :marker (String) —

    The marker for the next set of connection groups to retrieve.

  • :max_items (Integer) —

    The maximum number of connection groups to return.

Returns:

See Also:



7568
7569
7570
7571
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7568

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

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_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:

See Also:



7628
7629
7630
7631
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7628

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

#list_distribution_tenants(params = {}) ⇒ Types::ListDistributionTenantsResult

Lists the distribution tenants in your Amazon Web Services account.

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_distribution_tenants({
  association_filter: {
    distribution_id: "string",
    connection_group_id: "string",
  },
  marker: "string",
  max_items: 1,
})

Response structure


resp.next_marker #=> String
resp.distribution_tenant_list #=> Array
resp.distribution_tenant_list[0].id #=> String
resp.distribution_tenant_list[0].distribution_id #=> String
resp.distribution_tenant_list[0].name #=> String
resp.distribution_tenant_list[0].arn #=> String
resp.distribution_tenant_list[0].domains #=> Array
resp.distribution_tenant_list[0].domains[0].domain #=> String
resp.distribution_tenant_list[0].domains[0].status #=> String, one of "active", "inactive"
resp.distribution_tenant_list[0].connection_group_id #=> String
resp.distribution_tenant_list[0].customizations.web_acl.action #=> String, one of "override", "disable"
resp.distribution_tenant_list[0].customizations.web_acl.arn #=> String
resp.distribution_tenant_list[0].customizations.certificate.arn #=> String
resp.distribution_tenant_list[0].customizations.geo_restrictions.restriction_type #=> String, one of "blacklist", "whitelist", "none"
resp.distribution_tenant_list[0].customizations.geo_restrictions.locations #=> Array
resp.distribution_tenant_list[0].customizations.geo_restrictions.locations[0] #=> String
resp.distribution_tenant_list[0].created_time #=> Time
resp.distribution_tenant_list[0].last_modified_time #=> Time
resp.distribution_tenant_list[0].etag #=> String
resp.distribution_tenant_list[0].enabled #=> Boolean
resp.distribution_tenant_list[0].status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :association_filter (Types::DistributionTenantAssociationFilter) —

    Filter by the associated distribution ID or connection group ID.

  • :marker (String) —

    The marker for the next set of results.

  • :max_items (Integer) —

    The maximum number of distribution tenants to return.

Returns:

See Also:



7690
7691
7692
7693
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7690

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

#list_distribution_tenants_by_customization(params = {}) ⇒ Types::ListDistributionTenantsByCustomizationResult

Lists distribution tenants by the customization that you specify.

You must specify either the CertificateArn parameter or WebACLArn parameter, but not both in the same request.

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_distribution_tenants_by_customization({
  web_acl_arn: "string",
  certificate_arn: "string",
  marker: "string",
  max_items: 1,
})

Response structure


resp.next_marker #=> String
resp.distribution_tenant_list #=> Array
resp.distribution_tenant_list[0].id #=> String
resp.distribution_tenant_list[0].distribution_id #=> String
resp.distribution_tenant_list[0].name #=> String
resp.distribution_tenant_list[0].arn #=> String
resp.distribution_tenant_list[0].domains #=> Array
resp.distribution_tenant_list[0].domains[0].domain #=> String
resp.distribution_tenant_list[0].domains[0].status #=> String, one of "active", "inactive"
resp.distribution_tenant_list[0].connection_group_id #=> String
resp.distribution_tenant_list[0].customizations.web_acl.action #=> String, one of "override", "disable"
resp.distribution_tenant_list[0].customizations.web_acl.arn #=> String
resp.distribution_tenant_list[0].customizations.certificate.arn #=> String
resp.distribution_tenant_list[0].customizations.geo_restrictions.restriction_type #=> String, one of "blacklist", "whitelist", "none"
resp.distribution_tenant_list[0].customizations.geo_restrictions.locations #=> Array
resp.distribution_tenant_list[0].customizations.geo_restrictions.locations[0] #=> String
resp.distribution_tenant_list[0].created_time #=> Time
resp.distribution_tenant_list[0].last_modified_time #=> Time
resp.distribution_tenant_list[0].etag #=> String
resp.distribution_tenant_list[0].enabled #=> Boolean
resp.distribution_tenant_list[0].status #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :web_acl_arn (String) —

    Filter by the ARN of the associated WAF web ACL.

  • :certificate_arn (String) —

    Filter by the ARN of the associated ACM certificate.

  • :marker (String) —

    The marker for the next set of results.

  • :max_items (Integer) —

    The maximum number of distribution tenants to return by the specified customization.

Returns:

See Also:



7757
7758
7759
7760
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7757

def list_distribution_tenants_by_customization(params = {}, options = {})
  req = build_request(:list_distribution_tenants_by_customization, 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].etag #=> 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].s3_origin_config.origin_read_timeout #=> Integer
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].custom_origin_config.ip_address_type #=> String, one of "ipv4", "ipv6", "dualstack"
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_mtls_config.client_certificate_arn #=> String
resp.distribution_list.items[0].origins.items[0].vpc_origin_config.vpc_origin_id #=> String
resp.distribution_list.items[0].origins.items[0].vpc_origin_config. #=> String
resp.distribution_list.items[0].origins.items[0].vpc_origin_config.origin_read_timeout #=> Integer
resp.distribution_list.items[0].origins.items[0].vpc_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].response_completion_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].origin_groups.items[0].selection_criteria #=> String, one of "default", "media-quality-based"
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.grpc_config.enabled #=> Boolean
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].grpc_config.enabled #=> Boolean
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", "None"
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", "TLSv1.3_2025", "TLSv1.2_2025"
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
resp.distribution_list.items[0].connection_mode #=> String, one of "direct", "tenant-only"
resp.distribution_list.items[0].anycast_ip_list_id #=> String
resp.distribution_list.items[0].viewer_mtls_config.mode #=> String, one of "required", "optional"
resp.distribution_list.items[0].viewer_mtls_config.trust_store_config.trust_store_id #=> String
resp.distribution_list.items[0].viewer_mtls_config.trust_store_config.advertise_trust_store_ca_names #=> Boolean
resp.distribution_list.items[0].viewer_mtls_config.trust_store_config.ignore_certificate_expiry #=> Boolean
resp.distribution_list.items[0].connection_function_association.id #=> 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 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:

See Also:



7981
7982
7983
7984
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 7981

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

#list_distributions_by_anycast_ip_list_id(params = {}) ⇒ Types::ListDistributionsByAnycastIpListIdResult

Lists the distributions in your account that are associated with the specified AnycastIpListId.

Examples:

Request syntax with placeholder values


resp = client.list_distributions_by_anycast_ip_list_id({
  marker: "string",
  max_items: 1,
  anycast_ip_list_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].etag #=> 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].s3_origin_config.origin_read_timeout #=> Integer
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].custom_origin_config.ip_address_type #=> String, one of "ipv4", "ipv6", "dualstack"
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_mtls_config.client_certificate_arn #=> String
resp.distribution_list.items[0].origins.items[0].vpc_origin_config.vpc_origin_id #=> String
resp.distribution_list.items[0].origins.items[0].vpc_origin_config. #=> String
resp.distribution_list.items[0].origins.items[0].vpc_origin_config.origin_read_timeout #=> Integer
resp.distribution_list.items[0].origins.items[0].vpc_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].response_completion_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].origin_groups.items[0].selection_criteria #=> String, one of "default", "media-quality-based"
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.grpc_config.enabled #=> Boolean
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].grpc_config.enabled #=> Boolean
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", "None"
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", "TLSv1.3_2025", "TLSv1.2_2025"
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
resp.distribution_list.items[0].connection_mode #=> String, one of "direct", "tenant-only"
resp.distribution_list.items[0].anycast_ip_list_id #=> String
resp.distribution_list.items[0].viewer_mtls_config.mode #=> String, one of "required", "optional"
resp.distribution_list.items[0].viewer_mtls_config.trust_store_config.trust_store_id #=> String
resp.distribution_list.items[0].viewer_mtls_config.trust_store_config.advertise_trust_store_ca_names #=> Boolean
resp.distribution_list.items[0].viewer_mtls_config.trust_store_config.ignore_certificate_expiry #=> Boolean
resp.distribution_list.items[0].connection_function_association.id #=> 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. The response includes 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 distributions that you want returned in the response.

  • :anycast_ip_list_id (required, String) —

    The ID of the Anycast static IP list.

Returns:

See Also:



8208
8209
8210
8211
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 8208

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

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_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:

See Also:



8263
8264
8265
8266
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 8263

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_connection_function(params = {}) ⇒ Types::ListDistributionsByConnectionFunctionResult

Lists distributions by connection function.

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_by_connection_function({
  marker: "string",
  max_items: 1,
  connection_function_identifier: "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].etag #=> 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].s3_origin_config.origin_read_timeout #=> Integer
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].custom_origin_config.ip_address_type #=> String, one of "ipv4", "ipv6", "dualstack"
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_mtls_config.client_certificate_arn #=> String
resp.distribution_list.items[0].origins.items[0].vpc_origin_config.vpc_origin_id #=> String
resp.distribution_list.items[0].origins.items[0].vpc_origin_config. #=> String
resp.distribution_list.items[0].origins.items[0].vpc_origin_config.origin_read_timeout #=> Integer
resp.distribution_list.items[0].origins.items[0].vpc_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].response_completion_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].origin_groups.items[0].selection_criteria #=> String, one of "default", "media-quality-based"
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.grpc_config.enabled #=> Boolean
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].grpc_config.enabled #=> Boolean
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", "None"
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", "TLSv1.3_2025", "TLSv1.2_2025"
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
resp.distribution_list.items[0].connection_mode #=> String, one of "direct", "tenant-only"
resp.distribution_list.items[0].anycast_ip_list_id #=> String
resp.distribution_list.items[0].viewer_mtls_config.mode #=> String, one of "required", "optional"
resp.distribution_list.items[0].viewer_mtls_config.trust_store_config.trust_store_id #=> String
resp.distribution_list.items[0].viewer_mtls_config.trust_store_config.advertise_trust_store_ca_names #=> Boolean
resp.distribution_list.items[0].viewer_mtls_config.trust_store_config.ignore_certificate_expiry #=> Boolean
resp.distribution_list.items[0].connection_function_association.id #=> 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. The response includes 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 distributions that you want returned in the response.

  • :connection_function_identifier (required, String) —

    The distributions by connection function identifier.

Returns:

See Also:



8491
8492
8493
8494
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 8491

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

#list_distributions_by_connection_mode(params = {}) ⇒ Types::ListDistributionsByConnectionModeResult

Lists the distributions by the connection mode that you specify.

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_by_connection_mode({
  marker: "string",
  max_items: 1,
  connection_mode: "direct", # required, accepts direct, tenant-only
})

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].etag #=> 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].s3_origin_config.origin_read_timeout #=> Integer
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].custom_origin_config.ip_address_type #=> String, one of "ipv4", "ipv6", "dualstack"
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_mtls_config.client_certificate_arn #=> String
resp.distribution_list.items[0].origins.items[0].vpc_origin_config.vpc_origin_id #=> String
resp.distribution_list.items[0].origins.items[0].vpc_origin_config. #=> String
resp.distribution_list.items[0].origins.items[0].vpc_origin_config.origin_read_timeout #=> Integer
resp.distribution_list.items[0].origins.items[0].vpc_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].response_completion_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].origin_groups.items[0].selection_criteria #=> String, one of "default", "media-quality-based"
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.grpc_config.enabled #=> Boolean
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].grpc_config.enabled #=> Boolean
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", "None"
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", "TLSv1.3_2025", "TLSv1.2_2025"
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
resp.distribution_list.items[0].connection_mode #=> String, one of "direct", "tenant-only"
resp.distribution_list.items[0].anycast_ip_list_id #=> String
resp.distribution_list.items[0].viewer_mtls_config.mode #=> String, one of "required", "optional"
resp.distribution_list.items[0].viewer_mtls_config.trust_store_config.trust_store_id #=> String
resp.distribution_list.items[0].viewer_mtls_config.trust_store_config.advertise_trust_store_ca_names #=> Boolean
resp.distribution_list.items[0].viewer_mtls_config.trust_store_config.ignore_certificate_expiry #=> Boolean
resp.distribution_list.items[0].connection_function_association.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :marker (String) —

    The marker for the next set of distributions to retrieve.

  • :max_items (Integer) —

    The maximum number of distributions to return.

  • :connection_mode (required, String) —

    This field specifies whether the connection mode is through a standard distribution (direct) or a multi-tenant distribution with distribution tenants (tenant-only).

Returns:

See Also:



8717
8718
8719
8720
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 8717

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

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_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:

See Also:



8772
8773
8774
8775
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 8772

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.

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_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:

See Also:



8827
8828
8829
8830
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 8827

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_owned_resource(params = {}) ⇒ Types::ListDistributionsByOwnedResourceResult

Lists the CloudFront distributions that are associated with the specified resource that you own.

Examples:

Request syntax with placeholder values


resp = client.list_distributions_by_owned_resource({
  resource_arn: "string", # required
  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].distribution_id #=> String
resp.distribution_list.items[0]. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the CloudFront resource that you've shared with other Amazon Web Services accounts.

  • :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 to return.

Returns:

See Also:



8876
8877
8878
8879
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 8876

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

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_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].etag #=> 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].s3_origin_config.origin_read_timeout #=> Integer
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].custom_origin_config.ip_address_type #=> String, one of "ipv4", "ipv6", "dualstack"
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_mtls_config.client_certificate_arn #=> String
resp.distribution_list.items[0].origins.items[0].vpc_origin_config.vpc_origin_id #=> String
resp.distribution_list.items[0].origins.items[0].vpc_origin_config. #=> String
resp.distribution_list.items[0].origins.items[0].vpc_origin_config.origin_read_timeout #=> Integer
resp.distribution_list.items[0].origins.items[0].vpc_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].response_completion_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].origin_groups.items[0].selection_criteria #=> String, one of "default", "media-quality-based"
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.grpc_config.enabled #=> Boolean
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].grpc_config.enabled #=> Boolean
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", "None"
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", "TLSv1.3_2025", "TLSv1.2_2025"
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
resp.distribution_list.items[0].connection_mode #=> String, one of "direct", "tenant-only"
resp.distribution_list.items[0].anycast_ip_list_id #=> String
resp.distribution_list.items[0].viewer_mtls_config.mode #=> String, one of "required", "optional"
resp.distribution_list.items[0].viewer_mtls_config.trust_store_config.trust_store_id #=> String
resp.distribution_list.items[0].viewer_mtls_config.trust_store_config.advertise_trust_store_ca_names #=> Boolean
resp.distribution_list.items[0].viewer_mtls_config.trust_store_config.ignore_certificate_expiry #=> Boolean
resp.distribution_list.items[0].connection_function_association.id #=> 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 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:

See Also:



9121
9122
9123
9124
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 9121

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.

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_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:

See Also:



9178
9179
9180
9181
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 9178

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_trust_store(params = {}) ⇒ Types::ListDistributionsByTrustStoreResult

Lists distributions by trust store.

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_by_trust_store({
  trust_store_identifier: "string", # required
  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].etag #=> 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].s3_origin_config.origin_read_timeout #=> Integer
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].custom_origin_config.ip_address_type #=> String, one of "ipv4", "ipv6", "dualstack"
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_mtls_config.client_certificate_arn #=> String
resp.distribution_list.items[0].origins.items[0].vpc_origin_config.vpc_origin_id #=> String
resp.distribution_list.items[0].origins.items[0].vpc_origin_config. #=> String
resp.distribution_list.items[0].origins.items[0].vpc_origin_config.origin_read_timeout #=> Integer
resp.distribution_list.items[0].origins.items[0].vpc_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].response_completion_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].origin_groups.items[0].selection_criteria #=> String, one of "default", "media-quality-based"
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.grpc_config.enabled #=> Boolean
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].grpc_config.enabled #=> Boolean
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", "None"
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", "TLSv1.3_2025", "TLSv1.2_2025"
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
resp.distribution_list.items[0].connection_mode #=> String, one of "direct", "tenant-only"
resp.distribution_list.items[0].anycast_ip_list_id #=> String
resp.distribution_list.items[0].viewer_mtls_config.mode #=> String, one of "required", "optional"
resp.distribution_list.items[0].viewer_mtls_config.trust_store_config.trust_store_id #=> String
resp.distribution_list.items[0].viewer_mtls_config.trust_store_config.advertise_trust_store_ca_names #=> Boolean
resp.distribution_list.items[0].viewer_mtls_config.trust_store_config.ignore_certificate_expiry #=> Boolean
resp.distribution_list.items[0].connection_function_association.id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :trust_store_identifier (required, String) —

    The distributions by trust store identifier.

  • :marker (String) —

    Use this field when paginating results to indicate where to begin in your list. The response includes 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 distributions that you want returned in the response.

Returns:

See Also:



9406
9407
9408
9409
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 9406

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

#list_distributions_by_vpc_origin_id(params = {}) ⇒ Types::ListDistributionsByVpcOriginIdResult

List CloudFront distributions by their VPC origin ID.

Examples:

Example: To list distributions by VPC origin ID


# The following command lists distributions by VPC origin ID:

resp = client.list_distributions_by_vpc_origin_id({
  vpc_origin_id: "vo_BQwjxxQxjCaBcQLzJUFkDM", 
})

resp.to_h outputs the following:
{
  distribution_id_list: {
    is_truncated: false, 
    items: [
    ], 
    marker: "a", 
    max_items: 100, 
    quantity: 0, 
  }, 
}

Request syntax with placeholder values


resp = client.list_distributions_by_vpc_origin_id({
  marker: "string",
  max_items: 1,
  vpc_origin_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) —

    The marker associated with the VPC origin distributions list.

  • :max_items (Integer) —

    The maximum number of items included in the list.

  • :vpc_origin_id (required, String) —

    The VPC origin ID.

Returns:

See Also:



9469
9470
9471
9472
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 9469

def list_distributions_by_vpc_origin_id(params = {}, options = {})
  req = build_request(:list_distributions_by_vpc_origin_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].etag #=> 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].s3_origin_config.origin_read_timeout #=> Integer
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].custom_origin_config.ip_address_type #=> String, one of "ipv4", "ipv6", "dualstack"
resp.distribution_list.items[0].origins.items[0].custom_origin_config.origin_mtls_config.client_certificate_arn #=> String
resp.distribution_list.items[0].origins.items[0].vpc_origin_config.vpc_origin_id #=> String
resp.distribution_list.items[0].origins.items[0].vpc_origin_config. #=> String
resp.distribution_list.items[0].origins.items[0].vpc_origin_config.origin_read_timeout #=> Integer
resp.distribution_list.items[0].origins.items[0].vpc_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].response_completion_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].origin_groups.items[0].selection_criteria #=> String, one of "default", "media-quality-based"
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.grpc_config.enabled #=> Boolean
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].grpc_config.enabled #=> Boolean
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", "None"
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", "TLSv1.3_2025", "TLSv1.2_2025"
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
resp.distribution_list.items[0].connection_mode #=> String, one of "direct", "tenant-only"
resp.distribution_list.items[0].anycast_ip_list_id #=> String
resp.distribution_list.items[0].viewer_mtls_config.mode #=> String, one of "required", "optional"
resp.distribution_list.items[0].viewer_mtls_config.trust_store_config.trust_store_id #=> String
resp.distribution_list.items[0].viewer_mtls_config.trust_store_config.advertise_trust_store_ca_names #=> Boolean
resp.distribution_list.items[0].viewer_mtls_config.trust_store_config.ignore_certificate_expiry #=> Boolean
resp.distribution_list.items[0].connection_function_association.id #=> String

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:

See Also:



9706
9707
9708
9709
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 9706

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_domain_conflicts(params = {}) ⇒ Types::ListDomainConflictsResult

We recommend that you use the ListDomainConflicts API operation to check for domain conflicts, as it supports both standard distributions and distribution tenants. ListConflictingAliases performs similar checks but only supports standard distributions.

Lists existing domain associations that conflict with the domain that you specify.

You can use this API operation to identify potential domain conflicts when moving domains between standard distributions and/or distribution tenants. Domain conflicts must be resolved first before they can be moved.

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</code>), if they exist. If you provide </em>.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.</p> To list conflicting domains, specify the following: The domain to search for The ID of a standard distribution or distribution tenant in your account that has an attached TLS certificate, which covers the specified domain For more information, including how to set up the standard distribution or distribution tenant, and the certificate, see Moving an alternate domain name to a different standard distribution or distribution tenant in the Amazon CloudFront Developer Guide. You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.</p>

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_domain_conflicts({
  domain: "string", # required
  domain_control_validation_resource: { # required
    distribution_id: "string",
    distribution_tenant_id: "string",
  },
  max_items: 1,
  marker: "string",
})

Response structure


resp.domain_conflicts #=> Array
resp.domain_conflicts[0].domain #=> String
resp.domain_conflicts[0].resource_type #=> String, one of "distribution", "distribution-tenant"
resp.domain_conflicts[0].resource_id #=> String
resp.domain_conflicts[0]. #=> String
resp.next_marker #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain (required, String) —

    The domain to check for conflicts.

  • :domain_control_validation_resource (required, Types::DistributionResourceId) —

    The distribution resource identifier. This can be the standard distribution or distribution tenant that has a valid certificate, which covers the domain that you specify.

  • :max_items (Integer) —

    The maximum number of domain conflicts to return.

  • :marker (String) —

    The marker for the next set of domain conflicts.

Returns:

See Also:



9799
9800
9801
9802
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 9799

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

See Also:



9855
9856
9857
9858
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 9855

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:

See Also:



9907
9908
9909
9910
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 9907

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.

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_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:

See Also:



9973
9974
9975
9976
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 9973

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:

See Also:



10027
10028
10029
10030
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 10027

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

#list_invalidations_for_distribution_tenant(params = {}) ⇒ Types::ListInvalidationsForDistributionTenantResult

Lists the invalidations for a distribution tenant.

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_for_distribution_tenant({
  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):

  • :id (required, String) —

    The ID of the distribution tenant.

  • :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 invalidations to return for the distribution tenant.

Returns:

See Also:



10081
10082
10083
10084
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 10081

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

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

Gets a list of key groups.

You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

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:

See Also:



10133
10134
10135
10136
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 10133

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({
  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:

See Also:



10208
10209
10210
10211
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 10208

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 (OACs) 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.

If you're not using origin access controls for your Amazon Web Services account, the ListOriginAccessControls operation doesn't return the Items element in the response.

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_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:

See Also:



10272
10273
10274
10275
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 10272

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.

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_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:

See Also:



10351
10352
10353
10354
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 10351

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.

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_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:

See Also:



10398
10399
10400
10401
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 10398

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.

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_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:

See Also:



10455
10456
10457
10458
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 10455

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.

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_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:

See Also:



10562
10563
10564
10565
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 10562

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", "None"
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:

See Also:



10618
10619
10620
10621
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 10618

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 in the Amazon CloudFront Developer Guide.

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:

See Also:



10654
10655
10656
10657
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 10654

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

#list_trust_stores(params = {}) ⇒ Types::ListTrustStoresResult

Lists trust stores.

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_trust_stores({
  marker: "string",
  max_items: 1,
})

Response structure


resp.next_marker #=> String
resp.trust_store_list #=> Array
resp.trust_store_list[0].id #=> String
resp.trust_store_list[0].arn #=> String
resp.trust_store_list[0].name #=> String
resp.trust_store_list[0].status #=> String, one of "pending", "active", "failed"
resp.trust_store_list[0].number_of_ca_certificates #=> Integer
resp.trust_store_list[0].last_modified_time #=> Time
resp.trust_store_list[0].reason #=> String
resp.trust_store_list[0].etag #=> 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. The response includes 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 trust stores that you want returned in the response.

Returns:

See Also:



10702
10703
10704
10705
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 10702

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

#list_vpc_origins(params = {}) ⇒ Types::ListVpcOriginsResult

List the CloudFront VPC origins in your account.

Examples:

Example: To list VPC origins


# The following command lists VPC origins:

resp = client.list_vpc_origins({
})

resp.to_h outputs the following:
{
  vpc_origin_list: {
    is_truncated: true, 
    items: [
      {
        arn: "arn:aws:cloudfront::123456789012:vpcorigin/vo_BQwjxxQxjCaBcQLzJUFkDM", 
        created_time: Time.parse("2024-10-15T17:19:42.318Z"), 
        id: "vo_BQwjxxQxjCaBcQLzJUFkDM", 
        last_modified_time: Time.parse("2024-10-15T17:24:35.188Z"), 
        name: "my-vpcorigin-name", 
        origin_endpoint_arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-alb-us-west-2/e6aa5c7d26415c6d", 
        status: "Deployed", 
      }, 
    ], 
    marker: "a", 
    max_items: 100, 
    quantity: 1, 
  }, 
}

Request syntax with placeholder values


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

Response structure


resp.vpc_origin_list.marker #=> String
resp.vpc_origin_list.next_marker #=> String
resp.vpc_origin_list.max_items #=> Integer
resp.vpc_origin_list.is_truncated #=> Boolean
resp.vpc_origin_list.quantity #=> Integer
resp.vpc_origin_list.items #=> Array
resp.vpc_origin_list.items[0].id #=> String
resp.vpc_origin_list.items[0].name #=> String
resp.vpc_origin_list.items[0].status #=> String
resp.vpc_origin_list.items[0].created_time #=> Time
resp.vpc_origin_list.items[0].last_modified_time #=> Time
resp.vpc_origin_list.items[0].arn #=> String
resp.vpc_origin_list.items[0]. #=> String
resp.vpc_origin_list.items[0].origin_endpoint_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :marker (String) —

    The marker associated with the VPC origins list.

  • :max_items (Integer) —

    The maximum number of items included in the list.

Returns:

See Also:



10776
10777
10778
10779
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 10776

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

#publish_connection_function(params = {}) ⇒ Types::PublishConnectionFunctionResult

Publishes a connection function.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The connection function ID.

  • :if_match (required, String) —

    The current version (ETag value) of the connection function.

Returns:

See Also:



10819
10820
10821
10822
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 10819

def publish_connection_function(params = {}, options = {})
  req = build_request(:publish_connection_function, 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: "FunctionName", # 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:

See Also:



10873
10874
10875
10876
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 10873

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

#put_resource_policy(params = {}) ⇒ Types::PutResourcePolicyResult

Creates a resource control policy for a given CloudFront resource.

Examples:

Request syntax with placeholder values


resp = client.put_resource_policy({
  resource_arn: "string", # required
  policy_document: "string", # required
})

Response structure


resp.resource_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the CloudFront resource for which the policy is being created.

  • :policy_document (required, String) —

    The JSON-formatted resource policy to create.

Returns:

See Also:



10906
10907
10908
10909
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 10906

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

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:



10944
10945
10946
10947
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 10944

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

#test_connection_function(params = {}) ⇒ Types::TestConnectionFunctionResult

Tests a connection function.

Examples:

Request syntax with placeholder values


resp = client.test_connection_function({
  id: "ResourceId", # required
  if_match: "string", # required
  stage: "DEVELOPMENT", # accepts DEVELOPMENT, LIVE
  connection_object: "data", # required
})

Response structure


resp.connection_function_test_result.connection_function_summary.name #=> String
resp.connection_function_test_result.connection_function_summary.id #=> String
resp.connection_function_test_result.connection_function_summary.connection_function_config.comment #=> String
resp.connection_function_test_result.connection_function_summary.connection_function_config.runtime #=> String, one of "cloudfront-js-1.0", "cloudfront-js-2.0"
resp.connection_function_test_result.connection_function_summary.connection_function_config.key_value_store_associations.quantity #=> Integer
resp.connection_function_test_result.connection_function_summary.connection_function_config.key_value_store_associations.items #=> Array
resp.connection_function_test_result.connection_function_summary.connection_function_config.key_value_store_associations.items[0].key_value_store_arn #=> String
resp.connection_function_test_result.connection_function_summary.connection_function_arn #=> String
resp.connection_function_test_result.connection_function_summary.status #=> String
resp.connection_function_test_result.connection_function_summary.stage #=> String, one of "DEVELOPMENT", "LIVE"
resp.connection_function_test_result.connection_function_summary.created_time #=> Time
resp.connection_function_test_result.connection_function_summary.last_modified_time #=> Time
resp.connection_function_test_result.compute_utilization #=> String
resp.connection_function_test_result.connection_function_execution_logs #=> Array
resp.connection_function_test_result.connection_function_execution_logs[0] #=> String
resp.connection_function_test_result.connection_function_error_message #=> String
resp.connection_function_test_result.connection_function_output #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The connection function ID.

  • :if_match (required, String) —

    The current version (ETag value) of the connection function.

  • :stage (String) —

    The connection function stage.

  • :connection_object (required, String, StringIO, File) —

    The connection object.

Returns:

See Also:



11000
11001
11002
11003
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 11000

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

Examples:

Request syntax with placeholder values


resp = client.test_function({
  name: "FunctionName", # 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.

Returns:

See Also:



11080
11081
11082
11083
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 11080

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 in the Amazon CloudFront Developer Guide.

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:



11114
11115
11116
11117
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 11114

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

#update_anycast_ip_list(params = {}) ⇒ Types::UpdateAnycastIpListResult

Updates an Anycast static IP list.

Examples:

Request syntax with placeholder values


resp = client.update_anycast_ip_list({
  id: "string", # required
  ip_address_type: "ipv4", # accepts ipv4, ipv6, dualstack
  ipam_cidr_configs: [
    {
      cidr: "string", # required
      ipam_pool_arn: "string", # required
      anycast_ip: "string",
      status: "provisioned", # accepts provisioned, failed-provision, provisioning, deprovisioned, failed-deprovision, deprovisioning, advertised, failed-advertise, advertising, withdrawn, failed-withdraw, withdrawing
    },
  ],
  if_match: "string", # required
})

Response structure


resp.anycast_ip_list.id #=> String
resp.anycast_ip_list.name #=> String
resp.anycast_ip_list.status #=> String
resp.anycast_ip_list.arn #=> String
resp.anycast_ip_list.ip_address_type #=> String, one of "ipv4", "ipv6", "dualstack"
resp.anycast_ip_list.ipam_config.quantity #=> Integer
resp.anycast_ip_list.ipam_config.ipam_cidr_configs #=> Array
resp.anycast_ip_list.ipam_config.ipam_cidr_configs[0].cidr #=> String
resp.anycast_ip_list.ipam_config.ipam_cidr_configs[0].ipam_pool_arn #=> String
resp.anycast_ip_list.ipam_config.ipam_cidr_configs[0].anycast_ip #=> String
resp.anycast_ip_list.ipam_config.ipam_cidr_configs[0].status #=> String, one of "provisioned", "failed-provision", "provisioning", "deprovisioned", "failed-deprovision", "deprovisioning", "advertised", "failed-advertise", "advertising", "withdrawn", "failed-withdraw", "withdrawing"
resp.anycast_ip_list.anycast_ips #=> Array
resp.anycast_ip_list.anycast_ips[0] #=> String
resp.anycast_ip_list.ip_count #=> Integer
resp.anycast_ip_list.last_modified_time #=> Time
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the Anycast static IP list.

  • :ip_address_type (String) —

    The IP address type for the Anycast static IP list. You can specify one of the following options:

    • ipv4 only

    • ipv6 only

    • dualstack - Allocate a list of both IPv4 and IPv6 addresses

  • :ipam_cidr_configs (Array<Types::IpamCidrConfig>) —

    A list of IPAM CIDR configurations that specify the IP address ranges and IPAM pool settings for updating the Anycast static IP list.

  • :if_match (required, String) —

    The current version (ETag value) of the Anycast static IP list that you are updating.

Returns:

See Also:



11186
11187
11188
11189
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 11186

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

  1. Use GetCachePolicyConfig to get the current configuration.

  2. Locally modify the fields in the cache policy configuration that you want to update.

  3. Call UpdateCachePolicy by providing the entire cache policy configuration, including the fields that you modified and those that you didn't.

If your minimum TTL is greater than 0, CloudFront will cache content for at least the duration specified in the cache policy's minimum TTL, even if the Cache-Control: no-cache, no-store, or private directives are present in the origin headers.

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:

See Also:



11298
11299
11300
11301
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 11298

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:

See Also:



11343
11344
11345
11346
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 11343

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_connection_function(params = {}) ⇒ Types::UpdateConnectionFunctionResult

Updates a connection function.

Examples:

Request syntax with placeholder values


resp = client.update_connection_function({
  id: "ResourceId", # required
  if_match: "string", # required
  connection_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
        },
      ],
    },
  },
  connection_function_code: "data", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The connection function ID.

  • :if_match (required, String) —

    The current version (ETag value) of the connection function you are updating.

  • :connection_function_config (required, Types::FunctionConfig) —

    Contains configuration information about a CloudFront function.

  • :connection_function_code (required, String, StringIO, File) —

    The connection function code.

Returns:

See Also:



11408
11409
11410
11411
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 11408

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

#update_connection_group(params = {}) ⇒ Types::UpdateConnectionGroupResult

Updates a connection group.

Examples:

Request syntax with placeholder values


resp = client.update_connection_group({
  id: "string", # required
  ipv_6_enabled: false,
  if_match: "string", # required
  anycast_ip_list_id: "string",
  enabled: false,
})

Response structure


resp.connection_group.id #=> String
resp.connection_group.name #=> String
resp.connection_group.arn #=> String
resp.connection_group.created_time #=> Time
resp.connection_group.last_modified_time #=> Time
resp.connection_group.tags.items #=> Array
resp.connection_group.tags.items[0].key #=> String
resp.connection_group.tags.items[0].value #=> String
resp.connection_group.ipv_6_enabled #=> Boolean
resp.connection_group.routing_endpoint #=> String
resp.connection_group.anycast_ip_list_id #=> String
resp.connection_group.status #=> String
resp.connection_group.enabled #=> Boolean
resp.connection_group.is_default #=> Boolean
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the connection group.

  • :ipv_6_enabled (Boolean) —

    Enable IPv6 for the connection group. For more information, see Enable IPv6 in the Amazon CloudFront Developer Guide.

  • :if_match (required, String) —

    The value of the ETag header that you received when retrieving the connection group that you're updating.

  • :anycast_ip_list_id (String) —

    The ID of the Anycast static IP list.

  • :enabled (Boolean) —

    Whether the connection group is enabled.

Returns:

See Also:



11473
11474
11475
11476
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 11473

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

  1. Use GetContinuousDeploymentPolicyConfig to get the current configuration.

  2. Locally modify the fields in the continuous deployment policy configuration that you want to update.

  3. 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:

See Also:



11562
11563
11564
11565
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 11562

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

  1. Use GetDistributionConfig to get the current configuration, including the version identifier (ETag).

  2. Update the distribution configuration that was returned in the response. Note the following important requirements and restrictions:

    • You must copy the ETag field value from the response. (You'll use it for the IfMatch parameter in your request.) Then, remove the ETag field from the distribution configuration.

    • You can't change the value of CallerReference.

  3. Submit an UpdateDistribution request, providing the updated 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
            origin_read_timeout: 1,
          },
          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,
            ip_address_type: "ipv4", # accepts ipv4, ipv6, dualstack
            origin_mtls_config: {
              client_certificate_arn: "string", # required
            },
          },
          vpc_origin_config: {
            vpc_origin_id: "string", # required
            owner_account_id: "string",
            origin_read_timeout: 1,
            origin_keepalive_timeout: 1,
          },
          connection_attempts: 1,
          connection_timeout: 1,
          response_completion_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
              },
            ],
          },
          selection_criteria: "default", # accepts default, media-quality-based
        },
      ],
    },
    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",
      grpc_config: {
        enabled: false, # required
      },
      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",
          grpc_config: {
            enabled: false, # required
          },
          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,
      include_cookies: false,
      bucket: "string",
      prefix: "string",
    },
    price_class: "PriceClass_100", # accepts PriceClass_100, PriceClass_200, PriceClass_All, None
    enabled: false, # required
    viewer_certificate: {
      cloud_front_default_certificate: false,
      iam_certificate_id: "ServerCertificateId",
      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, TLSv1.3_2025, TLSv1.2_2025
      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,
    anycast_ip_list_id: "string",
    tenant_config: {
      parameter_definitions: [
        {
          name: "ParameterName", # required
          definition: { # required
            string_schema: {
              comment: "sensitiveStringType",
              default_value: "ParameterValue",
              required: false, # required
            },
          },
        },
      ],
    },
    connection_mode: "direct", # accepts direct, tenant-only
    viewer_mtls_config: {
      mode: "required", # accepts required, optional
      trust_store_config: {
        trust_store_id: "string", # required
        advertise_trust_store_ca_names: false,
        ignore_certificate_expiry: false,
      },
    },
    connection_function_association: {
      id: "ResourceId", # required
    },
    cache_tag_config: {
      header_name: "string", # required
    },
  },
  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]. #=> 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].s3_origin_config.origin_read_timeout #=> Integer
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].custom_origin_config.ip_address_type #=> String, one of "ipv4", "ipv6", "dualstack"
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_mtls_config.client_certificate_arn #=> String
resp.distribution.distribution_config.origins.items[0].vpc_origin_config.vpc_origin_id #=> String
resp.distribution.distribution_config.origins.items[0].vpc_origin_config. #=> String
resp.distribution.distribution_config.origins.items[0].vpc_origin_config.origin_read_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].vpc_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].response_completion_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.origin_groups.items[0].selection_criteria #=> String, one of "default", "media-quality-based"
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.grpc_config.enabled #=> Boolean
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].grpc_config.enabled #=> Boolean
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", "None"
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", "TLSv1.3_2025", "TLSv1.2_2025"
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.distribution_config.anycast_ip_list_id #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions #=> Array
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].name #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].definition.string_schema.comment #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].definition.string_schema.default_value #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].definition.string_schema.required #=> Boolean
resp.distribution.distribution_config.connection_mode #=> String, one of "direct", "tenant-only"
resp.distribution.distribution_config.viewer_mtls_config.mode #=> String, one of "required", "optional"
resp.distribution.distribution_config.viewer_mtls_config.trust_store_config.trust_store_id #=> String
resp.distribution.distribution_config.viewer_mtls_config.trust_store_config.advertise_trust_store_ca_names #=> Boolean
resp.distribution.distribution_config.viewer_mtls_config.trust_store_config.ignore_certificate_expiry #=> Boolean
resp.distribution.distribution_config.connection_function_association.id #=> String
resp.distribution.distribution_config.cache_tag_config.header_name #=> String
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:

See Also:



12136
12137
12138
12139
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 12136

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

#update_distribution_tenant(params = {}) ⇒ Types::UpdateDistributionTenantResult

Updates a distribution tenant.

Examples:

Request syntax with placeholder values


resp = client.update_distribution_tenant({
  id: "string", # required
  distribution_id: "string",
  domains: [
    {
      domain: "string", # required
    },
  ],
  customizations: {
    web_acl: {
      action: "override", # required, accepts override, disable
      arn: "string",
    },
    certificate: {
      arn: "string", # required
    },
    geo_restrictions: {
      restriction_type: "blacklist", # required, accepts blacklist, whitelist, none
      locations: ["string"],
    },
  },
  parameters: [
    {
      name: "ParameterName", # required
      value: "ParameterValue", # required
    },
  ],
  connection_group_id: "string",
  if_match: "string", # required
  managed_certificate_request: {
    validation_token_host: "cloudfront", # required, accepts cloudfront, self-hosted
    primary_domain_name: "string",
    certificate_transparency_logging_preference: "enabled", # accepts enabled, disabled
  },
  enabled: false,
})

Response structure


resp.distribution_tenant.id #=> String
resp.distribution_tenant.distribution_id #=> String
resp.distribution_tenant.name #=> String
resp.distribution_tenant.arn #=> String
resp.distribution_tenant.domains #=> Array
resp.distribution_tenant.domains[0].domain #=> String
resp.distribution_tenant.domains[0].status #=> String, one of "active", "inactive"
resp.distribution_tenant.tags.items #=> Array
resp.distribution_tenant.tags.items[0].key #=> String
resp.distribution_tenant.tags.items[0].value #=> String
resp.distribution_tenant.customizations.web_acl.action #=> String, one of "override", "disable"
resp.distribution_tenant.customizations.web_acl.arn #=> String
resp.distribution_tenant.customizations.certificate.arn #=> String
resp.distribution_tenant.customizations.geo_restrictions.restriction_type #=> String, one of "blacklist", "whitelist", "none"
resp.distribution_tenant.customizations.geo_restrictions.locations #=> Array
resp.distribution_tenant.customizations.geo_restrictions.locations[0] #=> String
resp.distribution_tenant.parameters #=> Array
resp.distribution_tenant.parameters[0].name #=> String
resp.distribution_tenant.parameters[0].value #=> String
resp.distribution_tenant.connection_group_id #=> String
resp.distribution_tenant.created_time #=> Time
resp.distribution_tenant.last_modified_time #=> Time
resp.distribution_tenant.enabled #=> Boolean
resp.distribution_tenant.status #=> String
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the distribution tenant.

  • :distribution_id (String) —

    The ID for the multi-tenant distribution.

  • :domains (Array<Types::DomainItem>) —

    The domains to update for the distribution tenant. A domain object can contain only a domain property. You must specify at least one domain. Each distribution tenant can have up to 5 domains.

  • :customizations (Types::Customizations) —

    Customizations for the distribution tenant. For each distribution tenant, you can specify the geographic restrictions, and the Amazon Resource Names (ARNs) for the ACM certificate and WAF web ACL. These are specific values that you can override or disable from the multi-tenant distribution that was used to create the distribution tenant.

  • :parameters (Array<Types::Parameter>) —

    A list of parameter values to add to the resource. A parameter is specified as a key-value pair. A valid parameter value must exist for any parameter that is marked as required in the multi-tenant distribution.

  • :connection_group_id (String) —

    The ID of the target connection group.

  • :if_match (required, String) —

    The value of the ETag header that you received when retrieving the distribution tenant to update. This value is returned in the response of the GetDistributionTenant API operation.

  • :managed_certificate_request (Types::ManagedCertificateRequest) —

    An object that contains the CloudFront managed ACM certificate request.

  • :enabled (Boolean) —

    Indicates whether the distribution tenant should be updated to an enabled state. If you update the distribution tenant and it's not enabled, the distribution tenant won't serve traffic.

Returns:

See Also:



12261
12262
12263
12264
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 12261

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

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]. #=> 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].s3_origin_config.origin_read_timeout #=> Integer
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].custom_origin_config.ip_address_type #=> String, one of "ipv4", "ipv6", "dualstack"
resp.distribution.distribution_config.origins.items[0].custom_origin_config.origin_mtls_config.client_certificate_arn #=> String
resp.distribution.distribution_config.origins.items[0].vpc_origin_config.vpc_origin_id #=> String
resp.distribution.distribution_config.origins.items[0].vpc_origin_config. #=> String
resp.distribution.distribution_config.origins.items[0].vpc_origin_config.origin_read_timeout #=> Integer
resp.distribution.distribution_config.origins.items[0].vpc_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].response_completion_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.origin_groups.items[0].selection_criteria #=> String, one of "default", "media-quality-based"
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.grpc_config.enabled #=> Boolean
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].grpc_config.enabled #=> Boolean
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", "None"
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", "TLSv1.3_2025", "TLSv1.2_2025"
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.distribution_config.anycast_ip_list_id #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions #=> Array
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].name #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].definition.string_schema.comment #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].definition.string_schema.default_value #=> String
resp.distribution.distribution_config.tenant_config.parameter_definitions[0].definition.string_schema.required #=> Boolean
resp.distribution.distribution_config.connection_mode #=> String, one of "direct", "tenant-only"
resp.distribution.distribution_config.viewer_mtls_config.mode #=> String, one of "required", "optional"
resp.distribution.distribution_config.viewer_mtls_config.trust_store_config.trust_store_id #=> String
resp.distribution.distribution_config.viewer_mtls_config.trust_store_config.advertise_trust_store_ca_names #=> Boolean
resp.distribution.distribution_config.viewer_mtls_config.trust_store_config.ignore_certificate_expiry #=> Boolean
resp.distribution.distribution_config.connection_function_association.id #=> String
resp.distribution.distribution_config.cache_tag_config.header_name #=> String
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:

See Also:



12535
12536
12537
12538
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 12535

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

#update_domain_association(params = {}) ⇒ Types::UpdateDomainAssociationResult

We recommend that you use the UpdateDomainAssociation API operation to move a domain association, as it supports both standard distributions and distribution tenants. AssociateAlias performs similar checks but only supports standard distributions.

Moves a domain from its current standard distribution or distribution tenant to another one.

You must first disable the source distribution (standard distribution or distribution tenant) and then separately call this operation to move the domain to another target distribution (standard distribution or distribution tenant).

To use this operation, specify the domain and the ID of the target resource (standard distribution or distribution tenant). For more information, including how to set up the target resource, prerequisites that you must complete, and other restrictions, see Moving an alternate domain name to a different standard distribution or distribution tenant in the Amazon CloudFront Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.update_domain_association({
  domain: "string", # required
  target_resource: { # required
    distribution_id: "string",
    distribution_tenant_id: "string",
  },
  if_match: "string",
})

Response structure


resp.domain #=> String
resp.resource_id #=> String
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain (required, String) —

    The domain to update.

  • :target_resource (required, Types::DistributionResourceId) —

    The target standard distribution or distribution tenant resource for the domain. You can specify either DistributionId or DistributionTenantId, but not both.

  • :if_match (String) —

    The value of the ETag identifier for the standard distribution or distribution tenant that will be associated with the domain.

Returns:

See Also:



12607
12608
12609
12610
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 12607

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

See Also:



12688
12689
12690
12691
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 12688

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:

See Also:



12755
12756
12757
12758
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 12755

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: "FunctionName", # 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.

Returns:

See Also:



12882
12883
12884
12885
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 12882

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:

  1. Get the current key group with GetKeyGroup or GetKeyGroupConfig.

  2. Locally modify the fields in the key group that you want to update. For example, add or remove public key IDs.

  3. 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:

See Also:



12943
12944
12945
12946
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 12943

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:

See Also:



13010
13011
13012
13013
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 13010

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:

See Also:



13061
13062
13063
13064
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 13061

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:

  1. Use GetOriginRequestPolicyConfig to get the current configuration.

  2. Locally modify the fields in the origin request policy configuration that you want to update.

  3. 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:

See Also:



13158
13159
13160
13161
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 13158

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:

See Also:



13208
13209
13210
13211
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 13208

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:

  1. Call GetRealtimeLogConfig to get the current real-time log configuration.

  2. Locally modify the parameters in the real-time log configuration that you want to update.

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

  • :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:

See Also:



13296
13297
13298
13299
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 13296

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:

  1. Use GetResponseHeadersPolicyConfig to get the current policy's configuration.

  2. Modify the fields in the response headers policy configuration that you want to update.

  3. 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:

See Also:



13469
13470
13471
13472
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 13469

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, None
    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]. #=> 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", "None"
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:

See Also:



13559
13560
13561
13562
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 13559

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

#update_trust_store(params = {}) ⇒ Types::UpdateTrustStoreResult

Updates a trust store.

Examples:

Request syntax with placeholder values


resp = client.update_trust_store({
  id: "ResourceId", # required
  ca_certificates_bundle_source: { # required
    ca_certificates_bundle_s3_location: {
      bucket: "string", # required
      key: "string", # required
      region: "CaCertificatesBundleS3LocationRegionString", # required
      version: "string",
    },
  },
  if_match: "string", # required
})

Response structure


resp.trust_store.id #=> String
resp.trust_store.arn #=> String
resp.trust_store.name #=> String
resp.trust_store.status #=> String, one of "pending", "active", "failed"
resp.trust_store.number_of_ca_certificates #=> Integer
resp.trust_store.last_modified_time #=> Time
resp.trust_store.reason #=> String
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The trust store ID.

  • :ca_certificates_bundle_source (required, Types::CaCertificatesBundleSource) —

    The CA certificates bundle source.

  • :if_match (required, String) —

    The current version (ETag value) of the trust store you are updating.

Returns:

See Also:



13611
13612
13613
13614
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 13611

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

#update_vpc_origin(params = {}) ⇒ Types::UpdateVpcOriginResult

Update an Amazon CloudFront VPC origin in your account.

Examples:

Example: To update a VPC origin


# The following command updates a VPC origin:

resp = client.update_vpc_origin({
  id: "vo_BQwjxxQxjCaBcQLzJUFkDM", 
  if_match: "ETVPDKIKX0DER", 
  vpc_origin_endpoint_config: {
    arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-alb-us-west-2/e6aa5c7d26415c6d", 
    http_port: 80, 
    https_port: 443, 
    name: "my-vpcorigin-name", 
    origin_protocol_policy: "match-viewer", 
    origin_ssl_protocols: {
      items: [
        "TLSv1.1", 
        "TLSv1.2", 
      ], 
      quantity: 2, 
    }, 
  }, 
})

resp.to_h outputs the following:
{
  etag: "E3UN6WX5RRO2AG", 
  vpc_origin: {
    arn: "arn:aws:cloudfront::123456789012:vpcorigin/vo_BQwjxxQxjCaBcQLzJUFkDM", 
    created_time: Time.parse("2024-10-15T17:19:42.318Z"), 
    id: "vo_BQwjxxQxjCaBcQLzJUFkDM", 
    last_modified_time: Time.parse("2024-10-15T17:47:08.133Z"), 
    status: "Deploying", 
    vpc_origin_endpoint_config: {
      arn: "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-alb-us-west-2/e6aa5c7d26415c6d", 
      http_port: 80, 
      https_port: 443, 
      name: "my-vpcorigin-name", 
      origin_protocol_policy: "match-viewer", 
      origin_ssl_protocols: {
        items: [
          "TLSv1.1", 
          "TLSv1.2", 
        ], 
        quantity: 2, 
      }, 
    }, 
  }, 
}

Request syntax with placeholder values


resp = client.update_vpc_origin({
  vpc_origin_endpoint_config: { # required
    name: "string", # required
    arn: "string", # required
    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
    },
  },
  id: "string", # required
  if_match: "string", # required
})

Response structure


resp.vpc_origin.id #=> String
resp.vpc_origin.arn #=> String
resp.vpc_origin. #=> String
resp.vpc_origin.status #=> String
resp.vpc_origin.created_time #=> Time
resp.vpc_origin.last_modified_time #=> Time
resp.vpc_origin.vpc_origin_endpoint_config.name #=> String
resp.vpc_origin.vpc_origin_endpoint_config.arn #=> String
resp.vpc_origin.vpc_origin_endpoint_config.http_port #=> Integer
resp.vpc_origin.vpc_origin_endpoint_config.https_port #=> Integer
resp.vpc_origin.vpc_origin_endpoint_config.origin_protocol_policy #=> String, one of "http-only", "match-viewer", "https-only"
resp.vpc_origin.vpc_origin_endpoint_config.origin_ssl_protocols.quantity #=> Integer
resp.vpc_origin.vpc_origin_endpoint_config.origin_ssl_protocols.items #=> Array
resp.vpc_origin.vpc_origin_endpoint_config.origin_ssl_protocols.items[0] #=> String, one of "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2"
resp.etag #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :vpc_origin_endpoint_config (required, Types::VpcOriginEndpointConfig) —

    The VPC origin endpoint configuration.

  • :id (required, String) —

    The VPC origin ID.

  • :if_match (required, String) —

    The VPC origin to update, if a match occurs.

Returns:

See Also:



13722
13723
13724
13725
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 13722

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

#verify_dns_configuration(params = {}) ⇒ Types::VerifyDnsConfigurationResult

Verify the DNS configuration for your domain names. This API operation checks whether your domain name points to the correct routing endpoint of the connection group, such as d111111abcdef8.cloudfront.net. You can use this API operation to troubleshoot and resolve DNS configuration issues.

Examples:

Request syntax with placeholder values


resp = client.verify_dns_configuration({
  domain: "string",
  identifier: "string", # required
})

Response structure


resp.dns_configuration_list #=> Array
resp.dns_configuration_list[0].domain #=> String
resp.dns_configuration_list[0].status #=> String, one of "valid-configuration", "invalid-configuration", "unknown-configuration"
resp.dns_configuration_list[0].reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain (String) —

    The domain name that you're verifying.

  • :identifier (required, String) —

    The identifier of the distribution tenant. You can specify the ARN, ID, or name of the distribution tenant.

Returns:

See Also:



13762
13763
13764
13765
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 13762

def verify_dns_configuration(params = {}, options = {})
  req = build_request(:verify_dns_configuration, 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
invalidation_for_distribution_tenant_completed #get_invalidation_for_distribution_tenant 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.



13880
13881
13882
13883
13884
 
# File 'gems/aws-sdk-cloudfront/lib/aws-sdk-cloudfront/client.rb', line 13880

def wait_until(waiter_name, params = {}, options = {})
  w = waiter(waiter_name, options)
  yield(w.waiter) if block_given? # deprecated
  w.wait(params)
end