Amazon CloudFront

This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the Amazon CloudFront Developer Guide.

Usage

cloudfront(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- cloudfront(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

associate_alias	The AssociateAlias API operation only supports standard distributions
associate_distribution_tenant_web_acl	Associates the WAF web ACL with a distribution tenant
associate_distribution_web_acl	Associates the WAF web ACL with a distribution
copy_distribution	Creates a staging distribution using the configuration of the provided primary distribution
create_anycast_ip_list	Creates an Anycast static IP list
create_cache_policy	Creates a cache policy
create_cloud_front_origin_access_identity	Creates a new origin access identity
create_connection_function	Creates a connection function
create_connection_group	Creates a connection group
create_continuous_deployment_policy	Creates a continuous deployment policy that distributes traffic for a custom domain name to two different CloudFront distributions
create_distribution	Creates a CloudFront distribution
create_distribution_tenant	Creates a distribution tenant
create_distribution_with_tags	Create a new distribution with tags
create_field_level_encryption_config	Create a new field-level encryption configuration
create_field_level_encryption_profile	Create a field-level encryption profile
create_function	Creates a CloudFront function
create_invalidation	Create a new invalidation
create_invalidation_for_distribution_tenant	Creates an invalidation for a distribution tenant
create_key_group	Creates a key group that you can use with CloudFront signed URLs and signed cookies
create_key_value_store	Specifies the key value store resource to add to your account
create_monitoring_subscription	Enables or disables additional Amazon CloudWatch metrics for the specified CloudFront distribution
create_origin_access_control	Creates a new origin access control in CloudFront
create_origin_request_policy	Creates an origin request policy
create_public_key	Uploads a public key to CloudFront that you can use with signed URLs and signed cookies, or with field-level encryption
create_realtime_log_config	Creates a real-time log configuration
create_response_headers_policy	Creates a response headers policy
create_streaming_distribution	This API is deprecated
create_streaming_distribution_with_tags	This API is deprecated
create_trust_store	Creates a trust store
create_vpc_origin	Create an Amazon CloudFront VPC origin
delete_anycast_ip_list	Deletes an Anycast static IP list
delete_cache_policy	Deletes a cache policy
delete_cloud_front_origin_access_identity	Delete an origin access identity
delete_connection_function	Deletes a connection function
delete_connection_group	Deletes a connection group
delete_continuous_deployment_policy	Deletes a continuous deployment policy
delete_distribution	Delete a distribution
delete_distribution_tenant	Deletes a distribution tenant
delete_field_level_encryption_config	Remove a field-level encryption configuration
delete_field_level_encryption_profile	Remove a field-level encryption profile
delete_function	Deletes a CloudFront function
delete_key_group	Deletes a key group
delete_key_value_store	Specifies the key value store to delete
delete_monitoring_subscription	Disables additional CloudWatch metrics for the specified CloudFront distribution
delete_origin_access_control	Deletes a CloudFront origin access control
delete_origin_request_policy	Deletes an origin request policy
delete_public_key	Remove a public key you previously added to CloudFront
delete_realtime_log_config	Deletes a real-time log configuration
delete_resource_policy	Deletes the resource policy attached to the CloudFront resource
delete_response_headers_policy	Deletes a response headers policy
delete_streaming_distribution	Delete a streaming distribution
delete_trust_store	Deletes a trust store
delete_vpc_origin	Delete an Amazon CloudFront VPC origin
describe_connection_function	Describes a connection function
describe_function	Gets configuration information and metadata about a CloudFront function, but not the function's code
describe_key_value_store	Specifies the key value store and its configuration
disassociate_distribution_tenant_web_acl	Disassociates a distribution tenant from the WAF web ACL
disassociate_distribution_web_acl	Disassociates a distribution from the WAF web ACL
get_anycast_ip_list	Gets an Anycast static IP list
get_cache_policy	Gets a cache policy, including the following metadata:
get_cache_policy_config	Gets a cache policy configuration
get_cloud_front_origin_access_identity	Get the information about an origin access identity
get_cloud_front_origin_access_identity_config	Get the configuration information about an origin access identity
get_connection_function	Gets a connection function
get_connection_group	Gets information about a connection group
get_connection_group_by_routing_endpoint	Gets information about a connection group by using the endpoint that you specify
get_continuous_deployment_policy	Gets a continuous deployment policy, including metadata (the policy's identifier and the date and time when the policy was last modified)
get_continuous_deployment_policy_config	Gets configuration information about a continuous deployment policy
get_distribution	Get the information about a distribution
get_distribution_config	Get the configuration information about a distribution
get_distribution_tenant	Gets information about a distribution tenant
get_distribution_tenant_by_domain	Gets information about a distribution tenant by the associated domain
get_field_level_encryption	Get the field-level encryption configuration information
get_field_level_encryption_config	Get the field-level encryption configuration information
get_field_level_encryption_profile	Get the field-level encryption profile information
get_field_level_encryption_profile_config	Get the field-level encryption profile configuration information
get_function	Gets the code of a CloudFront function
get_invalidation	Get the information about an invalidation
get_invalidation_for_distribution_tenant	Gets information about a specific invalidation for a distribution tenant
get_key_group	Gets a key group, including the date and time when the key group was last modified
get_key_group_config	Gets a key group configuration
get_managed_certificate_details	Gets details about the CloudFront managed ACM certificate
get_monitoring_subscription	Gets information about whether additional CloudWatch metrics are enabled for the specified CloudFront distribution
get_origin_access_control	Gets a CloudFront origin access control, including its unique identifier
get_origin_access_control_config	Gets a CloudFront origin access control configuration
get_origin_request_policy	Gets an origin request policy, including the following metadata:
get_origin_request_policy_config	Gets an origin request policy configuration
get_public_key	Gets a public key
get_public_key_config	Gets a public key configuration
get_realtime_log_config	Gets a real-time log configuration
get_resource_policy	Retrieves the resource policy for the specified CloudFront resource that you own and have shared
get_response_headers_policy	Gets a response headers policy, including metadata (the policy's identifier and the date and time when the policy was last modified)
get_response_headers_policy_config	Gets a response headers policy configuration
get_streaming_distribution	Gets information about a specified RTMP distribution, including the distribution configuration
get_streaming_distribution_config	Get the configuration information about a streaming distribution
get_trust_store	Gets a trust store
get_vpc_origin	Get the details of an Amazon CloudFront VPC origin
list_anycast_ip_lists	Lists your Anycast static IP lists
list_cache_policies	Gets a list of cache policies
list_cloud_front_origin_access_identities	Lists origin access identities
list_conflicting_aliases	The ListConflictingAliases API operation only supports standard distributions
list_connection_functions	Lists connection functions
list_connection_groups	Lists the connection groups in your Amazon Web Services account
list_continuous_deployment_policies	Gets a list of the continuous deployment policies in your Amazon Web Services account
list_distributions	List CloudFront distributions
list_distributions_by_anycast_ip_list_id	Lists the distributions in your account that are associated with the specified AnycastIpListId
list_distributions_by_cache_policy_id	Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified cache policy
list_distributions_by_connection_function	Lists distributions by connection function
list_distributions_by_connection_mode	Lists the distributions by the connection mode that you specify
list_distributions_by_key_group	Gets a list of distribution IDs for distributions that have a cache behavior that references the specified key group
list_distributions_by_origin_request_policy_id	Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified origin request policy
list_distributions_by_owned_resource	Lists the CloudFront distributions that are associated with the specified resource that you own
list_distributions_by_realtime_log_config	Gets a list of distributions that have a cache behavior that's associated with the specified real-time log configuration
list_distributions_by_response_headers_policy_id	Gets a list of distribution IDs for distributions that have a cache behavior that's associated with the specified response headers policy
list_distributions_by_trust_store	Lists distributions by trust store
list_distributions_by_vpc_origin_id	List CloudFront distributions by their VPC origin ID
list_distributions_by_web_acl_id	List the distributions that are associated with a specified WAF web ACL
list_distribution_tenants	Lists the distribution tenants in your Amazon Web Services account
list_distribution_tenants_by_customization	Lists distribution tenants by the customization that you specify
list_domain_conflicts	We recommend that you use the ListDomainConflicts API operation to check for domain conflicts, as it supports both standard distributions and distribution tenants
list_field_level_encryption_configs	List all field-level encryption configurations that have been created in CloudFront for this account
list_field_level_encryption_profiles	Request a list of field-level encryption profiles that have been created in CloudFront for this account
list_functions	Gets a list of all CloudFront functions in your Amazon Web Services account
list_invalidations	Lists invalidation batches
list_invalidations_for_distribution_tenant	Lists the invalidations for a distribution tenant
list_key_groups	Gets a list of key groups
list_key_value_stores	Specifies the key value stores to list
list_origin_access_controls	Gets the list of CloudFront origin access controls (OACs) in this Amazon Web Services account
list_origin_request_policies	Gets a list of origin request policies
list_public_keys	List all public keys that have been added to CloudFront for this account
list_realtime_log_configs	Gets a list of real-time log configurations
list_response_headers_policies	Gets a list of response headers policies
list_streaming_distributions	List streaming distributions
list_tags_for_resource	List tags for a CloudFront resource
list_trust_stores	Lists trust stores
list_vpc_origins	List the CloudFront VPC origins in your account
publish_connection_function	Publishes a connection function
publish_function	Publishes a CloudFront function by copying the function code from the DEVELOPMENT stage to LIVE
put_resource_policy	Creates a resource control policy for a given CloudFront resource
tag_resource	Add tags to a CloudFront resource
test_connection_function	Tests a connection function
test_function	Tests a CloudFront function
untag_resource	Remove tags from a CloudFront resource
update_anycast_ip_list	Updates an Anycast static IP list
update_cache_policy	Updates a cache policy configuration
update_cloud_front_origin_access_identity	Update an origin access identity
update_connection_function	Updates a connection function
update_connection_group	Updates a connection group
update_continuous_deployment_policy	Updates a continuous deployment policy
update_distribution	Updates the configuration for a CloudFront distribution
update_distribution_tenant	Updates a distribution tenant
update_distribution_with_staging_config	Copies the staging distribution's configuration to its corresponding primary distribution
update_domain_association	We recommend that you use the UpdateDomainAssociation API operation to move a domain association, as it supports both standard distributions and distribution tenants
update_field_level_encryption_config	Update a field-level encryption configuration
update_field_level_encryption_profile	Update a field-level encryption profile
update_function	Updates a CloudFront function
update_key_group	Updates a key group
update_key_value_store	Specifies the key value store to update
update_origin_access_control	Updates a CloudFront origin access control
update_origin_request_policy	Updates an origin request policy configuration
update_public_key	Update public key information
update_realtime_log_config	Updates a real-time log configuration
update_response_headers_policy	Updates a response headers policy
update_streaming_distribution	Update a streaming distribution
update_trust_store	Updates a trust store
update_vpc_origin	Update an Amazon CloudFront VPC origin in your account
verify_dns_configuration	Verify the DNS configuration for your domain names

Examples

if (FALSE) { # \dontrun{
svc <- cloudfront()
svc$associate_alias(
  Foo = 123
)
} # }