Module aws_sdk_cloudfront::types

source ·
Expand description

Data structures used by operation inputs/outputs.

Modules§

  • Builders
  • Error types that Amazon CloudFront can respond with.

Structs§

  • A list of key groups, and the public keys in each key group, that CloudFront can use to verify the signatures of signed URLs and signed cookies.

  • A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.

  • Amazon Web Services services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions. The status is returned in the CloudFront response; you can't configure it yourself.

  • A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

  • A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:

  • A complex type that describes how CloudFront processes requests.

  • A complex type that contains zero or more CacheBehavior elements.

  • A cache policy.

  • A cache policy configuration.

  • An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in the cache key and in requests that CloudFront sends to the origin.

  • An object that determines whether any HTTP headers (and if so, which headers) are included in the cache key and in requests that CloudFront sends to the origin.

  • A list of cache policies.

  • An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in the cache key and in requests that CloudFront sends to the origin.

  • Contains a cache policy.

  • A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:

  • CloudFront origin access identity.

  • Origin access identity configuration. Send a GET request to the /CloudFront API version/CloudFront/identity ID/config resource.

  • Lists the origin access identities for CloudFront.Send a GET request to the /CloudFront API version/origin-access-identity/cloudfront resource. The response includes a CloudFrontOriginAccessIdentityList element with zero or more CloudFrontOriginAccessIdentitySummary child elements. By default, your entire list of origin access identities is returned in one single page. If the list is long, you can paginate it using the MaxItems and Marker parameters.

  • Summary of the information about a CloudFront origin access identity.

  • An alias (also called a CNAME) and the CloudFront distribution and Amazon Web Services account ID that it's associated with. The distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own.

  • A list of aliases (also called CNAMEs) and the CloudFront distributions and Amazon Web Services accounts that they are associated with. In the list, the distribution and account IDs are partially hidden, which allows you to identify the distributions and accounts that you own, but helps to protect the information of ones that you don't own.

  • A field-level encryption content type profile.

  • The configuration for a field-level encryption content type-profile mapping.

  • Field-level encryption content type-profile.

  • A continuous deployment policy.

  • Contains the configuration for a continuous deployment policy.

  • Contains a list of continuous deployment policies.

  • A summary of the information about your continuous deployment policies.

  • This configuration determines which HTTP requests are sent to the staging distribution. If the HTTP request contains a header and value that matches what you specify here, the request is sent to the staging distribution. Otherwise the request is sent to the primary distribution.

  • Contains the percentage of traffic to send to a staging distribution.

  • Contains a list of cookie names.

  • This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

  • A complex type that controls:

  • A complex type that controls:

  • A complex type that contains the list of Custom Headers for each origin.

  • A custom origin. A custom origin is any origin that is not an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is configured with static website hosting is a custom origin.

  • A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if request URLs don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

  • A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.

  • A distribution configuration.

  • A distribution Configuration and a list of tags to be associated with the distribution.

  • A list of distribution IDs.

  • A distribution list.

  • A summary of the information about a CloudFront distribution.

  • Complex data type for field-level encryption profiles that includes all of the encryption entities.

  • Complex data type for field-level encryption profiles that includes the encryption key and field pattern specifications.

  • Contains information about the Amazon Kinesis data stream where you are sending real-time log data in a real-time log configuration.

  • A complex data type that includes the profile configurations and other options specified for field-level encryption.

  • A complex data type that includes the profile configurations specified for field-level encryption.

  • List of field-level encryption configurations.

  • A complex data type for field-level encryption profiles.

  • A complex data type of profiles for the field-level encryption.

  • List of field-level encryption profiles.

  • The field-level encryption profile summary.

  • A summary of a field-level encryption item.

  • A complex data type that includes the field patterns to match for field-level encryption.

  • This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

  • A CloudFront function that is associated with a cache behavior in a CloudFront distribution.

  • A list of CloudFront functions that are associated with a cache behavior in a CloudFront distribution. Your functions must be published to the LIVE stage to associate them with a cache behavior.

  • Contains configuration information about a CloudFront function.

  • A list of CloudFront functions.

  • Contains metadata about a CloudFront function.

  • Contains configuration information and metadata about a CloudFront function.

  • A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.

  • Contains a list of HTTP header names.

  • The import source for the key value store.

  • An invalidation.

  • An invalidation batch.

  • The InvalidationList complex type describes the list of invalidation objects. For more information about invalidation, see Invalidating Objects (Web Distributions Only) in the Amazon CloudFront Developer Guide.

  • A summary of an invalidation request.

  • A key group.

  • A key group configuration.

  • A list of key groups.

  • Contains information about a key group.

  • A list of CloudFront key pair identifiers.

  • The key value store. Use this to separate data from function code, allowing you to update data without having to publish a new version of a function. The key value store holds keys and their corresponding values.

  • The key value store association.

  • The key value store associations.

  • The key value store list.

  • A list of identifiers for the public keys that CloudFront can use to verify the signatures of signed URLs and signed cookies.

  • Contains information about the Amazon Kinesis data stream where you are sending real-time log data.

  • A complex type that contains a Lambda@Edge function association.

  • A complex type that specifies a list of Lambda@Edge functions associations for a cache behavior.

  • A complex type that controls whether access logs are written for the distribution.

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

  • An origin.

  • A CloudFront origin access control, including its unique identifier.

  • A CloudFront origin access control configuration.

  • A list of CloudFront origin access controls.

  • A CloudFront origin access control.

  • A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.

  • An origin group includes two origins (a primary origin and a second origin to failover to) and a failover criteria that you specify. You create an origin group to support origin failover in CloudFront. When you create or update a distribution, you can specify the origin group instead of a single origin, and CloudFront will failover from the primary origin to the second origin under the failover conditions that you've chosen.

  • A complex data type that includes information about the failover criteria for an origin group, including the status codes for which CloudFront will failover from the primary origin to the second origin.

  • An origin in an origin group.

  • A complex data type for the origins included in an origin group.

  • A complex data type for the origin groups specified for a distribution.

  • An origin request policy.

  • An origin request policy configuration.

  • An object that determines whether any cookies in viewer requests (and if so, which cookies) are included in requests that CloudFront sends to the origin.

  • An object that determines whether any HTTP headers (and if so, which headers) are included in requests that CloudFront sends to the origin.

  • A list of origin request policies.

  • An object that determines whether any URL query strings in viewer requests (and if so, which query strings) are included in requests that CloudFront sends to the origin.

  • Contains an origin request policy.

  • CloudFront Origin Shield.

  • A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.

  • Contains information about the origins for this distribution.

  • This object determines 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.

  • A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

  • A public key that you can use with signed URLs and signed cookies, or with field-level encryption.

  • Configuration information about a public key that you can use with signed URLs and signed cookies, or with field-level encryption.

  • A list of public keys that you can use with signed URLs and signed cookies, or with field-level encryption.

  • Contains information about a public key.

  • Query argument-profile mapping for field-level encryption.

  • Configuration for query argument-profile mapping for field-level encryption.

  • Query argument-profile mapping for field-level encryption.

  • This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field.

  • Contains a list of query string names.

  • A real-time log configuration.

  • A list of real-time log configurations.

  • A subscription configuration for additional CloudWatch metrics.

  • A response headers policy.

  • A list of HTTP header names that CloudFront includes as values for the Access-Control-Allow-Headers HTTP response header.

  • A list of HTTP methods that CloudFront includes as values for the Access-Control-Allow-Methods HTTP response header.

  • A list of origins (domain names) that CloudFront can use as the value for the Access-Control-Allow-Origin HTTP response header.

  • A list of HTTP headers that CloudFront includes as values for the Access-Control-Expose-Headers HTTP response header.

  • A response headers policy configuration.

  • The policy directives and their values that CloudFront includes as values for the Content-Security-Policy HTTP response header.

  • Determines whether CloudFront includes the X-Content-Type-Options HTTP response header with its value set to nosniff.

  • A configuration for a set of HTTP response headers that are used for cross-origin resource sharing (CORS). CloudFront adds these headers to HTTP responses that it sends for CORS requests that match a cache behavior associated with this response headers policy.

  • An HTTP response header name and its value. CloudFront includes this header in HTTP responses that it sends for requests that match a cache behavior that's associated with this response headers policy.

  • A list of HTTP response header names and their values. CloudFront includes these headers in HTTP responses that it sends for requests that match a cache behavior that's associated with this response headers policy.

  • Determines whether CloudFront includes the X-Frame-Options HTTP response header and the header's value.

  • A list of response headers policies.

  • Determines whether CloudFront includes the Referrer-Policy HTTP response header and the header's value.

  • The name of an HTTP header that CloudFront removes from HTTP responses to requests that match the cache behavior that this response headers policy is attached to.

  • A list of HTTP header names that CloudFront removes from HTTP responses to requests that match the cache behavior that this response headers policy is attached to.

  • A configuration for a set of security-related HTTP response headers. CloudFront adds these headers to HTTP responses that it sends for requests that match a cache behavior associated with this response headers policy.

  • A configuration for enabling the Server-Timing header in HTTP responses sent from CloudFront. CloudFront adds this header to HTTP responses that it sends in response to requests that match a cache behavior that's associated with this response headers policy.

  • Determines whether CloudFront includes the Strict-Transport-Security HTTP response header and the header's value.

  • Contains a response headers policy.

  • Determines whether CloudFront includes the X-XSS-Protection HTTP response header and the header's value.

  • A complex type that identifies ways in which you want to restrict distribution of your content.

  • A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

  • A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin or an S3 bucket that is configured as a website endpoint, use the CustomOriginConfig element instead.

  • Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user's requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values.

  • A list of Amazon Web Services accounts and the active CloudFront key pairs in each account that CloudFront can use to verify the signatures of signed URLs and signed cookies.

  • The CloudFront domain name of the staging distribution.

  • A complex data type for the status codes that you specify that, when returned by a primary origin, trigger CloudFront to failover to a second origin.

  • A streaming distribution tells CloudFront where you want RTMP content to be delivered from, and the details about how to track and manage content delivery.

  • The RTMP distribution's configuration information.

  • A streaming distribution Configuration and a list of tags to be associated with the streaming distribution.

  • A streaming distribution list.

  • A summary of the information for a CloudFront streaming distribution.

  • A complex type that controls whether access logs are written for this streaming distribution.

  • A complex type that contains Tag key and Tag value.

  • A complex type that contains zero or more Tag elements.

  • A complex type that contains zero or more Tag elements.

  • Contains the result of testing a CloudFront function with TestFunction.

  • The traffic configuration of your continuous deployment.

  • A list of key groups whose public keys CloudFront can use to verify the signatures of signed URLs and signed cookies.

  • A list of Amazon Web Services accounts whose public keys CloudFront can use to verify the signatures of signed URLs and signed cookies.

  • A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.

Enums§

  • When writing a match expression against CachePolicyCookieBehavior, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against CachePolicyHeaderBehavior, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against CachePolicyQueryStringBehavior, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against CachePolicyType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against CertificateSource, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against ContinuousDeploymentPolicyType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against EventType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against Format, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against FrameOptionsList, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against FunctionRuntime, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against FunctionStage, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against GeoRestrictionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against HttpVersion, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against IcpRecordalStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against ImportSourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against ItemSelection, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against Method, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against MinimumProtocolVersion, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against OriginAccessControlOriginTypes, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against OriginAccessControlSigningBehaviors, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against OriginAccessControlSigningProtocols, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against OriginProtocolPolicy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against OriginRequestPolicyCookieBehavior, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against OriginRequestPolicyHeaderBehavior, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against OriginRequestPolicyQueryStringBehavior, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against OriginRequestPolicyType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against PriceClass, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against RealtimeMetricsSubscriptionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against ReferrerPolicyList, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against ResponseHeadersPolicyAccessControlAllowMethodsValues, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against ResponseHeadersPolicyType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against SslProtocol, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against SslSupportMethod, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
  • When writing a match expression against ViewerProtocolPolicy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.